Merge branch 'development' into feat/questions

Author: nicolelim02

backend/question-service/src/models/Question.ts

@@ -20,16 +20,6 @@ const questionSchema: Schema<IQuestion> = new mongoose.Schema(
     },
     category: {
       type: [String],
-      enum: [
-        "Strings",
-        "Algorithms",
-        "Data Structures",
-        "Bit Manipulation",
-        "Recursion",
-        "Databases",
-        "Arrays",
-        "Brainteaser",
-      ],
       required: true,
     },
   },

backend/user-service/.env.sample

@@ -5,6 +5,8 @@ PORT=3001
 JWT_SECRET=you-can-replace-this-with-your-own-secret
 
 # admin default credentials
+ADMIN_FIRST_NAME=Admin
+ADMIN_LAST_NAME=User
 ADMIN_USERNAME=administrator
 ADMIN_EMAIL=[email protected]
 ADMIN_PASSWORD=Admin@123

backend/user-service/README.md

@@ -48,10 +48,12 @@
 
 - Body
 
-  - Required: `username` (string), `email` (string), `password` (string)
+  - Required: `firstName` (string), `lastName` (string), `username` (string), `email` (string), `password` (string)
 
     ```json
     {
+      "firstName": "SampleFirstName",
+      "lastName": "SampleLastName",
       "username": "SampleUserName",
       "email": "[email protected]",
       "password": "SecurePassword"

backend/user-service/controller/user-controller.ts

@@ -26,15 +26,27 @@ export async function createUser(
   res: Response
 ): Promise<Response> {
   try {
-    const { username, email, password } = req.body;
+    const { firstName, lastName, username, email, password } = req.body;
     const existingUser = await _findUserByUsernameOrEmail(username, email);
     if (existingUser) {
       return res
         .status(409)
-        .json({ message: "username or email already exists" });
+        .json({ message: "Username or email already exists" });
     }
 
-    if (username && email && password) {
+    if (firstName && lastName && username && email && password) {
+      const { isValid: isValidFirstName, message: firstNameMessage } =
+        validateName(firstName, "first name");
+      if (!isValidFirstName) {
+        return res.status(400).json({ message: firstNameMessage });
+      }
+
+      const { isValid: isValidLastName, message: lastNameMessage } =
+        validateName(lastName, "last name");
+      if (!isValidLastName) {
+        return res.status(400).json({ message: lastNameMessage });
+      }
+
       const { isValid: isValidUsername, message: usernameMessage } =
         validateUsername(username);
       if (!isValidUsername) {
@@ -55,15 +67,23 @@ export async function createUser(
 
       const salt = bcrypt.genSaltSync(10);
       const hashedPassword = bcrypt.hashSync(password, salt);
-      const createdUser = await _createUser(username, email, hashedPassword);
+
+      const createdUser = await _createUser(
+        firstName,
+        lastName,
+        username,
+        email,
+        hashedPassword,
+      );
       return res.status(201).json({
         message: `Created new user ${username} successfully`,
         data: formatUserResponse(createdUser),
       });
     } else {
-      return res
-        .status(400)
-        .json({ message: "username and/or email and/or password are missing" });
+      return res.status(400).json({
+        message:
+          "At least one of first name, last name, username, email and password are missing",
+      });
     }
   } catch (err) {
     console.error(err);
@@ -120,18 +140,15 @@ export async function updateUser(
 ): Promise<Response> {
   try {
     const {
-      username,
-      email,
-      password,
+      oldPassword,
+      newPassword,
       profilePictureUrl,
       firstName,
       lastName,
       biography,
     } = req.body;
     if (
-      username ||
-      email ||
-      password ||
+      (oldPassword && newPassword) ||
       profilePictureUrl ||
       firstName ||
       lastName ||
@@ -148,42 +165,23 @@ export async function updateUser(
         return res.status(404).json({ message: `User ${userId} not found` });
       }
 
-      if (username) {
-        const { isValid: isValidUsername, message: usernameMessage } =
-          validateUsername(username);
-        if (!isValidUsername) {
-          return res.status(400).json({ message: usernameMessage });
-        }
-
-        const existingUser = await _findUserByUsername(username);
-        if (existingUser && existingUser.id !== userId) {
-          return res.status(409).json({ message: "username already exists" });
-        }
-      }
-
-      if (email) {
-        const { isValid: isValidEmail, message: emailMessage } =
-          validateEmail(email);
-        if (!isValidEmail) {
-          return res.status(400).json({ message: emailMessage });
-        }
-
-        const existingUser = await _findUserByEmail(email);
-        if (existingUser && existingUser.id !== userId) {
-          return res.status(409).json({ message: "email already exists" });
+      let hashedPassword: string | undefined;
+      if (oldPassword && newPassword) {
+        const match = await bcrypt.compare(oldPassword, user.password);
+        if (!match) {
+          return res
+            .status(403)
+            .json({ message: "Wrong current password given" });
         }
-      }
 
-      let hashedPassword: string | undefined;
-      if (password) {
         const { isValid: isValidPassword, message: passwordMessage } =
-          validatePassword(password);
+          validatePassword(newPassword);
         if (!isValidPassword) {
           return res.status(400).json({ message: passwordMessage });
         }
 
         const salt = bcrypt.genSaltSync(10);
-        hashedPassword = bcrypt.hashSync(password, salt);
+        hashedPassword = bcrypt.hashSync(newPassword, salt);
       }
 
       if (firstName) {
@@ -212,8 +210,6 @@ export async function updateUser(
 
       const updatedUser = await _updateUserById(
         userId,
-        username,
-        email,
         hashedPassword,
         profilePictureUrl,
         firstName,

backend/user-service/model/repository.ts

@@ -1,7 +1,6 @@
 import UserModel, { IUser } from "./user-model";
 import "dotenv/config";
 import { connect } from "mongoose";
-import { faker } from "@faker-js/faker";
 
 export async function connectToDB() {
   const mongoDBUri: string | undefined = process.env.DB_CLOUD_URI;
@@ -14,17 +13,19 @@ export async function connectToDB() {
 }
 
 export async function createUser(
+  firstName: string,
+  lastName: string,
   username: string,
   email: string,
   password: string,
   isAdmin: boolean = false
 ): Promise<IUser> {
   return new UserModel({
+    firstName,
+    lastName,
     username,
     email,
     password,
-    firstName: faker.person.firstName(),
-    lastName: faker.person.lastName(),
     isAdmin,
   }).save();
 }
@@ -58,8 +59,6 @@ export async function findAllUsers(): Promise<IUser[]> {
 
 export async function updateUserById(
   userId: string,
-  username: string,
-  email: string,
   password: string | undefined,
   profilePictureUrl: string,
   firstName: string,
@@ -70,8 +69,6 @@ export async function updateUserById(
     userId,
     {
       $set: {
-        username,
-        email,
         password,
         profilePictureUrl,
         firstName,

backend/user-service/model/user-model.ts

@@ -8,8 +8,8 @@ export interface IUser extends Document {
   isAdmin: boolean;
 
   profilePictureUrl?: string;
-  firstName?: string;
-  lastName?: string;
+  firstName: string;
+  lastName: string;
   biography?: string;
 }
 
@@ -43,11 +43,11 @@ const UserModelSchema: Schema<IUser> = new mongoose.Schema({
   },
   firstName: {
     type: String,
-    required: false,
+    required: true,
   },
   lastName: {
     type: String,
-    required: false,
+    required: true,
   },
   biography: {
     type: String,

backend/user-service/scripts/seed.ts

@@ -4,17 +4,21 @@ import { connectToDB, createUser, findUserByEmail } from "../model/repository";
 export async function seedAdminAccount() {
   await connectToDB();
 
+  const adminFirstName = process.env.ADMIN_FIRST_NAME || "Admin";
+  const adminLastName = process.env.ADMIN_LAST_NAME || "User";
   const adminUsername = process.env.ADMIN_USERNAME || "administrator";
   const adminEmail = process.env.ADMIN_EMAIL || "[email protected]";
   const adminPassword = process.env.ADMIN_PASSWORD || "Admin@123";
 
   if (
+    !process.env.ADMIN_FIRST_NAME ||
+    !process.env.ADMIN_LAST_NAME ||
     !process.env.ADMIN_USERNAME ||
     !process.env.ADMIN_EMAIL ||
     !process.env.ADMIN_PASSWORD
   ) {
     console.error(
-      "Admin account not seeded in .env. Using default admin account credentials (username: administrator, email: [email protected], password: Admin@123)"
+      "Admin account not seeded in .env. Using default admin account credentials (first name: Admin, last name: User, username: administrator, email: [email protected], password: Admin@123)"
     );
   }
 
@@ -28,7 +32,7 @@ export async function seedAdminAccount() {
     const salt = bcrypt.genSaltSync(10);
     const hashedPassword = bcrypt.hashSync(adminPassword, salt);
 
-    await createUser(adminUsername, adminEmail, hashedPassword, true);
+    await createUser(adminFirstName, adminLastName, adminUsername, adminEmail, hashedPassword, true);
 
     console.log("Admin account created successfully.");
     process.exit(0);