Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add feat/ContactUs-form branch #381

Closed
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions backend/controller/contact.controller.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
const { z } = require("zod");
const nodemailer = require("nodemailer");
require("dotenv").config();

// Define the Zod schema for contact form validation
const contactSchema = z.object({
mail: z.string().email(),
subject: z.string().min(5, "Subject must be at least 5 characters long."),
message: z.string().min(5, "Message must be at least 5 characters long."),
});

const createContactUs = async (req, res) => {
const validation = contactSchema.safeParse(req.body);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Environment variables EMAIL_USER and EMAIL_PASS are not set.

Please set EMAIL_USER and EMAIL_PASS in your deployment environment to prevent authentication issues.

🔗 Analysis chain

Ensure environment variables are loaded correctly.

While you have require("dotenv").config(); at the top, it's important to ensure that the environment variables EMAIL_USER and EMAIL_PASS are properly loaded and handled in case they're missing.

Run the following script to check if the environment variables are set:

Ensure that these variables are set in your deployment environment to prevent authentication errors.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that EMAIL_USER and EMAIL_PASS are defined in the environment.

# Check for EMAIL_USER
if [ -z "$EMAIL_USER" ]; then
  echo "Environment variable EMAIL_USER is not set."
else
  echo "Environment variable EMAIL_USER is set."
fi

# Check for EMAIL_PASS
if [ -z "$EMAIL_PASS" ]; then
  echo "Environment variable EMAIL_PASS is not set."
else
  echo "Environment variable EMAIL_PASS is set."
fi

Length of output: 225


if (!validation.success) {
console.error("Error at validation");
return res.status(400).json({
status: "error",
errors: "contactSchema is not validate",
});
}

const { mail, subject, message } = req.body;

try {
const transporter = nodemailer.createTransport({
service: "gmail",
host: "smtp.gmail.com",
port: 587,
secure: false,
auth: {
user: process.env.EMAIL_USER,
pass: process.env.EMAIL_PASS,
},
// Uncomment this if needed
// tls: {
// rejectUnauthorized: false, // Disable strict SSL verification
// },
});

const mailOptions = {
// from: mail,
from: process.env.EMAIL_USER,
+ replyTo: mail,
to: process.env.EMAIL_USER,
subject: subject,
text: message,
};

// Send mail with defined transport object
transporter.sendMail(mailOptions, (error, mailOptions) => {
if (error) {
return console.error("Error occurred: " + error.message);
}

});

res.status(200).json({
status: "success",
message: "Your contact request has been successfully received.",
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix race condition in email sending logic.

The success response is sent regardless of whether the email was successfully sent or not, creating a race condition.

Apply this diff to fix the issue:

    // Send mail with defined transport object
-   transporter.sendMail(mailOptions, (error, mailOptions) => {
-     if (error) {
-       return console.error("Error occurred: " + error.message);
-     }
-
-   });
-
-   res.status(200).json({
-     status: "success",
-     message: "Your contact request has been successfully received.",
-   });
+   await new Promise((resolve, reject) => {
+     transporter.sendMail(mailOptions, (error, info) => {
+       if (error) {
+         console.error("Error occurred: " + error.message);
+         reject(error);
+       }
+       resolve(info);
+     });
+   });
+   
+   res.status(200).json({
+     status: "success",
+     message: "Your contact request has been successfully received.",
+   });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
transporter.sendMail(mailOptions, (error, mailOptions) => {
if (error) {
return console.error("Error occurred: " + error.message);
}
});
res.status(200).json({
status: "success",
message: "Your contact request has been successfully received.",
});
await new Promise((resolve, reject) => {
transporter.sendMail(mailOptions, (error, info) => {
if (error) {
console.error("Error occurred: " + error.message);
reject(error);
}
resolve(info);
});
});
res.status(200).json({
status: "success",
message: "Your contact request has been successfully received.",
});

} catch (err) {
console.error(`Error at transport: ${err}`);
res.status(500).json({
status: "error",
message:
"There was an error sending your message. Please try again later.",
});
}
};

module.exports = { createContactUs };
2 changes: 1 addition & 1 deletion backend/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ require("dotenv").config();
const cors = require("cors");
const mongoose = require("mongoose");
const logger = require("./config/logger");
const errorMiddleware = require("./middlewares/errorMiddleware"); // Corrected typo
const errorMiddleware = require("../backend/middlewares/errorMiddleware"); // Corrected typo
const passport = require("passport");
const { handleGoogleOAuth } = require("./controller/googleOAuth.controller");
const app = express();
Expand Down
7 changes: 7 additions & 0 deletions backend/routes/contactUsRouter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const express = require("express");
const router = express.Router();
const { createContactUs } = require("../controller/contact.controller"); // Correct controller path

router.post("/contactus", createContactUs);

module.exports = router;
60 changes: 24 additions & 36 deletions backend/routes/index.js
Original file line number Diff line number Diff line change
@@ -1,57 +1,45 @@
const express = require("express");
const logger = require("../config/logger"); // Import your Winston logger
const logger = require("../config/logger"); // Import Winston logger
require("dotenv").config();

const config = {
JWT_SECRET: process.env.JWT_SECRET,
GOOGLE_CLIENT_ID: process.env.GOOGLE_CLIENT_ID,
GOOGLE_CLIENT_SECRET: process.env.GOOGLE_CLIENT_SECRET,
};

const router = express.Router();

let feedbackRouter;

try {
feedbackRouter = require("./feedbackRouter");
} catch (error) {
logger.error("Error loading feedbackRouter:", error); // Log the error with Winston
feedbackRouter = (req, res) => {
res
.status(500)
.json({ error: "Feedback functionality is currently unavailable" });
};
}
// Utility function to safely load modules and handle errors
const safeRequire = (modulePath, fallbackMessage) => {
try {
return require(modulePath);
} catch (error) {
logger.error(`Error loading ${modulePath}:`, error);
return (req, res) => {
res.status(500).json({ error: fallbackMessage });
};
}
};

let eventRouter;
try {
eventRouter = require("./eventRouter");
} catch (error) {
logger.error("Error loading eventRouter:", error); // Log the error with Winston
eventRouter = (req, res) => {
res
.status(500)
.json({ error: "Event functionality is currently unavailable" });
};
}
// Safely load routers with error handling
const feedbackRouter = safeRequire("./feedbackRouter", "Feedback functionality is currently unavailable");
const contactUsRouter = safeRequire("./contactUsRouter", "Contact Us functionality is currently unavailable");
const eventRouter = safeRequire("./eventRouter", "Event functionality is currently unavailable");

router.get("/", (req, res) => {
return res.json({
message: "Welcome to the restaurant API!",
version: "1.0.0",
endpoints: {
Reservation: "/reservation",
Feedback: "/feedback", // Added feedback endpoint documentation
Feedback: "/feedback",
},
documentation: "https://api-docs-url.com",
});
});

router.use("/event", eventRouter);
router.use("/admin", require("./adminRouter"));
router.use("/admin", safeRequire("./adminRouter", "Admin functionality is currently unavailable"));
router.use("/feedback", feedbackRouter);
router.use("/user", require("./customerRouter"));
router.use("/reservation", require("./reservationRouter"));
router.use("/newsletter", require("./newsletterRoute"));
router.use("/forgot", require("./forgotRouter"));
router.use("/user", safeRequire("./customerRouter", "User functionality is currently unavailable"));
router.use("/reservation", safeRequire("./reservationRouter", "Reservation functionality is currently unavailable"));
router.use("/newsletter", safeRequire("./newsletterRoute", "Newsletter functionality is currently unavailable"));
router.use("/forgot", safeRequire("./forgotRouter", "Forgot password functionality is currently unavailable"));
router.use("/contact", contactUsRouter);

module.exports = router;
1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"framer-motion": "^11.5.6",
"gsap": "^3.12.5",
"js-cookie": "^3.0.5",
"lucide-react": "^0.453.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-icons": "^5.2.1",
Expand Down
169 changes: 169 additions & 0 deletions frontend/src/components/Pages/ContactUs.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
/* eslint-disable prettier/prettier */
/* eslint-disable no-unused-vars */
import { useState } from 'react';
import { motion } from 'framer-motion';
import { useInView } from 'react-intersection-observer';
import chess from '../../assets/img/chess.gif';
import { FaStar } from 'react-icons/fa6';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove unused import FaStar.

The FaStar component from react-icons is imported but never used in the code.

-import { FaStar } from 'react-icons/fa6';
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
import { FaStar } from 'react-icons/fa6';


const ContactUs = () => {
const { ref, inView } = useInView({
threshold: 0.2,
triggerOnce: true,
});

const animationVariants = {
hidden: { opacity: 0, y: 50 },
visible: { opacity: 1, y: 0, transition: { duration: 0.5 } },
};

// Use an environment variable for backend URL
const API_URL = import.meta.env.VITE_BACKEND_URL || 'http://localhost:3000';
const [mail, setMail] = useState('');
const [subject, setSubject] = useState('');
const [message, setMessage] = useState('');
const [submitted, setSubmitted] = useState(false);
const [hover, setHover] = useState(null);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove unused state variable hover.

The hover state and its setter are declared but never used in the component.

-const [hover, setHover] = useState(null);
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const [hover, setHover] = useState(null);

const [error, setError] = useState(null);
const [isLoading, setIsLoading] = useState(false);

const handleSubmit = async (e) => {
e.preventDefault();

// Basic client-side validation for security
if (!mail || !subject || !message) {
setError('All fields are required.');
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance input validation.

The current validation only checks for empty fields. Consider adding more robust validation:

  1. Email format validation
  2. Maximum length checks
  3. Input sanitization
-    if (!mail || !subject || !message) {
-      setError('All fields are required.');
-      return;
-    }
+    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    if (!mail || !subject || !message) {
+      setError('All fields are required.');
+      return;
+    }
+    if (!emailRegex.test(mail)) {
+      setError('Please enter a valid email address.');
+      return;
+    }
+    if (subject.length > 100) {
+      setError('Subject must be less than 100 characters.');
+      return;
+    }
+    if (message.length > 1000) {
+      setError('Message must be less than 1000 characters.');
+      return;
+    }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Basic client-side validation for security
if (!mail || !subject || !message) {
setError('All fields are required.');
return;
}
// Basic client-side validation for security
const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
if (!mail || !subject || !message) {
setError('All fields are required.');
return;
}
if (!emailRegex.test(mail)) {
setError('Please enter a valid email address.');
return;
}
if (subject.length > 100) {
setError('Subject must be less than 100 characters.');
return;
}
if (message.length > 1000) {
setError('Message must be less than 1000 characters.');
return;
}


// Clear any previous errors
setError(null);

setIsLoading(true);
try {
const response = await fetch(`${API_URL}/api/contact/contactus`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ mail, subject, message }),
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add response status check after the fetch request.

Currently, the code assumes that the fetch request is always successful. It's good practice to check the response status and handle errors accordingly.

Apply this diff to check the response status:

           const response = await fetch(`${API_URL}/api/contact/contactus`, {
             method: 'POST',
             headers: {
               'Content-Type': 'application/json',
             },
             body: JSON.stringify({ mail, subject, message }),
           });
+          if (!response.ok) {
+            throw new Error('Network response was not ok');
+          }
           setSubmitted(true);
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const response = await fetch(`${API_URL}/api/contact/contactus`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ mail, subject, message }),
});
const response = await fetch(`${API_URL}/api/contact/contactus`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({ mail, subject, message }),
});
if (!response.ok) {
throw new Error('Network response was not ok');
}


if (!response.ok) {
+ throw new Error('Network response was not ok');
+ }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix syntax error in error handling.

The throw statement has incorrect syntax and makes the following code unreachable.

      if (!response.ok) {
-        throw new Error('Network response was not ok');
-     }
+        throw new Error(`Network response was not ok: ${response.status}`);
+      }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (!response.ok) {
+ throw new Error('Network response was not ok');
+ }
if (!response.ok) {
throw new Error(`Network response was not ok: ${response.status}`);
}
🧰 Tools
🪛 Biome

