add visitReference to cancel message (#772)

Co-authored-by: Tom Watkins <tom.watkins@justice.gov.uk>

Author: emmalanigan

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/CancelVisitRequest.kt

@@ -9,15 +9,19 @@ data class CancelVisitRequest(
   @Schema(description = "Username for user who actioned this request", required = false)
   val actionedBy: String?,
 ) {
-  fun toHmppsMessage(who: String): HmppsMessage =
+  fun toHmppsMessage(
+    who: String,
+    visitReference: String,
+  ): HmppsMessage =
     HmppsMessage(
       eventType = HmppsMessageEventType.VISIT_CANCELLED,
-      messageAttributes = modelToMap(),
+      messageAttributes = modelToMap(visitReference),
       who = who,
     )
 
-  private fun modelToMap(): Map<String, Any?> =
+  private fun modelToMap(visitReference: String): Map<String, Any?> =
     mapOf(
+      "visitReference" to visitReference,
       "cancelOutcome" to this.cancelOutcome,
       "actionedBy" to this.actionedBy,
     )

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/VisitQueueService.kt

@@ -69,7 +69,7 @@ class VisitQueueService(
       return Response(data = null, errors = visitResponse.errors)
     }
 
-    val hmppsMessage = visit.toHmppsMessage(who)
+    val hmppsMessage = visit.toHmppsMessage(who, visitReference)
 
     try {
       val stringifiedMessage = objectMapper.writeValueAsString(hmppsMessage)

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/VisitsIntegrationTest.kt

@@ -210,7 +210,7 @@ class VisitsIntegrationTest : IntegrationTestBase() {
       queueMessages.size.shouldBe(1)
 
       val messageJson = queueMessages[0].body()
-      val expectedMessage = cancelVisitRequest.toHmppsMessage(defaultCn)
+      val expectedMessage = cancelVisitRequest.toHmppsMessage(defaultCn, visitReference)
       messageJson.shouldContainJsonKeyValue("$.eventType", expectedMessage.eventType.eventTypeCode)
       messageJson.shouldContainJsonKeyValue("$.who", defaultCn)
       val objectMapper = jacksonObjectMapper()

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/CancelVisitRequestTest.kt

@@ -11,7 +11,7 @@ class CancelVisitRequestTest :
     {
       it("correctly creates cancel visit queue event") {
         val consumerName = "client-name"
-        val timestamp = "2020-12-04T10:42:43"
+        val visitReference = "v9-d7-ed-7u"
         val cancelVisitRequest =
           CancelVisitRequest(
             cancelOutcome =
@@ -22,12 +22,13 @@ class CancelVisitRequestTest :
             actionedBy = "test-consumer",
           )
 
-        val hmppsMessage = cancelVisitRequest.toHmppsMessage(consumerName)
+        val hmppsMessage = cancelVisitRequest.toHmppsMessage(consumerName, visitReference)
         hmppsMessage.eventType.shouldBe(HmppsMessageEventType.VISIT_CANCELLED)
         hmppsMessage.who.shouldBe(consumerName)
 
         val hmppsMessageString = objectMapper.writeValueAsString(hmppsMessage)
         hmppsMessageString.shouldBeValidJson()
+        hmppsMessageString.shouldContainJsonKeyValue("$.messageAttributes.visitReference", visitReference)
         hmppsMessageString.shouldContainJsonKeyValue("$.messageAttributes.cancelOutcome.text", cancelVisitRequest.cancelOutcome.text)
         hmppsMessageString.shouldContainJsonKeyValue("$.messageAttributes.cancelOutcome.outcomeStatus", cancelVisitRequest.cancelOutcome.outcomeStatus.toString())
       }