add activity log middleware and align response statue setting

onlyjackfrost · onlyjackfrost · commit c01fba1acd35 · 2023-09-11T17:54:28.000+08:00
diff --git a/packages/core/src/lib/cache-layer/cacheLayerRefresher.ts b/packages/core/src/lib/cache-layer/cacheLayerRefresher.ts
@@ -1,7 +1,7 @@
 import ms, { StringValue } from 'ms';
 import { uniq } from 'lodash';
 import { ToadScheduler, SimpleIntervalJob, AsyncTask } from 'toad-scheduler';
-import { inject, injectable } from 'inversify';
+import { inject, injectable, multiInject } from 'inversify';
 import { TYPES } from '@vulcan-sql/core/types';
 import { APISchema, IActivityLogger } from '@vulcan-sql/core/models';
 import { ConfigurationError } from '../utils/errors';
@@ -28,15 +28,16 @@ export interface ICacheLayerRefresher {
 export class CacheLayerRefresher implements ICacheLayerRefresher {
   private cacheLoader: ICacheLayerLoader;
   private scheduler = new ToadScheduler();
-  private activityLogger: IActivityLogger;
+  private activityLoggers: IActivityLogger[];
   private logger = getLogger({ scopeName: 'CORE' });
 
   constructor(
     @inject(TYPES.CacheLayerLoader) loader: ICacheLayerLoader,
-    @inject(TYPES.Extension_ActivityLogger) activityLogger: IActivityLogger
+    @multiInject(TYPES.Extension_ActivityLogger)
+    activityLoggers: IActivityLogger[]
   ) {
     this.cacheLoader = loader;
-    this.activityLogger = activityLogger;
+    this.activityLoggers = activityLoggers;
   }
 
   public async start(
@@ -48,6 +49,7 @@ export class CacheLayerRefresher implements ICacheLayerRefresher {
     // check if the index name is duplicated more than one API schemas
     this.checkDuplicateIndex(schemas);
     // traverse each cache table of each schema
+    const activityLogger = this.getActivityLogger();
     await Promise.all(
       schemas.map(async (schema) => {
         // skip the schema by return if not set the cache
@@ -83,11 +85,12 @@ export class CacheLayerRefresher implements ICacheLayerRefresher {
                       sql,
                       refreshResult,
                     };
-                    await this.activityLogger.log(content).catch((err: any) => {
-                      this.logger.debug(
-                        `Failed to log activity after refreshing cache: ${err}`
-                      );
-                    });
+                    if (activityLogger)
+                      activityLogger.log(content).catch((err: any) => {
+                        this.logger.debug(
+                          `Failed to log activity after refreshing cache: ${err}`
+                        );
+                      });
                   }
                 }),
                 { preventOverrun: true, id: workerId }
@@ -111,11 +114,12 @@ export class CacheLayerRefresher implements ICacheLayerRefresher {
                   sql,
                   refreshResult,
                 };
-                await this.activityLogger.log(content).catch((err: any) => {
-                  this.logger.debug(
-                    `Failed to log activity after refreshing cache: ${err}`
-                  );
-                });
+                if (activityLogger)
+                  activityLogger.log(content).catch((err: any) => {
+                    this.logger.debug(
+                      `Failed to log activity after refreshing cache: ${err}`
+                    );
+                  });
               }
             }
           })
@@ -131,6 +135,14 @@ export class CacheLayerRefresher implements ICacheLayerRefresher {
     this.scheduler.stop();
   }
 
