test: update email route test

scripts/run-integration.sh

@@ -7,7 +7,7 @@ docker compose -f docker-compose.yml -f docker-compose.test.yml up -d
 
 if [ "$#" -eq  "0" ]
   then
-    vitest run -c ./vitest.config.integration.ts
+    vitest -c ./vitest.config.integration.ts 
 else
     vitest -c ./vitest.config.integration.ts --ui
 fi

v1/controller/__tests__/user/getUserByIdHandler.test.ts

@@ -7,7 +7,6 @@ import { User } from "../../../types/user.types";
 
 describe("getUserByIdHandler", () => {
   type GetUserByIdMockRequest = Request<GetUserByIdInput["params"]>;
-
   let request: Partial<GetUserByIdMockRequest>;
   let response: Partial<Response>;
   let next = vi.fn();

v1/errors/global/ConflictError.ts

@@ -3,10 +3,16 @@ interface ConflictError extends Error {
 }
 
 class ConflictError extends Error {
-  constructor(message: string) {
+  constructor(message?: string) {
     super(message);
     this.name = "ConflictError";
     this.statusCode = 409;
+
+    Object.setPrototypeOf(this, ConflictError.prototype);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ConflictError);
+    }
   }
 }
 

v1/schema/user.schema.ts

@@ -34,7 +34,7 @@ export const loginUserSchema = object({
   body: object({
     email: string({
       required_error: "Email is a required field.",
-    }).email("Please enter a valid email adress"),
+    }).email("Please enter a valid email address."),
     password: string({
       required_error: "Password is a required field.",
     }).min(8, "Password must be at least 8 characters long."),
@@ -71,7 +71,7 @@ export const createUserSchema = object({
   body: object({
     email: string({
       required_error: "Email is a required field.",
-    }).email("Please enter a valid email adress"),
+    }).email("Please enter a valid email address."),
     password: string({
       required_error: "Password is a required field.",
     }).min(8, "Password must be at least 8 characters long."),
@@ -94,7 +94,17 @@ export const updateEmailSchema = object({
   body: object({
     newEmail: string({
       required_error: "New email is a required field.",
-    }).email("Please enter a valid email adress"),
+    }).email("Please enter a valid email address."),
+  }),
+  params: object({
+    userId: string({
+      required_error: "User ID is required.",
+    }).regex(
+      new RegExp(
+        /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/,
+      ),
+      "ID must be a valid UUID.",
+    ),
   }),
 });
 

v1/tests/helpers/reset-db.ts

@@ -3,16 +3,24 @@ import { PrismaClient } from "@prisma/client";
 const prisma = new PrismaClient();
 
 export default async function resetDb() {
-  await prisma.$transaction([
-    prisma.users.deleteMany({
-      where: {
-        email: "[email protected]",
-      },
-    }),
-    prisma.blacklist.deleteMany({
-      where: {
-        token: "test-token",
-      },
-    }),
-  ]);
+  await prisma.users.delete({
+    where: {
+      email: "[email protected]",
+    },
+  });
+
+  await prisma.users.delete({
+    where: {
+      user_id: "00000000-0000-0000-0000-000000000001",
+    },
+  });
+
+  await prisma.users.create({
+    data: {
+      email: "[email protected]",
+      password_hash: "testpassword",
+      user_id: "00000000-0000-0000-0000-000000000001",
+      email_verified: false,
+    },
+  });
 }

v1/tests/helpers/setup.ts

@@ -1,14 +1,20 @@
 import resetDb from "./reset-db.js";
-import { beforeAll } from "vitest";
+import { beforeAll, afterAll, afterEach } from "vitest";
 import { createServer } from "../../utils/express.utils.js";
-import { UserInput } from "../../types/user.types.js";
+import { UserInput, User } from "../../types/user.types.js";
 import { Config } from "../../utils/options.js";
 
 export const exampleUser: UserInput = {
   email: "[email protected]",
   password: "testpassword",
 };
 
+export const exampleUser2: User = {
+  userId: "00000000-0000-0000-0000-000000000001",
+  email: "[email protected]",
+  emailVerified: false,
+};
+
 export const app = createServer();
 
 export const apiKey = Config.API_KEY;

v1/tests/users/getUser.ts

@@ -1,6 +1,6 @@
 import { describe, expect, expectTypeOf, it } from "vitest";
 import request from "supertest";
-import { exampleUser, apiKey, appId, app } from "../helpers/setup";
+import { exampleUser2, apiKey, appId, app } from "../helpers/setup";
 import { Endpoints } from "../../utils/options";
 import { User } from "../../types/user.types";
 import { ZodIssue } from "zod";
@@ -10,16 +10,8 @@ export const getUserRouteTest = () =>
     const endpoint = Endpoints.GET_USER;
 
     it("should respond with a `200` status code and user info when a valid api key and app id is present", async () => {
-      const loginResponse = await request(app)
-        .post(Endpoints.LOGIN)
-        .send(exampleUser)
-        .set("x-gator-api-key", apiKey)
-        .set("x-gator-app-id", appId);
-
-      const loginBody = loginResponse.body;
-
       const { status, body } = await request(app)
-        .get(endpoint.replace(":userId", loginBody.userId))
+        .get(endpoint.replace(":userId", exampleUser2.userId))
         .set("x-gator-api-key", apiKey)
         .set("x-gator-app-id", appId);
 
@@ -28,8 +20,8 @@ export const getUserRouteTest = () =>
       expectTypeOf(body).toMatchTypeOf<User>();
 
       expect(body).toMatchObject({
-        userId: loginBody.userId,
-        email: exampleUser.email,
+        userId: exampleUser2.userId,
+        email: exampleUser2.email,
         emailVerified: false,
       });
     });

v1/tests/users/login.ts

@@ -1,7 +1,8 @@
-import { describe, expect, expectTypeOf, it } from "vitest";
+import { describe, expect, expectTypeOf, it, vi } from "vitest";
 import request from "supertest";
 import { AuthResponse } from "../../types/user.types";
 import { exampleUser, apiKey, appId, app } from "../helpers/setup";
+import * as UserService from "../../service/user.service";
 import { Endpoints } from "../../utils/options";
 import { ZodIssue } from "zod";
 
@@ -67,10 +68,32 @@ export const loginRouteTest = () =>
       expect(body).toMatchObject([
         {
           code: "invalid_string",
-          message: "Please enter a valid email adress",
+          message: "Please enter a valid email address.",
           path: ["body", "email"],
           validation: "email",
         },
       ]);
     });
+
+    it("should respond with a `500` status code when an unexpected error occurs", async () => {
+      const loginUserSpy = vi.spyOn(UserService, "loginUser");
+
+      const err = new Error("Something went wrong");
+
+      loginUserSpy.mockRejectedValue(err);
+
+      const { status, body } = await request(app)
+        .post(endpoint)
+        .send(exampleUser)
+        .set("x-gator-api-key", apiKey)
+        .set("x-gator-app-id", appId);
+
+      expect(status).toBe(500);
+
+      expect(body).toMatchObject({
+        error: {
+          message: "An unexpected error occurred. Please try again later.",
+        },
+      });
+    });
   });

