ROC-1105: Add possibility to return origin request id (#23)

hmcts · Dec 18, 2017 · 86beda4 · 86beda4
1 parent 417c2bc
commit 86beda4
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 6 deletions.
diff --git a/log/tracing/requestTracing.js b/log/tracing/requestTracing.js
@@ -23,6 +23,15 @@ function notUUID (uuidString) {
   return !UUID_REGEX.test(uuidString)
 }
 
+function getHeaderValue (headerName) {
+  const initialRequest = RequestTracing.getInitialRequest()
+  if (initialRequest) {
+    return initialRequest.headers[headerName]
+  } else {
+    return undefined
+  }
+}
+
 class RequestTracing {
   static middleware (req, res, next) {
     if (tracingHeadersNotPresentOrInvalid(req)) {
@@ -35,12 +44,16 @@ class RequestTracing {
     return LocalStorage.retrieveInitialRequest()
   }
 
+  static getOriginRequestId () {
+    return getHeaderValue(ORIGIN_REQUEST_ID_HEADER)
+  }
+
   static getRootRequestId () {
-    return RequestTracing.getInitialRequest().headers[ROOT_REQUEST_ID_HEADER]
+    return getHeaderValue(ROOT_REQUEST_ID_HEADER)
   }
 
   static getCurrentRequestId () {
-    return RequestTracing.getInitialRequest().headers[REQUEST_ID_HEADER]
+    return getHeaderValue(REQUEST_ID_HEADER)
   }
 
   static createNextRequestId () {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/nodejs-logging",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "",
   "main": "Logger.js",
   "scripts": {

diff --git a/test/unit/tracing/requestTracing.js b/test/unit/tracing/requestTracing.js
@@ -1,5 +1,5 @@
 'use strict'
-/* global describe, context, it, beforeEach */
+/* global describe, context, it, beforeEach, afterEach */
 
 const uuid = require('uuid')
 
@@ -157,8 +157,22 @@ describe('RequestTracing', () => {
     it(`should return the ${REQUEST_ID_HEADER}`, (done) => {
       function createNextFunction (done) {
         return function () {
-          const rootRequestId = RequestTracing.getCurrentRequestId()
-          expect(rootRequestId).to.equal(req.headers[REQUEST_ID_HEADER])
+          const requestId = RequestTracing.getCurrentRequestId()
+          expect(requestId).to.equal(req.headers[REQUEST_ID_HEADER])
+          done()
+        }
+      }
+
+      RequestTracing.middleware(req, req, createNextFunction(done))
+    })
+  })
+
+  describe('getOriginRequestId', () => {
+    it(`should return the ${ORIGIN_REQUEST_ID_HEADER}`, (done) => {
+      function createNextFunction (done) {
+        return function () {
+          const originRequestId = RequestTracing.getOriginRequestId()
+          expect(originRequestId).to.equal(req.headers[ORIGIN_REQUEST_ID_HEADER])
           done()
         }
       }
@@ -173,4 +187,55 @@ describe('RequestTracing', () => {
       expect(nextRequestId).to.match(UUID_REGEX)
     })
   })
+
+  context('when initial request is undefined', () => {
+    let sinonSandbox
+
+    beforeEach(() => {
+      sinonSandbox = sinon.sandbox.create()
+      sinonSandbox.stub(RequestTracing, 'getInitialRequest').callsFake(() => {
+        return undefined
+      })
+    })
+
+    afterEach(() => {
+      sinonSandbox.restore()
+    })
+
+    it('should return undefined root request id', (done) => {
+      function createNextFunction (done) {
+        return function () {
+          const rootRequestId = RequestTracing.getRootRequestId()
+          expect(rootRequestId).to.be.undefined
+          done()
+        }
+      }
+
+      RequestTracing.middleware(req, req, createNextFunction(done))
+    })
+
+    it('should return undefined current request id', (done) => {
+      function createNextFunction (done) {
+        return function () {
+          const requestId = RequestTracing.getCurrentRequestId()
+          expect(requestId).to.be.undefined
+          done()
+        }
+      }
+
+      RequestTracing.middleware(req, req, createNextFunction(done))
+    })
+
+    it('should return undefined origin request id', (done) => {
+      function createNextFunction (done) {
+        return function () {
+          const originRequestId = RequestTracing.getOriginRequestId()
+          expect(originRequestId).to.be.undefined
+          done()
+        }
+      }
+
+      RequestTracing.middleware(req, req, createNextFunction(done))
+    })
+  })
 })