fix: upsert user url path

Author: zzswang

openapi.json

@@ -1,5 +1,5 @@
 {
-  "hash": "50b02791c7a6d303f38dd96ffece6974ae0eb8160c754e35f57027533f749d24",
+  "hash": "c80adbd84331e9f7fe3c09aabc748e951271b91b5a3c134306b310209049b0a9",
   "openapi": "3.0.0",
   "paths": {
     "/hello": {
@@ -4414,19 +4414,10 @@
         ]
       }
     },
-    "/users/{employeeId}/@upsertUserByEmployeeId": {
+    "/users/@upsertUserByEmployeeId": {
       "post": {
         "operationId": "upsertUserByEmployeeId",
-        "parameters": [
-          {
-            "name": "employeeId",
-            "required": true,
-            "in": "path",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "parameters": [],
         "requestBody": {
           "required": true,
           "content": {
@@ -4465,19 +4456,10 @@
         ]
       }
     },
-    "/users/{userId}/@upsertUserById": {
+    "/users/@upsertUserById": {
       "post": {
         "operationId": "upsertUserById",
-        "parameters": [
-          {
-            "name": "userId",
-            "required": true,
-            "in": "path",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "parameters": [],
         "requestBody": {
           "required": true,
           "content": {
@@ -4516,19 +4498,10 @@
         ]
       }
     },
-    "/users/{username}/@upsertUserByUsername": {
+    "/users/@upsertUserByUsername": {
       "post": {
         "operationId": "upsertUserByUsername",
-        "parameters": [
-          {
-            "name": "username",
-            "required": true,
-            "in": "path",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "parameters": [],
         "requestBody": {
           "required": true,
           "content": {
@@ -4567,19 +4540,10 @@
         ]
       }
     },
-    "/users/{email}/@upsertUserByEmail": {
+    "/users/@upsertUserByEmail": {
       "post": {
         "operationId": "upsertUserByEmail",
-        "parameters": [
-          {
-            "name": "email",
-            "required": true,
-            "in": "path",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "parameters": [],
         "requestBody": {
           "required": true,
           "content": {
@@ -4618,19 +4582,10 @@
         ]
       }
     },
-    "/users/{phone}/@upsertUserByPhone": {
+    "/users/@upsertUserByPhone": {
       "post": {
         "operationId": "upsertUserByPhone",
-        "parameters": [
-          {
-            "name": "phone",
-            "required": true,
-            "in": "path",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "parameters": [],
         "requestBody": {
           "required": true,
           "content": {

src/user/user.controller.ts

@@ -148,14 +148,12 @@ export class UserController {
   })
   @UseInterceptors(UnsetCacheInterceptor)
   @CacheKey('/users/:id')
-  @Post(':employeeId/@upsertUserByEmployeeId')
-  async upsertByEmployeeId(
-    @Param('employeeId') employeeId: string,
-    @Body() dto: CreateUserDto
-  ): Promise<UserDocument> {
+  @Post('@upsertUserByEmployeeId')
+  async upsertByEmployeeId(@Body() dto: CreateUserDto): Promise<UserDocument> {
+    this.requireUpsertKey(dto.employeeId, 'employeeId', 'upsertByEmployeeId');
     await this.ensureNamespaceExists(dto.ns);
 
-    return this.userService.upsertByEmployee(employeeId, dto);
+    return this.userService.upsertByEmployee(dto.employeeId as string, dto);
   }
 
   /**
@@ -168,14 +166,12 @@ export class UserController {
   })
   @UseInterceptors(UnsetCacheInterceptor)
   @CacheKey('/users/:id')
-  @Post(':userId/@upsertUserById')
-  async upsertById(
-    @Param('userId') userId: string,
-    @Body() dto: CreateUserDto
-  ): Promise<UserDocument> {
+  @Post('@upsertUserById')
+  async upsertById(@Body() dto: CreateUserDto): Promise<UserDocument> {
+    this.requireUpsertKey(dto.id, 'id', 'upsertById');
     await this.ensureNamespaceExists(dto.ns);
 
-    return this.userService.upsertById(userId, { ...dto, id: userId });
+    return this.userService.upsertById(dto.id as string, dto);
   }
 
   /**
@@ -188,14 +184,12 @@ export class UserController {
   })
   @UseInterceptors(UnsetCacheInterceptor)
   @CacheKey('/users/:id')
-  @Post(':username/@upsertUserByUsername')
-  async upsertByUsername(
-    @Param('username') username: string,
-    @Body() dto: CreateUserDto
-  ): Promise<UserDocument> {
+  @Post('@upsertUserByUsername')
+  async upsertByUsername(@Body() dto: CreateUserDto): Promise<UserDocument> {
+    this.requireUpsertKey(dto.username, 'username', 'upsertByUsername');
     await this.ensureNamespaceExists(dto.ns);
 
-    return this.userService.upsertByUsername(username, dto);
+    return this.userService.upsertByUsername(dto.username as string, dto);
   }
 
   /**
@@ -208,14 +202,12 @@ export class UserController {
   })
   @UseInterceptors(UnsetCacheInterceptor)
   @CacheKey('/users/:id')
-  @Post(':email/@upsertUserByEmail')
-  async upsertByEmail(
-    @Param('email') email: string,
-    @Body() dto: CreateUserDto
-  ): Promise<UserDocument> {
+  @Post('@upsertUserByEmail')
+  async upsertByEmail(@Body() dto: CreateUserDto): Promise<UserDocument> {
+    this.requireUpsertKey(dto.email, 'email', 'upsertByEmail');
     await this.ensureNamespaceExists(dto.ns);
 
-    return this.userService.upsertByEmail(email, dto);
+    return this.userService.upsertByEmail(dto.email as string, dto);
   }
 
   /**
@@ -228,14 +220,26 @@ export class UserController {
   })
   @UseInterceptors(UnsetCacheInterceptor)
   @CacheKey('/users/:id')
-  @Post(':phone/@upsertUserByPhone')
-  async upsertByPhone(
-    @Param('phone') phone: string,
-    @Body() dto: CreateUserDto
-  ): Promise<UserDocument> {
+  @Post('@upsertUserByPhone')
+  async upsertByPhone(@Body() dto: CreateUserDto): Promise<UserDocument> {
+    this.requireUpsertKey(dto.phone, 'phone', 'upsertByPhone');
     await this.ensureNamespaceExists(dto.ns);
 
-    return this.userService.upsertByPhone(phone, dto);
+    return this.userService.upsertByPhone(dto.phone as string, dto);
+  }
+
+  private requireUpsertKey(
+    value: string | null | undefined,
+    field: 'employeeId' | 'id' | 'username' | 'email' | 'phone',
+    operation: string
+  ): asserts value is string {
+    if (!value) {
+      throw new BadRequestException({
+        code: ErrorCodes.VALIDATE_FAILED,
+        message: `${field} is required for ${operation}.`,
+        keyValue: { field },
+      });
+    }
   }
 
   private async ensureNamespaceExists(ns?: string): Promise<void> {

test/user.e2e-spec.ts

@@ -60,7 +60,7 @@ describe('User crud (e2e)', () => {
   });
 
   it(`Create user`, async () => {
-    const userDoc = mockUser();
+    const userDoc = { ...mockUser(), ns: `test-ns-${nanoid(8)}` };
 
     // ns 不存在
     await request(app.getHttpServer())
@@ -211,8 +211,8 @@ describe('User crud (e2e)', () => {
     });
 
     const createResp = await request(app.getHttpServer())
-      .post(`/users/${userId}/@upsertUserById`)
-      .send(userDoc)
+      .post('/users/@upsertUserById')
+      .send({ ...userDoc, id: userId })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -221,8 +221,8 @@ describe('User crud (e2e)', () => {
     expect(createResp.body.id).toBe(userId);
 
     const updateResp = await request(app.getHttpServer())
-      .post(`/users/${userId}/@upsertUserById`)
-      .send({ ...userDoc, intro: 'updated by id' })
+      .post('/users/@upsertUserById')
+      .send({ ...userDoc, id: userId, intro: 'updated by id' })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -264,8 +264,8 @@ describe('User crud (e2e)', () => {
 
     // upsertByEmail: username conflict
     const upsertByEmailConflictResp = await request(app.getHttpServer())
-      .post(`/users/${encodeURIComponent(userA.email)}/@upsertUserByEmail`)
-      .send({ ...mockUser(), ns, username: userB.username })
+      .post('/users/@upsertUserByEmail')
+      .send({ ...mockUser(), ns, email: userA.email, username: userB.username })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -274,8 +274,8 @@ describe('User crud (e2e)', () => {
 
     // upsertByPhone: email conflict
     const upsertByPhoneConflictResp = await request(app.getHttpServer())
-      .post(`/users/${userA.phone}/@upsertUserByPhone`)
-      .send({ ...mockUser(), ns, email: userB.email })
+      .post('/users/@upsertUserByPhone')
+      .send({ ...mockUser(), ns, phone: userA.phone, email: userB.email })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -284,8 +284,8 @@ describe('User crud (e2e)', () => {
 
     // upsertByEmployeeId: phone conflict
     const upsertByEmployeeIdConflictResp = await request(app.getHttpServer())
-      .post(`/users/${baseA.employeeId}/@upsertUserByEmployeeId`)
-      .send({ ...mockUser(), ns, phone: userB.phone })
+      .post('/users/@upsertUserByEmployeeId')
+      .send({ ...mockUser(), ns, employeeId: baseA.employeeId, phone: userB.phone })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -294,8 +294,8 @@ describe('User crud (e2e)', () => {
 
     // upsertByUsername: employeeId conflict
     const upsertByUsernameConflictResp = await request(app.getHttpServer())
-      .post(`/users/${userA.username}/@upsertUserByUsername`)
-      .send({ ...mockUser(), ns, employeeId: baseB.employeeId })
+      .post('/users/@upsertUserByUsername')
+      .send({ ...mockUser(), ns, username: userA.username, employeeId: baseB.employeeId })
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')