@defra-fish/gafl-webapp-service/src/pages/recurring-payments/cancel/details/__tests__/route.spec.js

The websales frontend for the GAFL service

import pageRoute from '../../../../../routes/page-route.js'
import { CANCEL_RP_DETAILS, CANCEL_RP_CONFIRM } from '../../../../../uri.js'
import { addLanguageCodeToUri } from '../../../../../processors/uri-helper.js'
import { getData } from '../route.js'
import moment from 'moment-timezone'
import { cacheDateFormat, dateDisplayFormat } from '../../../../../processors/date-and-time-display.js'

jest.mock('../../../../../routes/page-route.js')
jest.mock('../../../../../uri.js', () => ({
  ...jest.requireActual('../../../../../uri.js'),
  CANCEL_RP_DETAILS: { page: Symbol('cancel-rp-details-page'), uri: Symbol('cancel-rp-details-uri') },
  CANCEL_RP_CONFIRM: { uri: Symbol('cancel-rp-confirm-uri') }
}))
jest.mock('../../../../../processors/uri-helper.js')
jest.mock('moment-timezone', () =>
  jest.fn(() => ({
    format: jest.fn()
  }))
)
jest.mock('../../../../../processors/date-and-time-display.js', () => ({
  cacheDateFormat: Symbol('cache-date-format'),
  dateDisplayFormat: Symbol('date-display-format')
}))

describe('route', () => {
  beforeEach(jest.clearAllMocks)

  describe('pageRoute receives expected arguments', () => {
    it('should call the pageRoute with cancel-rp-details, /buy/cancel-recurring-payment/details, dateOfBirthValidator, nextPage and getData', async () => {
      jest.isolateModules(() => {
        require('../route.js')
        expect(pageRoute).toHaveBeenCalledWith(
          CANCEL_RP_DETAILS.page,
          CANCEL_RP_DETAILS.uri,
          expect.any(Function),
          expect.any(Function),
          expect.any(Function)
        )
      })
    })
  })

  it('calls addLanguageCodeToUri with request object', async () => {
    jest.isolateModules(() => {
      require('../route.js')
    })
    const [[, , , completion]] = pageRoute.mock.calls
    const sampleRequest = Symbol('sample request')
    completion(sampleRequest)
    expect(addLanguageCodeToUri).toHaveBeenCalledWith(sampleRequest, expect.anything())
  })

  it('calls addLanguageCodeToUri with CANCEL_RP_AUTHENTICATE uri', () => {
    jest.isolateModules(() => {
      require('../route.js')
    })
    const [[, , , completion]] = pageRoute.mock.calls
    completion({})
    expect(addLanguageCodeToUri).toHaveBeenCalledWith(expect.anything(), CANCEL_RP_CONFIRM.uri)
  })

  it('returns the value of addLanguageCodeToUri', () => {
    jest.isolateModules(() => {
      require('../route.js')
    })
    const [[, , , completion]] = pageRoute.mock.calls
    const expectedCompletionRedirect = Symbol('expected-completion-redirect')
    addLanguageCodeToUri.mockReturnValueOnce(expectedCompletionRedirect)

    const completionRedirect = completion({})

    expect(completionRedirect).toBe(expectedCompletionRedirect)
  })

  const getSampleCatalog = () => ({
    rp_cancel_details_licence_holder: 'Licence holder',
    rp_cancel_details_licence_type: 'Licence type',
    rp_cancel_details_payment_card: 'Payment card',
    rp_cancel_details_last_purchased: 'Last purchased',
    rp_cancel_details_licence_valid_until: 'Valid until'
  })

  const getSamplePermission = () => ({
    permission: {
      licensee: {
        firstName: 'John',
        lastName: 'Smith'
      },
      permit: {
        description: 'Salmon and sea trout'
      },
      endDate: '01-01-2026',
      referenceNumber: 'abc123'
    },
    recurringPayment: {
      lastDigitsCardNumbers: '1234'
    }
  })

  const createMockRequest = ({ currentPermission = getSamplePermission(), catalog = getSampleCatalog() } = {}) => ({
    cache: () => ({
      helpers: {
        transaction: {
          getCurrentPermission: jest.fn().mockResolvedValue(currentPermission)
        }
      }
    }),
    i18n: {
      getCatalog: () => catalog
    },
    locale: Symbol('en-GB')
  })

  describe('getData', () => {
    beforeEach(() => {
      jest.clearAllMocks()
    })

    it('returns request.i18n.getCatalog()', async () => {
      const mssgs = getSampleCatalog()
      const mockRequest = createMockRequest({ catalog: mssgs })

      const result = await getData(mockRequest)

      expect(result.mssgs).toEqual(mssgs)
    })

    it('returns summaryTable with expected data', async () => {
      const mssgs = getSampleCatalog()
      const sampleData = {
        permission: {
          licensee: {
            firstName: 'Brenin',
            lastName: 'Pysgotwr'
          },
          permit: {
            description: 'Wellies and old shopping trollies'
          },
          endDate: '21-03-2026',
          referenceNumber: 'aaa-111-bbb-222'
        },
        recurringPayment: {
          lastDigitsCardNumbers: '9999'
        }
      }
      const sampleFormattedDate = Symbol('formatted-end-date')
      const mockRequest = createMockRequest({ catalog: mssgs, currentPermission: sampleData })
      moment.mockReturnValueOnce({
        format: () => sampleFormattedDate
      })

      const result = await getData(mockRequest)

      expect(result.summaryTable).toEqual([
        {
          key: { text: mssgs.rp_cancel_details_licence_holder },
          value: { text: `${sampleData.permission.licensee.firstName} ${sampleData.permission.licensee.lastName}` }
        },
        { key: { text: mssgs.rp_cancel_details_licence_type }, value: { text: sampleData.permission.permit.description } },
        {
          key: { text: mssgs.rp_cancel_details_payment_card },
          value: { text: `**** **** **** ${sampleData.recurringPayment.lastDigitsCardNumbers}` }
        },
        { key: { text: mssgs.rp_cancel_details_last_purchased }, value: { text: sampleData.permission.referenceNumber } },
        { key: { text: mssgs.rp_cancel_details_licence_valid_until }, value: { text: sampleFormattedDate } }
      ])
    })

    it('passes cache date format and request locale to moment', async () => {
      const data = getSamplePermission()
      data.permission.endDate = Symbol('end-date')
      const mockRequest = createMockRequest({ currentPermission: data })

      await getData(mockRequest)

      expect(moment).toHaveBeenCalledWith(data.permission.endDate, cacheDateFormat, mockRequest.locale)
    })

    it('requests correct date format', async () => {
      const data = getSamplePermission()
      data.permission.endDate = Symbol('end-date')
      const mockRequest = createMockRequest({ currentPermission: data })
      const format = jest.fn()
      moment.mockReturnValueOnce({
        format
      })

      await getData(mockRequest)

      expect(format).toHaveBeenCalledWith(dateDisplayFormat)
    })
  })
})