adjust activity payload

Author: onlyjackfrost

packages/core/src/lib/cache-layer/cacheLayerRefresher.ts

@@ -5,6 +5,8 @@ import { inject, injectable, multiInject } from 'inversify';
 import { TYPES } from '@vulcan-sql/core/types';
 import {
   APISchema,
+  ActivityLogContentOptions,
+  ActivityLogType,
   CacheLayerInfo,
   IActivityLogger,
 } from '@vulcan-sql/core/models';
@@ -111,11 +113,12 @@ export class CacheLayerRefresher implements ICacheLayerRefresher {
     } finally {
       // send activity log
       const content = {
+        isSuccess: refreshResult === RefreshResult.SUCCESS ? true : false,
+        activityLogType: ActivityLogType.CACHE_REFRESH,
         logTime: now,
         urlPath,
         sql,
-        refreshResult,
-      };
+      } as ActivityLogContentOptions;
       const activityLoggers = this.getActivityLoggers();
       for (const activityLogger of activityLoggers)
         activityLogger.log(content).catch((err: any) => {

packages/core/src/models/extensions/logger.ts

@@ -7,6 +7,14 @@ export enum ActivityLoggerType {
   HTTP_LOGGER = 'http-logger',
 }
 
+export enum ActivityLogType {
+  CACHE_REFRESH = 'cache-refresh',
+  API_REQUEST = 'api-request',
+}
+export interface ActivityLogContentOptions {
+  isSuccess: boolean;
+  activityLogType: ActivityLogType;
+}
 export interface IActivityLogger {
   isEnabled(): boolean;
   log(content: any): Promise<void>;

packages/serve/src/lib/middleware/activityLogMiddleware.ts

@@ -4,6 +4,8 @@ import {
   VulcanInternalExtension,
   IActivityLoggerOptions,
   getLogger,
+  ActivityLogType,
+  ActivityLogContentOptions,
 } from '@vulcan-sql/core';
 import { Next, KoaContext, BuiltInMiddleware } from '@vulcan-sql/serve/models';
 import { inject, multiInject } from 'inversify';
@@ -42,7 +44,10 @@ export class ActivityLogMiddleware extends BuiltInMiddleware<IActivityLoggerOpti
     const body = context.response.body as any;
     const error = body?.message;
     const user = context.state.user;
+    const status = context.response.status || context.status;
     const activityLog = {
+      activityLogType: ActivityLogType.API_REQUEST,
+      isSuccess: status.toString().startsWith('2') ? true : false,
       logTime,
       duration,
       method: context.request.method,
@@ -51,10 +56,10 @@ export class ActivityLogMiddleware extends BuiltInMiddleware<IActivityLoggerOpti
       header: context.request.header,
       params: context.params,
       query: context.request.query,
-      status: context.response.status || context.status,
+      status,
       error,
       user,
-    };
+    } as ActivityLogContentOptions;
     for (const activityLogger of Object.values(this.activityLoggerMap)) {
       activityLogger.log(activityLog).catch((e) => {
         logger.debug(`Error when logging activity: ${e}`);

packages/serve/test/middlewares/built-in-middlewares/activityLogMiddleware.spec.ts

@@ -5,7 +5,7 @@ import { IncomingHttpHeaders } from 'http';
 import { ParsedUrlQuery } from 'querystring';
 import { KoaContext } from '@vulcan-sql/serve/models';
 
-import { HttpLogger } from '@vulcan-sql/core';
+import { ActivityLogType, HttpLogger } from '@vulcan-sql/core';
 import { ActivityLogMiddleware } from '@vulcan-sql/serve/middleware/activityLogMiddleware';
 
 jest.mock('../../../../core/src/lib/loggers/httpLogger', () => {
@@ -76,6 +76,8 @@ describe('Test activity log middlewares', () => {
     };
 
     const expected = {
+      isSuccess: true,
+      activityLogType: ActivityLogType.API_REQUEST,
       method: ctx.request.method,
       url: ctx.request.originalUrl,
       status: ctx.response.status,
@@ -95,6 +97,8 @@ describe('Test activity log middlewares', () => {
     // Assert
     const logMock = mockLogger.log as jest.Mock;
     const actual = logMock.mock.calls[0];
+    expect(actual[0].isSuccess).toEqual(expected.isSuccess);
+    expect(actual[0].activityLogType).toEqual(expected.activityLogType);
     expect(actual[0].method).toEqual(expected.method);
     expect(actual[0].url).toEqual(expected.url);
     expect(actual[0].status).toEqual(expected.status);
@@ -146,6 +150,8 @@ describe('Test activity log middlewares', () => {
     };
     const body = ctx.response.body as any;
     const expected = {
+      isSucess: false,
+      activityLogType: ActivityLogType.API_REQUEST,
       method: ctx.request.method,
       url: ctx.request.originalUrl,
       status: ctx.response.status,
@@ -165,6 +171,8 @@ describe('Test activity log middlewares', () => {
     // Assert
     const logMock = mockLogger.log as jest.Mock;
     const actual = logMock.mock.calls[0];
+    expect(actual[0].isSuccess).toEqual(expected.isSucess);
+    expect(actual[0].activityLogType).toEqual(expected.activityLogType);
     expect(actual[0].method).toEqual(expected.method);
     expect(actual[0].url).toEqual(expected.url);
     expect(actual[0].status).toEqual(expected.status);