@ministryofjustice/hmpps-digital-prison-reporting-frontend/dpr/routes/journeys/view-report/sync/report/utils.test.ts

The Digital Prison Reporting Frontend contains templates and code to help display data effectively in UI applications.

import type { Request, Response } from 'express'
import { Url } from 'url'
import { Services } from '../../../../../types/Services'
import SyncReportUtils from './utils'

// mocks
import mockReportVariant from '../../../../../../../test-app/mocks/mockClients/reports/mockVariants/request-examples/success'
import { components } from '../../../../../types/api'
import {
  DownloadPermissionService,
  BookmarkService,
  ReportingService,
  RecentlyViewedStoreService,
} from '../../../../../services'
import createMockData from '../../../../../../../test-app/mocks/mockClients/reports/mockAsyncData'
import mockSyncListData from '../../../../../../../test-app/mocks/mockClients/reports/mockSyncListData'

jest.mock('parseurl', () => ({
  __esModule: true,
  default: jest.fn().mockImplementation(() => ({ pathname: 'pathname', search: 'search' } as Url)),
}))

describe('SyncReportUtils', () => {
  let req: Request
  let res: Response
  let services: Services
  let reportingService: ReportingService
  let downloadPermissionService: DownloadPermissionService
  let recentlyViewedService: RecentlyViewedStoreService
  let bookmarkService: BookmarkService
  let mockDefinition: components['schemas']['SingleVariantReportDefinition']

  beforeEach(() => {
    req = {
      params: {
        reportId: 'reportId',
        id: 'id',
      },
      query: {
        dataProductDefinitionsPath: 'this/that/other',
      },
      get: jest.fn().mockReturnValue('host'),
      originalUrl: 'originalUrl',
      baseUrl: 'baseUrl',
      protocol: 'protocol',
    } as unknown as Request

    res = {
      locals: {
        user: {
          uuid: 'userId',
        },
        token: 'T03En',
      },
    } as unknown as Response

    mockDefinition = {
      id: 'reportId',
      name: 'reportName',
      description: 'description',
      variant: mockReportVariant as components['schemas']['VariantDefinition'],
    }

    const mockData = createMockData(1)
    reportingService = {
      getDefinition: jest.fn().mockResolvedValue(mockDefinition),
      getListWithWarnings: jest.fn().mockResolvedValue({ data: mockData }),
      getCount: jest.fn().mockResolvedValue(100),
    } as unknown as ReportingService

    downloadPermissionService = {
      downloadEnabled: jest.fn().mockResolvedValue(false),
    } as unknown as DownloadPermissionService

    recentlyViewedService = {
      setRecentlyViewed: jest.fn().mockResolvedValue({}),
    } as unknown as RecentlyViewedStoreService

    bookmarkService = {
      isBookmarked: jest.fn().mockResolvedValue(false),
    } as unknown as BookmarkService

    services = {
      reportingService,
      downloadPermissionService,
      bookmarkService,
      recentlyViewedService,
    } as unknown as Services
  })

  describe('getReport', () => {
    it('should get the report', async () => {
      const result = await SyncReportUtils.getReport({ req, res, services })

      expect(result).toEqual(mockSyncListData)
    })
  })
})