MIA-1718 typed schedules

Author: anthony-britton-moj

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

@@ -0,0 +1,78 @@
+package uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import com.fasterxml.jackson.annotation.JsonSubTypes
+import com.fasterxml.jackson.annotation.JsonSubTypes.Type
+import com.fasterxml.jackson.annotation.JsonTypeInfo
+import java.time.LocalTime
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
+@JsonSubTypes(
+  value = [
+    Type(value = SingleSchedule::class, name = "SINGLE"),
+    Type(value = FreeFormSchedule::class, name = "FREEFORM"),
+    Type(value = WeeklySchedule::class, name = "WEEKLY"),
+    Type(value = BiWeeklySchedule::class, name = "BIWEEKLY"),
+    Type(value = ShiftSchedule::class, name = "SHIFT"),
+  ],
+)
+sealed interface AuthorisationSchedule {
+  val type: Type
+
+  enum class Type {
+    SINGLE,
+    FREEFORM,
+    WEEKLY,
+    BIWEEKLY,
+    SHIFT,
+  }
+}
+
+data class SingleSchedule(
+  val startTime: LocalTime,
+  val returnTime: LocalTime,
+) : AuthorisationSchedule {
+  override val type = AuthorisationSchedule.Type.SINGLE
+}
+
+data object FreeFormSchedule : AuthorisationSchedule {
+  override val type = AuthorisationSchedule.Type.FREEFORM
+}
+
+data class WeekDayPattern(val day: Int, val overnight: Boolean, val startTime: LocalTime, val returnTime: LocalTime)
+
+data class WeeklySchedule(
+  val weeklyPattern: List<WeekDayPattern> = listOf(),
+  val absencesPerDay: Int? = null,
+) : AuthorisationSchedule {
+  override val type = AuthorisationSchedule.Type.WEEKLY
+}
+
+data class BiWeeklyPattern(val weekA: List<WeekDayPattern> = listOf(), val weekB: List<WeekDayPattern> = listOf())
+
+data class BiWeeklySchedule(
+  @JsonProperty("biweeklyPattern")
+  val biWeeklyPattern: BiWeeklyPattern = BiWeeklyPattern(),
+  val absencesPerDay: Int? = null,
+) : AuthorisationSchedule {
+  override val type = AuthorisationSchedule.Type.BIWEEKLY
+}
+
+data class ShiftPattern(
+  val type: ShiftPattern.Type,
+  val count: Int,
+  val startTime: LocalTime?,
+  val returnTime: LocalTime?,
+) {
+  enum class Type {
+    DAY,
+    NIGHT,
+    REST,
+  }
+}
+
+data class ShiftSchedule(
+  val shiftPattern: List<ShiftPattern> = listOf(),
+) : AuthorisationSchedule {
+  override val type = AuthorisationSchedule.Type.SHIFT
+}

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

@@ -1,6 +1,5 @@
 package uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation
 
-import com.fasterxml.jackson.databind.JsonNode
 import jakarta.persistence.Column
 import jakarta.persistence.Entity
 import jakarta.persistence.Id
