Merge pull request #53 from Enigmatis/polaris-logs-export-create-logger

refactor!: changes according to api changes

package.json

@@ -65,7 +65,9 @@
     "@enigmatis/polaris-common": "^1.0.10",
     "@types/serialize-error": "^2.1.0",
     "@types/winston": "^2.4.4",
+    "@types/uuid": "^3.4.7",
     "clean-deep": "^3.2.0",
+    "uuid": "^3.4.0",
     "serialize-error": "^3.0.0",
     "winston": "^3.2.1",
     "winston-daily-rotate-file": "^3.10.0",

src/entities/entity.ts

@@ -1,5 +1,9 @@
+import { Reality } from './reality';
+
 export interface Entity {
     id?: string;
+    type?: string;
+    reality?: Reality;
     name?: string;
     secondaryIds?: string[];
 }

src/entities/event-kind-description-log-property.ts → src/entities/event-kind-description.ts

@@ -1,4 +1,4 @@
-export interface EventKindDescriptionLogProperty {
+export interface EventKindDescription {
     systemId?: string;
     requestingSystemId?: string;
 }

src/entities/index.ts

@@ -1,5 +1,5 @@
-export * from './event-kind-description-log-property';
-export * from './reality-log-property';
-export * from './request-log-property';
-export * from './system-log-property';
+export * from './event-kind-description';
+export * from './reality';
+export * from './request';
+export * from './requesting-system';
 export * from './entity';

src/entities/reality-log-property.ts → src/entities/reality.ts

@@ -1,4 +1,4 @@
-export interface RealityLogProperty {
+export interface Reality {
     type?: string;
     id?: number;
     name?: string;

src/entities/request.ts

@@ -0,0 +1,10 @@
+import { RequestingSystem } from './requesting-system';
+
+export interface Request {
+    requestingIp?: string;
+    requestingUserIdentifier?: string;
+    requestingSystem?: RequestingSystem;
+    requestQuery?: any;
+    requestingHost?: string;
+    request?: any;
+}

src/entities/system-log-property.ts → src/entities/requesting-system.ts

@@ -1,4 +1,4 @@
-export interface SystemLogProperty {
+export interface RequestingSystem {
     name?: string;
     id?: string;
 }

src/polaris-log-properties.ts

@@ -1,22 +1,18 @@
-import {
-    Entity,
-    EventKindDescriptionLogProperty,
-    RealityLogProperty,
-    RequestLogProperty,
-} from './entities';
+import { Entity, EventKindDescription, Reality, Request } from './entities';
 
 export interface PolarisLogProperties {
     throwable?: object;
     elapsedTime?: number;
     logId?: string;
     customProperties?: object;
-    requestId?: string;
     response?: object;
-    recordId?: string;
+    messageId?: string;
     eventKind?: string;
-    eventKindDescription?: EventKindDescriptionLogProperty;
-    reality?: RealityLogProperty;
-    request?: RequestLogProperty;
+    eventKindDescription?: EventKindDescription;
+    reality?: Reality;
+    request?: Request;
     entity?: Entity;
-    entities?: Entity[];
+    upn?: string;
+    ip?: string;
+    host?: string;
 }

src/polaris-logger.ts

@@ -5,16 +5,14 @@ import { Logger } from 'winston';
 import { LoggerConfiguration } from './configurations/logger-configuration';
 import { PolarisLogProperties } from './polaris-log-properties';
 import { createLogger } from './winston-logger';
+const uuidv1 = require('uuid/v1');
 
 export class PolarisLogger {
     private static getAppPropertiesToAssign(applicationProperties?: ApplicationProperties) {
         if (applicationProperties) {
             return {
                 systemId: applicationProperties.id,
                 systemName: applicationProperties.name,
-                eventKindDescription: {
-                    systemId: applicationProperties.id,
-                },
                 version: applicationProperties.version,
                 environment: applicationProperties.environment,
                 component: applicationProperties.component,
@@ -56,12 +54,21 @@ export class PolarisLogger {
     }
 
     private buildLog(message: string, polarisLogProperties?: PolarisLogProperties) {
+        const eventKindDescription =
+            this.applicationLogProperties?.id || polarisLogProperties?.request?.requestingSystem?.id
+                ? {
+                      systemId: this.applicationLogProperties?.id,
+                      requestingSystemId: polarisLogProperties?.request?.requestingSystem?.id,
+                  }
+                : undefined;
+        const messageId = polarisLogProperties?.messageId || uuidv1();
         const propertiesWithCustom = {
             message,
             ...(polarisLogProperties && polarisLogProperties.customProperties),
             ...polarisLogProperties,
             ...PolarisLogger.getAppPropertiesToAssign(this.applicationLogProperties),
-            customProperties: undefined,
+            eventKindDescription,
+            messageId,
             throwable:
                 polarisLogProperties &&
                 polarisLogProperties.throwable &&

src/type-declarations/clean-deep.d.ts

@@ -1,5 +1,5 @@
 declare function clean(toClean: object): object;
 
 declare module 'clean-deep' {
-    export = clean
+    export = clean;
 }

test/polaris-logger.test.ts

@@ -1,3 +1,4 @@
+import uuid = require('uuid/v1');
 import { Logger } from 'winston';
 import { LoggerConfiguration } from '../src/configurations/logger-configuration';
 import { ApplicationProperties } from '../src/main';
@@ -34,7 +35,7 @@ describe('polaris-logger tests', () => {
     const message: string = 'log message';
 
     test('creating a polaris logger with application properties and configuration - winston createLogger was called with configuration', () => {
-        const logger = new PolarisLogger(config, appProps);
+        new PolarisLogger(config, appProps);
 
         expect(createLogger).toHaveBeenCalledWith(config);
     });
@@ -44,6 +45,17 @@ describe('polaris-logger tests', () => {
         logger.fatal(message);
         expect(loggerImplMock.fatal).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
+        });
+    });
+
+    test('fatal - logging message & messagId - message & messageId are in the log', () => {
+        const logger = new PolarisLogger(config);
+        const messageId = uuid();
+        logger.fatal(message, { messageId });
+        expect(loggerImplMock.fatal).toHaveBeenCalledWith({
+            message,
+            messageId,
         });
     });
 
@@ -52,6 +64,7 @@ describe('polaris-logger tests', () => {
         logger.error(message);
         expect(loggerImplMock.error).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
         });
     });
 
@@ -60,6 +73,7 @@ describe('polaris-logger tests', () => {
         logger.warn(message);
         expect(loggerImplMock.warn).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
         });
     });
 
@@ -68,6 +82,7 @@ describe('polaris-logger tests', () => {
         logger.info(message);
         expect(loggerImplMock.info).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
         });
     });
 
@@ -76,6 +91,7 @@ describe('polaris-logger tests', () => {
         logger.debug(message);
         expect(loggerImplMock.debug).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
         });
     });
 
@@ -84,6 +100,7 @@ describe('polaris-logger tests', () => {
         logger.trace(message);
         expect(loggerImplMock.trace).toHaveBeenCalledWith({
             message,
+            messageId: expect.anything(),
         });
     });
 
@@ -98,6 +115,7 @@ describe('polaris-logger tests', () => {
                 eventKindDescription: { systemId: appProps.id },
                 systemId: appProps.id,
                 systemName: appProps.name,
+                messageId: expect.anything(),
             }),
         );
     });

tslint.json

@@ -22,6 +22,9 @@
       true,
       "never-prefix"
     ],
-    "object-literal-sort-keys": false
+    "object-literal-sort-keys": false,
+    "no-var-requires": false,
+    "no-submodule-imports": false,
+    "no-unused-expression": false
   }
-}
+}