Refactor placement-request page information

integration_tests/pages/admin/placementApplications/showPage.ts

@@ -1,25 +1,16 @@
+import { ApprovedPremises, PlacementRequest, PlacementRequestDetail } from '@approved-premises/api'
 import Page from '../../page'
 
-import {
-  ApprovedPremises,
-  FullPerson,
-  PlacementRequest,
-  PlacementRequestDetail,
-} from '../../../../server/@types/shared'
-import { adminSummary, matchingInformationSummary } from '../../../../server/utils/placementRequests'
 import { bookingSummaryList } from '../../../../server/utils/bookings'
+import { placementRequestSummaryList } from '../../../../server/utils/placementRequests/placementRequestSummaryList'
 
 export default class ShowPage extends Page {
   constructor(private readonly placementRequest: PlacementRequestDetail) {
-    super((placementRequest.person as FullPerson).name)
+    super('Placement request')
   }
 
   shouldShowSummary(): void {
-    this.shouldContainSummaryListItems(adminSummary(this.placementRequest).rows)
-  }
-
-  shouldShowMatchingInformationSummary(): void {
-    this.shouldContainSummaryListItems(matchingInformationSummary(this.placementRequest).rows)
+    this.shouldContainSummaryListItems(placementRequestSummaryList(this.placementRequest).rows)
   }
 
   clickPlacementRequest(placementRequest: PlacementRequest): void {

integration_tests/tests/admin/placementRequests.cy.ts

@@ -113,7 +113,6 @@ context('Placement Requests', () => {
       unmatchedPlacementRequests,
       unableToMatchPlacementRequests,
       matchedPlacementRequests,
-      preferredAps,
       matchedPlacementRequest,
       parolePlacementRequest,
     } = stubArtifacts()
@@ -149,8 +148,6 @@ context('Placement Requests', () => {
 
     // And I should see the information about the placement request
     showPage.shouldShowSummary()
-    showPage.shouldShowMatchingInformationSummary()
-    showPage.shouldShowPreferredAps(preferredAps)
 
     // And I should not see any booking information
     showPage.shouldNotShowBookingInformation()
@@ -173,7 +170,6 @@ context('Placement Requests', () => {
 
     // And I should see the information about the placement request
     showPage.shouldShowSummary()
-    showPage.shouldShowMatchingInformationSummary()
 
     showPage.shouldNotShowCreateBookingOption()
     showPage.shouldShowAmendBookingOption()

server/controllers/admin/placementRequests/placementRequestsController.test.ts

@@ -6,6 +6,7 @@ import PlacementRequestsController from './placementRequestsController'
 import { PlacementRequestService } from '../../../services'
 import { userDetailsFactory } from '../../../testutils/factories'
 import placementRequestDetail from '../../../testutils/factories/placementRequestDetail'
+import { placementRequestSummaryList } from '../../../utils/placementRequests/placementRequestSummaryList'
 
 jest.mock('../../../utils/applications/utils')
 jest.mock('../../../utils/applications/getResponses')
@@ -41,6 +42,7 @@ describe('PlacementRequestsController', () => {
 
       expect(response.render).toHaveBeenCalledWith('admin/placementRequests/show', {
         placementRequest,
+        placementRequestSummaryList: placementRequestSummaryList(placementRequest),
       })
       expect(placementRequestService.getPlacementRequest).toHaveBeenCalledWith(token, 'some-uuid')
     })

server/controllers/admin/placementRequests/placementRequestsController.ts

@@ -1,5 +1,6 @@
 import type { Request, Response, TypedRequestHandler } from 'express'
 import { PlacementRequestService } from '../../../services'
+import { placementRequestSummaryList } from '../../../utils/placementRequests/placementRequestSummaryList'
 
 export default class PlacementRequestsController {
   constructor(private readonly placementRequestService: PlacementRequestService) {}
@@ -10,6 +11,7 @@ export default class PlacementRequestsController {
 
       res.render('admin/placementRequests/show', {
         placementRequest,
+        placementRequestSummaryList: placementRequestSummaryList(placementRequest),
       })
     }
   }

server/testutils/factories/offlineApplication.ts

@@ -0,0 +1,16 @@
+import { Factory } from 'fishery'
+import { faker } from '@faker-js/faker/locale/en_GB'
+
+import type { OfflineApplication } from '@approved-premises/api'
+
+import { fullPersonFactory, restrictedPersonFactory } from './person'
+import { DateFormats } from '../../utils/dateUtils'
+
+class OfflineApplicationFactory extends Factory<OfflineApplication> {}
+
+export default OfflineApplicationFactory.define(() => ({
+  type: 'CAS1',
+  id: faker.string.uuid(),
+  person: faker.helpers.arrayElement([fullPersonFactory.build(), restrictedPersonFactory.build()]),
+  createdAt: DateFormats.dateObjToIsoDateTime(faker.date.past()),
+}))

server/utils/match/index.test.ts

@@ -1,12 +1,14 @@
 import type {
   ApType,
+  Application,
   ApprovedPremisesApplication,
   Cas1SpaceBookingCharacteristic,
   FullPerson,
   PlacementCriteria,
 } from '@approved-premises/api'
 import { when } from 'jest-when'
 import type { SummaryListItem } from '@approved-premises/ui'
+import applyPaths from '../../paths/apply'
 import paths from '../../paths/match'
 import {
   personFactory,
@@ -23,6 +25,7 @@ import {
   apManagerDetailsRow,
   apTypeLabelsForRadioInput,
   apTypeRow,
+  apTypeWithViewTimelineActionRow,
   arrivalDateRow,
   calculateDepartureDate,
   characteristicsRow,
@@ -49,10 +52,11 @@ import {
   placementLength,
   placementLengthRow,
   placementRequestSummaryListForMatching,
-  postcodeRow,
+  preferredPostcodeRow,
   premisesNameRow,
   redirectToSpaceBookingsNew,
   releaseTypeRow,
+  requestedOrEstimatedArrivalDateRow,
   requirementsHtmlString,
   spaceBookingPersonNeedsSummaryCardRows,
   spaceBookingPremisesSummaryCardRows,
@@ -71,6 +75,7 @@ import { textValue } from '../applications/helpers'
 import { preferredApsRow } from '../placementRequests/preferredApsRow'
 import { placementRequirementsRow } from '../placementRequests/placementRequirementsRow'
 import applicationFactory from '../../testutils/factories/application'
+import offlineApplicationFactory from '../../testutils/factories/offlineApplication'
 
 jest.mock('../retrieveQuestionResponseFromFormArtifact')
 
@@ -111,6 +116,78 @@ describe('matchUtils', () => {
     })
   })
 
+  describe('requestedOrEstimatedArrivalDateRow', () => {
+    it('should return Estimated arrival date with date when is parole', () => {
+      const arrivalDate = '2024-01-28'
+      expect(requestedOrEstimatedArrivalDateRow(true, arrivalDate)).toEqual({
+        key: { text: 'Estimated arrival date' },
+        value: { text: 'Sun 28 Jan 2024' },
+      })
+    })
+
+    it('should return Requested arrival date with date when is not parole', () => {
+      const arrivalDate = '2024-01-28'
+      expect(requestedOrEstimatedArrivalDateRow(false, arrivalDate)).toEqual({
+        key: { text: 'Requested arrival date' },
+        value: { text: 'Sun 28 Jan 2024' },
+      })
+    })
+  })
+
+  describe('apTypeRow', () => {
+    it.each(Object.keys(apTypeLabels) as Array<ApType>)(
+      'should return the correct type for AP Type %s',
+      (apType: ApType) => {
+        const placementRequestWithApType = placementRequestDetailFactory.build({
+          type: apType,
+        })
+
+        expect(apTypeWithViewTimelineActionRow(placementRequestWithApType)).toEqual({
+          key: {
+            text: 'Type of AP',
+          },
+          value: {
+            text: apTypeLabels[apType],
+          },
+          actions: {
+            items: [
+              {
+                href: `${applyPaths.applications.show({ id: placementRequestWithApType.application.id })}?tab=timeline`,
+                text: 'View timeline',
+              },
+            ],
+          },
+        })
+      },
+    )
+
+    it('should return the correct type for AP Type normal without actions when placement-request has no application', () => {
+      const apType: ApType = 'normal'
+      const placementRequestWithApType = placementRequestDetailFactory.build({
+        type: apType,
+        application: undefined,
+      })
+      expect(apTypeWithViewTimelineActionRow(placementRequestWithApType)).toEqual({
+        key: {
+          text: 'Type of AP',
+        },
+        value: {
+          text: apTypeLabels[apType],
+        },
+      })
+    })
+  })
+
+  describe('preferredPostcodeRow', () => {
+    it('returns preferred postcode', () => {
+      const postcode = 'B71'
+      expect(preferredPostcodeRow(postcode)).toEqual({
+        key: { text: 'Preferred postcode' },
+        value: { text: postcode },
+      })
+    })
+  })
+
   describe('distanceRow', () => {
     const spaceSearchResult = spaceSearchResultFactory.build()
     const postcodeArea = 'HR1 2AF'
@@ -417,7 +494,7 @@ describe('matchUtils', () => {
         departureDateRow(dates.endDate),
         placementLengthRow(dates.placementLength),
         releaseTypeRow(placementRequest),
-        licenceExpiryDateRow(placementRequest.application as ApprovedPremisesApplication),
+        licenceExpiryDateRow(placementRequest),
         totalCapacityRow(totalCapacity),
         apManagerDetailsRow(managerDetails),
         spaceRequirementsRow(filterOutAPTypes(placementRequest.essentialCriteria)),
@@ -430,6 +507,27 @@ describe('matchUtils', () => {
       )
     })
 
+    it(`should generate the expected matching details when placement-request's application is undefined`, () => {
+      const undefinedApplication: Application = undefined
+      const placementRequestWithoutLicenceExpiry = {
+        ...placementRequest,
+        application: undefinedApplication,
+      }
+      expect(
+        occupancyViewSummaryListForMatchingDetails(totalCapacity, placementRequestWithoutLicenceExpiry, managerDetails),
+      ).toEqual(expectedMatchingDetailsSummaryListItems(''))
+    })
+
+    it(`should generate the expected matching details when placement-request's application is not of type ApprovedPremisesApplication`, () => {
+      const placementRequestWithoutLicenceExpiry = {
+        ...placementRequest,
+        application: offlineApplicationFactory.build(),
+      }
+      expect(
+        occupancyViewSummaryListForMatchingDetails(totalCapacity, placementRequestWithoutLicenceExpiry, managerDetails),
+      ).toEqual(expectedMatchingDetailsSummaryListItems(''))
+    })
+
     it(`should generate the expected matching details with blank licence expiry date when application's license-expiry date is not set`, () => {
       const placementRequestWithoutLicenceExpiry = {
         ...placementRequest,
@@ -625,7 +723,7 @@ describe('matchUtils', () => {
           ),
         ),
         lengthOfStayRow(placementRequest.duration),
-        postcodeRow(placementRequest.location),
+        preferredPostcodeRow(placementRequest.location),
         apTypeRow(placementRequest.type),
         placementRequirementsRow(placementRequest, 'essential'),
         placementRequirementsRow(placementRequest, 'desirable'),

server/utils/match/index.ts

@@ -34,6 +34,7 @@ import { placementRequirementsRow } from '../placementRequests/placementRequirem
 import { allReleaseTypes } from '../applications/releaseTypeUtils'
 import { placementDates } from './placementDates'
 import { occupancyCriteriaMap } from './occupancy'
+import paths from '../../paths/apply'
 
 export { placementDates } from './placementDates'
 export { occupancySummary } from './occupancySummary'
@@ -181,14 +182,12 @@ export const occupancyViewSummaryListForMatchingDetails = (
 ): Array<SummaryListItem> => {
   const placementRequestDates = placementDates(placementRequest.expectedArrival, placementRequest.duration)
   const essentialCharacteristics = filterOutAPTypes(placementRequest.essentialCriteria)
-  const application = placementRequest.application as ApprovedPremisesApplication
-
   return [
     arrivalDateRow(placementRequestDates.startDate),
     departureDateRow(placementRequestDates.endDate),
     placementLengthRow(placementRequestDates.placementLength),
     releaseTypeRow(placementRequest),
-    licenceExpiryDateRow(application),
+    licenceExpiryDateRow(placementRequest),
     totalCapacityRow(totalCapacity),
     apManagerDetailsRow(managerDetails),
     spaceRequirementsRow(essentialCharacteristics),
@@ -244,6 +243,15 @@ export const arrivalDateRow = (arrivalDate: string) => ({
   },
 })
 
+export const requestedOrEstimatedArrivalDateRow = (isParole: boolean, arrivalDate: string) => ({
+  key: {
+    text: isParole ? 'Estimated arrival date' : 'Requested arrival date',
+  },
+  value: {
+    text: DateFormats.isoDateToUIDate(arrivalDate),
+  },
+})
+
 export const departureDateRow = (departureDate: string) => ({
   key: {
     text: 'Expected departure date',
@@ -280,6 +288,31 @@ export const apTypeRow = (apType: ApType) => ({
   },
 })
 
+export const apTypeWithViewTimelineActionRow = (placementRequest: PlacementRequestDetail) => {
+  const apTypeItem = {
+    key: {
+      text: 'Type of AP',
+    },
+    value: {
+      text: apTypeLabels[placementRequest.type],
+    },
+  }
+  if (placementRequest.application) {
+    return {
+      ...apTypeItem,
+      actions: {
+        items: [
+          {
+            href: `${paths.applications.show({ id: placementRequest.application.id })}?tab=timeline`,
+            text: 'View timeline',
+          },
+        ],
+      },
+    }
+  }
+  return apTypeItem
+}
+
 export const addressRow = (spaceSearchResult: SpaceSearchResult) => ({
   key: {
     text: 'Address',
@@ -376,14 +409,21 @@ export const releaseTypeRow = (placementRequest: PlacementRequest) => ({
   },
 })
 
-export const licenceExpiryDateRow = (application: ApprovedPremisesApplication) => ({
-  key: {
-    text: 'Licence expiry date',
-  },
-  value: {
-    text: application.licenceExpiryDate ? DateFormats.isoDateToUIDate(application.licenceExpiryDate) : '',
-  },
-})
+export const licenceExpiryDateRow = (placementRequest: PlacementRequestDetail) => {
+  let licenceExpiryDate: string | undefined
+  if (placementRequest.application && 'licenceExpiryDate' in placementRequest.application) {
+    const application = placementRequest.application as ApprovedPremisesApplication
+    licenceExpiryDate = application.licenceExpiryDate
+  }
+  return {
+    key: {
+      text: 'Licence expiry date',
+    },
+    value: {
+      text: licenceExpiryDate ? DateFormats.isoDateToUIDate(licenceExpiryDate) : '',
+    },
+  }
+}
 
 export const startDateObjFromParams = (params: { startDate: string } | ObjectWithDateParts<'startDate'>) => {
   if (params['startDate-day'] && params['startDate-month'] && params['startDate-year']) {
@@ -444,9 +484,9 @@ export const lengthOfStayRow = (lengthInDays: number) => ({
   },
 })
 
-export const postcodeRow = (postcodeDistrict: PlacementRequestDetail['location']) => ({
+export const preferredPostcodeRow = (postcodeDistrict: PlacementRequestDetail['location']) => ({
   key: {
-    text: 'Postcode',
+    text: 'Preferred postcode',
   },
   value: {
     text: postcodeDistrict,
@@ -464,7 +504,7 @@ export const placementRequestSummaryListForMatching = (placementRequest: Placeme
       DateFormats.dateObjToIsoDate(calculateDepartureDate(placementRequest.expectedArrival, placementRequest.duration)),
     ),
     lengthOfStayRow(placementRequest.duration),
-    postcodeRow(placementRequest.location),
+    preferredPostcodeRow(placementRequest.location),
     apTypeRow(placementRequest.type),
   ]