fix: namespace get by key

Author: zzswang

openapi.json

@@ -1,5 +1,5 @@
 {
-  "hash": "c16c180c2d62fd4ce0bb4fb78b3036b51724c1344dd1528a52d4624602bae82f",
+  "hash": "e53a5702f1615db98d73ccef5f59a195fde4908d6a0a9f265ce3800fac5b5d1a",
   "openapi": "3.0.0",
   "paths": {
     "/hello": {
@@ -2086,23 +2086,23 @@
         ]
       }
     },
-    "/namespaces/{namespaceIdOrKey}": {
+    "/namespaces/{key}": {
       "get": {
         "operationId": "getNamespace",
         "parameters": [
           {
-            "name": "namespaceIdOrKey",
+            "name": "key",
             "required": true,
             "in": "path",
-            "description": "Namespace id or key, if key should encodeURIComponent",
+            "description": "Namespace key, key should encodeURIComponent",
             "schema": {
               "type": "string"
             }
           }
         ],
         "responses": {
           "200": {
-            "description": "The namespace with expected id or key.",
+            "description": "The namespace with expected key.",
             "content": {
               "application/json": {
                 "schema": {
@@ -2117,7 +2117,7 @@
             "ApiKey": []
           }
         ],
-        "summary": "Find namespace by id or key",
+        "summary": "Find namespace by key",
         "tags": [
           "namespace"
         ]
@@ -2126,7 +2126,7 @@
         "operationId": "updateNamespace",
         "parameters": [
           {
-            "name": "namespaceIdOrKey",
+            "name": "key",
             "required": true,
             "in": "path",
             "schema": {
@@ -2165,14 +2165,12 @@
         "tags": [
           "namespace"
         ]
-      }
-    },
-    "/namespaces/{namespaceId}": {
+      },
       "delete": {
         "operationId": "deleteNamespace",
         "parameters": [
           {
-            "name": "namespaceId",
+            "name": "key",
             "required": true,
             "in": "path",
             "schema": {

src/auth/auth.service.ts

@@ -65,7 +65,7 @@ export class AuthService {
 
     // 递归添加命名空间及其父级的权限
     const addNamespacePermissions = async (nsKey: string) => {
-      const namespace = await this.namespaceService.getByKey(nsKey);
+      const namespace = await this.namespaceService.get(nsKey);
       namespace?.permissions?.forEach((permission) => permissions.add(permission));
       if (namespace?.ns) {
         await addNamespacePermissions(namespace.ns);

src/namespace/namespace.controller.ts

@@ -1,4 +1,4 @@
-import { CacheKey, CacheTTL } from '@nestjs/cache-manager';
+import { CacheTTL } from '@nestjs/cache-manager';
 import {
   Body,
   ConflictException,
@@ -52,7 +52,7 @@ export class NamespaceController {
     const { key, ns } = createDto;
 
     if (key) {
-      const namespace = await this.namespaceService.getByKey(key);
+      const namespace = await this.namespaceService.get(key);
       if (namespace) {
         throw new ConflictException({
           code: ErrorCodes.NAMESPACE_ALREADY_EXISTS,
@@ -68,7 +68,7 @@ export class NamespaceController {
     }
 
     if (ns) {
-      const parent = await this.namespaceService.getByKey(ns);
+      const parent = await this.namespaceService.get(ns);
       if (!parent) {
         throw new NotFoundException({
           code: ErrorCodes.NAMESPACE_NOT_FOUND,
@@ -114,27 +114,27 @@ export class NamespaceController {
   }
 
   /**
-   * Find namespace by id or key
+   * Find namespace by key
    */
   @ApiOperation({ operationId: 'getNamespace' })
   @ApiOkResponse({
-    description: 'The namespace with expected id or key.',
+    description: 'The namespace with expected key.',
     type: Namespace,
   })
   @ApiParam({
-    name: 'namespaceIdOrKey',
+    name: 'key',
     type: 'string',
-    description: 'Namespace id or key, if key should encodeURIComponent',
+    description: 'Namespace key, key should encodeURIComponent',
   })
   @UseInterceptors(SetCacheInterceptor)
   @CacheTTL(24 * 3600)
-  @Get(':namespaceIdOrKey')
-  async get(@Param('namespaceIdOrKey') namespaceIdOrKey: string): Promise<NamespaceDocument> {
-    const namespace = await this.namespaceService.get(namespaceIdOrKey);
+  @Get(':key')
+  async get(@Param('key') key: string): Promise<NamespaceDocument> {
+    const namespace = await this.namespaceService.get(key);
     if (!namespace) {
       throw new NotFoundException({
         code: ErrorCodes.NAMESPACE_NOT_FOUND,
-        message: `Namespace ${namespaceIdOrKey} not found.`,
+        message: `Namespace ${key} not found.`,
       });
     }
     return namespace;
@@ -149,17 +149,16 @@ export class NamespaceController {
     type: Namespace,
   })
   @UseInterceptors(UnsetCacheInterceptor)
-  @CacheKey('/namespaces/:id,/namespaces/:key')
-  @Patch(':namespaceIdOrKey')
+  @Patch(':key')
   async update(
-    @Param('namespaceIdOrKey') namespaceIdOrKey: string,
+    @Param('key') key: string,
     @Body() updateDto: UpdateNamespaceDto
   ): Promise<NamespaceDocument> {
-    const namespace = await this.namespaceService.update(namespaceIdOrKey, updateDto);
+    const namespace = await this.namespaceService.update(key, updateDto);
     if (!namespace) {
       throw new NotFoundException({
         code: ErrorCodes.NAMESPACE_NOT_FOUND,
-        message: `Namespace ${namespaceIdOrKey} not found.`,
+        message: `Namespace ${key} not found.`,
       });
     }
     return namespace;
@@ -172,8 +171,8 @@ export class NamespaceController {
   @ApiNoContentResponse({ description: 'No content.' })
   @HttpCode(HttpStatus.NO_CONTENT)
   @UseInterceptors(UnsetCacheInterceptor)
-  @Delete(':namespaceId')
-  async delete(@Param('namespaceId') namespaceId: string): Promise<void> {
-    await this.namespaceService.delete(namespaceId);
+  @Delete(':key')
+  async delete(@Param('key') key: string): Promise<void> {
+    await this.namespaceService.delete(key);
   }
 }

src/namespace/namespace.service.spec.ts

@@ -66,16 +66,6 @@ describe('NamespaceService', () => {
   });
 
   describe('getNamespace', () => {
-    it('should get a namespace by id', async () => {
-      const toBeCreated = mockNamespace('n-1');
-      const namespace = await service.create(toBeCreated);
-      expect(namespace).toBeDefined();
-
-      const foundByNs = await service.get(namespace.id);
-      expect(foundByNs).toBeDefined();
-      expect(foundByNs).toMatchObject(toBeCreated);
-    });
-
     it('should get a namespace by key', async () => {
       const namespace1 = await service.create(mockNamespace('nn-1'));
       const namespace2 = await service.create(mockNamespace('nn-2'));
@@ -98,7 +88,7 @@ describe('NamespaceService', () => {
       const namespace = await service.create(toBeCreated);
       expect(namespace).toBeDefined();
 
-      await service.delete(namespace.id);
+      await service.delete(namespace.key);
       const found = await service.get(namespace.key);
       expect(found).toEqual(null);
     });
@@ -128,7 +118,7 @@ describe('NamespaceService', () => {
       const toBeCreated = mockNamespace('n-1');
       const namespace = await service.create(toBeCreated);
       const updateDoc = { name: 'updated name' };
-      const updated = await service.update(namespace.id, updateDoc);
+      const updated = await service.update(namespace.key, updateDoc);
       expect(updated).toBeDefined();
       expect(updated).toMatchObject(updateDoc);
     });

src/namespace/namespace.service.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { DeleteResult } from 'mongodb';
-import { isObjectIdOrHexString, Model } from 'mongoose';
+import { Model } from 'mongoose';
 
 import { buildMongooseQuery } from 'src/mongo';
 
@@ -33,30 +33,20 @@ export class NamespaceService {
     return this.namespaceModel.find(filter).sort(sort).skip(offset).limit(limit).exec();
   }
 
-  get(idOrKey: string): Promise<NamespaceDocument> {
-    if (isObjectIdOrHexString(idOrKey)) {
-      return this.namespaceModel.findById(idOrKey).exec();
-    }
-    return this.getByKey(idOrKey);
+  update(key: string, updateDto: UpdateNamespaceDto): Promise<NamespaceDocument> {
+    return this.namespaceModel.findOneAndUpdate({ key }, updateDto, { new: true }).exec();
   }
 
-  update(idOrKey: string, updateDto: UpdateNamespaceDto): Promise<NamespaceDocument> {
-    if (isObjectIdOrHexString(idOrKey)) {
-      return this.namespaceModel.findByIdAndUpdate(idOrKey, updateDto, { new: true }).exec();
-    }
-    return this.namespaceModel.findOneAndUpdate({ key: idOrKey }, updateDto, { new: true }).exec();
-  }
-
-  upsertByKey(key: string, dto: UpsertNamespaceDto) {
+  upsertByKey(key: string, dto: UpsertNamespaceDto): Promise<NamespaceDocument> {
     const filter = { key };
     return this.namespaceModel.findOneAndUpdate(filter, dto, { upsert: true, new: true }).exec();
   }
 
-  delete(id: string) {
-    return this.namespaceModel.findByIdAndDelete(id).exec();
+  delete(key: string): Promise<NamespaceDocument> {
+    return this.namespaceModel.findOneAndDelete({ key }).exec();
   }
 
-  getByKey(key: string): Promise<NamespaceDocument | null> {
+  get(key: string): Promise<NamespaceDocument | null> {
     return this.namespaceModel.findOne({ key }).exec();
   }
 

src/user/user.controller.ts

@@ -128,7 +128,7 @@ export class UserController {
 
     // 查询用户的 ns 是否存在
     if (ns) {
-      const namespace = await this.namespaceService.getByKey(ns);
+      const namespace = await this.namespaceService.get(ns);
       if (!namespace) {
         throw new NotFoundException({
           code: ErrorCodes.NAMESPACE_NOT_FOUND,
@@ -217,7 +217,7 @@ export class UserController {
   ): Promise<UserDocument> {
     const { username, email, phone, employeeId, ns } = updateDto;
     if (ns) {
-      const namespace = await this.namespaceService.getByKey(ns);
+      const namespace = await this.namespaceService.get(ns);
       if (!namespace) {
         throw new NotFoundException({
           code: ErrorCodes.NAMESPACE_NOT_FOUND,
@@ -318,7 +318,7 @@ export class UserController {
   ): Promise<UserDocument> {
     const { username, email, phone, ns, employeeId: toBeUpdatedEmployeeId } = dto;
     if (ns) {
-      const namespace = await this.namespaceService.getByKey(ns);
+      const namespace = await this.namespaceService.get(ns);
       if (!namespace) {
         throw new NotFoundException({
           code: ErrorCodes.NAMESPACE_NOT_FOUND,

test/namespace.e2e-spec.ts

@@ -120,7 +120,7 @@ describe('Namespace crud (e2e)', () => {
     });
 
     const resp1 = await request(app.getHttpServer())
-      .get(`/namespaces/${encodeURIComponent(ns1.id)}`)
+      .get(`/namespaces/${encodeURIComponent(ns1.key)}`)
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
@@ -148,7 +148,7 @@ describe('Namespace crud (e2e)', () => {
     const nameToBeUpdated = 'test name';
 
     const resp = await request(app.getHttpServer())
-      .patch(`/namespaces/${ns.id}`)
+      .patch(`/namespaces/${ns.key}`)
       .send({
         name: nameToBeUpdated,
       })
@@ -169,11 +169,11 @@ describe('Namespace crud (e2e)', () => {
     });
 
     await request(app.getHttpServer())
-      .delete(`/namespaces/${ns.id}`)
+      .delete(`/namespaces/${ns.key}`)
       .set('Content-Type', 'application/json')
       .set('x-api-key', auth.apiKey)
       .set('Accept', 'application/json')
       .expect(204);
-    expect(await namespaceService.get(ns.id)).toBeNull();
+    expect(await namespaceService.get(ns.key)).toBeNull();
   });
 });