@@ -106,7 +105,7 @@ class TemporaryAbsenceAuthorisation(
   end: LocalDate,
   locations: SequencedSet<Location>,
   reasonPath: ReasonPath,
-  schedule: JsonNode?,
+  schedule: AuthorisationSchedule?,
   legacyId: Long?,
   @Id
   @Column(name = "id", nullable = false, updatable = false)
@@ -201,7 +200,7 @@ class TemporaryAbsenceAuthorisation(
 
   @JdbcTypeCode(SqlTypes.JSON)
   @Column(name = "schedule")
-  var schedule: JsonNode? = schedule
+  var schedule: AuthorisationSchedule? = schedule
     private set
 
   @Column(name = "legacy_id")
@@ -338,8 +337,8 @@ class TemporaryAbsenceAuthorisation(
     }
   }
 
-  fun applySchedule(json: JsonNode) = apply {
-    schedule = json
+  fun applySchedule(schedule: AuthorisationSchedule) = apply {
+    this.schedule = schedule
   }
 
   fun applyLegacyId(legacyId: Long) = apply {

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/model/CreateTapAuthorisationRequest.kt

@@ -15,6 +15,7 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.Re
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataKey
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataRequired
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.of
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.AuthorisationSchedule
 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.model.actions.DateRange
@@ -40,6 +41,7 @@ data class CreateTapAuthorisationRequest(
   override val start: LocalDate,
   override val end: LocalDate,
   val contactInformation: String?,
+  val schedule: AuthorisationSchedule?,
   @JsonIgnore
   val submittedAt: LocalDateTime = ExternalMovementContext.get().requestAt,
   @JsonIgnore
@@ -48,7 +50,6 @@ data class CreateTapAuthorisationRequest(
   val approvedAt: LocalDateTime? = if (statusCode == AuthorisationStatus.Code.APPROVED) ExternalMovementContext.get().requestAt else null,
   @JsonIgnore
   val approvedBy: String? = if (statusCode == AuthorisationStatus.Code.APPROVED) ExternalMovementContext.get().username else null,
-  val schedule: JsonNode? = null,
 ) : ReferenceDataRequired,
   DateRange,
   StartAndEnd<LocalDate> {

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/model/TapAuthorisation.kt

@@ -1,7 +1,7 @@
 package uk.gov.justice.digital.hmpps.externalmovementsapi.model
 
-import com.fasterxml.jackson.databind.JsonNode
 import io.swagger.v3.oas.annotations.media.Schema
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.AuthorisationSchedule
 import uk.gov.justice.digital.hmpps.externalmovementsapi.integration.prisonregister.Prison
 import uk.gov.justice.digital.hmpps.externalmovementsapi.model.location.Location
 import uk.gov.justice.digital.hmpps.externalmovementsapi.model.referencedata.CodedDescription
@@ -28,7 +28,7 @@ data class TapAuthorisation(
   val totalOccurrenceCount: Long,
   val occurrences: List<Occurrence>,
   val locations: SequencedSet<Location>,
-  val schedule: JsonNode?,
+  val schedule: AuthorisationSchedule?,
   val comments: String?,
 ) {
   @Schema(name = "TapAuthorisation.Occurrence")

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/sync/internal/ResyncExtensions.kt

@@ -1,9 +1,8 @@
 package uk.gov.justice.digital.hmpps.externalmovementsapi.sync.internal
 
-import com.fasterxml.jackson.databind.ObjectMapper
-import com.fasterxml.jackson.module.kotlin.treeToValue
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataDomain.Code.ABSENCE_REASON_CATEGORY
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.ReferenceDataPaths
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.SingleSchedule
 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.Code.APPROVED
@@ -31,7 +30,6 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.model.actions.occurrenc
 import uk.gov.justice.digital.hmpps.externalmovementsapi.model.location.Location
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.TapAuthorisation
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.TapOccurrence
-import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.write.AuthorisationSchedule
 import java.time.LocalDate.now
 
 internal fun TemporaryAbsenceAuthorisation.applyAbsenceCategorisation(
@@ -105,16 +103,16 @@ internal fun TemporaryAbsenceOccurrence.checkCancellation(request: TapOccurrence
   }
 }
 
-fun TemporaryAbsenceAuthorisation.occurrence(objectMapper: ObjectMapper): TemporaryAbsenceOccurrence? = this.schedule?.let {
-  val schedule = objectMapper.treeToValue<AuthorisationSchedule>(it)
+fun TemporaryAbsenceAuthorisation.occurrence(): TemporaryAbsenceOccurrence? = this.schedule?.takeIf { it is SingleSchedule }?.let {
+  it as SingleSchedule
   TemporaryAbsenceOccurrence(
     authorisation = this,
     absenceType = absenceType,
     absenceSubType = absenceSubType,
     absenceReasonCategory = absenceReasonCategory,
     absenceReason = absenceReason,
-    start = start.atTime(schedule.startTime),
-    end = end.atTime(schedule.returnTime),
+    start = start.atTime(it.startTime),
+    end = end.atTime(it.returnTime),
     contactInformation = null,
     accompaniedBy = accompaniedBy,
     transport = transport,

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/sync/internal/ResyncTapHierarchy.kt

@@ -1,7 +1,6 @@
 package uk.gov.justice.digital.hmpps.externalmovementsapi.sync.internal
 
 import com.fasterxml.jackson.databind.ObjectMapper
-import com.fasterxml.jackson.module.kotlin.treeToValue
 import com.microsoft.applicationinsights.TelemetryClient
 import org.springframework.stereotype.Service
 import org.springframework.transaction.annotation.Transactional
@@ -18,6 +17,7 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.Re
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataRepository
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataRequired
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.ReferenceDataPaths
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.SingleSchedule
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.TemporaryAbsenceAuthorisation
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.TemporaryAbsenceAuthorisationRepository
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.movement.TemporaryAbsenceMovement
@@ -63,7 +63,6 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.MigratedOc
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.TapAuthorisation
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.TapMovement
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.migrate.TapOccurrence
-import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.write.AuthorisationSchedule
 import java.time.LocalDate
 import java.time.LocalDateTime.of
 import java.util.UUID
@@ -264,13 +263,13 @@ class ResyncTapHierarchy(
       .forEach { auth ->
         val authOccurrences = occurrencesByAuthId[auth.id] ?: emptyList()
         if (authOccurrences.isEmpty()) {
-          auth.occurrence(objectMapper)
+          auth.occurrence()
             ?.calculateStatus { code -> rdSupplier(OccurrenceStatus::class, code) as OccurrenceStatus }
             ?.also(occurrenceRepository::save)
         } else {
-          val schedule = auth.schedule?.let { objectMapper.treeToValue<AuthorisationSchedule>(it) }
           // if legacyId is not null this has likely been updated from nomis
-          authOccurrences.single().takeIf { it.dpsOnly }?.updateFrom(auth, rdSupplier, schedule)
+          authOccurrences.single().takeIf { it.dpsOnly }
+            ?.updateFrom(auth, rdSupplier, auth.schedule.takeIf { it is SingleSchedule } as? SingleSchedule)
         }
       }
   }
@@ -307,7 +306,7 @@ class ResyncTapHierarchy(
       comments = comments,
       start = start,
       end = end,
-      schedule = schedule()?.let { objectMapper.valueToTree(it) },
+      schedule = schedule(),
       reasonPath = reasonPath,
       locations = occurrences.mapTo(linkedSetOf()) { it.location }.takeIf { it.isNotEmpty() }
         ?: location?.takeUnless(Location::isNullOrEmpty)?.let { linkedSetOf(it) } ?: linkedSetOf(),
@@ -327,7 +326,7 @@ class ResyncTapHierarchy(
     applyLogistics(request, rdPaths)
     applyComments(ChangeAuthorisationComments(request.comments))
     applyLegacyId(request.legacyId)
-    request.schedule()?.also { applySchedule(objectMapper.valueToTree(it)) }
+    request.schedule()?.also { applySchedule(it) }
     (
       request.occurrences.mapNotNullTo(linkedSetOf()) { it.location.takeUnless(Location::isNullOrEmpty) }
         .takeIf { it.isNotEmpty() }
@@ -403,7 +402,7 @@ class ResyncTapHierarchy(
   private fun TemporaryAbsenceOccurrence.updateFrom(
     authorisation: TemporaryAbsenceAuthorisation,
     rdSupplier: (KClass<out ReferenceData>, String) -> ReferenceData,
-    schedule: AuthorisationSchedule?,
+    schedule: SingleSchedule?,
   ) = apply {
     authorisationPersonAndPrison(authorisation)
     applyAbsenceCategorisation(

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/sync/internal/SyncTapAuthorisation.kt

@@ -1,6 +1,5 @@
 package uk.gov.justice.digital.hmpps.externalmovementsapi.sync.internal
 
-import com.fasterxml.jackson.databind.ObjectMapper
 import org.springframework.data.repository.findByIdOrNull
 import org.springframework.stereotype.Service
 import org.springframework.transaction.annotation.Transactional
@@ -64,7 +63,6 @@ class SyncTapAuthorisation(
   private val referenceDataRepository: ReferenceDataRepository,
   private val authorisationRepository: TemporaryAbsenceAuthorisationRepository,
   private val occurrenceRepository: TemporaryAbsenceOccurrenceRepository,
-  private val objectMapper: ObjectMapper,
 ) {
   fun sync(personIdentifier: String, request: TapAuthorisation): SyncResponse {
     val person = personSummaryService.getWithSave(personIdentifier)
@@ -81,7 +79,7 @@ class SyncTapAuthorisation(
         ExternalMovementContext.get().copy(requestAt = request.created.at, username = request.created.by).set()
         val saved = authorisationRepository.save(request.asEntity(person, rdPaths))
         if (!saved.repeat && saved.schedule != null && saved.status.code !in listOf(APPROVED.name, EXPIRED.name)) {
-          saved.createOccurrence(objectMapper, rdPaths)
+          saved.createOccurrence(rdPaths)
         }
         saved
       }
@@ -145,7 +143,7 @@ class SyncTapAuthorisation(
       end = end,
       locations = location?.takeUnless(Location::isNullOrEmpty)?.let { linkedSetOf(it) } ?: linkedSetOf(),
       reasonPath = reasonPath,
-      schedule = schedule()?.let { objectMapper.valueToTree(it) },
+      schedule = schedule(),
       legacyId = legacyId,
       id = id ?: newUuid(),
     )
@@ -177,15 +175,14 @@ class SyncTapAuthorisation(
         } else {
           occ.updateFrom(this, request, rdPaths)
         }
-      } ?: createOccurrence(objectMapper, rdPaths)
+      } ?: createOccurrence(rdPaths)
     }
   }
 
   private fun TemporaryAbsenceAuthorisation.createOccurrence(
-    objectMapper: ObjectMapper,
     rdPaths: ReferenceDataPaths,
   ) {
-    occurrence(objectMapper)?.calculateStatus { code ->
+    occurrence()?.calculateStatus { code ->
       rdPaths.getReferenceData(OccurrenceStatus::class, code) as OccurrenceStatus
     }?.also(occurrenceRepository::save)
   }
@@ -246,6 +243,6 @@ class SyncTapAuthorisation(
 
   private fun TemporaryAbsenceAuthorisation.checkSchedule(request: TapAuthorisation, rdPaths: ReferenceDataPaths) {
     applyDateRange(ChangeAuthorisationDateRange(request.start, request.end), rdPaths::getReferenceData)
-    request.schedule()?.also { applySchedule(objectMapper.valueToTree(it)) }
+    request.schedule()?.also { applySchedule(it) }
   }
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/sync/migrate/MigrateTapRequest.kt

@@ -11,6 +11,8 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.Re
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataDomain.Code.TRANSPORT
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataRequired
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.of
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.AuthorisationSchedule
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.SingleSchedule
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.movement.TemporaryAbsenceMovement
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.referencedata.AuthorisationStatus
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.referencedata.OccurrenceStatus
@@ -19,7 +21,6 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.events.TemporaryAbsence
 import uk.gov.justice.digital.hmpps.externalmovementsapi.events.TemporaryAbsenceMigrated
 import uk.gov.justice.digital.hmpps.externalmovementsapi.model.location.Location
 import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.AtAndBy
-import uk.gov.justice.digital.hmpps.externalmovementsapi.sync.write.AuthorisationSchedule
 import java.time.LocalDate
 import java.time.LocalDateTime
 import java.time.LocalTime
@@ -94,7 +95,7 @@ data class TapAuthorisation(
   )
 
   fun schedule(): AuthorisationSchedule? = if (!repeat && occurrences.isEmpty()) {
-    AuthorisationSchedule(startTime, endTime)
+    SingleSchedule(startTime, endTime)
   } else {
     null
   }

src/main/kotlin/uk/gov/justice/digital/hmpps/externalmovementsapi/sync/write/AuthorisationSchedule.kt

@@ -10,6 +10,8 @@ import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.Re
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataDomain.Code.TRANSPORT
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.ReferenceDataRequired
 import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.referencedata.of
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.AuthorisationSchedule
+import uk.gov.justice.digital.hmpps.externalmovementsapi.domain.tap.authorisation.SingleSchedule
 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.model.location.Location
@@ -50,7 +52,7 @@ data class TapAuthorisation(
   ) + OccurrenceStatus.Code.entries.map { TAP_OCCURRENCE_STATUS of it.name }
 
   fun schedule(): AuthorisationSchedule? = if (!repeat) {
-    AuthorisationSchedule(startTime, endTime)
+    SingleSchedule(startTime, endTime)
   } else {
     null
   }