+  private getActivityLogger(): IActivityLogger | undefined {
+    const activityLogger = this.activityLoggers.find((logger) =>
+      logger.isEnabled()
+    );
+
+    return activityLogger;
+  }
+
   private checkDuplicateCacheTableName(schemas: APISchema[]) {
     const tableNames = schemas
       // => [[table1, table2], [table1, table3], [table4]]
diff --git a/packages/core/src/lib/template-engine/compiler-environment/base.ts b/packages/core/src/lib/template-engine/compiler-environment/base.ts
@@ -7,6 +7,7 @@ import * as nunjucks from 'nunjucks';
 export abstract class BaseCompilerEnvironment extends nunjucks.Environment {
   abstract getExtensions(): ExtensionBase[];
 
+  // initialize template engines extensions
   public async initializeExtensions() {
     const extensions = this.getExtensions();
     for (const extension of extensions) {
diff --git a/packages/core/src/models/extensions/logger.ts b/packages/core/src/models/extensions/logger.ts
@@ -7,6 +7,7 @@ export enum ActivityLoggerType {
 }
 
 export interface IActivityLogger {
+  isEnabled(): boolean;
   log(content: any): Promise<void>;
 }
 
@@ -17,7 +18,7 @@ export abstract class BaseActivityLogger<ActivityLoggerTypeOption>
 {
   public abstract log(context: any): Promise<void>;
 
-  protected isEnabled(): boolean {
+  public isEnabled(): boolean {
     const config = this.getConfig();
     if (!config) return false;
     if (config.enabled === true) return true;
diff --git a/packages/core/test/cache-layer/cacheLayerRefresher.spec.ts b/packages/core/test/cache-layer/cacheLayerRefresher.spec.ts
@@ -25,6 +25,7 @@ jest.mock('../../src/lib/loggers/httpLogger', () => {
     ...originalModule,
     HttpLogger: jest.fn().mockImplementation(() => {
       return {
+        isEnabled: jest.fn().mockReturnValue(true),
         log: jest.fn().mockResolvedValue(true), // Spy on the add method
       };
     }),
@@ -122,7 +123,7 @@ describe('Test cache layer refresher', () => {
         ] as Array<CacheLayerInfo>,
       },
     ];
-    const refresher = new CacheLayerRefresher(stubCacheLoader, mockLogger);
+    const refresher = new CacheLayerRefresher(stubCacheLoader, [mockLogger]);
 
     // Act, Assert
     await expect(() => refresher.start(schemas)).rejects.toThrow(
@@ -173,7 +174,7 @@ describe('Test cache layer refresher', () => {
         ] as Array<CacheLayerInfo>,
       },
     ];
-    const refresher = new CacheLayerRefresher(stubCacheLoader, mockLogger);
+    const refresher = new CacheLayerRefresher(stubCacheLoader, [mockLogger]);
 
     // Act, Assert
     await expect(() => refresher.start(schemas)).rejects.toThrow(
@@ -219,7 +220,7 @@ describe('Test cache layer refresher', () => {
       ];
       // Act
       const loader = new CacheLayerLoader(options, stubFactory as any);
-      const refresher = new CacheLayerRefresher(loader, mockLogger);
+      const refresher = new CacheLayerRefresher(loader, [mockLogger]);
       await refresher.start(schemas);
 
       // Assert
@@ -295,7 +296,7 @@ describe('Test cache layer refresher', () => {
 
     // Stub the load method to not do any thing.
     stubCacheLoader.load.resolves();
-    const refresher = new CacheLayerRefresher(stubCacheLoader, mockLogger);
+    const refresher = new CacheLayerRefresher(stubCacheLoader, [mockLogger]);
     // Act
     await refresher.start(schemas);
 
@@ -366,7 +367,7 @@ describe('Test cache layer refresher', () => {
       ];
       // Act
       const loader = new CacheLayerLoader(options, stubFactory as any);
-      const refresher = new CacheLayerRefresher(loader, mockLogger);
+      const refresher = new CacheLayerRefresher(loader, [mockLogger]);
       await refresher.start(schemas);
 
       // Assert
@@ -413,7 +414,7 @@ describe('Test cache layer refresher', () => {
       // Act
       const loader = new CacheLayerLoader(options, stubFactory as any);
       stubCacheLoader.load.throws();
-      const refresher = new CacheLayerRefresher(loader, mockLogger);
+      const refresher = new CacheLayerRefresher(loader, [mockLogger]);
       await refresher.start(schemas);
 
       // Assert
diff --git a/packages/extension-authenticator-canner/src/lib/authenticator/pat.ts b/packages/extension-authenticator-canner/src/lib/authenticator/pat.ts
@@ -76,7 +76,7 @@ export class CannerPATAuthenticator extends BaseAuthenticator<CannerPATOptions>
           operationName: 'UserMe',
           variables: {},
           query:
-            'query UserMe{userMe {accountRole attributes createdAt email groups {id name} lastName firstName username}}',
+            'query UserMe{userMe {id accountRole attributes createdAt email groups {id name} lastName firstName username}}',
         },
         {
           headers: {
diff --git a/packages/serve/src/lib/middleware/activityLogMiddleware.ts b/packages/serve/src/lib/middleware/activityLogMiddleware.ts
@@ -0,0 +1,64 @@
+import {
+  TYPES as CORE_TYPES,
+  BaseActivityLogger,
+  VulcanInternalExtension,
+  IActivityLoggerOptions,
+  getLogger,
+} from '@vulcan-sql/core';
+import { Next, KoaContext, BuiltInMiddleware } from '@vulcan-sql/serve/models';
+import { inject, multiInject } from 'inversify';
+import moment = require('moment');
+
+const logger = getLogger({ scopeName: 'SERVE' });
+
+@VulcanInternalExtension('activity-log')
+export class ActivityLogMiddleware extends BuiltInMiddleware<IActivityLoggerOptions> {
+  private activityLoggers: BaseActivityLogger<any>[];
+  private activityLoggerMap: Record<string, BaseActivityLogger<any>> = {};
+  constructor(
+    @inject(CORE_TYPES.ExtensionConfig) config: any,
+    @inject(CORE_TYPES.ExtensionName) name: string,
+    @multiInject(CORE_TYPES.Extension_ActivityLogger)
+    activityLoggers: BaseActivityLogger<any>[]
+  ) {
+    super(config, name);
+    this.activityLoggers = activityLoggers;
+  }
+  public override async onActivate(): Promise<void> {
+    for (const logger of this.activityLoggers) {
+      if (logger.isEnabled()) {
+        const id = logger.getExtensionId();
+        this.activityLoggerMap[id!] = logger;
+      }
+    }
+  }
+  public async handle(context: KoaContext, next: Next) {
+    if (!this.enabled) return next();
+    const logTime = moment.utc().format('YYYY-MM-DD HH:mm:ss');
+    const startTime = Date.now();
+    await next();
+    const endTime = Date.now();
+    const duration = endTime - startTime;
+    const body = context.response.body as any;
+    const error = body?.message;
+    const user = context.state.user;
+    for (const activityLogger of Object.values(this.activityLoggerMap)) {
+      const activityLog = {
+        logTime,
+        duration,
+        method: context.request.method,
+        url: context.request.originalUrl,
+        ip: context.request.ip,
+        header: context.request.header,
+        params: context.params,
+        query: context.request.query,
+        status: context.response.status,
+        error,
+        user,
+      };
+      activityLogger.log(activityLog).catch((e) => {
+        logger.debug(`Error when logging activity: ${e}`);
+      });
+    }
+  }
+}
diff --git a/packages/serve/src/lib/middleware/auth/authCredentialsMiddleware.ts b/packages/serve/src/lib/middleware/auth/authCredentialsMiddleware.ts
@@ -66,7 +66,7 @@ export class AuthCredentialsMiddleware extends BaseAuthMiddleware {
       if (result.status === AuthStatus.INDETERMINATE) continue;
       // if state is failed, return directly
       if (result.status === AuthStatus.FAIL) {
-        context.status = 401;
+        context.response.status = 401;
         context.body = {
           type: result.type,
           message: result.message || 'verify token failed',
diff --git a/packages/serve/src/lib/middleware/auth/authRouterMiddleware.ts b/packages/serve/src/lib/middleware/auth/authRouterMiddleware.ts
@@ -40,7 +40,7 @@ export class AuthRouterMiddleware extends BaseAuthMiddleware {
   private mountTokenEndpoint() {
     this.router.post(`/auth/token`, async (context: KoaContext) => {
       if (isEmpty(context.request.body)) {
-        context.status = 400;
+        context.response.status = 400;
         context.body = { message: 'Please provide request parameters.' };
         return;
       }
@@ -50,7 +50,7 @@ export class AuthRouterMiddleware extends BaseAuthMiddleware {
         const msg = `Please provide auth "type", supported types: ${Object.keys(
           this.options
         )}.`;
-        context.status = 400;
+        context.response.status = 400;
         context.body = { message: msg };
         return;
       }
@@ -59,7 +59,7 @@ export class AuthRouterMiddleware extends BaseAuthMiddleware {
         const msg = `auth type "${type}" does not support, only supported: ${Object.keys(
           this.options
         )}.`;
-        context.status = 400;
+        context.response.status = 400;
         context.body = { message: msg };
         return;
       }
@@ -69,7 +69,7 @@ export class AuthRouterMiddleware extends BaseAuthMiddleware {
         context.body = result;
         return;
       } catch (err) {
-        context.status = 400;
+        context.response.status = 400;
         context.body = {
           message: (err as Error).message,
         };
@@ -81,7 +81,7 @@ export class AuthRouterMiddleware extends BaseAuthMiddleware {
     // The route should work after the token authenticated
     this.router.get(`/auth/user-profile`, async (context: KoaContext) => {
       if (!context.state.user) {
-        context.status = 404;
+        context.response.status = 404;
         context.body = {
           message: 'User profile not found.',
         };
diff --git a/packages/serve/src/lib/middleware/index.ts b/packages/serve/src/lib/middleware/index.ts
@@ -23,10 +23,12 @@ import { ClassType, ExtensionBase } from '@vulcan-sql/core';
 import { DocRouterMiddleware } from './docRouterMiddleware';
 import { ErrorHandlerMiddleware } from './errorHandlerMIddleware';
 import { CatalogRouterMiddleware } from './catalogRouterMiddleware';
+import { ActivityLogMiddleware } from './activityLogMiddleware';
 
 // The array is the middleware running order
 export const BuiltInRouteMiddlewares: ClassType<ExtensionBase>[] = [
   RequestIdMiddleware,
+  ActivityLogMiddleware,
   ErrorHandlerMiddleware,
   AccessLogMiddleware,
   CorsMiddleware,
diff --git a/packages/serve/test/middlewares/built-in-middlewares/activityLogMiddleware.spec.ts b/packages/serve/test/middlewares/built-in-middlewares/activityLogMiddleware.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ export enum ActivityLoggerType {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`export interface IActivityLogger {`
	`10`	`+ isEnabled(): boolean;`
`10`	`11`	`log(content: any): Promise<void>;`
`11`	`12`	`}`
`12`	`13`
`@@ -17,7 +18,7 @@ export abstract class BaseActivityLogger<ActivityLoggerTypeOption>`
`17`	`18`	`{`
`18`	`19`	`public abstract log(context: any): Promise<void>;`
`19`	`20`
`20`		`- protected isEnabled(): boolean {`
	`21`	`+ public isEnabled(): boolean {`
`21`	`22`	`const config = this.getConfig();`
`22`	`23`	`if (!config) return false;`
`23`	`24`	`if (config.enabled === true) return true;`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ export class CannerPATAuthenticator extends BaseAuthenticator<CannerPATOptions>`
`76`	`76`	`operationName: 'UserMe',`
`77`	`77`	`variables: {},`
`78`	`78`	`query:`
`79`		`- 'query UserMe{userMe {accountRole attributes createdAt email groups {id name} lastName firstName username}}',`
	`79`	`+ 'query UserMe{userMe {id accountRole attributes createdAt email groups {id name} lastName firstName username}}',`
`80`	`80`	`},`
`81`	`81`	`{`
`82`	`82`	`headers: {`