node-server-engine 1.1.1 → 1.1.3

package/src/utils/report/output.types.ts

@@ -1,70 +1,70 @@
-import { LogSeverity } from 'const';
-
-/** Structure of the request reporting in log entries */
-interface LogEntryRequest {
-  /** Requested URL */
-  url: string;
-  /** HTTP method used */
-  method: string;
-  /** Referer website */
-  referrer?: string;
-  /** User-Agent of the connected client */
-  userAgent?: string;
-  /** IP address of the client */
-  remoteIp: string | undefined;
-  /** HTTP status code returned to the client */
-  responseStatusCode?: number;
-}
-
-/** Structure of the context entry in log entries */
-interface LogEntryContext {
-  /** User that made a request */
-  user?: string;
-  /** Info on the processed HTTP request */
-  httpRequest?: LogEntryRequest;
-}
-
-/** Structure of a log entry */
-export interface LogEntry {
-  /** Severity level at which the entry should be logged */
-  severity: LogSeverity;
-  /** Type of error */
-  errorType?: string;
-  /** Human readable error message that will be logged */
-  message: string;
-  /** Stack-trace of the error */
-
-  stack_trace?: string;
-  /** Additional data that accompanies the error in the logs */
-  data?: unknown;
-  /** Machine readable error code that is returned to the client */
-  errorCode?: string;
-  /** HTTP status code that is returned to the client */
-  statusCode?: number;
-  /** GCP error type */
-  '@type'?: string;
-  /** Error context */
-  context?: LogEntryContext;
-}
-
-/** Stricture of a log entry context entry */
-interface LogEntryServiceContext {
-  /** Name of the service in which the error ocurred */
-  service?: string;
-  /** Version of the service in which the error ocurred */
-  version?: string;
-  /** Environment in which the error ocurred (dev/staging/prod) */
-  environment?: string;
-  /** ID of the instance that got the error */
-  instance?: string;
-}
-
-/** Complete log entry with call-stack */
-export interface FullLogEntry extends LogEntry {
-  /** Line at which the error was thrown */
-  lineNumber: number;
-  /** Name of the file in which the error was thrown */
-  fileName: string;
-  /** Context of the error */
-  serviceContext: LogEntryServiceContext;
-}
+import { LogSeverity } from 'const';
+
+/** Structure of the request reporting in log entries */
+interface LogEntryRequest {
+  /** Requested URL */
+  url: string;
+  /** HTTP method used */
+  method: string;
+  /** Referer website */
+  referrer?: string;
+  /** User-Agent of the connected client */
+  userAgent?: string;
+  /** IP address of the client */
+  remoteIp: string | undefined;
+  /** HTTP status code returned to the client */
+  responseStatusCode?: number;
+}
+
+/** Structure of the context entry in log entries */
+interface LogEntryContext {
+  /** User that made a request */
+  user?: string;
+  /** Info on the processed HTTP request */
+  httpRequest?: LogEntryRequest;
+}
+
+/** Structure of a log entry */
+export interface LogEntry {
+  /** Severity level at which the entry should be logged */
+  severity: LogSeverity;
+  /** Type of error */
+  errorType?: string;
+  /** Human readable error message that will be logged */
+  message: string;
+  /** Stack-trace of the error */
+
+  stack_trace?: string;
+  /** Additional data that accompanies the error in the logs */
+  data?: unknown;
+  /** Machine readable error code that is returned to the client */
+  errorCode?: string;
+  /** HTTP status code that is returned to the client */
+  statusCode?: number;
+  /** GCP error type */
+  '@type'?: string;
+  /** Error context */
+  context?: LogEntryContext;
+}
+
+/** Stricture of a log entry context entry */
+interface LogEntryServiceContext {
+  /** Name of the service in which the error ocurred */
+  service?: string;
+  /** Version of the service in which the error ocurred */
+  version?: string;
+  /** Environment in which the error ocurred (dev/staging/prod) */
+  environment?: string;
+  /** ID of the instance that got the error */
+  instance?: string;
+}
+
+/** Complete log entry with call-stack */
+export interface FullLogEntry extends LogEntry {
+  /** Line at which the error was thrown */
+  lineNumber: number;
+  /** Name of the file in which the error was thrown */
+  fileName: string;
+  /** Context of the error */
+  serviceContext: LogEntryServiceContext;
+}

package/src/utils/report/report.test.ts

