Map 1548 uof use locations api to get location data #712

GurnankCheema · 2024-09-16T16:05:36Z

MAP-1548
The code change in this ticket swaps the retrieval of the internal location data within a prison from prison-api to the new locations-inside-prison-api.

In prison-api, locations id's are an integer value but in locations-inside-prison-api the location id's are uuid's.
This difference means the the id from locations-inside-prison-api can not be saved against the same key in the DB.
Therefore a new key of incidentLocationId has been introduced to hold the UUID form of the id.

Incident location's are encountrered in 3 main places:
- /incident-details when making a brand new report
- /check-your-answers also when making a brand new report
- /view-report for existing reports

There is no complication in the case of a new report as the UUID will just be assigned to the new incidentLocationId key.
However for /view-report, the DB record will contain the nomis locationId. Because the new locations api does not store the nomis locationId, it won't be possible to obtain the location description from the location-api using it.
So we will use the nomis-sync-prisoner-mapping service to look up the equivalent location id (called dpsLocationId) and use it when calling the locations-api to get the location description.

The mapping of the main elements between the prison-api and locations-api location object is like this:

Just for clarity:

locationId is the (current) variable used to store prisonApi's location id
incidentLocationId is the (new) variable used to store the locationsInsidePrisonApi's location id
nomisLocationId is the actual key in the object returned by locationsInsidePrisonApi and it relates to the prisonApis location id
dpsLocationId is the actual key in the object returned by locationsInsidePrisonApi

…an prison api

and make TODO more understandable and correct unit test and remove uneccesary config

…has already reached check-your-answers page

GurnankCheema · 2024-09-17T06:03:23Z

.circleci/config.yml

@@ -96,7 +96,7 @@ jobs:
          command: sudo apt-get install libxss1
      - run:
          name: Get wiremock
-          command: curl -o wiremock.jar https://repo1.maven.org/maven2/com/github/tomakehurst/wiremock-standalone/2.27.1/wiremock-standalone-2.27.1.jar


wiremock updated as per template project

GurnankCheema · 2024-09-17T06:05:01Z

integration-tests/integration/createIncident/adding-involved-staff.cy.js

