refactor(json-api-server): restructure modules for better ORM type separation and enhance ACL support

Author: klerick

apps/json-api-server/src/app/app.module.ts

@@ -1,34 +1,64 @@
 import { Module } from '@nestjs/common';
-import { LoggerModule } from 'nestjs-pino';
+import { LoggerErrorInterceptor, LoggerModule } from 'nestjs-pino';
+import { ClsModule, ClsServiceManager } from 'nestjs-cls';
 
-import { TypeOrmDatabaseModule } from '@nestjs-json-api/typeorm-database';
-import { MicroOrmDatabaseModule } from '@nestjs-json-api/microorm-database';
-import { ResourcesTypeModule } from './resources/type-orm/resources-type.module';
-import { ResourcesMicroModule } from './resources/micro-orm/resources-micro.module';
+import { APP_INTERCEPTOR } from '@nestjs/core';
 import { RpcModule } from './rpc/rpc.module';
 
-const ormModule =
-  process.env['ORM_TYPE'] === 'typeorm'
-    ? TypeOrmDatabaseModule
-    : MicroOrmDatabaseModule;
+import {JsonApiTypeOrm, JsonApiMicroOrm} from './json-api'
 
-const resourceModule =
+const jsonAPiModule =
   process.env['ORM_TYPE'] === 'typeorm'
-    ? ResourcesTypeModule
-    : ResourcesMicroModule;
+    ? JsonApiTypeOrm
+    : JsonApiMicroOrm;
+
 
 @Module({
   imports: [
-    ormModule,
-    resourceModule,
+    jsonAPiModule,
+    ClsModule.forRoot({
+      global: true,
+      middleware: { mount: true, generateId: true },
+    }),
     RpcModule,
     LoggerModule.forRoot({
       pinoHttp: {
         level: process.env['NODE_ENV'] === 'test' ? 'silent' : 'debug',
+        transport: {
+          target: 'pino-pretty',
+          options: {
+            translateTime: 'UTC:mm/dd/yyyy, h:MM:ss TT Z',
+            levelFirst: true,
+            colorize: true,
+            messageFormat: `{service} - {if context}[{context}]{end} {msg} {if requestId}({requestId}){end}`,
+            ignore: `hostname,service,context,message,requestId`,
+          },
+        },
+        genReqId: function (req, res) {
+          const cls = ClsServiceManager.getClsService();
+          const existingID = cls.getId()
+          res.setHeader('X-Request-Id', existingID)
+          return existingID
+        },
+        customProps: () => {
+          const cls = ClsServiceManager.getClsService();
+          const contextId = cls.getId();
+          if (!contextId) {
+            return {};
+          }
+          return {
+            ['requestId']: contextId,
+          };
+        }
       },
     }),
   ],
   controllers: [],
-  providers: [],
+  providers: [
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: LoggerErrorInterceptor,
+    },
+  ],
 })
 export class AppModule {}

apps/json-api-server/src/app/json-api/index.ts

@@ -0,0 +1,2 @@
+export { JsonApiTypeOrm } from './type-orm/json-api-type-orm';
+export { JsonApiMicroOrm } from './micro-orm/json-api-micro-orm';

apps/json-api-server/src/app/json-api/micro-orm/acl/acl.module.ts

@@ -0,0 +1,22 @@
+import { Global, Module, OnModuleInit } from '@nestjs/common';
+import { AclPermissionsModule } from '@klerick/acl-json-api-nestjs';
+import { ClsService } from 'nestjs-cls';
+import { RulesLoaderService } from './rules-loader.service';
+
+import {
+  ContextTestAcl,
+  MicroOrmDatabaseModule,
+} from '@nestjs-json-api/microorm-database';
+
+@Module({
+  imports: [
+    AclPermissionsModule.forRoot({
+      rulesLoader: RulesLoaderService,
+      contextStore: ClsService,
+      onNoRules: 'allow',
+    }),
+    MicroOrmDatabaseModule.forFeature([ContextTestAcl], 'default'),
+  ],
+  providers: [RulesLoaderService],
+})
+export class AclModule {}

apps/json-api-server/src/app/json-api/micro-orm/acl/rules-loader.service.ts

