@financial-times/dotcom-middleware-navigation 7.3.1 → 7.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/dotcom-middleware-navigation",
-  "version": "7.3.1",
+  "version": "7.3.3",
   "description": "",
   "main": "dist/node/index.js",
   "types": "src/index.ts",
@@ -18,8 +18,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@financial-times/dotcom-server-navigation": "file:../../packages/dotcom-server-navigation",
-    "@financial-times/dotcom-types-navigation": "file:../dotcom-types-navigation"
+    "@financial-times/dotcom-server-navigation": "^7.3.3",
+    "@financial-times/dotcom-types-navigation": "^7.3.3"
   },
   "devDependencies": {
     "check-engine": "^1.10.1",
@@ -30,7 +30,8 @@
     "npm": "7.x || 8.x"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "src/"
   ],
   "repository": {
     "type": "git",
@@ -41,4 +42,4 @@
   "volta": {
     "extends": "../../package.json"
   }
-}
+}

package/src/__test__/handleEdition.spec.ts

@@ -0,0 +1,64 @@
+import subject from '../handleEdition'
+import httpMocks from 'node-mocks-http'
+
+describe('dotcom-middleware-navigation/src/handleEdition', () => {
+  describe('with no query string parameter or cookie set', () => {
+    let request
+    let response
+    let result
+
+    beforeAll(() => {
+      request = httpMocks.createRequest()
+      response = httpMocks.createResponse()
+      result = subject(request, response)
+    })
+
+    it('returns the default edition', () => {
+      expect(result).toEqual('uk')
+    })
+
+    it('sets an edition vary header', () => {
+      expect(response.getHeader('vary')).toBe('FT-Edition')
+    })
+  })
+
+  describe('with an edition header set', () => {
+    let request
+    let response
+    let result
+
+    beforeAll(() => {
+      request = httpMocks.createRequest({ headers: { 'ft-edition': 'international' } })
+      response = httpMocks.createResponse()
+      result = subject(request, response)
+    })
+
+    it('returns the set edition', () => {
+      expect(result).toEqual('international')
+    })
+
+    it('sets an edition vary header', () => {
+      expect(response.getHeader('vary')).toBe('FT-Edition')
+    })
+  })
+
+  describe('with a query string parameter set', () => {
+    let request
+    let response
+    let result
+
+    beforeAll(() => {
+      request = httpMocks.createRequest({ query: { edition: 'international' } })
+      response = httpMocks.createResponse()
+      result = subject(request, response)
+    })
+
+    it('returns the selected edition', () => {
+      expect(result).toEqual('international')
+    })
+
+    it('sets a next-edition cookie with the selected edition', () => {
+      expect(response.cookies['next-edition'].value).toBe('international')
+    })
+  })
+})

package/src/__test__/navigation.spec.ts

