Merge pull request #12 from Enigmatis/response-in-logs

Now cleans the log object

package.json

@@ -46,17 +46,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Enigmatis/graphql-logger.git"
+    "url": "git+https://github.com/Enigmatis/polaris-graphql-logger.git"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/Enigmatis/graphql-logger/issues"
+    "url": "https://github.com/Enigmatis/polaris-graphql-logger/issues"
   },
-  "homepage": "https://github.com/Enigmatis/graphql-logger#readme",
+  "homepage": "https://github.com/Enigmatis/polaris-graphql-logger#readme",
   "dependencies": {
-    "@enigmatis/polaris-common": "^1.1.0",
+    "@enigmatis/polaris-common": "^1.1.1",
     "@enigmatis/polaris-logs": "^2.8.1",
     "clean-deep": "^3.3.0",
     "winston": "^3.2.1"

src/logger/graphql-log-properties.ts

@@ -1,6 +1,3 @@
 import { PolarisLogProperties } from '@enigmatis/polaris-logs';
 
-export type GraphQLLogProperties = Omit<
-    PolarisLogProperties,
-    'response' | 'upn' | 'ip' | 'host' | 'reality'
->;
+export type GraphQLLogProperties = Omit<PolarisLogProperties, 'upn' | 'ip' | 'host' | 'reality'>;

src/logger/polaris-graphql-logger.ts

@@ -1,3 +1,4 @@
+import cleanDeep from 'clean-deep';
 import { AbstractPolarisLogger, LoggerConfiguration } from '@enigmatis/polaris-logs';
 import { ApplicationProperties, PolarisGraphQLContext } from '@enigmatis/polaris-common';
 import { GraphQLLogProperties } from './graphql-log-properties';
@@ -64,7 +65,7 @@ export class PolarisGraphQLLogger extends AbstractPolarisLogger {
     ): GraphQLLogProperties {
         const basicLogProperties: any = this.buildLog(message, graphQLLogProperties);
 
-        const contextLogProperties = {
+        const contextLogProperties: object = {
             messageId: context?.requestHeaders?.requestId,
             eventKind: graphQLLogProperties?.eventKind,
             reality: {
@@ -90,9 +91,9 @@ export class PolarisGraphQLLogger extends AbstractPolarisLogger {
                 },
                 requestingHost: graphQLLogProperties?.request?.requestingHost,
             },
-            response: context?.response,
         };
 
-        return { ...basicLogProperties, ...contextLogProperties };
+        const mergedLogObject: object = { ...basicLogProperties, ...contextLogProperties };
+        return cleanDeep(mergedLogObject);
     }
 }

test/context-util.ts

@@ -3,15 +3,13 @@ export const query = 'foo';
 export const operationName = 'foo';
 export const variables = new Map<string, string>();
 variables.set('hello', 'world');
-export const response = jest.fn();
 export const getContextWithRequestHeaders = (
     requestHeaders: PolarisRequestHeaders,
     requestingIp: string,
 ): PolarisGraphQLContext => {
     return {
         requestHeaders,
         request: { query, operationName, variables },
-        response,
         returnedExtensions: { globalDataVersion: 0 },
         responseHeaders: {},
         clientIp: requestingIp,

test/polaris-graphql-logger.test.ts

@@ -4,13 +4,7 @@ import {
     LoggerConfiguration,
     PolarisLogProperties,
 } from '@enigmatis/polaris-logs';
-import {
-    getContextWithRequestHeaders,
-    operationName,
-    query,
-    response,
-    variables,
-} from './context-util';
+import { getContextWithRequestHeaders, operationName, query, variables } from './context-util';
 
 const messageId = '0';
 const upn = 'upn';
@@ -63,7 +57,6 @@ describe('build log properties tests', () => {
                 requestingIp,
                 requestingSystem: { id: requestingSystemId, name: requestingSystemName },
             },
-            response,
         });
     });
 
@@ -94,7 +87,6 @@ describe('build log properties tests', () => {
                 requestingIp,
                 requestingSystem: { id: requestingSystemId, name: requestingSystemName },
             },
-            response,
         });
     });
 
@@ -125,7 +117,6 @@ describe('build log properties tests', () => {
                 requestingIp,
                 requestingSystem: { id: requestingSystemId, name: requestingSystemName },
             },
-            response,
         });
     });
     test('info, graphql log properties exist, with application properties', () => {
@@ -169,7 +160,6 @@ describe('build log properties tests', () => {
             version: appProps.version,
             systemName: appProps.name,
             systemId: appProps.id,
-            response,
         });
     });
 });

tsconfig.json

@@ -10,6 +10,7 @@
     "resolveJsonModule": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
     "typeRoots": [
       "src/type-declarations"
     ],