@apolitical/logger 1.0.2 → 2.0.0-beta.3

package/CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [2.0.0] - 2022-01-18
+### Changed
+- Dependencies
+- Node version
+- Labels definition instead of metadata
+### Added
+- Logger middleware
+
 ## [1.0.2] - 2021-07-08
 ### Updated
 - Dependencies

package/README.md

@@ -41,14 +41,15 @@ const childLogger = logger.where(__filename, 'debugging');
 childLogger.debug('Accessed:', { count: 0 });
 ```
 
-### The _metadata_ object
+### The _labels_ object
 
-And also, the metadata object allows you to keep extra info along the logger journey:
+And also, the labels allow you to keep extra info along the logger journey:
 
 ```
 const opts = {
-  metadata: {
-    serviceName: 'apolitical-service'
+  labels: {
+    name: 'apolitical-service',
+    version: 'v1.0.0'
   }
 };
 const logger = apoliticalLogger(opts);

package/package.json

@@ -1,19 +1,13 @@
 {
   "name": "@apolitical/logger",
-  "version": "1.0.2",
+  "version": "2.0.0-beta.3",
   "description": "Node.js module to expose Apolitical's logger service",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>"
-  ],
   "license": "MIT",
-  "main": "index.js",
+  "main": "src/index.js",
+  "files": [
+    "src"
+  ],
   "scripts": {
     "test": "jest --bail --runInBand",
     "integration-test": "jest --bail --runInBand",
@@ -30,19 +24,20 @@
     "Node Modules"
   ],
   "dependencies": {
-    "@google-cloud/logging-winston": "4.1.0",
-    "awilix": "4.3.4",
-    "winston": "3.3.3"
+    "@google-cloud/logging-winston": "4.1.1",
+    "awilix": "6.0.0",
+    "winston": "3.4.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "0.0.1",
-    "audit-ci": "4.1.0",
-    "husky": "7.0.1",
-    "jest": "27.0.6",
-    "lint-staged": "11.0.0"
+    "@apolitical/eslint-config": "1.0.0-beta.0",
+    "audit-ci": "5.1.2",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.1.7"
   },
   "engines": {
-    "node": ">=12.20.1"
+    "node": ">=16.13.2"
   },
   "eslintConfig": {
     "extends": "@apolitical/eslint-config/base.config"
@@ -67,7 +62,12 @@
     "testEnvironment": "node",
     "testTimeout": 60000,
     "maxConcurrency": 1,
-    "maxWorkers": 1
+    "maxWorkers": 1,
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-path .gitignore",

package/src/config.js

@@ -9,7 +9,7 @@ module.exports = {
   },
   LOGGER: {
     LOGGING_LEVELS: ['error', 'warn', 'info', 'debug'],
-    ALLOWED_METADATA: ['serviceName', 'requestId'],
+    ALLOWED_LABELS: ['name', 'version'],
     TRANSPORTS: {
       FILE: {
         ERROR_OPTIONS: {

package/src/container.js

@@ -2,28 +2,22 @@
 
 // External Modules
 const { createContainer, asValue, asFunction } = require('awilix');
-
 const path = require('path');
 const winston = require('winston');
 const winstonGoogle = require('@google-cloud/logging-winston');
-
 // Configuration
 const config = require('./config');
-
 // Services
 const loggerService = require('./services/logger.service');
 
 const container = createContainer();
 container.register({
   // External Modules
-
   path: asValue(path),
   winston: asValue(winston),
   winstonGoogle: asValue(winstonGoogle),
-
   // Configuration
   config: asValue(config),
-
   // Services
   loggerService: asFunction(loggerService).singleton(),
 });

package/src/index.js

@@ -0,0 +1,11 @@
+'use strict';
+
+const { resolve } = require('./container');
+
+const winstonGoogle = resolve('winstonGoogle');
+const loggerService = resolve('loggerService');
+
+module.exports = {
+  createLogger: loggerService,
+  loggerMiddleware: winstonGoogle.express.makeMiddleware,
+};

package/src/services/logger.service.js

@@ -2,15 +2,15 @@
 
 module.exports =
   ({ path, winston, winstonGoogle, config }) =>
-  ({ logLevel = 'info', metadata = {} }) => {
-    const { LOGGING_LEVELS, ALLOWED_METADATA } = config.LOGGER;
+  ({ logLevel = 'info', labels = {} }) => {
+    const { LOGGING_LEVELS, ALLOWED_LABELS } = config.LOGGER;
     const { ERROR_OPTIONS, COMBINED_OPTIONS } = config.LOGGER.TRANSPORTS.FILE;
     const { CLOUD_FUNCTION, CREDENTIALS } = config.GOOGLE;
 
-    function allowedMetadata() {
-      return ALLOWED_METADATA.reduce((acc, cv) => {
-        if (metadata[cv]) {
-          acc[cv] = metadata[cv];
+    function allowedLabels() {
+      return ALLOWED_LABELS.reduce((acc, cv) => {
+        if (labels[cv]) {
+          acc[cv] = labels[cv];
         }
         return acc;
       }, {});
@@ -27,7 +27,15 @@ module.exports =
       const transports = [];
       if (config.NODE_ENV === 'production') {
         if (CLOUD_FUNCTION || CREDENTIALS) {
-          transports.push(new winstonGoogle.LoggingWinston());
+          transports.push(
+            new winstonGoogle.LoggingWinston({
+              labels,
+              serviceContext: {
+                service: labels.name,
+                version: labels.version,
+              },
+            }),
+          );
         } else {
           transports.push(new winston.transports.Console());
         }
@@ -52,14 +60,18 @@ module.exports =
           };
           return acc;
         },
-        { metadata: logger.defaultMeta },
+        {
+          add: logger.add,
+          labels: logger.labels,
+          transports: logger.transports,
+        },
       );
     }
 
     function createWrapper(logger) {
       function where(filePath, method) {
         const file = path.basename(filePath);
-        const childLogger = logger.child({ location: { file, method } });
+        const childLogger = logger.child({ labels: { file, method } });
         return createWrapper(childLogger);
       }
       function write(message) {
@@ -70,10 +82,10 @@ module.exports =
     }
 
     const loggerInstance = winston.createLogger({
+      labels: allowedLabels(),
       level: logLevel,
       levels: loggingLevels(),
       format: loggerFormat(),
-      defaultMeta: allowedMetadata(),
       transports: loggerTransports(),
     });
 

package/.gitlab-ci.yml

@@ -1,22 +0,0 @@
-# External jobs
-include:
-  - project: 'apolitical/templates/gitlab-pipelines'
-    ref: master
-    file: 'Node-Testing.gitlab-ci.yml'
-
-stages:
-  - cache
-  - test
-  - publish
-
-publish-module:
-  stage: publish
-  image: node:12.20.1-alpine3.11
-  extends: 
-    - .use-cache
-  only:
-    - tags
-    - /^v\d+\.\d+\.\d+$/  
-  script:
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
-    - yarn publish --access=public

package/.husky/pre-commit

@@ -1,6 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-format
-
-yarn test

package/index.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const container = require('./src/container');
-
-module.exports = container.resolve('loggerService');

package/test/unit/logger/__snapshots__/logger.spec.js.snap

@@ -1,27 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Logger Service Child should create child logger with where method 1`] = `
-Object {
-  "debug": [Function],
-  "error": [Function],
-  "info": [Function],
-  "metadata": Object {
-    "requestId": "some-request-id",
-    "serviceName": "some-service-name",
-  },
-  "stream": Object {
-    "write": [Function],
-  },
-  "warn": [Function],
-  "where": [Function],
-}
-`;
-
-exports[`Logger Service Child should create child using child method 1`] = `
-Object {
-  "location": Object {
-    "file": "logger.spec.js",
-    "method": "test",
-  },
-}
-`;

package/test/unit/logger/container.js

@@ -1,25 +0,0 @@
-'use strict';
-
-const { createContainer, asValue, asFunction } = require('awilix');
-
-// External Modules
-const path = require('path');
-
-// Local Modules
-const config = require('../../../src/config');
-const loggerService = require('../../../src/services/logger.service');
-
-// Stubs
-const winston = require('./stubs/winston.stub');
-const winstonGoogle = require('./stubs/winston.google.stub');
-
-const testContainer = createContainer();
-testContainer.register({
-  path: asValue(path),
-  winston: asValue(winston),
-  winstonGoogle: asValue(winstonGoogle),
-  config: asValue(config),
-  loggerService: asFunction(loggerService).singleton(),
-});
-
-module.exports = testContainer;

package/test/unit/logger/logger.helper.js

@@ -1,43 +0,0 @@
-'use strict';
-
-const container = require('./container');
-
-const winston = container.resolve('winston');
-const config = container.resolve('config');
-
-const loggerOpts = {
-  logLevel: 'info',
-  metadata: {
-    serviceName: 'some-service-name',
-    requestId: 'some-request-id',
-  },
-};
-
-const loggerStub = {
-  defaultMeta: {
-    serviceName: loggerOpts.metadata.serviceName,
-    requestId: loggerOpts.metadata.requestId,
-  },
-  child: jest.fn(),
-};
-
-config.LOGGER.LOGGING_LEVELS.forEach((level) => {
-  loggerStub[level] = jest.fn();
-});
-
-module.exports = {
-  setUp() {
-    loggerStub.child.mockReturnValue(loggerStub);
-    winston.format.combine.mockReturnValue('colorize and simple');
-    winston.format.colorize.mockReturnValue('colorize');
-    winston.format.simple.mockReturnValue('simple');
-    winston.createLogger.mockReturnValue(loggerStub);
-
-    return {
-      logger: {
-        opts: loggerOpts,
-        stub: loggerStub,
-      },
-    };
-  },
-};

package/test/unit/logger/logger.spec.js

@@ -1,122 +0,0 @@
-'use strict';
-
-const container = require('./container');
-
-const config = container.resolve('config');
-const winston = container.resolve('winston');
-const winstonGoogle = container.resolve('winstonGoogle');
-const loggerService = container.resolve('loggerService');
-
-const loggerHelper = require('./logger.helper');
-
-describe('Logger Service', () => {
-  const { LOGGING_LEVELS } = config.LOGGER;
-  let logger = null;
-
-  beforeEach(() => {
-    ({ logger } = loggerHelper.setUp());
-  });
-
-  describe('General', () => {
-    test('should be exposed as function', () => {
-      expect(typeof loggerService).toBe('function');
-    });
-
-    test('should provide logger levels', () => {
-      const instance = loggerService(logger.opts);
-      LOGGING_LEVELS.forEach((level) => {
-        expect(typeof instance[level]).toBe('function');
-      });
-    });
-
-    test('should invoke logger methods with message', () => {
-      const instance = loggerService(logger.opts);
-      LOGGING_LEVELS.forEach((level) => {
-        instance[level]('some-message');
-        expect(logger.stub[level]).toHaveBeenCalledTimes(1);
-        expect(logger.stub[level]).toHaveBeenLastCalledWith('some-message');
-      });
-    });
-
-    test('should invoke logger methods with extras', () => {
-      const instance = loggerService(logger.opts);
-      LOGGING_LEVELS.forEach((level) => {
-        instance[level]('some-message', { bar: 'foo' });
-        expect(logger.stub[level]).toHaveBeenCalledTimes(1);
-        expect(logger.stub[level]).toHaveBeenLastCalledWith('some-message', {
-          bar: 'foo',
-        });
-      });
-    });
-  });
-
-  describe('Transport', () => {
-    test('should use console and files in non-prod envs', () => {
-      loggerService(logger.opts);
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.transports.length).toEqual(3);
-      expect(winston.transports.Console).toHaveBeenCalledTimes(1);
-      expect(winston.transports.File).toHaveBeenCalledTimes(2);
-    });
-
-    test('should use console in prod env (without credentials)', () => {
-      config.NODE_ENV = 'production';
-      loggerService(logger.opts);
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.transports.length).toEqual(1);
-      expect(winston.transports.Console).toHaveBeenCalledTimes(1);
-    });
-
-    test('should use google winston in prod env (with credentials)', () => {
-      config.NODE_ENV = 'production';
-      config.GOOGLE.CREDENTIALS = 'some-credentials';
-      loggerService(logger.opts);
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.transports.length).toEqual(1);
-      expect(winstonGoogle.LoggingWinston).toHaveBeenCalledTimes(1);
-    });
-
-    test('should use google winston in prod env (with cloud function)', () => {
-      config.NODE_ENV = 'production';
-      config.GOOGLE.GOOGLE_CLOUD_FUNCTION = 'true';
-      loggerService(logger.opts);
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.transports.length).toEqual(1);
-      expect(winstonGoogle.LoggingWinston).toHaveBeenCalledTimes(1);
-    });
-  });
-
-  describe('Metadata', () => {
-    test('should not use default metadata', () => {
-      loggerService({});
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.defaultMeta).toEqual({});
-    });
-
-    test('should use default metadata', () => {
-      loggerService(logger.opts);
-      const params = winston.createLogger.mock.calls[0][0];
-      expect(params.defaultMeta).toEqual({
-        requestId: 'some-request-id',
-        serviceName: 'some-service-name',
-      });
-    });
-  });
-
-  describe('Child', () => {
-    test('should create child logger with where method', () => {
-      const instance = loggerService(logger.opts);
-      const childLogger = instance.where(__filename, 'test');
-      expect(logger.stub.child).toHaveBeenCalledTimes(1);
-      expect(childLogger).toMatchSnapshot();
-    });
-
-    test('should create child using child method', () => {
-      const instance = loggerService(logger.opts);
-      instance.where(__filename, 'test');
-      expect(logger.stub.child).toHaveBeenCalledTimes(1);
-      const params = logger.stub.child.mock.calls[0][0];
-      expect(params).toMatchSnapshot();
-    });
-  });
-});

package/test/unit/logger/stubs/winston.google.stub.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = {
-  LoggingWinston: jest.fn(),
-};

package/test/unit/logger/stubs/winston.stub.js

@@ -1,14 +0,0 @@
-'use strict';
-
-module.exports = {
-  format: {
-    combine: jest.fn(),
-    colorize: jest.fn(),
-    simple: jest.fn(),
-  },
-  transports: {
-    Console: jest.fn(),
-    File: jest.fn(),
-  },
-  createLogger: jest.fn(),
-};