make routes more descriptive

UoaWDCC · Mar 10, 2024 · f8964ac · f8964ac
1 parent 8a0715b
commit f8964ac
Show file tree

Hide file tree

Showing 8 changed files with 139 additions and 73 deletions.
diff --git a/client/index.html b/client/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />

diff --git a/client/src/models/__generated__/schema.d.ts b/client/src/models/__generated__/schema.d.ts
diff --git a/common/__generated__/swagger.json b/common/__generated__/swagger.json
diff --git a/server/src/data-layer/services/UserDataService.test.ts b/server/src/data-layer/services/UserDataService.test.ts
@@ -2,6 +2,8 @@ import { additionalInfoMock } from "test-config/mocks/User.mock"
 import UserDataService from "./UserDataService"
 import { cleanFirestore } from "test-config/TestUtils"
 
+const TEST_UID_1 = "testUser"
+
 describe("UserService integration tests", () => {
   let userService: UserDataService
 
@@ -14,33 +16,50 @@ describe("UserService integration tests", () => {
   })
 
   it("should add a user", async () => {
-    await userService.createUserData("testUser", additionalInfoMock)
-    const user = await userService.getUserData("testUser")
+    await userService.createUserData(TEST_UID_1, additionalInfoMock)
+    const user = await userService.getUserData(TEST_UID_1)
+
+    expect(user).toEqual({ ...additionalInfoMock, uid: TEST_UID_1 })
+  })
+
+  it("should know if a user has a document", async () => {
+    let result = await userService.userDataExists(TEST_UID_1)
+    expect(result).toEqual(false)
+
+    await userService.createUserData(TEST_UID_1, additionalInfoMock)
+    result = await userService.userDataExists(TEST_UID_1)
+    expect(result).toEqual(true)
 
-    expect(user).toEqual(additionalInfoMock)
+    await userService.deleteUserData(TEST_UID_1)
+    result = await userService.userDataExists(TEST_UID_1)
+    expect(result).toEqual(false)
   })
 
   it("edit a user", async () => {
-    await userService.createUserData("testUser", additionalInfoMock)
-    await userService.editUserData("testUser", { does_racing: false })
-    const user = await userService.getUserData("testUser")
+    await userService.createUserData(TEST_UID_1, additionalInfoMock)
+    await userService.editUserData(TEST_UID_1, { does_racing: false })
+    const user = await userService.getUserData(TEST_UID_1)
 
-    expect(user).toEqual({ ...additionalInfoMock, does_racing: false })
+    expect(user).toEqual({
+      ...additionalInfoMock,
+      does_racing: false,
+      uid: TEST_UID_1
+    })
   })
 
   it("should delete a user", async () => {
-    await userService.createUserData("testUser", additionalInfoMock)
+    await userService.createUserData(TEST_UID_1, additionalInfoMock)
 
-    await userService.deleteUserData("testUser")
-    const user = await userService.getUserData("testUser")
+    await userService.deleteUserData(TEST_UID_1)
+    const user = await userService.getUserData(TEST_UID_1)
 
-    expect(user).not.toEqual(additionalInfoMock)
+    expect(user).not.toEqual({ ...additionalInfoMock, uid: TEST_UID_1 })
     expect(user).toEqual(undefined)
   })
 
   it("should get all users", async () => {
-    await userService.createUserData("testUser", additionalInfoMock)
-    await userService.createUserData("testUser1", additionalInfoMock)
+    await userService.createUserData(TEST_UID_1, additionalInfoMock)
+    await userService.createUserData("testUser2", additionalInfoMock)
 
     const users = await userService.getAllUserData()
 

diff --git a/server/src/data-layer/services/UserDataService.ts b/server/src/data-layer/services/UserDataService.ts
@@ -24,9 +24,16 @@ export default class UserDataService {
 
   public async getUserData(uid: string) {
     const userDoc = await FirestoreCollections.users.doc(uid).get()
+    const data = userDoc.data()
+    if (data === undefined) return undefined
     return { ...userDoc.data(), uid }
   }
 
+  public async userDataExists(uid: string) {
+    const snapshot = await FirestoreCollections.users.doc(uid).get()
+    return snapshot.exists
+  }
+
   public async getFilteredUsers(filters: Partial<UserAdditionalInfo>) {
     // TODO
   }

diff --git a/server/src/middleware/__generated__/routes.ts b/server/src/middleware/__generated__/routes.ts
diff --git a/server/src/service-layer/controllers/UserController.ts b/server/src/service-layer/controllers/UserController.ts
@@ -1,5 +1,6 @@
 import UserDataService from "data-layer/services/UserDataService"
 import {
+  CreateUserRequestBody,
   EditUsersRequestBody,
   SelfRequestModel
 } from "service-layer/request-models/UserRequests"
@@ -8,11 +9,12 @@ import {
   Body,
   Controller,
   Get,
-  Post,
   Route,
   Security,
   SuccessResponse,
-  Request
+  Request,
+  Patch,
+  Put
 } from "tsoa"
 
 @Route("users")
@@ -37,15 +39,23 @@ export class UsersController extends Controller {
   }
 
   @SuccessResponse("200", "Created")
-  @Security("jwt")
-  @Post()
-  public async createUser(@Body() requestBody: { id: string }): Promise<void> {
-    this.setStatus(200) // set return status 200
+  @Security("jwt", ["admin"])
+  @Put("create")
+  public async createUser(
+    @Body() requestBody: CreateUserRequestBody
+  ): Promise<void> {
+    const { uid, user } = requestBody
+    if (await new UserDataService().userDataExists(uid)) {
+      this.setStatus(409)
+      return
+    }
+    await new UserDataService().createUserData(uid, user)
+    this.setStatus(200)
   }
 
   @SuccessResponse("200", "Edited")
   @Security("jwt", ["admin"])
-  @Post("bulk-edit")
+  @Patch("bulk-edit")
   public async editUsers(
     @Body() requestBody: EditUsersRequestBody
   ): Promise<void> {

diff --git a/server/src/service-layer/request-models/UserRequests.ts b/server/src/service-layer/request-models/UserRequests.ts
@@ -5,6 +5,11 @@ export interface EditUsersRequestBody {
   users: { uid: string; updatedInformation: UserAdditionalInfo }[]
 }
 
+export interface CreateUserRequestBody {
+  uid: string
+  user: UserAdditionalInfo
+}
+
 export interface SelfRequestModel {
   user?: UserRecord
 }