[error] 53-53: Expected a semicolon or an implicit semicolon after a statement, but found none

An explicit or implicit semicolon is expected here...

...Which is required to end this statement

(parse)


[error] 53-54: This code is unreachable

... because this statement will throw an exception beforehand

(lint/correctness/noUnreachable)


setSubmitted(true);
setTimeout(() => {
setMail('');
setSubject('');
setMessage('');
setSubmitted(false);
}, 3000);
} catch (error) {
setError('An error occurred while sending Mail...');
console.error('Mail sending failed : ', error);
} finally {
setIsLoading(false);
}
};

return (
<div className="bg-amber-100 h-full py-24 px-4 sm:px-6 lg:px-8">
<div className="max-w-7xl mx-auto">
<motion.div
ref={ref}
initial="hidden"
animate={inView ? 'visible' : 'hidden'}
variants={animationVariants}
className="lg:grid lg:grid-cols-2 lg:gap-8 lg:items-center"
>
<div className="mt-8 mb-8 lg:mb-0 relative">
<h2 className="text-5xl font-black text-[#004D43]">
Feel Free To Mail Us..
</h2>
<p className="mt-5 text-lg text-gray-700 pb-3">
Have questions or need assistance ? Reach out to us, and we'll be
happy to help !!
</p>
<div className="flex md:h-[40vh] md:w-[60vh] ml-20 mt-20 items-center justify-center mt-12">
<img
src={chess}
alt="Chess"
loading="lazy"
className="md:p-10 p-5 object-contain bg-[#004D43] rounded-full shadow-2xl"
/>
</div>
</div>

<div className="bg-[#004D43] rounded-xl p-3 pt-4 mt-40 h-fit">
<form onSubmit={handleSubmit} className="space-y-4">
<div>
<input
type="email"
id="mail"
value={mail}
placeholder="Email ID"
onChange={(e) => setMail(e.target.value)}
required
className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43]"
/>
</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve form accessibility.