v1/tests/users/main.test.ts

@@ -1,6 +1,7 @@
 import { testAuthMiddleware } from "../middleware/authenticate";
 import { signUpRouteTest } from "./signup";
 import { loginRouteTest } from "./login";
+import { updateEmailRouteTest } from "./updateEmail";
 import { forIn } from "lodash";
 
 import { Endpoints } from "../../utils/options";
@@ -17,3 +18,5 @@ signUpRouteTest();
 loginRouteTest();
 
 getUserRouteTest();
+
+updateEmailRouteTest();

v1/tests/users/signup.ts

@@ -62,7 +62,7 @@ export const signUpRouteTest = () =>
       expect(body).toMatchObject([
         {
           code: "invalid_string",
-          message: "Please enter a valid email adress",
+          message: "Please enter a valid email address.",
           path: ["body", "email"],
           validation: "email",
         },

v1/tests/users/updateEmail.ts

@@ -0,0 +1,89 @@
+import { describe, expect, expectTypeOf, it } from "vitest";
+import request from "supertest";
+import {
+  exampleUser2,
+  exampleUser,
+  apiKey,
+  appId,
+  app,
+} from "../helpers/setup";
+import { Endpoints } from "../../utils/options";
+import { ZodIssue } from "zod";
+
+export const updateEmailRouteTest = () =>
+  describe("[PUT] /api/v1/users/:userId/update-email", () => {
+    const endpoint = Endpoints.UPDATE_EMAIL;
+
+    it("should respond with a `204` status code when a valid api key and app id is present", async () => {
+      const { status } = await request(app)
+        .put(endpoint.replace(":userId", exampleUser2.userId))
+        .send({ newEmail: "[email protected]" })
+        .set("x-gator-api-key", apiKey)
+        .set("x-gator-app-id", appId);
+
+      expect(status).toBe(204);
+    });
+
+    it("should respond with a `404` status code when the user does not exist", async () => {
+      const invalidUserId = "00000000-0000-0000-0000-000000000000";
+      const { status, body } = await request(app)
+        .put(endpoint.replace(":userId", invalidUserId))
+        .send({ newEmail: "[email protected]" })
+        .set("x-gator-api-key", apiKey)
+        .set("x-gator-app-id", appId);
+
+      expect(status).toBe(404);
+
+      expect(body).toMatchObject({
+        error: {
+          name: "UserNotFoundError",
+          message: `User not found with ID: ${invalidUserId}`,
+          errorCode: "USER_NOT_FOUND",
+        },
+      });
+    });
+
+    it("should respond with a `400` status code and Zod errors when the request body is invalid", async () => {
+      const { status, body } = await request(app)
+        .put(endpoint.replace(":userId", exampleUser2.userId))
+        .send({ newEmail: "invalid-email" })
+        .set("x-gator-api-key", apiKey)
+        .set("x-gator-app-id", appId);
+
+      expect(status).toBe(400);
+
+      expectTypeOf(body).toMatchTypeOf<ZodIssue[]>();
+
+      expect(body).toMatchObject([
+        {
+          validation: "email",
+          code: "invalid_string",
+          message: "Please enter a valid email address.",
+          path: ["body", "newEmail"],
+        },
+      ]);
+    });
+
+    it("should respond with a `400` status code and Zod errors when the user id is invalid", async () => {
+      const { status, body } = await request(app)
+        .put(endpoint.replace(":userId", "invalid-id"))
+        .send({ newEmail: "[email protected]" })
+        .set("x-gator-api-key", apiKey)
+        .set("x-gator-app-id", appId);
+
+      console.log(status, body);
+
+      expect(status).toBe(400);
+
+      expectTypeOf(body).toMatchTypeOf<ZodIssue[]>();
+
+      expect(body).toMatchObject([
+        {
+          validation: "regex",
+          code: "invalid_string",
+          message: "ID must be a valid UUID.",
+          path: ["params", "userId"],
+        },
+      ]);
+    });
+  });

v1/utils/express.utils.ts

@@ -8,7 +8,6 @@ import { Server } from "http";
 import { disconnectPostgres } from "../db/cleanup";
 import { exit } from "process";
 import logger from "../utils/logger";
-import { RequestHandler } from "express";
 import * as Errors from "../errors";
 
 export const shutdownSignals: NodeJS.Signals[] = [

v1/utils/jwt.utils.ts

@@ -1,6 +1,5 @@
 import jwt, { JwtPayload } from "jsonwebtoken";
 import { Response } from "express";
-import config from "config";
 import { checkBlackListedToken } from "../service/token.service";
 import { Config } from "./options";
 

v1/utils/options.ts

@@ -19,10 +19,10 @@ export enum Endpoints {
   SIGNUP = "/api/v1/users/sign-up",
   LOGIN = "/api/v1/users/login",
   GET_USER = "/api/v1/users/:userId",
-  UPDATE_EMAIL = "/api/v1/users/update-email",
-  UPDATE_PASSWORD = "/api/v1/users/update-password",
-  SEND_VERIFICATION_EMAIL = "/api/v1/users/send-verification-email",
-  VERIFY_EMAIL = "/api/v1/users/verify-email",
+  UPDATE_EMAIL = "/api/v1/users/:userId/update-email",
+  UPDATE_PASSWORD = "/api/v1/users/:userId/update-password",
+  SEND_VERIFICATION_EMAIL = "/api/v1/users/:userId/send-verification-email",
+  VERIFY_EMAIL = "/api/v1/users/:userId/verify-email",
   DELETE_USER = "/api/v1/users/:userId",
   REISSUE_TOKEN = "/api/v1/tokens/reissue-token",
   INVALIDATE_TOKEN = "/api/v1/tokens/invalidate-token",