Merge pull request #66 from guanquann/forget-password

nicolelim02 · web-flow · commit 9923e8f8f7e6 · 2024-10-19T18:02:05.000+08:00
Forget password functionality
diff --git a/backend/user-service/controller/user-controller.ts b/backend/user-service/controller/user-controller.ts
@@ -12,6 +12,7 @@ import {
   updateUserById as _updateUserById,
   updateUserPrivilegeById as _updateUserPrivilegeById,
   updateUserVerification as _updateUserVerification,
+  updateUserPassword as _updateUserPassword,
 } from "../model/repository";
 import {
   validateEmail,
@@ -25,8 +26,13 @@ import { upload } from "../config/multer";
 import { uploadFileToFirebase } from "../utils/utils";
 import redisClient from "../config/redis";
 import crypto from "crypto";
-import { sendAccVerificationMail } from "../utils/mailer";
-import { ACCOUNT_VERIFICATION_SUBJ } from "../utils/constants";
+import { sendMail } from "../utils/mailer";
+import {
+  ACCOUNT_VERIFICATION_SUBJ,
+  ACCOUNT_VERIFICATION_TEMPLATE,
+  RESET_PASSWORD_SUBJ,
+  RESET_PASSWORD_TEMPLATE,
+} from "../utils/constants";
 
 export async function createUser(
   req: Request,
@@ -113,11 +119,14 @@ export const sendVerificationMail = async (
     }
 
     const emailToken = crypto.randomBytes(16).toString("hex");
-    await redisClient.set(email, emailToken, { EX: 60 * 5 }); // expire in 5 minutes
-    await sendAccVerificationMail(
+    await redisClient.set(`email_verification:${email}`, emailToken, {
+      EX: 60 * 5,
+    }); // expire in 5 minutes
+    await sendMail(
       email,
       ACCOUNT_VERIFICATION_SUBJ,
       user.username,
+      ACCOUNT_VERIFICATION_TEMPLATE,
       emailToken
     );
 
@@ -145,7 +154,7 @@ export const verifyUser = async (
       return res.status(404).json({ message: `User ${email} not found` });
     }
 
-    const expectedToken = await redisClient.get(email);
+    const expectedToken = await redisClient.get(`email_verification:${email}`);
 
     if (expectedToken !== token) {
       return res
@@ -332,6 +341,93 @@ export async function updateUser(
   }
 }
 
+export const sendResetPasswordMail = async (
+  req: Request,
+  res: Response
+): Promise<Response> => {
+  try {
+    const { email } = req.body;
+    const user = await _findUserByEmail(email);
+
+    if (!user) {
+      return res.status(404).json({ message: `User not found` });
+    }
+
+    if (!user.isVerified) {
+      return res.status(403).json({
+        message: "User is not verified. Please verify your account first.",
+      });
+    }
+
+    const emailToken = crypto.randomBytes(16).toString("hex");
+    await redisClient.set(`password_reset:${email}`, emailToken, {
+      EX: 60 * 5,
+    }); // expire in 5 minutes
+    await sendMail(
+      email,
+      RESET_PASSWORD_SUBJ,
+      user.username,
+      RESET_PASSWORD_TEMPLATE,
+      emailToken
+    );
+
+    return res.status(200).json({
+      message: "Reset password email sent. Please check your inbox.",
+      data: { email, id: user.id },
+    });
+  } catch (error) {
+    return res.status(500).json({
+      message: "Unknown error when sending reset password email!",
+      error,
+    });
+  }
+};
+
+export const resetPassword = async (
+  req: Request,
+  res: Response
+): Promise<Response> => {
+  try {
+    const { email, token, password } = req.body;
+
+    const user = await _findUserByEmail(email);
+    if (!user) {
+      return res.status(404).json({ message: `User not found` });
+    }
+
+    const expectedToken = await redisClient.get(`password_reset:${email}`);
+
+    if (expectedToken !== token) {
+      return res
+        .status(400)
+        .json({ message: "Invalid token. Please request for a new one." });
+    }
+
+    const { isValid: isValidPassword, message: passwordMessage } =
+      validatePassword(password);
+    if (!isValidPassword) {
+      return res.status(400).json({ message: passwordMessage });
+    }
+
+    const salt = bcrypt.genSaltSync(10);
+    const hashedPassword = bcrypt.hashSync(password, salt);
+
+    const updatedUser = await _updateUserPassword(email, hashedPassword);
+
+    if (!updatedUser) {
+      return res.status(404).json({ message: `User's password not reset.` });
+    }
+
+    return res
+      .status(200)
+      .json({ message: `User's password successfully reset.` });
+  } catch (error) {
+    return res
+      .status(500)
+      .json({ message: "Unknown error when resetting user password!", error });
+  }
+};
+
 export async function updateUserPrivilege(
   req: Request,
   res: Response
diff --git a/backend/user-service/model/repository.ts b/backend/user-service/model/repository.ts
@@ -115,6 +115,21 @@ export async function updateUserVerification(
   );
 }
 
+export async function updateUserPassword(
+  email: string,
+  password: string
+): Promise<IUser | null> {
+  return UserModel.findOneAndUpdate(
+    { email },
+    {
+      $set: {
+        password,
+      },
+    },
+    { new: true } // return the updated user
+  );
+}
+
 export async function deleteUserById(userId: string): Promise<IUser | null> {
   return UserModel.findByIdAndDelete(userId);
 }
diff --git a/backend/user-service/routes/user-routes.ts b/backend/user-service/routes/user-routes.ts
@@ -10,6 +10,8 @@ import {
   updateUser,
   updateUserPrivilege,
   verifyUser,
+  sendResetPasswordMail,
+  resetPassword,
 } from "../controller/user-controller";
 import {
   verifyAccessToken,
@@ -34,6 +36,10 @@ router.post("/images", createImageLink);
 
 router.post("/send-verification-email", sendVerificationMail);
 
+router.post("/send-reset-password-email", sendResetPasswordMail);
+
+router.post("/reset-password", resetPassword);
+
 router.get("/:id", getUser);
 
 router.get("/verify-email/:email/:token", verifyUser);
diff --git a/backend/user-service/swagger.yml b/backend/user-service/swagger.yml
@@ -71,11 +71,22 @@ components:
         password:
           type: string
           required: true
-    EmailVerification:
+    Email:
       properties:
         email:
           type: string
           required: true
+    ResetPassword:
+      properties:
+        email:
+          type: string
+          required: true
+        token:
+          type: string
+          required: true
+        password:
+          type: string
+          required: true
     UserResponse:
       properties:
         message:
@@ -347,7 +358,73 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/EmailVerification"
+              $ref: "#/components/schemas/Email"
+      responses:
+        200:
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+        404:
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/users/send-reset-password-email:
+    post:
+      summary: Send reset password email
+      tags:
+        - users
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Email"
+      responses:
+        200:
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+        404:
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ServerErrorResponse"
+  /api/users/reset-password:
+    post:
+      summary: Reset password
+      tags:
+        - users
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ResetPassword"
       responses:
         200:
           description: Successful Response
diff --git a/backend/user-service/utils/constants.ts b/backend/user-service/utils/constants.ts
@@ -17,3 +17,23 @@ export const ACCOUNT_VERIFICATION_TEMPLATE = `
   </body>
 </html>
 `;
+
+export const RESET_PASSWORD_SUBJ = "Password Reset Link";
+
+export const RESET_PASSWORD_TEMPLATE = `
+<html>
+  <head>
+    <title>Password Reset</title>
+    <meta charset="utf-8" />
+  </head>
+  <body>
+    <p>Hello {{username}}!</p>
+    <p>
+      You have requested to reset your password. Please use this token: <strong>{{token}}</strong> to reset your password.
+    </p>
+    <p>If you did not request for a password reset, please ignore this email.</p>
+    <p>Regards,</p>
+    <p>Peerprep G28</p>
+  </body>
+</html>
+`;
diff --git a/backend/user-service/utils/mailer.ts b/backend/user-service/utils/mailer.ts
@@ -1,7 +1,6 @@
 import nodemailer from "nodemailer";
 import dotenv from "dotenv";
 import Handlebars from "handlebars";
-import { ACCOUNT_VERIFICATION_TEMPLATE } from "./constants";
 
 dotenv.config();
 
@@ -14,13 +13,14 @@ const transporter = nodemailer.createTransport({
   auth: { user: USER, pass: PASS },
 });
 
-export const sendAccVerificationMail = async (
+export const sendMail = async (
   to: string,
   subject: string,
   username: string,
+  htmlTemplate: string,
   token: string
 ) => {
-  const template = Handlebars.compile(ACCOUNT_VERIFICATION_TEMPLATE);
+  const template = Handlebars.compile(htmlTemplate);
   const replacement = { username, token };
   const html = template(replacement);
   const options = {
diff --git a/frontend/src/App.tsx b/frontend/src/App.tsx
@@ -10,6 +10,7 @@ import Landing from "./pages/Landing";
 import Home from "./pages/Home";
 import SignUp from "./pages/SignUp";
 import LogIn from "./pages/LogIn";
+import ForgetPassword from "./pages/ForgetPassword";
 import Matched from "./pages/Matched";
 import Timeout from "./pages/Timeout";
 import ProtectedRoutes from "./components/ProtectedRoutes";
@@ -72,6 +73,7 @@ function App() {
               path="verifyEmail/:userId?"
               element={<EmailVerification />}
             />
+            <Route path="forget-password" element={<ForgetPassword />} />
             <Route path="*" element={<Navigate to="/auth/login" />} />
           </Route>
         </Routes>
diff --git a/frontend/src/contexts/AuthContext.tsx b/frontend/src/contexts/AuthContext.tsx
@@ -108,7 +108,14 @@ const AuthProvider: React.FC<{ children?: React.ReactNode }> = (props) => {
 
   return (
     <AuthContext.Provider
-      value={{ signup, login, logout, user, setUser, loading }}
+      value={{
+        signup,
+        login,
+        logout,
+        user,
+        setUser,
+        loading,
+      }}
     >
       {children}
     </AuthContext.Provider>
diff --git a/frontend/src/pages/ForgetPassword/index.module.css b/frontend/src/pages/ForgetPassword/index.module.css
@@ -0,0 +1,8 @@
+.fullheight {
+  display: flex;
+}
+
+.center {
+  justify-content: center;
+  align-items: center;
+}
diff --git a/frontend/src/pages/ForgetPassword/index.tsx b/frontend/src/pages/ForgetPassword/index.tsx
diff --git a/frontend/src/pages/LogIn/index.tsx b/frontend/src/pages/LogIn/index.tsx
diff --git a/frontend/src/utils/constants.ts b/frontend/src/utils/constants.ts