@@ -0,0 +1,45 @@
+import {
+  AclAction,
+  AclRule,
+  AclRulesLoader,
+  AclSubject,
+} from '@klerick/acl-json-api-nestjs';
+import {
+  ContextTestAcl,
+} from '@nestjs-json-api/microorm-database';
+import { AnyEntity, EntityRepository } from '@mikro-orm/core';
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@mikro-orm/nestjs';
+
+@Injectable()
+export class RulesLoaderService implements AclRulesLoader {
+  @InjectRepository(ContextTestAcl, 'default')
+  private readonly contextTestAcl!: EntityRepository<ContextTestAcl>;
+
+  async getContext(): Promise<{ [x: string]: any }> {
+    const contexts = await this.contextTestAcl.findAll();
+    const context = contexts.at(0);
+    if (!context) return {}
+    return context.context;
+  }
+  async getHelpers(): Promise<{ [x: string]: (...arg: any[]) => any }> {
+    return {
+      removeMyselfOnly: (oldArray: number[], userId: number): number[] => {
+        return oldArray.filter(id => id !== userId);
+      }
+    };
+  }
+  async loadRules<E extends AnyEntity>(
+    entity: AclSubject<E>,
+    action: AclAction
+  ): Promise<AclRule<E>[]> {
+    const contexts = await this.contextTestAcl.findAll();
+    const context = contexts.at(0);
+    if (!context) return []
+
+    const rules = context.aclRules.rules as unknown as AclRule<E>[]
+
+    return rules.filter(r => r.action === action && (entity as any)['name'] === r.subject)
+
+  }
+}

apps/json-api-server/src/app/json-api/micro-orm/json-api-micro-orm.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { MicroOrmDatabaseModule } from '@nestjs-json-api/microorm-database';
+
+import { AclModule } from './acl/acl.module';
+import { ResourcesMicroModule } from './micro-orm/resources-micro.module';
+
+@Module({
+  imports: [MicroOrmDatabaseModule.forRoot(), AclModule, ResourcesMicroModule],
+})
+export class JsonApiMicroOrm {}

…book-list/extend-book-list.controller.ts …book-list/extend-book-list.controller.tsapps/json-api-server/src/app/resources/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts renamed to apps/json-api-server/src/app/json-api/micro-orm/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts apps/json-api-server/src/app/resources/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts renamed to apps/json-api-server/src/app/json-api/micro-orm/micro-orm/controllers/extend-book-list/extend-book-list.controller.ts

@@ -1,4 +1,4 @@
-import { Module } from '@nestjs/common';
+import { Module, Type } from '@nestjs/common';
 import { JsonApiModule } from '@klerick/json-api-nestjs';
 import { MicroOrmJsonApiModule } from '@klerick/json-api-nestjs-microorm';
 import {
@@ -9,6 +9,37 @@ import {
   BookList,
 } from '@nestjs-json-api/microorm-database';
 
+import {
+  UsersAcl,
+  ArticleAcl,
+  CategoryAcl,
+  TagAcl,
+  PostAcl,
+  CommentAcl,
+  DocumentAcl,
+  UserProfileAcl,
+  ContextTestAcl,
+} from '@nestjs-json-api/microorm-database';
+
+const GeneraleResource = [
+  Users,
+  Addresses,
+  Comments,
+  Roles,
+  BookList,
+  ContextTestAcl,
+];
+const AclResource = [
+  UsersAcl,
+  ArticleAcl,
+  CategoryAcl,
+  TagAcl,
+  PostAcl,
+  CommentAcl,
+  DocumentAcl,
+  UserProfileAcl,
+];
+
 import { ExtendBookListController } from './controllers/extend-book-list/extend-book-list.controller';
 import { ExtendUserController } from './controllers/extend-user/extend-user.controller';
 import { ExampleService } from './service/example.service';
@@ -18,17 +49,24 @@ import { wrapperJsonApiController } from '@klerick/acl-json-api-nestjs';
 @Module({
   imports: [
     JsonApiModule.forRoot(MicroOrmJsonApiModule, {
-      entities: [Users, Addresses, Comments, Roles, BookList],
+      entities: [...GeneraleResource, ...AclResource] as any,
       controllers: [ExtendBookListController, ExtendUserController],
       providers: [ExampleService],
       options: {
         debug: true,
         requiredSelectField: false,
         operationUrl: 'operation',
       },
-      // hooks: {
-      //   afterCreateController: wrapperJsonApiController,
-      // },
+      hooks: {
+        afterCreateController: (controllerClass: Type<any>) => {
+          if (
+            !controllerClass.name.startsWith('ContextTestAcl') &&
+            controllerClass.name.indexOf('Acl') > -1
+          ) {
+            wrapperJsonApiController(controllerClass);
+          }
+        },
+      },
     }),
   ],
 })