Merge pull request #238 from benheymink/master

feat: added support for setting debug logging within CorrelationIds

Author: theburningmonk

packages/lambda-powertools-correlation-ids/README.md

@@ -8,6 +8,8 @@ Main features:
 
 * respects convention for correlation IDs - i.e. `x-correlation-`
 
+* Manually enable/disable debug logging (`debug-log-enabled`) to be picked up by other/downstream middleware
+
 * allows you to store more than one correlation IDs, which allows you to *correlate* logs on multiple dimensions (e.g. by `x-correlation-user-id`, or `x-correlation-order-id`, etc.)
 
 ## Getting Started
@@ -23,17 +25,24 @@ const CorrelationIds = require('@dazn/lambda-powertools-correlation-ids')
 CorrelationIds.set('id', '12345678') // records id as x-correlation-id
 CorrelationIds.set('x-correlation-username', 'theburningmonk') // records as x-correlation-username
 
+// Manully enable debug logging (debug-log-enabled)
+CorrelationIds.debugLoggingEnabled = true
+
 const myCorrelationIds = CorrelationIds.get()
 // {
 //   'x-correlation-id': '12345678',
-//   'x-correlation-username': 'theburningmonk'
+//   'x-correlation-username': 'theburningmonk',
+//   'debug-log-enabled': 'true'
 // }
 
 CorrelationIds.clearAll() // removes all recorded correlation IDs
 CorrelationIds.replaceAllWith({  // bypasses the 'x-correlation-' convention
-  'DEBUG-LOG-ENABLED': 'true',
+  'debug-log-enabled': 'true',
   'User-Agent': 'jest test'
 })
+
+// Disable debug logging
+CorrelationIds.debugLoggingEnabled = false
 ```
 
 In practice, you're likely to only need `set` when you want to record correlation IDs from your function.

packages/lambda-powertools-correlation-ids/__tests__/index.js

@@ -43,6 +43,18 @@ const suite = (correlationIds) => () => {
     })
   })
 
+  describe('get/set debug logging', () => {
+    it('GETS and SETS state of debug logging', () => {
+      correlationIds.clearAll()
+      expect(correlationIds.debugLoggingEnabled).toBe(false)
+      correlationIds.debugLoggingEnabled = true
+      expect(correlationIds.debugLoggingEnabled).toBe(true)
+      expect(correlationIds.get()).toEqual({
+        'debug-log-enabled': 'true'
+      })
+    })
+  })
+
   describe('.replaceAllWith', () => {
     beforeEach(() => {
       correlationIds.set('x-correlation-id', 'this should be replaced')

packages/lambda-powertools-correlation-ids/index.js

@@ -25,10 +25,14 @@ class CorrelationIds {
     return this.context
   }
 
-  get debugEnabled () {
+  get debugLoggingEnabled () {
     return this.context[DEBUG_LOG_ENABLED] === 'true'
   }
 
+  set debugLoggingEnabled (enabled) {
+    this.context[DEBUG_LOG_ENABLED] = enabled ? 'true' : 'false'
+  }
+
   static clearAll () {
     globalCorrelationIds.clearAll()
   }
@@ -44,7 +48,15 @@ class CorrelationIds {
   static get () {
     return globalCorrelationIds.get()
   }
-};
+
+  static get debugLoggingEnabled () {
+    return globalCorrelationIds.debugLoggingEnabled
+  }
+
+  static set debugLoggingEnabled (enabled) {
+    globalCorrelationIds.debugLoggingEnabled = enabled
+  }
+}
 
 if (!global.CORRELATION_IDS) {
   global.CORRELATION_IDS = new CorrelationIds()