Move out incentive level additional information from polymorphic doma…

…in event field
ministryofjustice · Apr 4, 2023 · 23814db · 23814db
1 parent 0f65743
commit 23814db
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 34 deletions.
diff --git a/...kotlin/uk/gov/justice/digital/hmpps/incentivesapi/service/IncentiveLevelAuditedService.kt b/...kotlin/uk/gov/justice/digital/hmpps/incentivesapi/service/IncentiveLevelAuditedService.kt
@@ -62,7 +62,7 @@ class IncentiveLevelAuditedService(
       IncentivesDomainEventType.INCENTIVE_LEVEL_CHANGED,
       "An incentive level has been changed: $levelCode",
       occurredAt = LocalDateTime.now(clock),
-      AdditionalInformation(
+      IncentiveLevelRef(
         incentiveLevel = levelCode,
       ),
     )
@@ -77,3 +77,5 @@ class IncentiveLevelAuditedService(
     )
   }
 }
+
+data class IncentiveLevelRef(val incentiveLevel: String)
diff --git a/.../uk/gov/justice/digital/hmpps/incentivesapi/service/PrisonIncentiveLevelAuditedService.kt b/.../uk/gov/justice/digital/hmpps/incentivesapi/service/PrisonIncentiveLevelAuditedService.kt
@@ -47,10 +47,12 @@ class PrisonIncentiveLevelAuditedService(
       IncentivesDomainEventType.INCENTIVE_PRISON_LEVEL_CHANGED,
       "Incentive level (${prisonIncentiveLevel.levelCode}) in prison ${prisonIncentiveLevel.prisonId} has been updated",
       occurredAt = LocalDateTime.now(clock),
-      AdditionalInformation(
+      PrisonIncentiveLevelRef(
         incentiveLevel = prisonIncentiveLevel.levelCode,
         prisonId = prisonIncentiveLevel.prisonId,
       ),
     )
   }
 }
