Prevent publishing of excluded events (#222)

Author: anthony-britton-moj

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/domain/tap/authorisation/TemporaryAbsenceAuthorisation.kt

@@ -206,11 +206,7 @@ class TemporaryAbsenceAuthorisation(
     appliedActions = listOf()
   }
 
-  override fun domainEvents(): Set<DomainEvent<*>> {
-    val events = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
-    appliedActions = emptyList()
-    return events
-  }
+  override fun domainEvents(): Set<DomainEvent<*>> = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
 
   fun applyPrisonPerson(action: ChangePrisonPerson, person: (String) -> PersonSummary) {
     this.person = person(action.personIdentifier)

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/domain/tap/movement/TemporaryAbsenceMovement.kt

@@ -144,11 +144,7 @@ class TemporaryAbsenceMovement(
     appliedActions = listOf()
   }
 
-  override fun domainEvents(): Set<DomainEvent<*>> {
-    val events = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
-    appliedActions = emptyList()
-    return events
-  }
+  override fun domainEvents(): Set<DomainEvent<*>> = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
 
   override fun initialEvent(): DomainEvent<*> = when (direction) {
     Direction.OUT -> TemporaryAbsenceStarted(person.identifier, id, occurrence?.id)

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/domain/tap/occurrence/TemporaryAbsenceOccurrence.kt

@@ -238,11 +238,7 @@ class TemporaryAbsenceOccurrence(
     appliedActions = listOf()
   }
 
-  override fun domainEvents(): Set<DomainEvent<*>> {
-    val events = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
-    appliedActions = emptyList()
-    return events
-  }
+  override fun domainEvents(): Set<DomainEvent<*>> = appliedActions.mapNotNull { it.domainEvent(this) }.toSet()
 
   override fun excludeFromPublish(): Set<String> = setOf(
     TemporaryAbsenceStarted.EVENT_TYPE,

src/test/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/integration/tap/occurrence/ChangeOccurrenceCommentsIntTest.kt

@@ -14,6 +14,8 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.context.ExternalMovemen
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.IdGenerator.newUuid
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.TemporaryAbsenceAuthorisation
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.occurrence.TemporaryAbsenceOccurrence
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.referencedata.AuthorisationStatus
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.referencedata.OccurrenceStatus
 import uk.gov.justice.digital.hmpps.externalmovementsapi.events.HmppsDomainEvent
 import uk.gov.justice.digital.hmpps.externalmovementsapi.events.TemporaryAbsenceAuthorisationCommentsChanged
 import uk.gov.justice.digital.hmpps.externalmovementsapi.events.TemporaryAbsenceCommentsChanged
@@ -94,6 +96,43 @@ class ChangeOccurrenceCommentsIntTest(
     )
   }
 
+  @Test
+  fun `200 ok single tap occurrence comments updated - no publish`() {
+    val auth = givenTemporaryAbsenceAuthorisation(temporaryAbsenceAuthorisation(status = AuthorisationStatus.Code.PENDING))
+    val occurrence = givenTemporaryAbsenceOccurrence(temporaryAbsenceOccurrence(auth))
+    assertThat(occurrence.status.code).isEqualTo(OccurrenceStatus.Code.PENDING.name)
+
+    val request = action()
+    val res = applyOccurrenceComments(occurrence.id, request).successResponse<AuditHistory>().content.single()
+    assertThat(res.domainEvents).containsExactly(TemporaryAbsenceCommentsChanged.EVENT_TYPE)
+    assertThat(res.reason).isEqualTo(request.reason)
+    assertThat(res.changes).containsExactly(AuditedAction.Change("comments", occurrence.comments, request.comments))
+
+    val saved = requireNotNull(findTemporaryAbsenceOccurrence(occurrence.id))
+    assertThat(saved.comments).isEqualTo(request.comments)
+    assertThat(saved.authorisation.comments).isEqualTo(request.comments)
+
+    verifyAudit(
+      saved,
+      RevisionType.MOD,
+      setOf(
+        TemporaryAbsenceOccurrence::class.simpleName!!,
+        TemporaryAbsenceAuthorisation::class.simpleName!!,
+        HmppsDomainEvent::class.simpleName!!,
+      ),
+      ExternalMovementContext.get().copy(username = DEFAULT_USERNAME, reason = request.reason),
+    )
+
+    // TODO: Check these are not published
+    verifyEvents(
+      saved,
+      setOf(
+        TemporaryAbsenceCommentsChanged(occurrence.authorisation.person.identifier, occurrence.id),
+        TemporaryAbsenceAuthorisationCommentsChanged(auth.person.identifier, auth.id),
+      ),
+    )
+  }
+
   @Test
   fun `200 ok repeat tap occurrence comments updated successfully`() {
     val auth = givenTemporaryAbsenceAuthorisation(temporaryAbsenceAuthorisation(repeat = true))