Hia 745 bug v 1 persons hmpps id response is returning addresses in contact details when it shouldnt (#428)

popey2700 · web-flow · commit 6bc0cb1c7ce0 · 2024-05-21T13:15:59.000+01:00
* Fix Bug with Persons Model
diff --git a/.gitignore b/.gitignore
@@ -86,3 +86,6 @@ __pycache__/
 *.key
 *.csr
 *.pem
+
+# Localstack
+localstack/cache
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/ProbationOffenderSearchGateway.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/ProbationOffenderSearchGateway.kt
@@ -11,6 +11,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.ContactDetailsWithAddress
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.Offender
 
 @Component
@@ -116,8 +117,26 @@ class ProbationOffenderSearchGateway(
   }
 
   fun getAddressesForPerson(hmppsId: String): Response<List<Address>> {
-    val offender = getOffender(hmppsId)
-    return Response(data = offender.data?.contactDetails?.addresses.orEmpty().map { it.toAddress() }, errors = offender.errors)
+    val result =
+      webClient.requestList<ContactDetailsWithAddress>(
+        HttpMethod.POST,
+        "/search",
+        authenticationHeader(),
+        UpstreamApi.PROBATION_OFFENDER_SEARCH,
+        mapOf("crn" to hmppsId),
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        return Response(result.data.firstOrNull()?.contactDetails?.addresses.orEmpty().map { it.toAddress() })
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = emptyList(),
+          errors = result.errors,
+        )
+      }
+    }
   }
 
   private fun authenticationHeader(): Map<String, String> {
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/ContactDetailsWithEmailAndPhone.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/ContactDetailsWithEmailAndPhone.kt
@@ -1,9 +1,6 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
 
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.Address
-
 data class ContactDetailsWithEmailAndPhone(
-  val addresses: List<Address>?,
   val phoneNumbers: List<PhoneNumber>?,
   val emails: List<String>?,
 )
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Address.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Address.kt
@@ -1,7 +1,15 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch
 
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Address
 import java.time.LocalDate
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Address as HmppsAddress
+
+data class ContactDetailsWithAddress(
+  val contactDetails: Addresses? = null,
+)
+
+data class Addresses(
+  val addresses: List<Address>? = listOf(),
+)
 
 data class Address(
   val addressNumber: String?,
@@ -18,7 +26,7 @@ data class Address(
   val notes: String?,
 ) {
   fun toAddress() =
-    Address(
+    HmppsAddress(
       country = null,
       county = this.county,
       endDate = this.to,
@@ -39,7 +47,7 @@ data class Address(
     val description: String?,
   ) {
     fun toAddressType() =
-      Address.Type(
+      HmppsAddress.Type(
         code = this.code,
         description = this.description ?: this.code,
       )
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetails.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetails.kt
@@ -1,5 +1,15 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch
 
-open class ContactDetails(
-  open val addresses: List<Address>? = listOf(),
-)
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PhoneNumber
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ContactDetailsWithEmailAndPhone as PersonContactDetails
+
+class ContactDetails(
+  val phoneNumbers: List<PhoneNumber>?,
+  val emailAddresses: List<String>?,
+) {
+  fun toContactDetails(): PersonContactDetails =
+    PersonContactDetails(
+      phoneNumbers = this.phoneNumbers,
+      emails = this.emailAddresses,
+    )
+}
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetailsWithEmailAndPhone.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetailsWithEmailAndPhone.kt
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Offender.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Offender.kt
@@ -13,7 +13,7 @@ data class Offender(
   val gender: String? = null,
   val offenderProfile: OffenderProfile = OffenderProfile(),
   val offenderAliases: List<OffenderAlias> = listOf(),
-  val contactDetails: ContactDetailsWithEmailAndPhone? = null,
+  val contactDetails: ContactDetails? = null,
   val otherIds: OtherIds = OtherIds(),
   val age: Number = 0,
 ) {
@@ -34,7 +34,7 @@ data class Offender(
         ),
       pncId = otherIds.pncNumber,
       hmppsId = otherIds.crn,
-      contactDetails = this.contactDetails?.toContactdetails(),
+      contactDetails = this.contactDetails?.toContactDetails(),
     )
 
   fun toPersonProtectedCharacteristics(): PersonProtectedCharacteristics =
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonControllerTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonControllerTest.kt
@@ -76,14 +76,14 @@ internal class PersonControllerTest(
                     lastName = "Allen",
                     middleName = "Jonas",
                     dateOfBirth = LocalDate.parse("2023-03-01"),
-                    contactDetails = ContactDetailsWithEmailAndPhone(emptyList(), phoneNumbers, emails),
+                    contactDetails = ContactDetailsWithEmailAndPhone(phoneNumbers, emails),
                   ),
                   Person(
                     firstName = "Barry",
                     lastName = "Allen",
                     middleName = "Rock",
                     dateOfBirth = LocalDate.parse("2022-07-22"),
-                    contactDetails = ContactDetailsWithEmailAndPhone(emptyList(), phoneNumbers, emails),
+                    contactDetails = ContactDetailsWithEmailAndPhone(phoneNumbers, emails),
                   ),
                 ),
             ),
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/probationoffendersearch/GetAddressesForPersonTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/probationoffendersearch/GetAddressesForPersonTest.kt
@@ -29,17 +29,15 @@ class GetAddressesForPersonTest(
 ) : DescribeSpec(
     {
       val probationOffenderSearchApiMockServer = ProbationOffenderSearchApiMockServer()
-      val hmppsId = "2002/1121M"
+      val hmppsId = "X777776"
 
       beforeEach {
         probationOffenderSearchApiMockServer.start()
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
-            "firstName": "English",
-            "surname": "Breakfast",
             "contactDetails": {
               "addresses": [
                 {
@@ -102,7 +100,7 @@ class GetAddressesForPersonTest(
 
       it("returns an empty list when no addresses are found") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
@@ -123,7 +121,7 @@ class GetAddressesForPersonTest(
 
       it("returns an error when no results are returned") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           "[]",
         )
 
@@ -134,7 +132,7 @@ class GetAddressesForPersonTest(
 
       it("returns an empty list when there is no contactDetails field") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
@@ -152,7 +150,7 @@ class GetAddressesForPersonTest(
 
       it("returns an empty list when contactDetails field is null") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
@@ -171,7 +169,7 @@ class GetAddressesForPersonTest(
 
       it("returns an empty list when contactDetails.addresses field is null") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
@@ -192,7 +190,7 @@ class GetAddressesForPersonTest(
 
       it("returns an empty list when the type is an empty object") {
         probationOffenderSearchApiMockServer.stubPostOffenderSearch(
-          "{\"pncNumber\": \"$hmppsId\"}",
+          "{\"crn\": \"$hmppsId\"}",
           """
         [
           {
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/smoke/person/PersonSmokeTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/smoke/person/PersonSmokeTest.kt
@@ -44,89 +44,72 @@ class PersonSmokeTest : DescribeSpec(
 
       response.body().shouldBe(
         """
-  {
-   "data":{
-      "prisonerOffenderSearch":{
-         "firstName":"Robert",
-         "lastName":"Larsen",
-         "middleName":"John James",
-         "dateOfBirth":"1975-04-02",
-         "gender":"Female",
-         "ethnicity":"White: Eng./Welsh/Scot./N.Irish/British",
-         "aliases":[
-            {
-               "firstName":"Robert",
-               "lastName":"Lorsen",
-               "middleName":"Trevor",
-               "dateOfBirth":"1975-04-02",
-               "gender":"Male",
-               "ethnicity":"White : Irish"
-            }
-         ],
-         "identifiers":{
-            "nomisNumber":"A1234AA",
-            "croNumber":"29906/12J",
-            "deliusCrn":null
-         },
-         "pncId":"12/394773H",
-         "hmppsId":null,
-         "contactDetails":null
-      },
-      "probationOffenderSearch":{
-         "firstName":"string",
-         "lastName":"string",
-         "middleName":"string",
-         "dateOfBirth":"2019-08-24",
-         "gender":"string",
-         "ethnicity":"string",
-         "aliases":[
-            {
-               "firstName":"string",
-               "lastName":"string",
-               "middleName":"string",
-               "dateOfBirth":"2019-08-24",
-               "gender":"string",
-               "ethnicity":null
+        {
+            "data": {
+                "prisonerOffenderSearch": {
+                    "firstName": "Robert",
+                    "lastName": "Larsen",
+                    "middleName": "John James",
+                    "dateOfBirth": "1975-04-02",
+                    "gender": "Female",
+                    "ethnicity": "White: Eng./Welsh/Scot./N.Irish/British",
+                    "aliases": [
+                        {
+                            "firstName": "Robert",
+                            "lastName": "Lorsen",
+                            "middleName": "Trevor",
+                            "dateOfBirth": "1975-04-02",
+                            "gender": "Male",
+                            "ethnicity": "White : Irish"
+                        }
+                    ],
+                    "identifiers": {
+                        "nomisNumber": "A1234AA",
+                        "croNumber": "29906/12J",
+                        "deliusCrn": null
+                    },
+                    "pncId": "12/394773H",
+                    "hmppsId": null,
+                    "contactDetails": null
+                },
+                "probationOffenderSearch": {
+                    "firstName": "string",
+                    "lastName": "string",
+                    "middleName": "string",
+                    "dateOfBirth": "2019-08-24",
+                    "gender": "string",
+                    "ethnicity": "string",
+                    "aliases": [
+                        {
+                            "firstName": "string",
+                            "lastName": "string",
+                            "middleName": "string",
+                            "dateOfBirth": "2019-08-24",
+                            "gender": "string",
+                            "ethnicity": null
+                        }
+                    ],
+                    "identifiers": {
+                        "nomisNumber": "G5555TT",
+                        "croNumber": "123456/24A",
+                        "deliusCrn": "A123456"
+                    },
+                    "pncId": "2012/0052494Q",
+                    "hmppsId": "A123456",
+                    "contactDetails": {
+                        "phoneNumbers": [
+                            {
+                                "number": "string",
+                                "type": "TELEPHONE"
+                            }
+                        ],
+                        "emails": [
+                            "string"
+                        ]
+                    }
+                }
             }
-         ],
-         "identifiers":{
-            "nomisNumber":"G5555TT",
-            "croNumber":"123456/24A",
-            "deliusCrn":"A123456"
-         },
-         "pncId":"2012/0052494Q",
-         "hmppsId":"A123456",
-         "contactDetails":{
-            "addresses":[
-               {
-                  "addressNumber":"string",
-                  "district":"string",
-                  "buildingName":"string",
-                  "county":"string",
-                  "from":"2019-08-24",
-                  "postcode":"string",
-                  "streetName":"string",
-                  "type":{
-                     "code":"string",
-                     "description":"string"
-                  },
-                  "to":"2019-08-24",
-                  "town":"string",
-                  "noFixedAbode":true,
-                  "notes":"string"
-               }
-            ],
-            "phoneNumbers":[
-               {
-                  "number":"string",
-                  "type":"TELEPHONE"
-               }
-            ],
-            "emails":null
-         }
-      }
-   }
-}
+        }
     """.removeWhitespaceAndNewlines(),
       )
     }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,6 @@`
`1`	`1`	`package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps`
`2`	`2`
`3`		`-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.Address`
`4`		`-`
`5`	`3`	`data class ContactDetailsWithEmailAndPhone(`
`6`		`- val addresses: List<Address>?,`
`7`	`4`	`val phoneNumbers: List<PhoneNumber>?,`
`8`	`5`	`val emails: List<String>?,`
`9`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -29,17 +29,15 @@ class GetAddressesForPersonTest(`
`29`	`29`	`) : DescribeSpec(`
`30`	`30`	`{`
`31`	`31`	`val probationOffenderSearchApiMockServer = ProbationOffenderSearchApiMockServer()`
`32`		`- val hmppsId = "2002/1121M"`
	`32`	`+ val hmppsId = "X777776"`
`33`	`33`
`34`	`34`	`beforeEach {`
`35`	`35`	`probationOffenderSearchApiMockServer.start()`
`36`	`36`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`37`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`37`	`+ "{\"crn\": \"$hmppsId\"}",`
`38`	`38`	`"""`
`39`	`39`	`[`
`40`	`40`	`{`
`41`		`- "firstName": "English",`
`42`		`- "surname": "Breakfast",`
`43`	`41`	`"contactDetails": {`
`44`	`42`	`"addresses": [`
`45`	`43`	`{`
`@@ -102,7 +100,7 @@ class GetAddressesForPersonTest(`
`102`	`100`
`103`	`101`	`it("returns an empty list when no addresses are found") {`
`104`	`102`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`105`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`103`	`+ "{\"crn\": \"$hmppsId\"}",`
`106`	`104`	`"""`
`107`	`105`	`[`
`108`	`106`	`{`
`@@ -123,7 +121,7 @@ class GetAddressesForPersonTest(`
`123`	`121`
`124`	`122`	`it("returns an error when no results are returned") {`
`125`	`123`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`126`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`124`	`+ "{\"crn\": \"$hmppsId\"}",`
`127`	`125`	`"[]",`
`128`	`126`	`)`
`129`	`127`
`@@ -134,7 +132,7 @@ class GetAddressesForPersonTest(`
`134`	`132`
`135`	`133`	`it("returns an empty list when there is no contactDetails field") {`
`136`	`134`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`137`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`135`	`+ "{\"crn\": \"$hmppsId\"}",`
`138`	`136`	`"""`
`139`	`137`	`[`
`140`	`138`	`{`
`@@ -152,7 +150,7 @@ class GetAddressesForPersonTest(`
`152`	`150`
`153`	`151`	`it("returns an empty list when contactDetails field is null") {`
`154`	`152`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`155`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`153`	`+ "{\"crn\": \"$hmppsId\"}",`
`156`	`154`	`"""`
`157`	`155`	`[`
`158`	`156`	`{`
`@@ -171,7 +169,7 @@ class GetAddressesForPersonTest(`
`171`	`169`
`172`	`170`	`it("returns an empty list when contactDetails.addresses field is null") {`
`173`	`171`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`174`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`172`	`+ "{\"crn\": \"$hmppsId\"}",`
`175`	`173`	`"""`
`176`	`174`	`[`
`177`	`175`	`{`
`@@ -192,7 +190,7 @@ class GetAddressesForPersonTest(`
`192`	`190`
`193`	`191`	`it("returns an empty list when the type is an empty object") {`
`194`	`192`	`probationOffenderSearchApiMockServer.stubPostOffenderSearch(`
`195`		`- "{\"pncNumber\": \"$hmppsId\"}",`
	`193`	`+ "{\"crn\": \"$hmppsId\"}",`
`196`	`194`	`"""`
`197`	`195`	`[`
`198`	`196`	`{`