@apolitical/logger 2.0.0-beta.4 → 2.0.0

package/CHANGELOG.md

@@ -5,14 +5,17 @@ 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
+- Updated dependencies
+- Upgraded Node.js version
+- Revamped GitLab pipelines
+- Renamed `metadata` to `labels` to allow consistency with logger middleware
 ### Added
-- Logger middleware
+- Exposed logger middleware
+### Removed
+- Filtered winston logger functionality
+- Restricted metadata
 
 ## [1.0.2] - 2021-07-08
 ### Updated

package/README.md

@@ -2,6 +2,16 @@
 
 Node.js module to expose Apolitical's logger service
 
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 16.13.2+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
 ## Installation
 
 Install with `yarn`:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/logger",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0",
   "description": "Node.js module to expose Apolitical's logger service",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -29,12 +29,12 @@
     "winston": "3.4.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "1.0.0-beta.0",
+    "@apolitical/eslint-config": "1.0.1",
     "audit-ci": "5.1.2",
     "husky": "7.0.4",
     "jest": "27.4.7",
     "jest-junit": "13.0.0",
-    "lint-staged": "12.1.7"
+    "lint-staged": "12.2.1"
   },
   "engines": {
     "node": ">=16.13.2"

package/src/config.js

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

package/src/services/logger.service.js

@@ -2,20 +2,11 @@
 
 module.exports =
   ({ path, winston, winstonGoogle, config }) =>
-  ({ logLevel = 'info', labels = {} }) => {
-    const { LOGGING_LEVELS, ALLOWED_LABELS } = config.LOGGER;
+  ({ labels = {}, logLevel = 'info' }) => {
+    const { LOGGING_LEVELS } = config.LOGGER;
     const { ERROR_OPTIONS, COMBINED_OPTIONS } = config.LOGGER.TRANSPORTS.FILE;
     const { CLOUD_FUNCTION, CREDENTIALS } = config.GOOGLE;
 
-    function allowedLabels() {
-      return ALLOWED_LABELS.reduce((acc, cv) => {
-        if (labels[cv]) {
-          acc[cv] = labels[cv];
-        }
-        return acc;
-      }, {});
-    }
-
     function loggingLevels() {
       return LOGGING_LEVELS.reduce((acc, cv, idx) => {
         acc[cv] = idx;
@@ -52,9 +43,11 @@ module.exports =
     }
 
     function createWrapper(logger) {
-      function where(filePath, method) {
+      function where(filePath, method, otherLabels = {}) {
         const file = path.basename(filePath);
-        const childLogger = logger.child({ labels: { file, method } });
+        const childLogger = logger.child({
+          labels: Object.assign({ file, method }, labels, otherLabels),
+        });
         return createWrapper(childLogger);
       }
       function write(message) {
@@ -64,7 +57,7 @@ module.exports =
     }
 
     const loggerInstance = winston.createLogger({
-      labels: allowedLabels(),
+      labels,
       level: logLevel,
       levels: loggingLevels(),
       format: loggerFormat(),