@defra/bng-utils-lib 0.277.0 → 0.278.0

package/.jest/test.env.js

@@ -8,3 +8,4 @@ process.env.POSTGRES_PASSWORD='postgres'
 process.env.POSTGRES_DATABASE='bng'
 process.env.POSTGRES_PORT='5432'
 process.env.POSTGRES_SSL_MODE=''
+process.env.NODE_ENV='test'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/bng-utils-lib",
-  "version": "0.277.0",
+  "version": "0.278.0",
   "type": "module",
   "private": false,
   "description": "A library of utilities for the Biodiversity Net Gain Service",
@@ -14,8 +14,10 @@
   "license": "OGL-UK-3.0",
   "dependencies": {
     "@azure/identity": "^4.0.0",
-    "@defra/bng-connectors-lib": "0.277.0",
-    "axios": "^1.6.2"
+    "@defra/bng-connectors-lib": "0.278.0",
+    "axios": "^1.6.2",
+    "pino": "^8.17.2",
+    "pino-pretty": "10.3.1"
   },
-  "gitHead": "95cde914fb9a8dd2a3a194ba20bfc6022e36ea19"
+  "gitHead": "cd4c32776a56d6b20ed592896e1497222e8dfb9e"
 }

package/src/helpers/__tests__/logger-spec.js

@@ -0,0 +1,55 @@
+describe('The logger', () => {
+  const timeout = 1000
+  it('should be configured to log at warning level and above by default', done => {
+    jest.isolateModules(() => {
+      try {
+        const logger = require('../logger.js')
+        // Finishing the test in setImmediate is not long enough to conclude async operations
+        setTimeout(() => {
+          expect(logger.default.level).toEqual('warn')
+          done()
+        }, timeout)
+      } catch (err) {
+        setTimeout(() => {
+          done(err)
+        }, timeout)
+      }
+    })
+  })
+  it('should log at a configured level and above', done => {
+    jest.isolateModules(() => {
+      try {
+        process.env.LOG_LEVEL = 'info'
+        const logger = require('../logger.js')
+        // Finishing the test in setImmediate is not long enough to conclude async operations
+        setTimeout(async () => {
+          expect(logger.default.level).toEqual('info')
+          done()
+        }, timeout)
+      } catch (err) {
+        setTimeout(() => {
+          done(err)
+        }, timeout)
+      }
+    })
+  })
+  it('should log at warning level when an invalid log level is configured', done => {
+    jest.isolateModules(() => {
+      try {
+        process.env.LOG_LEVEL = 'invalid'
+        // Change the NODE_ENV to confiure use of pino-pretty. This increases test coverage.
+        process.env.NODE_ENV = 'development'
+        const logger = require('../logger.js')
+        // Finishing the test in setImmediate is not long enough to conclude async operations
+        setTimeout(async () => {
+          expect(logger.default.level).toEqual('warn')
+          done()
+        }, timeout)
+      } catch (err) {
+        setTimeout(() => {
+          done(err)
+        }, timeout)
+      }
+    })
+  })
+})

package/src/helpers/logger.js

@@ -0,0 +1,41 @@
+import pino from 'pino'
+
+const debug = 'debug'
+const error = 'error'
+const fatal = 'fatal'
+const info = 'info'
+const silent = 'silent'
+const trace = 'trace'
+const warn = 'warn'
+
+const logLevels = {
+  trace,
+  debug,
+  info,
+  warn,
+  error,
+  fatal,
+  silent
+}
+
+const logLevel = (process.env.LOG_LEVEL || logLevels.warn).toLowerCase()
+const loggerOptions = {
+  level: logLevels[logLevel] || logLevels.warn,
+  redact: {
+    paths: ['req.headers.authorization', 'req.headers.cookie', 'res.headers'],
+    remove: true
+  }
+}
+
+if (process.env.NODE_ENV === 'development') {
+  loggerOptions.transport = {
+    target: 'pino-pretty',
+    options: {
+      colorize: true
+    }
+  }
+}
+
+const logger = pino(loggerOptions)
+
+export default logger

package/src/utils.js

@@ -1,4 +1,5 @@
 import getBearerToken from './helpers/get-bearer-token.js'
 import getDBConnection from './helpers/get-db-connection.js'
+import logger from './helpers/logger.js'
 
-export { getBearerToken, getDBConnection }
+export { getBearerToken, getDBConnection, logger }