@@ -1,133 +1,133 @@
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { describe, it, beforeEach } from 'mocha';
-import { stub, match } from 'sinon';
-import * as output from './output';
-import { reportInfo, reportDebug, resetNamespaceSelector } from './report';
-import { InfoLogEntry } from './report.types';
-
-describe('Utils - Report', () => {
-  it('should collect filename and line number', () => {
-    let result = reportInfo('example');
-    expect(result.fileName).to.equal(
-      `${__dirname}/report.test.ts`.replace(/.*src\//, 'src/')
-    );
-    expect(result.severity).to.equal('INFO');
-    expect(result.message).to.equal('example');
-
-    const data: InfoLogEntry = { message: 'world' };
-    result = reportInfo(data);
-    expect(result.message).to.equal('world');
-    expect(result.fileName).to.equal(
-      `${__dirname}/report.test.ts`.replace(/.*src\//, 'src/')
-    );
-  });
-
-  describe('Report Debug', () => {
-    let globalNamespace: string;
-
-    beforeEach(() => {
-      resetNamespaceSelector();
-
-      globalNamespace = faker.lorem.slug();
-      reportDebug.setNameSpace(globalNamespace);
-    });
-
-    afterEach(() => {
-      reportDebug.clearNamespace();
-    });
-
-    it('should report when the namespace is specified', () => {
-      const namespace = faker.lorem.word();
-      process.env.DEBUG = globalNamespace + ':' + namespace;
-      const outputStub = stub(output, 'output');
-      const message = faker.lorem.sentence();
-      reportDebug({ message, namespace });
-      expect(outputStub).to.have.been.calledOnceWithExactly(
-        match({
-          message: `[${namespace}] ${message}`,
-          severity: 'DEBUG',
-          namespace: namespace
-        })
-      );
-    });
-
-    it('should report when the namespace is specified with a wildcard', () => {
-      const namespace = faker.lorem.word();
-      process.env.DEBUG = globalNamespace + ':' + `${namespace}:*`;
-      const outputStub = stub(output, 'output');
-      const message = faker.lorem.sentence();
-      const prefix = faker.lorem.word();
-      const actualNamespace = `${namespace}:${prefix}`;
-      reportDebug({ message, namespace: actualNamespace });
-      expect(outputStub).to.have.been.calledOnceWithExactly(
-        match({
-          message: `[${prefix}] ${message}`,
-          severity: 'DEBUG',
-          namespace: actualNamespace
-        })
-      );
-    });
-
-    it('should report when multiple namespaces are specified', () => {
-      const namespace = faker.lorem.word();
-      process.env.DEBUG =
-        globalNamespace +
-        ':' +
-        `${namespace},${faker.lorem.word()},${faker.lorem.word()}`;
-      const outputStub = stub(output, 'output');
-      const message = faker.lorem.sentence();
-      reportDebug({ message, namespace });
-      expect(outputStub).to.have.been.calledOnceWithExactly(
-        match({
-          message: `[${namespace}] ${message}`,
-          severity: 'DEBUG',
-          namespace: namespace
-        })
-      );
-    });
-
-    it('should not report when another namespace is specified', () => {
-      process.env.DEBUG = faker.lorem.word();
-      const outputStub = stub(output, 'output');
-      reportDebug({
-        message: faker.lorem.sentence(),
-        namespace: faker.lorem.word()
-      });
-      expect(outputStub).to.not.have.been.called;
-    });
-
-    it('should ignore the global namespace in server engine report debug', () => {
-      const namespace = 'engine';
-      process.env.DEBUG = `${namespace}:*`;
-      const prefix = faker.lorem.word();
-      const actualNamespace = `${namespace}:${prefix}`;
-      const outputStub = stub(output, 'output');
-      const message = faker.lorem.sentence();
-      reportDebug({ message, namespace: actualNamespace });
-      expect(outputStub).to.have.been.calledOnceWithExactly(
-        match({
-          message: `[${prefix}] ${message}`,
-          severity: 'DEBUG',
-          namespace: actualNamespace
-        })
-      );
-    });
-
-    it('should report with no global namespace', () => {
-      reportDebug.clearNamespace();
-      const namespace = faker.lorem.word();
-      process.env.DEBUG = namespace;
-      const outputStub = stub(output, 'output');
-      const message = faker.lorem.sentence();
-      reportDebug({ message, namespace });
-      expect(outputStub).to.have.been.calledOnceWithExactly(
-        match({
-          message: `[${namespace}] ${message}`,
-          severity: 'DEBUG',
-          namespace
-        })
-      );
-    });
-  });
-});
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import { describe, it, beforeEach } from 'mocha';
+import { stub, match } from 'sinon';
+import * as output from './output';
+import { reportInfo, reportDebug, resetNamespaceSelector } from './report';
+import { InfoLogEntry } from './report.types';
+
+describe('Utils - Report', () => {
+  it('should collect filename and line number', () => {
+    let result = reportInfo('example');
+    expect(result.fileName).to.equal(
+      `${__dirname}/report.test.ts`.replace(/.*src\//, 'src/')
+    );
+    expect(result.severity).to.equal('INFO');
+    expect(result.message).to.equal('example');
+
+    const data: InfoLogEntry = { message: 'world' };
+    result = reportInfo(data);
+    expect(result.message).to.equal('world');
+    expect(result.fileName).to.equal(
+      `${__dirname}/report.test.ts`.replace(/.*src\//, 'src/')
+    );
+  });
+
+  describe('Report Debug', () => {
+    let globalNamespace: string;
+
+    beforeEach(() => {
+      resetNamespaceSelector();
+
+      globalNamespace = faker.lorem.slug();
+      reportDebug.setNameSpace(globalNamespace);
+    });
+
+    afterEach(() => {
+      reportDebug.clearNamespace();
+    });
+
+    it('should report when the namespace is specified', () => {
+      const namespace = faker.lorem.word();
+      process.env.DEBUG = globalNamespace + ':' + namespace;
+      const outputStub = stub(output, 'output');
+      const message = faker.lorem.sentence();
+      reportDebug({ message, namespace });
+      expect(outputStub).to.have.been.calledOnceWithExactly(
+        match({
+          message: `[${namespace}] ${message}`,
+          severity: 'DEBUG',
+          namespace: namespace
+        })
+      );
+    });
+
+    it('should report when the namespace is specified with a wildcard', () => {
+      const namespace = faker.lorem.word();
+      process.env.DEBUG = globalNamespace + ':' + `${namespace}:*`;
+      const outputStub = stub(output, 'output');
+      const message = faker.lorem.sentence();
+      const prefix = faker.lorem.word();
+      const actualNamespace = `${namespace}:${prefix}`;
+      reportDebug({ message, namespace: actualNamespace });
+      expect(outputStub).to.have.been.calledOnceWithExactly(
+        match({
+          message: `[${prefix}] ${message}`,
+          severity: 'DEBUG',
+          namespace: actualNamespace
+        })
+      );
+    });
+
+    it('should report when multiple namespaces are specified', () => {
+      const namespace = faker.lorem.word();
+      process.env.DEBUG =
+        globalNamespace +
+        ':' +
+        `${namespace},${faker.lorem.word()},${faker.lorem.word()}`;
+      const outputStub = stub(output, 'output');
+      const message = faker.lorem.sentence();
+      reportDebug({ message, namespace });
+      expect(outputStub).to.have.been.calledOnceWithExactly(
+        match({
+          message: `[${namespace}] ${message}`,
+          severity: 'DEBUG',
+          namespace: namespace
+        })
+      );
+    });
+
+    it('should not report when another namespace is specified', () => {
+      process.env.DEBUG = faker.lorem.word();
+      const outputStub = stub(output, 'output');
+      reportDebug({
+        message: faker.lorem.sentence(),
+        namespace: faker.lorem.word()
+      });
+      expect(outputStub).to.not.have.been.called;
+    });
+
+    it('should ignore the global namespace in server engine report debug', () => {
+      const namespace = 'engine';
+      process.env.DEBUG = `${namespace}:*`;
+      const prefix = faker.lorem.word();
+      const actualNamespace = `${namespace}:${prefix}`;
+      const outputStub = stub(output, 'output');
+      const message = faker.lorem.sentence();
+      reportDebug({ message, namespace: actualNamespace });
+      expect(outputStub).to.have.been.calledOnceWithExactly(
+        match({
+          message: `[${prefix}] ${message}`,
+          severity: 'DEBUG',
+          namespace: actualNamespace
+        })
+      );
+    });
+
+    it('should report with no global namespace', () => {
+      reportDebug.clearNamespace();
+      const namespace = faker.lorem.word();
+      process.env.DEBUG = namespace;
+      const outputStub = stub(output, 'output');
+      const message = faker.lorem.sentence();
+      reportDebug({ message, namespace });
+      expect(outputStub).to.have.been.calledOnceWithExactly(
+        match({
+          message: `[${namespace}] ${message}`,
+          severity: 'DEBUG',
+          namespace
+        })
+      );
+    });
+  });
+});

package/src/utils/report/report.ts

@@ -1,134 +1,134 @@
-import { Request } from 'express';
-import { output } from './output';
-import { LogEntry, FullLogEntry } from './output.types';
-import { DebugLogEntry, InfoLogEntry } from './report.types';
-import { LogSeverity } from 'const';
-import { EngineError } from 'entities/EngineError';
-import { WebError } from 'entities/WebError';
-import {} from 'middleware/authHmac/authHmac.types';
-import {} from 'middleware/authJwt/authJwt.types';
-import {} from 'middleware/authTls/authTls.types';
-import {} from 'middleware/authAdmin/authAdmin.types';
-
-/** Default generic logger */
-export function reportInfo(data: InfoLogEntry | string): FullLogEntry {
-  return output({
-    severity: LogSeverity.INFO,
-    ...(typeof data === 'string' ? { message: data } : data)
-  });
-}
-
-/** Error specific logger */
-export function reportError(
-  error: unknown | Error | EngineError | WebError,
-  request?: Request
-): FullLogEntry {
-  let logEntry: LogEntry =
-    error instanceof Error
-      ? {
-          message: error.message,
-          stack_trace: error.stack,
-          severity: LogSeverity.ERROR
-        }
-      : {
-          message: 'An unknown error occurred',
-          data: error,
-          severity: LogSeverity.CRITICAL
-        };
-
-  if (error instanceof EngineError) {
-    logEntry = {
-      ...logEntry,
-      severity: error.severity,
-      errorType: error.constructor.name,
-      data: error.data,
-      '@type':
-        !(error instanceof WebError) || error.statusCode >= 500
-          ? 'type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent'
-          : undefined
-    };
-  }
-
-  if (error instanceof WebError) {
-    logEntry = {
-      ...logEntry,
-      errorCode: error.errorCode,
-      statusCode: error.statusCode
-    };
-  }
-
-  if (request) {
-    logEntry = {
-      ...logEntry,
-      context: {
-        user:
-          request.user?.id ?? request.hosts?.join(',') ?? request.admin?.email,
-        httpRequest: {
-          url: request.originalUrl,
-          method: request.method,
-          referrer: request.header('Referer'),
-          userAgent: request.header('User-Agent'),
-          remoteIp: request.ip,
-          responseStatusCode:
-            error instanceof WebError ? error.statusCode : undefined
-        }
-      }
-    };
-  }
-
-  return output(logEntry);
-}
-
-export let NAMESPACE_SELECTORS: undefined | Array<RegExp>;
-
-/** Generate the namespace selectors based on the debug variable */
-function initNamespaceSelector(): void {
-  if (process.env.DEBUG)
-    NAMESPACE_SELECTORS = process.env.DEBUG.split(',').map(
-      (namespace) => new RegExp('^' + namespace.replace(/\*/g, '.*?') + '$')
-    );
-}
-
-/** Reset the namespace selectors */
-export function resetNamespaceSelector(): void {
-  NAMESPACE_SELECTORS = undefined;
-}
-
-let debugNamespace: string | undefined;
-
-/** Log a message for debugging purpose, based on a namespace specified in an environment variable */
-export function reportDebug(data: DebugLogEntry): FullLogEntry | undefined {
-  if (!NAMESPACE_SELECTORS) initNamespaceSelector();
-  let { namespace } = data;
-  const isEngineReport = namespace ? namespace.startsWith('engine') : false;
-
-  if (debugNamespace && !isEngineReport) {
-    namespace = debugNamespace + ':' + namespace;
-  }
-
-  const match =
-    namespace &&
-    NAMESPACE_SELECTORS &&
-    NAMESPACE_SELECTORS.some((selector) => selector.test(namespace));
-  if (!match) return;
-
-  // Generate a prefix with the right most part of the namespace
-  const spaces = namespace.split(':');
-  const prefix = spaces[spaces.length - 1];
-
-  return output({
-    severity: LogSeverity.DEBUG,
-    ...data,
-    message: `[${prefix}] ${data.message}`
-  });
-}
-
-/** Specify a global debugging namespace */
-reportDebug.setNameSpace = function (globalNamespace: string): void {
-  debugNamespace = globalNamespace;
-};
-
-/** Remove any defined global namespace */
-reportDebug.clearNamespace = function (): void {
-  debugNamespace = undefined;
-};
+import { Request } from 'express';
+import { output } from './output';
+import { LogEntry, FullLogEntry } from './output.types';
+import { DebugLogEntry, InfoLogEntry } from './report.types';
+import { LogSeverity } from 'const';
+import { EngineError } from 'entities/EngineError';
+import { WebError } from 'entities/WebError';
+import {} from 'middleware/authHmac/authHmac.types';
+import {} from 'middleware/authJwt/authJwt.types';
+import {} from 'middleware/authTls/authTls.types';
+import {} from 'middleware/authAdmin/authAdmin.types';
+
+/** Default generic logger */
+export function reportInfo(data: InfoLogEntry | string): FullLogEntry {
+  return output({
+    severity: LogSeverity.INFO,
+    ...(typeof data === 'string' ? { message: data } : data)
+  });
+}
+
+/** Error specific logger */
+export function reportError(
+  error: unknown | Error | EngineError | WebError,
+  request?: Request
+): FullLogEntry {
+  let logEntry: LogEntry =
+    error instanceof Error
+      ? {
+          message: error.message,
+          stack_trace: error.stack,
+          severity: LogSeverity.ERROR
+        }
+      : {
+          message: 'An unknown error occurred',
+          data: error,
+          severity: LogSeverity.CRITICAL
+        };
+
+  if (error instanceof EngineError) {
+    logEntry = {
+      ...logEntry,
+      severity: error.severity,
+      errorType: error.constructor.name,
+      data: error.data,
+      '@type':
+        !(error instanceof WebError) || error.statusCode >= 500
+          ? 'type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent'
+          : undefined
+    };
+  }
+
+  if (error instanceof WebError) {
+    logEntry = {
+      ...logEntry,
+      errorCode: error.errorCode,
+      statusCode: error.statusCode
+    };
+  }
+
+  if (request) {
+    logEntry = {
+      ...logEntry,
+      context: {
+        user:
+          request.user?.id ?? request.hosts?.join(',') ?? request.admin?.email,
+        httpRequest: {
+          url: request.originalUrl,
+          method: request.method,
+          referrer: request.header('Referer'),
+          userAgent: request.header('User-Agent'),
+          remoteIp: request.ip,
+          responseStatusCode:
+            error instanceof WebError ? error.statusCode : undefined
+        }
+      }
+    };
+  }
+
+  return output(logEntry);
+}
+
+export let NAMESPACE_SELECTORS: undefined | Array<RegExp>;
+
+/** Generate the namespace selectors based on the debug variable */
+function initNamespaceSelector(): void {
+  if (process.env.DEBUG)
+    NAMESPACE_SELECTORS = process.env.DEBUG.split(',').map(
+      (namespace) => new RegExp('^' + namespace.replace(/\*/g, '.*?') + '$')
+    );
+}
+
+/** Reset the namespace selectors */
+export function resetNamespaceSelector(): void {
+  NAMESPACE_SELECTORS = undefined;
+}
+
+let debugNamespace: string | undefined;
+
+/** Log a message for debugging purpose, based on a namespace specified in an environment variable */
+export function reportDebug(data: DebugLogEntry): FullLogEntry | undefined {
+  if (!NAMESPACE_SELECTORS) initNamespaceSelector();
+  let { namespace } = data;
+  const isEngineReport = namespace ? namespace.startsWith('engine') : false;
+
+  if (debugNamespace && !isEngineReport) {
+    namespace = debugNamespace + ':' + namespace;
+  }
+
+  const match =
+    namespace &&
+    NAMESPACE_SELECTORS &&
+    NAMESPACE_SELECTORS.some((selector) => selector.test(namespace));
+  if (!match) return;
+
+  // Generate a prefix with the right most part of the namespace
+  const spaces = namespace.split(':');
+  const prefix = spaces[spaces.length - 1];
+
+  return output({
+    severity: LogSeverity.DEBUG,
+    ...data,
+    message: `[${prefix}] ${data.message}`
+  });
+}
+
+/** Specify a global debugging namespace */
+reportDebug.setNameSpace = function (globalNamespace: string): void {
+  debugNamespace = globalNamespace;
+};
+
+/** Remove any defined global namespace */
+reportDebug.clearNamespace = function (): void {
+  debugNamespace = undefined;
+};