@financial-times/dotcom-middleware-app-context 7.3.0 → 7.3.2

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@financial-times/dotcom-middleware-app-context",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "tsc": "../../node_modules/.bin/tsc --incremental",
     "clean": "npm run clean:dist && npm run clean:node_modules",
     "clean:dist": "rm -rf dist",
     "clean:node_modules": "rm -rf node_modules",
+    "build:node": "tsc",
     "build": "npm run build:node",
     "dev": "npm run build:node -- --watch",
-    "build:node": "npm run tsc -- --module commonjs --outDir ./dist/node",
     "preinstall": "[ \"$INIT_CWD\" != \"$PWD\" ] || npm_config_yes=true npx check-engine"
   },
   "keywords": [],
@@ -25,12 +24,16 @@
     "node-mocks-http": "^1.7.5"
   },
   "dependencies": {
-    "@financial-times/dotcom-server-app-context": "^7.3.0"
+    "@financial-times/dotcom-server-app-context": "file:../dotcom-server-app-context"
   },
   "engines": {
     "node": ">= 14.0.0",
     "npm": "7.x || 8.x"
   },
+  "files": [
+    "dist/",
+    "src/"
+  ],
   "repository": {
     "type": "git",
     "repository": "https://github.com/Financial-Times/dotcom-page-kit.git",
@@ -40,4 +43,4 @@
   "volta": {
     "extends": "../../package.json"
   }
-}
+}

package/src/__test__/index.spec.ts

@@ -0,0 +1,101 @@
+jest.mock('@financial-times/dotcom-server-app-context')
+
+import httpMocks from 'node-mocks-http'
+import { AppContext } from '@financial-times/dotcom-server-app-context'
+import { init } from '../index'
+
+const appContext = {
+  appName: 'my-app-name',
+  appVersion: '123'
+}
+
+const headers = {
+  'ft-edition': 'international',
+  'ft-ab': '-',
+  'ft-anonymous-user': '-'
+}
+
+describe('dotcom-middleware-app-context', () => {
+  let instance
+  let request
+  let response
+  let next
+
+  beforeEach(() => {
+    request = httpMocks.createRequest({ headers })
+    response = httpMocks.createResponse({ locals: {} })
+    next = jest.fn()
+    instance = init({ appContext })
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('returns a request handler function', () => {
+    expect(instance).toBeInstanceOf(Function)
+  })
+
+  describe('when handling a request', () => {
+    it('initialises app context with inferred data', () => {
+      const expected = {
+        appContext: expect.objectContaining({ edition: 'international' })
+      }
+
+      instance(request, response, next)
+
+      expect(AppContext).toHaveBeenCalledWith(expected)
+    })
+
+    it('ignores default "-" header values', () => {
+      const expectedA = {
+        appContext: expect.not.objectContaining({ abTestState: '-' })
+      }
+
+      const expectedB = {
+        appContext: expect.objectContaining({ isUserLoggedIn: false })
+      }
+
+      instance(request, response, next)
+
+      expect(AppContext).toHaveBeenCalledWith(expectedA)
+      expect(AppContext).toHaveBeenCalledWith(expectedB)
+    })
+
+    it('initialises app context with provided app context overrides', () => {
+      const expected = { appContext: expect.objectContaining(appContext) }
+
+      instance(request, response, next)
+
+      expect(AppContext).toHaveBeenCalledWith(expected)
+    })
+
+    it('appends the app context instance to response.locals', () => {
+      instance(request, response, next)
+      expect(response.locals.appContext).toBeInstanceOf(AppContext)
+    })
+
+    it('calls the fallthrough function', () => {
+      instance(request, response, next)
+      expect(next).toHaveBeenCalled()
+    })
+  })
+
+  describe('when the app context data is invalid', () => {
+    beforeEach(() => {
+      // NOTE: AppContext has been mocked but we must first
+      // tell TS it's a mock before we can use it like one.
+      const AppContextMock = AppContext as jest.Mock
+
+      AppContextMock.mockImplementation(() => {
+        throw Error('INVALID')
+      })
+    })
+
+    it('calls the fallthrough function with the error', () => {
+      instance(request, response, next)
+
+      expect(next).toHaveBeenCalledWith(expect.any(Error))
+    })
+  })
+})