@defra/lis-infra-ui-services 0.23.0-lreg-665.alpha.1 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/lis-infra-ui-services",
-  "version": "0.23.0-lreg-665.alpha.1",
+  "version": "0.23.0",
   "description": "UI-Services shared definitions for the livestock taxonomy topology.",
   "main": "src/index.js",
   "repository": {
@@ -19,7 +19,6 @@
     "./duration": "./src/duration.js",
     "./errors": "./src/errors/index.js",
     "./maintenance": "./src/maintenance.js",
-    "./navigation": "./src/navigation.js",
     "./nunjucks/build-navigation": "./src/nunjucks/build-navigation.js",
     "./nunjucks/context": "./src/nunjucks/context.js",
     "./nunjucks/filters": "./src/nunjucks/filters.js",

package/src/errors/index.js

@@ -58,5 +58,10 @@ export function catchAll(request, h) {
     return h.continue
   }
   const { view, pageTitle } = errorPageFor(statusCode)
-  return h.view(view, { pageTitle }).code(statusCode)
+  const developmentMessage =
+    process.env.NODE_ENV === 'development'
+      ? (response?.message ?? response?.source?.message)
+      : undefined
+
+  return h.view(view, { pageTitle, developmentMessage }).code(statusCode)
 }

package/src/errors/index.test.js

@@ -83,7 +83,10 @@ test.each([
     catchAll(request, toolkit)
 
     // Assert
-    assert.deepEqual(toolkit.view.mock.calls[0], [view, { pageTitle }])
+    assert.deepEqual(toolkit.view.mock.calls[0], [
+      view,
+      { pageTitle, developmentMessage: undefined }
+    ])
     assert.deepEqual(toolkit.code.mock.calls[0], [statusCode])
   }
 )