Add proper labels and ARIA attributes for better accessibility.

 <div>
+  <label htmlFor="mail" className="sr-only">Email Address</label>
   <input
     type="email"
     id="mail"
     value={mail}
     placeholder="Email ID"
+    aria-label="Email Address"
     onChange={(e) => setMail(e.target.value)}
     required
     className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43]"
   />
 </div>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<input
type="email"
id="mail"
value={mail}
placeholder="Email ID"
onChange={(e) => setMail(e.target.value)}
required
className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43]"
/>
</div>
<div>
<label htmlFor="mail" className="sr-only">Email Address</label>
<input
type="email"
id="mail"
value={mail}
placeholder="Email ID"
aria-label="Email Address"
onChange={(e) => setMail(e.target.value)}
required
className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43]"
/>
</div>

<div>
<input
type="text"
id="text"
placeholder="Subject"
value={subject}
onChange={(e) => setSubject(e.target.value)}
required
className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43]"
/>
</div>
<div>
<textarea
id="message"
placeholder="Write your message..."
rows="6"
value={message}
onChange={(e) => setMessage(e.target.value)}
required
className="mt-1 block w-full border border-gray-300 rounded-md shadow-sm py-2 px-3 focus:outline-none focus:ring-[#004D43] focus:border-[#004D43] resize-none"
></textarea>
</div>
<div>
<button
type="submit"
className="w-full flex justify-center py-2 px-4 border border-transparent rounded-md shadow-sm text-sm font-medium text-white bg-[#09342e] hover:bg-[#072d28] focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-[#004D43]"
disabled={isLoading}
>
{isLoading ? 'Sending...' : 'Send Mail'}
</button>
</div>
</form>
{submitted && (
<motion.div
initial={{ opacity: 0, y: -10, display: 'none', height: 0 }}
animate={{ opacity: 1, y: 0, display: 'block', height: 'auto' }}
className="mt-4 p-4 bg-green-100 border border-green-400 text-green-700 rounded"
>
Thank you, We will reply you soon...
</motion.div>
)}
{error && (
<motion.div
initial={{ opacity: 0, y: -10 }}
animate={{ opacity: 1, y: 0 }}
className="mt-4 p-4 bg-red-100 border border-red-400 text-red-700 rounded"
>
{error}
</motion.div>
)}
</div>
</motion.div>
</div>
</div>
);
};

export default ContactUs;
1 change: 1 addition & 0 deletions frontend/src/components/Shared/Navbar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const Navbar = () => {
{ name: 'RESERVATION', path: '/reservation' },
{ name: 'BOARDGAMES', path: '/boardgame' },
{ name: 'MEMBERSHIP', path: '/membership' }, // Add Membership here
{ name: 'CONTACTUS', path: '/contactus'}
];

useEffect(() => {
Expand Down
3 changes: 2 additions & 1 deletion frontend/src/router/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import Admin from '../components/Pages/Admin';
import VerifyOtp from '../components/Pages/VerifyOtp';
import EmailVerify from '../components/Pages/EmailVerify';
import Membership from '../components/Membership';
import ContactUs from '../components/Pages/ContactUs';
const router = createBrowserRouter(
createRoutesFromElements(
<Route path="/" element={<App />}>
Expand All @@ -39,7 +40,7 @@ const router = createBrowserRouter(
<Route path="/verifyotp/:id" element={<VerifyOtp />} />
<Route path="/email-verify" element={<EmailVerify />} />
<Route path="/membership" element={<Membership />} />

<Route path="/contactus" element={<ContactUs />} />
</Route>
)
);
Expand Down
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.