chore(serve): rename "audit-log" to "access-log".

- rename "AuditLoggingMiddleware" to "AccessLogMiddleware". - rename option name from "audit-log" to "access-log". - rename "AUDIT" to "ACCESS_LOG" in "getLogger" function.
Canner · Sep 12, 2022 · 916da3e · 916da3e
1 parent 977e858
commit 916da3e
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/packages/core/src/lib/utils/logger.ts b/packages/core/src/lib/utils/logger.ts
@@ -6,7 +6,7 @@ export enum LoggingScope {
   CORE = 'CORE',
   BUILD = 'BUILD',
   SERVE = 'SERVE',
-  AUDIT = 'AUDIT',
+  ACCESS_LOG = 'ACCESS_LOG',
 }
 
 type LoggingScopeTypes = keyof typeof LoggingScope;
@@ -53,7 +53,7 @@ const defaultMapConfig: LoggerMapConfig = {
     displayFilePath: 'hideNodeModulesOnly',
     displayFunctionName: true,
   },
-  [LoggingScope.AUDIT]: {
+  [LoggingScope.ACCESS_LOG]: {
     level: LoggingLevel.DEBUG,
     displayRequestId: false,
     displayFilePath: 'hidden',

diff --git a/.../src/lib/middleware/auditLogMiddleware.ts → ...src/lib/middleware/accessLogMiddleware.ts b/.../src/lib/middleware/auditLogMiddleware.ts → ...src/lib/middleware/accessLogMiddleware.ts
@@ -6,10 +6,10 @@ import {
 import * as bytes from 'bytes';
 import { BuiltInMiddleware, KoaContext, Next } from '@vulcan-sql/serve/models';
 
-@VulcanInternalExtension('audit-log')
-export class AuditLoggingMiddleware extends BuiltInMiddleware<LoggerOptions> {
+@VulcanInternalExtension('access-log')
+export class AccessLogMiddleware extends BuiltInMiddleware<LoggerOptions> {
   private logger = getLogger({
-    scopeName: 'AUDIT',
+    scopeName: 'ACCESS_LOG',
     options: this.getOptions(),
   });
 

diff --git a/packages/serve/src/lib/middleware/index.ts b/packages/serve/src/lib/middleware/index.ts
@@ -1,6 +1,6 @@
 export * from './corsMiddleware';
 export * from './requestIdMiddleware';
-export * from './auditLogMiddleware';
+export * from './accessLogMiddleware';
 export * from './rateLimitMiddleware';
 export * from './authMiddleware';
 export * from './response-format';
@@ -11,7 +11,7 @@ import { CorsMiddleware } from './corsMiddleware';
 import { AuthMiddleware } from './authMiddleware';
 import { RateLimitMiddleware } from './rateLimitMiddleware';
 import { RequestIdMiddleware } from './requestIdMiddleware';
-import { AuditLoggingMiddleware } from './auditLogMiddleware';
+import { AccessLogMiddleware } from './accessLogMiddleware';
 import { ResponseFormatMiddleware } from './response-format';
 import { EnforceHttpsMiddleware } from './enforceHttpsMiddleware';
 import { ClassType, ExtensionBase } from '@vulcan-sql/core';
@@ -22,7 +22,7 @@ export const BuiltInRouteMiddlewares: ClassType<ExtensionBase>[] = [
   CorsMiddleware,
   EnforceHttpsMiddleware,
   RequestIdMiddleware,
-  AuditLoggingMiddleware,
+  AccessLogMiddleware,
   RateLimitMiddleware,
   AuthMiddleware,
   ResponseFormatMiddleware,

diff --git a/...in-middlewares/auditLogMiddleware.spec.ts → ...n-middlewares/accessLogMiddleware.spec.ts b/...in-middlewares/auditLogMiddleware.spec.ts → ...n-middlewares/accessLogMiddleware.spec.ts
@@ -7,12 +7,12 @@ import { KoaContext } from '@vulcan-sql/serve/models';
 import * as core from '@vulcan-sql/core';
 import * as uuid from 'uuid';
 import {
-  AuditLoggingMiddleware,
+  AccessLogMiddleware,
   RequestIdMiddleware,
 } from '@vulcan-sql/serve/middleware';
 import bytes = require('bytes');
 
-describe('Test audit logging middlewares', () => {
+describe('Test access log middlewares', () => {
   afterEach(() => {
     sinon.default.restore();
   });
@@ -63,9 +63,9 @@ describe('Test audit logging middlewares', () => {
       ` <- header: ${JSON.stringify(resp.header)}`,
     ];
     // Act
-    const middleware = new AuditLoggingMiddleware({}, '');
-    // Use spy to trace the logger from getLogger( scopeName: 'AUDIT' }) to know in logger.info(...)
-    const spy = sinon.default.spy(core.getLogger({ scopeName: 'AUDIT' }));
+    const middleware = new AccessLogMiddleware({}, '');
+    // Use spy to trace the logger from getLogger( scopeName: 'ACCESS_LOG' }) to know in logger.info(...)
+    const spy = sinon.default.spy(core.getLogger({ scopeName: 'ACCESS_LOG' }));
     await middleware.handle(ctx, async () => Promise.resolve());
 
     // Assert
@@ -129,19 +129,19 @@ describe('Test audit logging middlewares', () => {
 
     // setup request-id middleware run first.
     const stubReqIdMiddleware = new RequestIdMiddleware({}, '');
-    const middleware = new AuditLoggingMiddleware(
+    const middleware = new AccessLogMiddleware(
       {
         options: {
           displayRequestId: true,
         },
       },
       ''
     );
-    // Use spy to trace the logger from getLogger( scopeName: 'AUDIT' }) to know in logger.info(...)
-    // it will get the setting of logger from above new audit logging middleware
+    // Use spy to trace the logger from getLogger( scopeName: 'ACCESS_LOG' }) to know in logger.info(...)
+    // it will get the setting of logger from above new ACCESS_LOG logging middleware
     const spy = sinon.default.spy(
       core.getLogger({
-        scopeName: 'AUDIT',
+        scopeName: 'ACCESS_LOG',
       })
     );
     // Act