@@ -17,7 +17,7 @@ context('Adding involved staff', () => {
    cy.task('stubOffenders', [offender])
    cy.task('stubPrison', offender.agencyId)
    cy.task('stubPrisons')
-    cy.task('stubLocation', '357591')


prisonApi returns integer form location ids.
The new locationsInsidePrisonApi returns UUID form id's

GurnankCheema · 2024-09-17T06:09:19Z

integration-tests/integration/createIncident/view-your-report.cy.js

@@ -16,8 +16,46 @@ context('A reporter views their own report', () => {
    cy.task('stubUserDetailsRetrieval', ['MR_ZAGATO', 'MRS_JONES', 'TEST_USER'])
  })

+  it("A user's report should contain the incident location description even if DB record only contains the nomis format (i.e integer format) of the location's Id", () => {


this is verifying that even if the report only contains the prisonApi location id, as is the case for existing reports, the location description will still be displayed at the /view-report endpoint

GurnankCheema · 2024-09-17T06:13:43Z

integration-tests/integration/reportPages/check-your-answers.cy.js

@@ -30,6 +30,12 @@ context('Check your answers page', () => {
    cy.login()
  })



this verifies that in the 'straight-forward' case of a new report being created and the locationsInsidePrisonApi's location id is persisted, the correct location description is displayed in /check-your-answers

GurnankCheema · 2024-09-17T06:18:39Z

server/config/forms/incidentDetailsForm.js

@@ -65,7 +59,9 @@ const requiredIncidentDate = joi
 const transientSchema = joi.object({
  incidentDate: requiredIncidentDate.meta({ fieldType: EXTRACTED }).alter(optionalForPartialValidation),

-  locationId: requiredIntegerMsg('Select the location of the incident').alter(optionalForPartialValidation),


Both incidentLocationId and locationId are needed in the validation schema because the /incident-details page encountered when making a new report requires incidentLocationId to be selected. However in /check-your-answers, we need to ensure validation passes where a user may be on the page already at the time the new code change is deployed and hence may only have the locationId persisted to db. Not having the locationId in the validation schema will cause validation to fail even though it previously passed and will cause the app to fail when user submits the form

GurnankCheema · 2024-09-17T06:29:25Z

server/routes/creatingReports/checkYourAnswers.ts

+    // This scenario would occur where a user is already at /check-your-answers when the new code to use incidentLocationId is deployed
+    // To pass validation we need the equivalent dpsLocationId persisted to the db as incidentLocationId.
+    // The following 'if-block' does that.
+


if at the /check-your-answers page only the prisonApi id exists, look up the equivalent locationsApi id and save it to db, This will ensure validation does not fail

Mjwillis

Nice work

GurnankCheema · 2024-09-17T16:23:06Z

server/config/types.ts

@@ -181,3 +181,14 @@ export const Destinations = {
  TASKLIST: 'back-to-task-list',
  CHECK_YOUR_ANSWERS: 'check-your-answers',
 }
+


types acceptable to locationsInsidePrisonApi

GurnankCheema · 2024-09-17T16:25:05Z

server/data/draftReportClient.ts

@@ -94,7 +94,7 @@ export default class DraftReportClient {
  async getDuplicateReports(bookingId: number, [startDate, endDate]: DateRange): Promise<OffenderReport[]> {
    const results = await this.query({
      text: `select r.incident_date date


now when making a new report it will be incidentLocationId that will be persisted (although locationId may also be persisted if the code change is deployed while a report is partly completed)

GurnankCheema · 2024-09-17T16:25:59Z

server/data/locationClient.ts

+
+export default class LocationClient {
+  constructor(private restClient: RestClient) {}
+


UUID must be 36 chars long including hyphens.
if undefined is returned then the front end will not display a dash rather the location description

GurnankCheema · 2024-09-17T16:28:23Z

server/data/locationClientTypes.ts

@@ -0,0 +1,7 @@
+export interface LocationInPrison {


there are other values returned in the locationApi response but these 4 are the only things of value to UoF.

GurnankCheema · 2024-09-17T16:29:50Z

server/data/nomisMappingClient.ts

+export default class NomisMappingClient {
+  constructor(private restClient: RestClient) {}
+
+  async getDpsLocationMappingUsingNomisLocationId(nomisLocationId: number): Promise<LocationMapping> {


getting the location's id from the locationsInsidePrisonApi but using the Nomis version of the id

GurnankCheema added 5 commits September 12, 2024 15:38

MAP-1548 switch to getting location data from locations api rather th…

ed63ae0

…an prison api

MAP-1548 update wiremock dependency

c432422

MAP-1548 fix e2e breaking tests

c924007

and make TODO more understandable and correct unit test and remove uneccesary config

MAP-1548 add further e2e tests

5911e3f

MAP-1548 fix potential issue if only only locationId exists and user …

26d78a1

…has already reached check-your-answers page

GurnankCheema commented Sep 17, 2024

View reviewed changes

Mjwillis approved these changes Sep 17, 2024

View reviewed changes

GurnankCheema commented Sep 17, 2024

View reviewed changes

GurnankCheema merged commit 8b4b9c7 into main Sep 17, 2024
9 checks passed

GurnankCheema deleted the MAP-1548-UoF-use-locations-api-to-get-location-data branch September 17, 2024 16:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Map 1548 uof use locations api to get location data #712

Map 1548 uof use locations api to get location data #712

GurnankCheema commented Sep 16, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024

Mjwillis left a comment

GurnankCheema Sep 17, 2024

GurnankCheema Sep 17, 2024

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024

		@@ -30,6 +30,12 @@ context('Check your answers page', () => {
		cy.login()
		})


		export default class LocationClient {
		constructor(private restClient: RestClient) {}

Map 1548 uof use locations api to get location data #712

Map 1548 uof use locations api to get location data #712

Conversation

GurnankCheema commented Sep 16, 2024 • edited Loading

GurnankCheema Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

Mjwillis left a comment

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

GurnankCheema Sep 17, 2024

Choose a reason for hiding this comment

GurnankCheema commented Sep 16, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading

GurnankCheema Sep 17, 2024 •

edited

Loading