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

package/dist/tsconfig.tsbuildinfo

@@ -502,7 +502,7 @@
         "affectsGlobalScope": false
       },
       "../../dotcom-server-app-context/package.json": {
-        "version": "9cacddca94231e361078ef269cc8b899cd9399e88e2ceb3e1142b9e06fc920fe",
+        "version": "31daffc0f5d6063db80435e6e821b316796d34d18fd69a0f35b2e6be6c3b7b63",
         "affectsGlobalScope": true
       },
       "../../dotcom-server-app-context/src/types.d.ts": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/dotcom-middleware-app-context",
-  "version": "7.3.1",
+  "version": "7.3.2",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
@@ -31,7 +31,8 @@
     "npm": "7.x || 8.x"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "src/"
   ],
   "repository": {
     "type": "git",

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))
+    })
+  })
+})

package/src/index.ts

@@ -0,0 +1,38 @@
+import { Request, Response, NextFunction } from 'express'
+import pkg from '@financial-times/dotcom-server-app-context/package.json'
+import { AppContext, TAppContext } from '@financial-times/dotcom-server-app-context'
+
+export type TMiddlewareOptions = {
+  appContext?: Partial<TAppContext>
+}
+
+export function init(options: TMiddlewareOptions = {}) {
+  return (request: Request, response: Response, next: NextFunction) => {
+    const appContext = {
+      // TODO: improve how we retrieve the app name.
+      // HACK: this is plucked from the debug headers set by n-express:
+      // https://github.com/Financial-Times/n-express/blob/HEAD/main.js#L76-L80
+      appName: response.get('ft-app-name'),
+      product: 'next',
+      edition: request.get('ft-edition'),
+      appVersion: process.env.CIRCLE_SHA1 || process.env.SOURCE_VERSION || process.env.HEROKU_SLUG_COMMIT,
+      // Many headers are set to a default value of "-" by the CDN so we need to ignore those
+      // https://github.com/Financial-Times/ft.com-cdn/blob/HEAD/src/vcl/next-preflight.vcl
+      abTestState: request.get('ft-ab') === '-' ? undefined : request.get('ft-ab'),
+      isProduction: process.env.NODE_ENV === 'production',
+      // This is set by the membership session service as part of preflight
+      // https://github.com/Financial-Times/next-preflight/blob/HEAD/server/tasks/membership/session.js
+      isUserLoggedIn: request.get('ft-anonymous-user') === 'false',
+      pageKitVersion: pkg.version === '0.0.0' ? 'development' : pkg.version,
+      ...options.appContext
+    }
+
+    try {
+      response.locals.appContext = new AppContext({ appContext })
+    } catch (error) {
+      next(error)
+    }
+
+    next()
+  }
+}