Merge branch 'development' into feat/users

Author: nicolelim02

.github/workflows/ci.yml

@@ -7,21 +7,33 @@ on:
 
 env:
   NODE_VERSION: 20
-  FIREBASE_PROJECT_ID: ${{ secrets.FIREBASE_PROJECT_ID }}
-  FIREBASE_PRIVATE_KEY: ${{ secrets.FIREBASE_PRIVATE_KEY }}
-  FIREBASE_CLIENT_EMAIL: ${{ secrets.FIREBASE_CLIENT_EMAIL }}
-  FIREBASE_STORAGE_BUCKET: ${{ secrets.FIREBASE_STORAGE_BUCKET }}
-  JWT_SECRET: ${{ secrets.JWT_SECRET }}
 
 permissions:
   contents: read
 
 jobs:
-  ci:
+  frontend-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setting node version
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Install dependencies
+        working-directory: frontend
+        run: npm install
+      - name: Linting
+        working-directory: frontend
+        run: npm run lint
+      - name: Frontend tests
+        run: docker compose -f docker-compose-test.yml run --rm test-frontend
+  backend-ci:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        service: [frontend, backend/question-service, backend/user-service]
+        service: [question-service, user-service]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -30,21 +42,16 @@ jobs:
         with:
           node-version: ${{ env.NODE_VERSION }}
       - name: Install dependencies
-        working-directory: ${{ matrix.service }}
+        working-directory: backend/${{ matrix.service }}
         run: npm install
       - name: Linting
-        working-directory: ${{ matrix.service }}
+        working-directory: backend/${{ matrix.service }}
         run: npm run lint
-      - name: Set .env variables
-        working-directory: ${{ matrix.service }}
-        run: |
-          touch .env
-          echo "FIREBASE_PROJECT_ID=${{ env.FIREBASE_PROJECT_ID }}" >> .env
-          echo "FIREBASE_PRIVATE_KEY=${{ env.FIREBASE_PRIVATE_KEY }}" >> .env
-          echo "FIREBASE_CLIENT_EMAIL=${{ env.FIREBASE_CLIENT_EMAIL }}" >> .env
-          echo "FIREBASE_CLIENT_EMAIL=${{ env.FIREBASE_CLIENT_EMAIL }}" >> .env
-          echo "FIREBASE_STORAGE_BUCKET=${{ env.FIREBASE_STORAGE_BUCKET }}" >> .env
-          echo "JWT_SECRET=${{ env.JWT_SECRET }}" >> .env
-      - name: Tests
-        working-directory: ${{ matrix.service }}
-        run: npm test
+      - name: Backend tests
+        env:
+          FIREBASE_PROJECT_ID: ${{ secrets.FIREBASE_PROJECT_ID }}
+          FIREBASE_PRIVATE_KEY: ${{ secrets.FIREBASE_PRIVATE_KEY }}
+          FIREBASE_CLIENT_EMAIL: ${{ secrets.FIREBASE_CLIENT_EMAIL }}
+          FIREBASE_STORAGE_BUCKET: ${{ secrets.FIREBASE_STORAGE_BUCKET }}
+          JWT_SECRET: ${{ secrets.JWT_SECRET }}
+        run: docker compose -f docker-compose-test.yml run --rm test-${{ matrix.service }}

backend/question-service/.env.sample

@@ -12,3 +12,5 @@ FIREBASE_STORAGE_BUCKET=>FIREBASE_STORAGE_BUCKET>
 ORIGINS=http://localhost:5173,http://127.0.0.1:5173
 
 USER_SERVICE_URL=http://user-service:3001/api
+
+MONGO_URI_TEST=mongodb://mongo:mongo@test-mongo:27017/

backend/question-service/tests/setup.ts

@@ -1,11 +1,8 @@
 import mongoose from "mongoose";
-import { MongoMemoryServer } from "mongodb-memory-server";
-
-let mongo: MongoMemoryServer;
 
 beforeAll(async () => {
-  mongo = await MongoMemoryServer.create();
-  const mongoUri = mongo.getUri();
+  const mongoUri =
+    process.env.MONGO_URI_TEST || "mongodb://mongo:mongo@test-mongo:27017/";
 
   if (mongoose.connection.readyState !== 0) {
     await mongoose.disconnect();
@@ -24,9 +21,5 @@ afterEach(async () => {
 });
 
 afterAll(async () => {
-  if (mongo) {
-    await mongo.stop();
-  }
-
   await mongoose.connection.close();
 });

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

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);
 }

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);

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