VB-5220 - Migrate a prisoner balance

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/controller/NomisSyncController.kt

@@ -13,14 +13,15 @@ import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.bind.annotation.RestController
 import uk.gov.justice.digital.hmpps.visitallocationapi.dto.nomis.VisitAllocationPrisonerMigrationDto
 import uk.gov.justice.digital.hmpps.visitallocationapi.dto.nomis.VisitAllocationPrisonerSyncDto
+import uk.gov.justice.digital.hmpps.visitallocationapi.service.NomisSyncService
 import uk.gov.justice.hmpps.kotlin.common.ErrorResponse
 
 const val VO_NOMIS = "/visits/allocation/prisoner"
 const val VO_PRISONER_MIGRATION: String = "$VO_NOMIS/migrate"
 const val VO_PRISONER_SYNC: String = "$VO_NOMIS/sync"
 
 @RestController
-class NomisSyncController {
+class NomisSyncController(val nomisSyncService: NomisSyncService) {
   @PreAuthorize("hasRole('ROLE_VISIT_ALLOCATION_API__NOMIS_API')")
   @PostMapping(VO_PRISONER_MIGRATION)
   @Operation(
@@ -43,7 +44,10 @@ class NomisSyncController {
       ),
     ],
   )
-  fun migratePrisonerVisitOrders(@RequestBody @Valid visitAllocationPrisonerMigrationDto: VisitAllocationPrisonerMigrationDto): ResponseEntity<Void> = ResponseEntity.status(HttpStatus.OK).build()
+  fun migratePrisonerVisitOrders(@RequestBody @Valid visitAllocationPrisonerMigrationDto: VisitAllocationPrisonerMigrationDto): ResponseEntity<Void> {
+    nomisSyncService.migratePrisoner(visitAllocationPrisonerMigrationDto)
+    return ResponseEntity.status(HttpStatus.OK).build()
+  }
 
   @PreAuthorize("hasRole('ROLE_VISIT_ALLOCATION_API__NOMIS_API')")
   @PostMapping(VO_PRISONER_SYNC)

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/dto/nomis/VisitAllocationPrisonerSyncDto.kt

@@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema
 import jakarta.validation.constraints.NotEmpty
 import jakarta.validation.constraints.NotNull
 import uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis.AdjustmentReasonCode
-import uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis.ChangeSource
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis.ChangeLogSource
 import java.time.LocalDate
 
 data class VisitAllocationPrisonerSyncDto(
@@ -39,7 +39,7 @@ data class VisitAllocationPrisonerSyncDto(
 
   @Schema(description = "The source of the change being made", example = "SYSTEM or STAFF", required = true)
   @field:NotNull
-  val changeSource: ChangeSource,
+  val changeLogSource: ChangeLogSource,
 
   @Schema(description = "Additional information on the sync reason", example = "Manually adjusted for phone credit", required = true)
   @field:NotEmpty

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/ChangeLogType.kt

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.enums
+
+@Suppress("unused")
+enum class ChangeLogType {
+  MIGRATION,
+  // TODO: Add other change types as they're needed.
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/NegativeVisitOrderStatus.kt

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.enums
+
+@Suppress("unused")
+enum class NegativeVisitOrderStatus {
+  USED,
+  REPAID,
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/NegativeVisitOrderType.kt

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.enums
+
+@Suppress("unused")
+enum class NegativeVisitOrderType {
+  NEGATIVE_VO,
+  NEGATIVE_PVO,
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/VisitOrderStatus.kt

@@ -5,6 +5,5 @@ enum class VisitOrderStatus {
   AVAILABLE,
   EXPIRED,
   ACCUMULATED,
-  SCHEDULED,
   USED,
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/nomis/ChangeSource.kt → src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/enums/nomis/ChangeLogSource.kt

@@ -1,7 +1,7 @@
 package uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis
 
 @Suppress("unused")
-enum class ChangeSource {
+enum class ChangeLogSource {
   SYSTEM,
   STAFF,
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/model/entity/ChangeLog.kt

@@ -0,0 +1,41 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.model.entity
+
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.EnumType
+import jakarta.persistence.Enumerated
+import jakarta.persistence.GeneratedValue
+import jakarta.persistence.GenerationType
+import jakarta.persistence.Id
+import jakarta.persistence.Table
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.ChangeLogType
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis.ChangeLogSource
+import java.time.LocalDateTime
+
+@Entity
+@Table(name = "CHANGE_LOG")
+data class ChangeLog(
+  @Id
+  @GeneratedValue(strategy = GenerationType.IDENTITY)
+  val id: Long = 0L,
+
+  @Column(nullable = false)
+  val prisonerId: String,
+
+  @Column(nullable = false)
+  val changeTimestamp: LocalDateTime = LocalDateTime.now(),
+
+  @Column(nullable = false)
+  @Enumerated(EnumType.STRING)
+  val changeType: ChangeLogType,
+
+  @Column(nullable = false)
+  @Enumerated(EnumType.STRING)
+  val changeSource: ChangeLogSource,
+
+  @Column(nullable = false)
+  val userId: String,
+
+  @Column(nullable = false)
+  val comment: String? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/model/entity/NegativeVisitOrder.kt

@@ -0,0 +1,39 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.model.entity
+
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.EnumType
+import jakarta.persistence.Enumerated
+import jakarta.persistence.GeneratedValue
+import jakarta.persistence.GenerationType
+import jakarta.persistence.Id
+import jakarta.persistence.Table
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.NegativeVisitOrderStatus
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.NegativeVisitOrderType
+import java.time.LocalDate
+import java.time.LocalDateTime
+
+@Entity
+@Table(name = "NEGATIVE_VISIT_ORDER")
+data class NegativeVisitOrder(
+  @Id
+  @GeneratedValue(strategy = GenerationType.IDENTITY)
+  val id: Long = 0L,
+
+  @Column(nullable = false)
+  val prisonerId: String,
+
+  @Column(nullable = false)
+  @Enumerated(EnumType.STRING)
+  val status: NegativeVisitOrderStatus,
+
+  @Column(nullable = false)
+  @Enumerated(EnumType.STRING)
+  val type: NegativeVisitOrderType,
+
+  @Column(nullable = false)
+  val createdTimestamp: LocalDateTime = LocalDateTime.now(),
+
+  @Column(nullable = false)
+  val repaidDate: LocalDate? = null,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/model/entity/PrisonerDetails.kt

@@ -0,0 +1,19 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.model.entity
+
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.Id
+import jakarta.persistence.Table
+import java.time.LocalDate
+
+@Entity
+@Table(name = "PRISONER_DETAILS")
+data class PrisonerDetails(
+
+  @Id
+  @Column(nullable = false)
+  val prisonerId: String,
+
+  @Column(nullable = false)
+  val lastAllocatedDate: LocalDate,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/model/entity/VisitOrder.kt

@@ -11,6 +11,7 @@ import jakarta.persistence.Table
 import uk.gov.justice.digital.hmpps.visitallocationapi.enums.VisitOrderStatus
 import uk.gov.justice.digital.hmpps.visitallocationapi.enums.VisitOrderType
 import java.time.LocalDate
+import java.time.LocalDateTime
 
 @Entity
 @Table(name = "VISIT_ORDER")
@@ -31,7 +32,7 @@ data class VisitOrder(
   val status: VisitOrderStatus,
 
   @Column(nullable = false)
-  val createdDate: LocalDate = LocalDate.now(),
+  val createdTimestamp: LocalDateTime = LocalDateTime.now(),
 
   @Column(nullable = false)
   val expiryDate: LocalDate? = null,

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/repository/ChangeLogRepository.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.repository
+
+import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.stereotype.Repository
+import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.ChangeLog
+
+@Repository
+interface ChangeLogRepository : JpaRepository<ChangeLog, Long>

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/repository/NegativeVisitOrderRepository.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.repository
+
+import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.stereotype.Repository
+import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.NegativeVisitOrder
+
+@Repository
+interface NegativeVisitOrderRepository : JpaRepository<NegativeVisitOrder, Long>

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/repository/PrisonerDetailsRepository.kt

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.repository
+
+import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.stereotype.Repository
+import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.PrisonerDetails
+
+@Repository
+interface PrisonerDetailsRepository : JpaRepository<PrisonerDetails, Long>

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/repository/VisitOrderRepository.kt

@@ -8,17 +8,17 @@ import org.springframework.transaction.annotation.Transactional
 import uk.gov.justice.digital.hmpps.visitallocationapi.enums.VisitOrderStatus
 import uk.gov.justice.digital.hmpps.visitallocationapi.enums.VisitOrderType
 import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.VisitOrder
-import java.time.LocalDate
+import java.time.LocalDateTime
 
 @Repository
 interface VisitOrderRepository : JpaRepository<VisitOrder, Long> {
   @Query(
-    "SELECT vo.createdDate FROM VisitOrder vo WHERE vo.prisonerId = :prisonerId AND vo.type = :type ORDER BY vo.createdDate DESC LIMIT 1",
+    "SELECT vo.createdTimestamp FROM VisitOrder vo WHERE vo.prisonerId = :prisonerId AND vo.type = :type ORDER BY vo.createdTimestamp DESC LIMIT 1",
   )
   fun findLastAllocatedDate(
     prisonerId: String,
     type: VisitOrderType,
-  ): LocalDate?
+  ): LocalDateTime?
 
   @Query(
     "SELECT COUNT (vo) FROM VisitOrder vo WHERE vo.prisonerId = :prisonerId AND vo.type = :type AND vo.status = :status",
@@ -40,7 +40,7 @@ interface VisitOrderRepository : JpaRepository<VisitOrder, Long> {
             WHERE prisoner_id = :prisonerId 
               AND type = 'VO'
               AND status = 'ACCUMULATED' 
-            ORDER BY created_date ASC 
+            ORDER BY created_timestamp ASC 
             LIMIT :amount)
     """,
     nativeQuery = true,
@@ -59,7 +59,7 @@ interface VisitOrderRepository : JpaRepository<VisitOrder, Long> {
             WHERE prisoner_id = :prisonerId
               AND type = 'PVO'
               AND status = 'AVAILABLE'
-              AND created_date < CURRENT_DATE - INTERVAL '28 days'
+              AND created_timestamp < CURRENT_TIMESTAMP - INTERVAL '28 days'
     """,
     nativeQuery = true,
   )
@@ -76,7 +76,7 @@ interface VisitOrderRepository : JpaRepository<VisitOrder, Long> {
             WHERE prisoner_id = :prisonerId
               AND type = :#{#type.name()}
               AND status = 'AVAILABLE'
-              AND created_date < CURRENT_DATE - INTERVAL '28 days'
+              AND created_timestamp < CURRENT_TIMESTAMP - INTERVAL '28 days'
     """,
     nativeQuery = true,
   )

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/service/AllocationService.kt

@@ -14,7 +14,6 @@ import uk.gov.justice.digital.hmpps.visitallocationapi.enums.VisitOrderType
 import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.VisitOrder
 import uk.gov.justice.digital.hmpps.visitallocationapi.repository.VisitOrderAllocationPrisonJobRepository
 import uk.gov.justice.digital.hmpps.visitallocationapi.repository.VisitOrderRepository
-import java.time.LocalDate
 import java.time.LocalDateTime
 
 @Transactional
@@ -116,13 +115,13 @@ class AllocationService(
     prisonerId = prisonerId,
     type = type,
     status = VisitOrderStatus.AVAILABLE,
-    createdDate = LocalDate.now(),
+    createdTimestamp = LocalDateTime.now(),
     expiryDate = null,
   )
 
   private fun isDueVO(prisonerId: String): Boolean {
     val lastVODate = visitOrderRepository.findLastAllocatedDate(prisonerId, VisitOrderType.VO)
-    return lastVODate == null || lastVODate <= LocalDate.now().minusDays(14)
+    return lastVODate == null || lastVODate <= LocalDateTime.now().minusDays(14)
   }
 
   private fun isDuePVO(prisonerId: String): Boolean {
@@ -133,7 +132,7 @@ class AllocationService(
       return isDueVO(prisonerId)
     }
 
-    return lastPVODate <= LocalDate.now().minusDays(28)
+    return lastPVODate <= LocalDateTime.now().minusDays(28)
   }
 
   private fun generateVos(prisoner: PrisonerDto, prisonIncentivesForPrisonerLevel: PrisonIncentiveAmountsDto): List<VisitOrder> {

src/main/kotlin/uk/gov/justice/digital/hmpps/visitallocationapi/service/ChangeLogService.kt

@@ -0,0 +1,32 @@
+package uk.gov.justice.digital.hmpps.visitallocationapi.service
+
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import org.springframework.stereotype.Service
+import org.springframework.transaction.annotation.Transactional
+import uk.gov.justice.digital.hmpps.visitallocationapi.dto.nomis.VisitAllocationPrisonerMigrationDto
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.ChangeLogType
+import uk.gov.justice.digital.hmpps.visitallocationapi.enums.nomis.ChangeLogSource
+import uk.gov.justice.digital.hmpps.visitallocationapi.model.entity.ChangeLog
+import uk.gov.justice.digital.hmpps.visitallocationapi.repository.ChangeLogRepository
+
+@Transactional
+@Service
+class ChangeLogService(private val changeLogRepository: ChangeLogRepository) {
+  companion object {
+    val LOG: Logger = LoggerFactory.getLogger(this::class.java)
+  }
+
+  fun logMigrationChange(migrationChangeDto: VisitAllocationPrisonerMigrationDto) {
+    LOG.info("Logging change to change_log table for prisoner ${migrationChangeDto.prisonerId}, change - $migrationChangeDto")
+    changeLogRepository.save(
+      ChangeLog(
+        prisonerId = migrationChangeDto.prisonerId,
+        changeType = ChangeLogType.MIGRATION,
+        changeSource = ChangeLogSource.SYSTEM,
+        userId = "SYSTEM",
+        comment = "migrated prisoner ${migrationChangeDto.prisonerId}, with vo balance ${migrationChangeDto.voBalance} and pvo balance ${migrationChangeDto.pvoBalance} and lastAllocatedDate ${migrationChangeDto.lastVoAllocationDate}",
+      ),
+    )
+  }
+}