+
+data class PrisonIncentiveLevelRef(val incentiveLevel: String, val prisonId: String)
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/incentivesapi/service/SnsService.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/incentivesapi/service/SnsService.kt
@@ -64,8 +64,6 @@ data class AdditionalInformation(
   val bookingId: Long? = null,
   val alertsAdded: List<String>? = null,
   val alertsRemoved: List<String>? = null,
-  val incentiveLevel: String? = null,
-  val prisonId: String? = null,
 )
 
 data class HMPPSDomainEvent<T>(

diff --git a/.../uk/gov/justice/digital/hmpps/incentivesapi/integration/IncentiveLevelResourceTestBase.kt b/.../uk/gov/justice/digital/hmpps/incentivesapi/integration/IncentiveLevelResourceTestBase.kt
@@ -17,6 +17,8 @@ import uk.gov.justice.digital.hmpps.incentivesapi.jpa.repository.PrisonIncentive
 import uk.gov.justice.digital.hmpps.incentivesapi.service.AuditEvent
 import uk.gov.justice.digital.hmpps.incentivesapi.service.HMPPSDomainEvent
 import uk.gov.justice.digital.hmpps.incentivesapi.service.HMPPSMessage
+import uk.gov.justice.digital.hmpps.incentivesapi.service.IncentiveLevelRef
+import uk.gov.justice.digital.hmpps.incentivesapi.service.PrisonIncentiveLevelRef
 import java.time.Clock
 import java.time.Instant
 import java.time.LocalDateTime
@@ -76,15 +78,19 @@ class IncentiveLevelResourceTestBase : SqsIntegrationTestBase() {
     assertThat(queueSize).isEqualTo(0)
   }
 
-  protected fun assertDomainEventSent(eventType: String): HMPPSDomainEvent<Map<String, *>?> {
+  protected val anyDomainEvent = object : TypeReference<HMPPSDomainEvent<Any?>>() {}
+  protected val incentiveLevelDomainEvent = object : TypeReference<HMPPSDomainEvent<IncentiveLevelRef>>() {}
+  protected val prisonIncentiveLevelDomainEvent = object : TypeReference<HMPPSDomainEvent<PrisonIncentiveLevelRef>>() {}
+
+  protected fun <T> assertDomainEventSent(eventType: String, typeReference: TypeReference<HMPPSDomainEvent<T>>): HMPPSDomainEvent<T> {
     val sqsClient = incentivesQueue.sqsClient
     val queueSize = sqsClient.getApproxQueueSize(testDomainEventQueueUrl!!)
     assertThat(queueSize).isEqualTo(1)
 
     val body = sqsClient.receiveMessage(testDomainEventQueueUrl).messages[0].body
     val (message, attributes) = objectMapper.readValue(body, HMPPSMessage::class.java)
     assertThat(attributes.eventType.Value).isEqualTo(eventType)
-    val domainEvent = objectMapper.readValue(message, object : TypeReference<HMPPSDomainEvent<Map<String, *>?>>() {})
+    val domainEvent = objectMapper.readValue(message, typeReference)
     assertThat(domainEvent.eventType).isEqualTo(eventType)
 
     return domainEvent

diff --git a/.../kotlin/uk/gov/justice/digital/hmpps/incentivesapi/resource/IncentiveLevelResourceTest.kt b/.../kotlin/uk/gov/justice/digital/hmpps/incentivesapi/resource/IncentiveLevelResourceTest.kt
@@ -186,9 +186,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(prisonIncentiveLevelRepository.count()).isEqualTo(0)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: EN4")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("EN4")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("EN4")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_ADDED").let {
         assertThat(it["code"]).isEqualTo("EN4")
@@ -442,7 +442,7 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         }
       }
 
-      assertDomainEventSent("incentives.levels.reordered").let {
+      assertDomainEventSent("incentives.levels.reordered", anyDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive levels have been re-ordered")
         assertThat(it.additionalInformation).isNull()
       }
@@ -581,9 +581,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(incentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: STD")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("STD")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("STD")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it["description"]).isEqualTo("Silver")
@@ -823,9 +823,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(incentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: STD")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("STD")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("STD")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it["description"]).isEqualTo("Silver")
@@ -974,9 +974,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(incentiveLevel?.whenUpdated).isNotEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: ENH")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("ENH")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("ENH")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it["code"]).isEqualTo("ENH")
@@ -1063,9 +1063,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(incentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: EN2")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("EN2")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("EN2")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it["code"]).isEqualTo("EN2")
@@ -1095,9 +1095,9 @@ class IncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(incentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.level.changed").let {
+      assertDomainEventSent("incentives.level.changed", incentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("An incentive level has been changed: ENT")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("ENT")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("ENT")
       }
       assertAuditMessageSentWithMap("INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it["code"]).isEqualTo("ENT")

diff --git a/...n/uk/gov/justice/digital/hmpps/incentivesapi/resource/PrisonIncentiveLevelResourceTest.kt b/...n/uk/gov/justice/digital/hmpps/incentivesapi/resource/PrisonIncentiveLevelResourceTest.kt
@@ -210,10 +210,10 @@ class PrisonIncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(prisonIncentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.prison-level.changed").let {
+      assertDomainEventSent("incentives.prison-level.changed", prisonIncentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive level (STD) in prison MDI has been updated")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("STD")
-        assertThat(it.additionalInformation?.get("prisonId")).isEqualTo("MDI")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("STD")
+        assertThat(it.additionalInformation.prisonId).isEqualTo("MDI")
       }
       assertAuditMessageSentWithMap("PRISON_INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it).containsAllEntriesOf(
@@ -278,10 +278,10 @@ class PrisonIncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(defaultLevelCodes).isEqualTo(listOf("WRI" to "ENH"))
       }
 
-      assertDomainEventSent("incentives.prison-level.changed").let {
+      assertDomainEventSent("incentives.prison-level.changed", prisonIncentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive level (ENH) in prison WRI has been updated")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("ENH")
-        assertThat(it.additionalInformation?.get("prisonId")).isEqualTo("WRI")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("ENH")
+        assertThat(it.additionalInformation.prisonId).isEqualTo("WRI")
       }
       assertAuditMessageSentWithMap("PRISON_INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it).containsAllEntriesOf(
@@ -632,10 +632,10 @@ class PrisonIncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(prisonIncentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.prison-level.changed").let {
+      assertDomainEventSent("incentives.prison-level.changed", prisonIncentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive level (BAS) in prison BAI has been updated")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("BAS")
-        assertThat(it.additionalInformation?.get("prisonId")).isEqualTo("BAI")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("BAS")
+        assertThat(it.additionalInformation.prisonId).isEqualTo("BAI")
       }
       assertAuditMessageSentWithMap("PRISON_INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it).containsAllEntriesOf(
@@ -699,10 +699,10 @@ class PrisonIncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(defaultLevelCodes).isEqualTo(listOf("WRI" to "ENH"))
       }
 
-      assertDomainEventSent("incentives.prison-level.changed").let {
+      assertDomainEventSent("incentives.prison-level.changed", prisonIncentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive level (ENH) in prison WRI has been updated")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("ENH")
-        assertThat(it.additionalInformation?.get("prisonId")).isEqualTo("WRI")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("ENH")
+        assertThat(it.additionalInformation.prisonId).isEqualTo("WRI")
       }
       assertAuditMessageSentWithMap("PRISON_INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it).containsAllEntriesOf(
@@ -1000,10 +1000,10 @@ class PrisonIncentiveLevelResourceTest : IncentiveLevelResourceTestBase() {
         assertThat(prisonIncentiveLevel?.whenUpdated).isEqualTo(now)
       }
 
-      assertDomainEventSent("incentives.prison-level.changed").let {
+      assertDomainEventSent("incentives.prison-level.changed", prisonIncentiveLevelDomainEvent).let {
         assertThat(it.description).isEqualTo("Incentive level (EN2) in prison WRI has been updated")
-        assertThat(it.additionalInformation?.get("incentiveLevel")).isEqualTo("EN2")
-        assertThat(it.additionalInformation?.get("prisonId")).isEqualTo("WRI")
+        assertThat(it.additionalInformation.incentiveLevel).isEqualTo("EN2")
+        assertThat(it.additionalInformation.prisonId).isEqualTo("WRI")
       }
       assertAuditMessageSentWithMap("PRISON_INCENTIVE_LEVEL_UPDATED").let {
         assertThat(it).containsAllEntriesOf(