@@ -100,7 +103,8 @@ test('catchAll logs server errors and renders the problem with the service page'
   assert.deepEqual(toolkit.view.mock.calls[0], [
     'error/problem-with-service',
     {
-      pageTitle: 'Sorry, there is a problem with the service'
+      pageTitle: 'Sorry, there is a problem with the service',
+      developmentMessage: undefined
     }
   ])
   assert.deepEqual(toolkit.code.mock.calls[0], [
@@ -139,12 +143,43 @@ test('catchAll prefers a client-attached statusCode over a boomified 500', () =>
   // Assert
   assert.deepEqual(toolkit.view.mock.calls[0], [
     'error/page-not-found',
-    { pageTitle: 'Page not found' }
+    { pageTitle: 'Page not found', developmentMessage: undefined }
   ])
   assert.deepEqual(toolkit.code.mock.calls[0], [statusCodes.notFound])
   assert.equal(logger.error.mock.calls.length, 0)
 })
 
+test("catchAll passes the error's own message to the page in development", () => {
+  // Arrange
+  vi.stubEnv('NODE_ENV', 'development')
+  const request = createBoomRequest(statusCodes.internalServerError)
+  request.response.message = 'Upstream timed out'
+  const toolkit = createToolkit()
+
+  // Act
+  catchAll(request, toolkit)
+
+  // Assert
+  assert.equal(
+    toolkit.view.mock.calls[0][1].developmentMessage,
+    'Upstream timed out'
+  )
+})
+
+test("catchAll leaves out the error's own message outside development", () => {
+  // Arrange
+  vi.stubEnv('NODE_ENV', 'production')
+  const request = createBoomRequest(statusCodes.internalServerError)
+  request.response.message = 'Upstream timed out'
+  const toolkit = createToolkit()
+
+  // Act
+  catchAll(request, toolkit)
+
+  // Assert
+  assert.equal(toolkit.view.mock.calls[0][1].developmentMessage, undefined)
+})
+
 test('catchAll does not log the 503 the maintenance plugin answered with', () => {
   // Arrange
   const toolkit = createToolkit()

package/src/nunjucks/context.js

@@ -57,12 +57,11 @@ function createPermissionCheck(request) {
  */
 
 /**
- * @param {{ config: object, buildNavigation: Function, getRequestBasePath: Function, logger: object, readFileSync: Function, moduleId?: string, errorPages?: ErrorPageLinks }} options
+ * @param {{ config: object, getRequestBasePath: Function, logger: object, readFileSync: Function, moduleId?: string, errorPages?: ErrorPageLinks }} options
  * @returns {Function}
  */
 export function createNunjucksContextBuilder({
   config,
-  buildNavigation,
   getRequestBasePath,
   logger,
   readFileSync,
@@ -106,7 +105,8 @@ export function createNunjucksContextBuilder({
       sectionName,
       serviceUrl: '/',
       breadcrumbs: [],
-      navigation: buildNavigation(request),
+      // No primary navigation links for now: only the service name and Sign out.
+      navigation: [],
       isSignedIn: Boolean(request?.auth?.credentials?.user),
       isFrontOffice: requestHubId === 'front-office',
       isBackOffice: requestHubId === 'back-office',

package/src/nunjucks/context.test.js

@@ -23,7 +23,6 @@ test('createNunjucksContextBuilder resolves built asset paths from the Vite mani
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -52,7 +51,6 @@ test('createNunjucksContextBuilder falls back to the source asset path without l
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -77,7 +75,6 @@ test('createNunjucksContextBuilder resolves sectionName from the module registry
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -98,7 +95,6 @@ test('createNunjucksContextBuilder leaves sectionName null when no moduleId is g
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -118,7 +114,6 @@ test('createNunjucksContextBuilder logs once when the Vite manifest is unavailab
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig({ isProduction: true }),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -143,7 +138,6 @@ test('createNunjucksContextBuilder always sets serviceUrl to the hub root even w
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '/cattle/register',
     logger: {
       error(loggedError, message) {
@@ -169,7 +163,6 @@ test('createNunjucksContextBuilder always sets serviceUrl to the hub root even w
 function createSignedInContextBuilder() {
   return createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: { error: () => undefined },
     readFileSync: () => '{}'
@@ -213,7 +206,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -237,7 +229,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -261,7 +252,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -281,7 +271,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -307,7 +296,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -330,7 +318,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -357,7 +344,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -383,7 +369,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -413,7 +398,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -443,7 +427,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -473,7 +456,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -503,7 +485,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -524,7 +505,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -553,7 +533,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -580,7 +559,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'

package/src/nunjucks/plugin.js

@@ -5,10 +5,7 @@ import hapiVision from '@hapi/vision'
 import { createRequire } from 'node:module'
 import { fileURLToPath } from 'node:url'
 
-import { getBasePathForModule } from '@defra/lis-hubs-infra-registry'
-
 import { createNunjucksContextBuilder } from './context.js'
-import { buildPrimaryNavigation } from './build-navigation.js'
 import * as filters from './filters.js'
 import * as globals from './globals.js'
 
@@ -168,7 +165,6 @@ export function createNunjucksConfig({
   moduleId,
   errorPages
 }) {
-  const basePath = moduleId ? getBasePathForModule(moduleId) : ''
   const projectRoot = config.get('root')
   const infrastructureRoot = path.resolve(
     path.dirname(fileURLToPath(import.meta.url)),
@@ -185,15 +181,8 @@ export function createNunjucksConfig({
     govukFrontendRoot
   })
 
-  const buildNavigation = (request) =>
-    buildPrimaryNavigation({
-      request,
-      basePath
-    })
-
   const context = createNunjucksContextBuilder({
     config,
-    buildNavigation,
     getRequestBasePath,
     logger,
     readFileSync,

package/src/nunjucks/plugin.test.js

@@ -4,15 +4,12 @@ import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
 import { tmpdir } from 'node:os'
 import path from 'node:path'
 import nunjucks from 'nunjucks'
-import { getBasePathForModule } from '@defra/lis-hubs-infra-registry'
 import { createNunjucksConfig } from './plugin.js'
 
 vi.mock('nunjucks')
-vi.mock('@defra/lis-hubs-infra-registry')
 
 const mocks = {
-  nunjucksConfigure: vi.mocked(nunjucks.configure),
-  getBasePathForModule: vi.mocked(getBasePathForModule)
+  nunjucksConfigure: vi.mocked(nunjucks.configure)
 }
 
 function createProjectRoot() {
@@ -49,25 +46,6 @@ describe('createNunjucksConfig()', () => {
     rmSync(projectRoot, { recursive: true, force: true })
   })
 
-  test('resolves the base path from the module registry when moduleId is given', () => {
-    // Arrange
-    mocks.getBasePathForModule.mockReturnValue('/cattle/register')
-    const config = {
-      get: vi.fn((key) => (key === 'root' ? projectRoot : false))
-    }
-
-    // Act
-    createNunjucksConfig({
-      config,
-      logger: {},
-      getRequestBasePath: vi.fn(),
-      moduleId: 'cattle-register'
-    })
-
-    // Assert
-    expect(mocks.getBasePathForModule).toHaveBeenCalledWith('cattle-register')
-  })
-
   test('defaults to an empty base path when no moduleId is given', () => {
     // Arrange
     const config = {
@@ -82,7 +60,6 @@ describe('createNunjucksConfig()', () => {
     })
 
     // Assert
-    expect(mocks.getBasePathForModule).not.toHaveBeenCalled()
     expect(nunjucksConfig.plugin).toBeDefined()
   })
 

package/src/nunjucks/routes/error/error-pages.test.js

@@ -160,4 +160,35 @@ describe('error pages', () => {
       '<a class="govuk-link" href="https://example.com/contact">British Cattle Movement Service (BCMS)</a>'
     )
   })
+
+  test('service unavailable says later when no return time is given', () => {
+    // Arrange
+    const context = { pageTitle: 'Sorry, the service is unavailable' }
+
+    // Act
+    const html = render('error/service-unavailable.njk', context)
+
+    // Assert
+    expect(textOf(html)).toContain('You will be able to use the service later.')
+  })
+
+  test.each([
+    'error/page-not-found.njk',
+    'error/not-authorised.njk',
+    'error/problem-with-service.njk',
+    'error/service-unavailable.njk'
+  ])('%s shows the development message only when one is given', (view) => {
+    // Arrange
+    const withMessage = { developmentMessage: 'Upstream timed out' }
+
+    // Act
+    const htmlWithMessage = render(view, withMessage)
+    const htmlWithoutMessage = render(view)
+
+    // Assert
+    expect(htmlWithMessage).toContain(
+      '<p class="govuk-body">Upstream timed out</p>'
+    )
+    expect(htmlWithoutMessage).not.toContain('Upstream timed out')
+  })
 })

package/src/nunjucks/routes/error/not-authorised.njk

@@ -9,6 +9,9 @@
       {% if signInHref %}
         <a href="{{ signInHref }}" role="button" draggable="false" class="govuk-button" data-module="govuk-button">Sign in</a>
       {% endif %}
+      {% if developmentMessage %}
+        <p class="govuk-body">{{ developmentMessage }}</p>
+      {% endif %}
     </div>
   </div>
 {% endblock %}

package/src/nunjucks/routes/error/page-not-found.njk

@@ -12,6 +12,9 @@
         <li><a class="govuk-link" href="https://www.gov.uk">GOV.UK</a></li>
       </ul>
       <p class="govuk-body">If you cannot find the information you need, <a class="govuk-link" href="{{ errorPages.contactHref }}">contact our support team</a>.</p>
+      {% if developmentMessage %}
+        <p class="govuk-body">{{ developmentMessage }}</p>
+      {% endif %}
     </div>
   </div>
 {% endblock %}

package/src/nunjucks/routes/error/problem-with-service.njk

@@ -6,6 +6,9 @@
       <h1 class="govuk-heading-l">Sorry, there is a problem with the service</h1>
       <p class="govuk-body">Try again later.</p>
       <p class="govuk-body">Contact the <a class="govuk-link" href="{{ errorPages.contactHref }}">British Cattle Movement Service (BCMS)</a> if you need to speak to someone about your account.</p>
+      {% if developmentMessage %}
+        <p class="govuk-body">{{ developmentMessage }}</p>
+      {% endif %}
     </div>
   </div>
 {% endblock %}

package/src/nunjucks/routes/error/service-unavailable.njk

@@ -10,6 +10,9 @@
         <p class="govuk-body">You will be able to use the service later.</p>
       {% endif %}
       <p class="govuk-body">Contact the <a class="govuk-link" href="{{ errorPages.contactHref }}">British Cattle Movement Service (BCMS)</a> if you need to speak to someone about your account.</p>
+      {% if developmentMessage %}
+        <p class="govuk-body">{{ developmentMessage }}</p>
+      {% endif %}
     </div>
   </div>
 {% endblock %}

package/src/navigation.js

@@ -1 +0,0 @@
-export { buildPrimaryNavigation } from './nunjucks/build-navigation.js'

package/src/nunjucks/build-navigation.js

@@ -1,61 +0,0 @@
-import { MODULES } from '@defra/lis-hubs-infra-registry'
-import { SUPPORTED_SPECIES, SUPPORTED_TAXONOMIES } from '../index.js'
-
-/** @import { Request } from '@hapi/hapi' */
-
-/**
- * @param {{ request: Request, basePath?: string }} options
- * @returns {object[]}
- */
-export function buildPrimaryNavigation({ request, basePath = '' }) {
-  const currentSpecies = getCurrentSpecies({ request, basePath })
-  const profileItem = {
-    text: 'Profile',
-    href: '/profile',
-    current: request?.path === '/profile' && !currentSpecies?.id
-  }
-  const permittedSpecies = request?.auth?.credentials?.authorizedSpecies
-
-  if (!Array.isArray(permittedSpecies) || permittedSpecies.length === 0) {
-    return []
-  }
-
-  return [
-    ...permittedSpecies.map((species) => ({
-      text: species.label,
-      href: getSpeciesHomePath(species),
-      current: species.id === currentSpecies?.id
-    })),
-    profileItem
-  ]
-}
-
-function getSpeciesHomePath(species) {
-  const homeModule = MODULES.find(
-    (module) => module.id === `${species.id}-home`
-  )
-
-  return homeModule?.path ?? `/${species.id}`
-}
-
-function getCurrentSpecies({ request, basePath }) {
-  for (const path of [request?.path, basePath]) {
-    if (typeof path !== 'string' || path.length === 0) {
-      continue
-    }
-
-    const [speciesSlug, taxonomySlug] = path.split('/').filter(Boolean)
-
-    const matchingTaxonomy = SUPPORTED_TAXONOMIES.find(
-      (taxonomy) => taxonomy.slug === taxonomySlug
-    )
-    const matchingSpecies = SUPPORTED_SPECIES.find(
-      (species) => species.slug === speciesSlug
-    )
-    if (matchingTaxonomy && matchingSpecies) {
-      return matchingSpecies
-    }
-  }
-
-  return null
-}

package/src/nunjucks/build-navigation.test.js

@@ -1,62 +0,0 @@
-import assert from 'node:assert/strict'
-import { test } from 'vitest'
-
-import { buildPrimaryNavigation } from './build-navigation.js'
-
-test('buildPrimaryNavigation renders species already authorized by the host', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/',
-      auth: {
-        credentials: {
-          authorizedSpecies: [
-            { id: 'cattle', label: 'Cattle' },
-            { id: 'sheep', label: 'Sheep' }
-          ]
-        }
-      }
-    }
-  })
-
-  assert.deepEqual(
-    navigation.map((item) => item.text),
-    ['Cattle', 'Sheep', 'Profile']
-  )
-})
-
-test('buildPrimaryNavigation renders no items when the user has no authorized species', () => {
-  const navigation = buildPrimaryNavigation({
-    request: { path: '/', app: {} }
-  })
-
-  assert.deepEqual(navigation, [])
-})
-
-test('buildPrimaryNavigation marks the profile item as current on the profile route', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/profile',
-      auth: {
-        credentials: {
-          authorizedSpecies: [{ id: 'cattle', label: 'Cattle' }]
-        }
-      }
-    }
-  })
-
-  assert.equal(navigation.at(-1)?.text, 'Profile')
-  assert.equal(navigation.at(-1)?.current, true)
-})
-
-test('buildPrimaryNavigation ignores the legacy request.app.authorizedSpecies', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/',
-      app: {
-        authorizedSpecies: [{ id: 'cattle', label: 'Cattle' }]
-      }
-    }
-  })
-
-  assert.deepEqual(navigation, [])
-})