@@ -0,0 +1,184 @@
+import * as subject from '../navigation'
+import httpMocks from 'node-mocks-http'
+
+const fakeMenusData = {
+  navbar: {
+    label: 'Navbar UK',
+    items: [{ label: 'Foo', url: '#' }]
+  },
+  drawer: {
+    label: 'Drawer UK',
+    items: [{ label: 'Foo', url: '#' }]
+  }
+}
+
+const fakeEditionsData = {
+  current: { id: 'uk', name: 'UK', url: '/' },
+  others: [{ id: 'international', name: 'International', url: '/' }]
+}
+
+const fakeActionsData = { id: 'subscribe', name: 'Subscribe for full access', url: '/products?' }
+
+const fakeSubNavigationData = {
+  breadcrumb: 'some-breadcrumb',
+  subsections: 'some-subsections'
+}
+
+const fakeNavigationData = { ...fakeMenusData, editions: fakeEditionsData, currentPath: '' }
+
+const FakeNavigation = {
+  getSubscribeAction: jest.fn().mockResolvedValue(fakeActionsData),
+  getMenusFor: jest.fn().mockResolvedValue(fakeMenusData),
+  getSubNavigationFor: jest.fn().mockResolvedValue(fakeSubNavigationData),
+  getEditionsFor: jest.fn().mockReturnValue(fakeEditionsData)
+}
+
+jest.mock(
+  '@financial-times/dotcom-server-navigation',
+  () => {
+    return {
+      Navigation: jest.fn().mockImplementation(() => FakeNavigation)
+    }
+  },
+  { virtual: true }
+)
+
+describe('dotcom-middleware-navigation', () => {
+  let request
+  let response
+  let next
+  let instance
+
+  beforeEach(() => {
+    request = httpMocks.createRequest()
+    response = httpMocks.createResponse({ locals: {} })
+    next = jest.fn()
+    instance = subject.init()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('returns a middleware function', () => {
+    expect(instance).toBeInstanceOf(Function)
+    expect(instance.length).toBe(3)
+  })
+
+  describe('when handling a request', () => {
+    it('appends the navigation properties to response.locals', async () => {
+      await instance(request, response, next)
+      expect(response.locals.navigation).toEqual(expect.objectContaining(fakeNavigationData))
+    })
+
+    it('prefers the vanity URL if set', async () => {
+      const request = httpMocks.createRequest({
+        path: '/path/to/app/1234',
+        headers: {
+          'ft-vanity-url': '/vanity-url'
+        }
+      })
+
+      await instance(request, response, next)
+      expect(FakeNavigation.getMenusFor).toHaveBeenCalledWith('/vanity-url', 'uk')
+    })
+
+    it('calls the fallthrough function', async () => {
+      await instance(request, response, next)
+      expect(next).toHaveBeenCalled()
+    })
+  })
+
+  describe('when handling a request with sub-navigation enabled', () => {
+    let instance
+
+    beforeEach(() => {
+      instance = subject.init({ enableSubNavigation: true })
+    })
+
+    it('prefers the path provided by the vanity URL header when available', async () => {
+      request = httpMocks.createRequest({
+        path: '/path/to/page/123',
+        headers: {
+          'ft-vanity-url': '/vanity-url'
+        }
+      })
+
+      await instance(request, response, next)
+
+      expect(FakeNavigation.getSubNavigationFor).toHaveBeenCalledWith('/vanity-url')
+    })
+
+    it('normalizes the current path', async () => {
+      request = httpMocks.createRequest({
+        path: '/path/to/page/123',
+        query: {
+          page: 2
+        },
+        headers: {
+          'ft-vanity-url': '/vanity-url?page=2'
+        }
+      })
+
+      await instance(request, response, next)
+
+      expect(FakeNavigation.getSubNavigationFor).toHaveBeenCalledWith('/vanity-url')
+    })
+
+    it('appends the sub-navigation properties on response.locals for the current path', async () => {
+      await instance(request, response, next)
+      expect(response.locals.navigation).toEqual(expect.objectContaining(fakeSubNavigationData))
+    })
+
+    it('fails silently if the the sub-navigation request fails', async () => {
+      FakeNavigation.getSubNavigationFor.mockRejectedValueOnce(new Error('Fail'))
+
+      await instance(request, response, next)
+
+      expect(next).not.toHaveBeenCalledWith(expect.any(Error))
+    })
+  })
+
+  describe('when handling a request with a custom getCurrentPath', () => {
+    it('executes the provided getCurrentPath function', async () => {
+      request = httpMocks.createRequest({
+        path: '/path/to/page/123',
+        headers: {
+          'ft-vanity-url': '/vanity-url?page=2'
+        }
+      })
+      const dummyPath = '/foo'
+      const instance = subject.init({ getCurrentPath: () => dummyPath })
+      await instance(request, response, next)
+
+      expect(FakeNavigation.getMenusFor).toHaveBeenCalledWith(dummyPath, 'uk')
+    })
+
+    it('allows overriding of how to calculate current path logic', async () => {
+      request = httpMocks.createRequest({
+        path: '/path/to/page/123',
+        headers: {
+          'ft-blocked-url': '/ig-content-test'
+        }
+      })
+
+      const instance = subject.init({ getCurrentPath: (request) => request.get('ft-blocked-url') })
+      await instance(request, response, next)
+
+      expect(FakeNavigation.getMenusFor).toHaveBeenCalledWith('/ig-content-test', 'uk')
+    })
+  })
+
+  describe('when something goes wrong', () => {
+    beforeEach(() => {
+      FakeNavigation.getMenusFor = jest.fn(() => {
+        throw Error('Whoops')
+      })
+    })
+
+    it('catches the error safely', async () => {
+      await instance(request, response, next)
+      expect(next).toHaveBeenCalledWith(expect.any(Error))
+    })
+  })
+})

package/src/handleEdition.ts

@@ -0,0 +1,28 @@
+import { isEdition } from '@financial-times/dotcom-server-navigation'
+import { Request, Response } from 'express'
+
+const defaultEdition = 'uk'
+
+export default (request: Request, response: Response): string => {
+  // NOTE: The FT-Edition header is set by the CDN and/or next-router...
+  // If an edition is selected with a cookie or query string it will be set to that.
+  // Otherwise the router will choose the best setting based on GeoIP.
+  // <https://github.com/Financial-Times/ft.com-cdn/blob/HEAD/src/vcl/next-editions.vcl>
+  // <https://github.com/Financial-Times/next-router/blob/HEAD/server/middleware/editions.js>
+  let currentEdition = request.get('FT-Edition') || defaultEdition
+
+  if (typeof request.query.edition === 'string' && isEdition(request.query.edition)) {
+    currentEdition = request.query.edition
+
+    response.cookie('next-edition', currentEdition, {
+      domain: 'ft.com',
+      maxAge: 1000 * 60 * 60 * 24 * 365 // 1 year
+    })
+  }
+
+  // NOTE: n-express overrides res.set() and res.vary() in order to merge all vary headers together.
+  // <https://github.com/Financial-Times/n-express/blob/HEAD/src/middleware/vary.js>
+  response.vary('FT-Edition')
+
+  return currentEdition
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './navigation'

package/src/navigation.ts

@@ -0,0 +1,57 @@
+import { Request, Response, NextFunction } from 'express'
+import { TNavigationData } from '@financial-times/dotcom-types-navigation'
+import { Navigation, TNavOptions } from '@financial-times/dotcom-server-navigation'
+import handleEdition from './handleEdition'
+import normalizePath from './normalizePath'
+
+type MiddlewareOptions = TNavOptions & {
+  enableSubNavigation?: boolean
+  getCurrentPath?: Function
+}
+
+const defaultOptions: MiddlewareOptions = {
+  enableSubNavigation: false,
+  getCurrentPath: (request) => normalizePath(request.get('ft-vanity-url') || request.path)
+}
+
+export const init = (userOptions: MiddlewareOptions = {}) => {
+  const options = { ...defaultOptions, ...userOptions }
+  const navigation = new Navigation(options)
+
+  // Not all pages appear in the navigation so this request will fail often.
+  // Because it's not critical, ignore the error and move on.
+  const getSubNavigationFor = (currentPath) => navigation.getSubNavigationFor(currentPath).catch(() => {})
+
+  return async (request: Request, response: Response, next: NextFunction) => {
+    try {
+      // The vanity URL will usually be referenced in the navigation data
+      // rather than the underlying path, so prefer that when available.
+      // <https://github.com/Financial-Times/ft.com-cdn/blob/4841fbf100e1c561a2f6729b9921ec12bb6b837c/src/vcl/next-preflight.vcl#L213-L219>
+      // NOTE: Next router sets the vanity header inc. any query string so it must be normalized.
+      const currentPath = options.getCurrentPath(request)
+      const currentEdition = handleEdition(request, response)
+
+      const [menusData, subNavigationData] = await Promise.all([
+        navigation.getMenusFor(currentPath, currentEdition),
+        options.enableSubNavigation ? getSubNavigationFor(currentPath) : null
+      ])
+
+      const editions = navigation.getEditionsFor(currentEdition)
+      const subscribeAction = navigation.getSubscribeAction()
+
+      const navigationData: TNavigationData = {
+        editions,
+        subscribeAction,
+        currentPath,
+        ...menusData,
+        ...subNavigationData
+      }
+
+      response.locals.navigation = navigationData
+
+      next()
+    } catch (error) {
+      next(error)
+    }
+  }
+}

package/src/normalizePath.ts

@@ -0,0 +1,6 @@
+import url from 'url'
+
+export default function normalizePath(currentPath: string): string {
+  // NOTE: We're using Node's old URL API because it can handle partial URLs
+  return url.parse(currentPath).pathname || ''
+}