OV-467 - Review comments incorporated

Author: sankhajuria

src/main/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/facade/OfficialVisitFacade.kt

@@ -71,9 +71,10 @@ class OfficialVisitFacade(
   fun searchForOfficialVisitSummaries(
     prisonCode: String,
     request: OfficialVisitSummarySearchRequest,
+    user: User,
     page: Int,
     size: Int,
-  ) = officialVisitSearchService.searchForOfficialVisitSummaries(prisonCode, request, page, size)
+  ) = officialVisitSearchService.searchForOfficialVisitSummaries(prisonCode, request, user, page, size)
 
   fun completeOfficialVisit(
     prisonCode: String,

src/main/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/resource/OfficialVisitController.kt

@@ -141,7 +141,8 @@ class OfficialVisitController(private val facade: OfficialVisitFacade) {
       schema = Schema(type = "integer", defaultValue = "10"),
     )
     size: Int = 20,
-  ): PagedModel<OfficialVisitSummarySearchResponse> = facade.searchForOfficialVisitSummaries(prisonCode, request, page, size)
+    httpRequest: HttpServletRequest,
+  ): PagedModel<OfficialVisitSummarySearchResponse> = facade.searchForOfficialVisitSummaries(prisonCode, request, httpRequest.getLocalRequestContext().user, page, size)
 
   @Operation(summary = "Completes an official visit.")
   @ApiResponses(

src/main/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/service/OfficialVisitSearchService.kt

@@ -31,7 +31,7 @@ class OfficialVisitSearchService(
   private val prisonerVisitedRepository: PrisonerVisitedRepository,
   private val metricsService: MetricsService,
 ) {
-  fun searchForOfficialVisitSummaries(prisonCode: String, request: OfficialVisitSummarySearchRequest, page: Int, size: Int): PagedModel<OfficialVisitSummarySearchResponse> = run {
+  fun searchForOfficialVisitSummaries(prisonCode: String, request: OfficialVisitSummarySearchRequest, user: User, page: Int, size: Int): PagedModel<OfficialVisitSummarySearchResponse> = run {
     require(request.endDate!! >= request.startDate) { "End date must be on or after the start date" }
     require(page >= 0) { "Page number must be greater than or equal to zero" }
     require(size > 0) { "Page size must be greater than zero" }
@@ -60,6 +60,7 @@ class OfficialVisitSearchService(
       eventType = MetricsEvents.SEARCH,
       info = SearchInfo(
         prisonCode = prisonCode,
+        username = user.username,
         startDate = request.startDate,
         searchTerm = mayBeSearchTerm.orEmpty(),
         endDate = request.endDate,

src/main/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/service/metrics/MetricsEvents.kt

@@ -132,11 +132,12 @@ data class VisitMetricInfo(
 
 data class SearchInfo(
   override val prisonCode: String,
+  override val username: String,
   val startDate: LocalDate,
   val searchTerm: String? = null,
   val endDate: LocalDate,
   val visitTypes: List<VisitType>?,
   val locationIds: List<UUID>?,
   val visitStatuses: List<VisitStatusType>?,
   val numberOfResults: Int = 0,
-) : MetricInfo(username = "", prisonCode = prisonCode)
+) : MetricInfo(username = username, prisonCode = prisonCode)

src/test/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/facade/OfficialVisitFacadeTest.kt

@@ -120,9 +120,9 @@ class OfficialVisitFacadeTest {
   fun `should delegate to correct service on search`() {
     val request: OfficialVisitSummarySearchRequest = mock()
 
-    facade.searchForOfficialVisitSummaries(MOORLAND, request, 0, 10)
+    facade.searchForOfficialVisitSummaries(MOORLAND, request, MOORLAND_PRISON_USER, 0, 10)
 
-    verify(officialVisitSearchService).searchForOfficialVisitSummaries(MOORLAND, request, 0, 10)
+    verify(officialVisitSearchService).searchForOfficialVisitSummaries(MOORLAND, request, MOORLAND_PRISON_USER, 0, 10)
   }
 
   @Test

src/test/kotlin/uk/gov/justice/digital/hmpps/officialvisitsapi/integration/resource/OfficialVisitSearchIntegrationTest.kt

@@ -172,6 +172,7 @@ class OfficialVisitSearchIntegrationTest : IntegrationTestBase() {
         ),
         info = eq(
           SearchInfo(
+            username = MOORLAND_PRISON_USER.username,
             prisonCode = MOORLAND_PRISON_USER.activeCaseLoadId!!,
             startDate = searchRequest.startDate!!,
             searchTerm = searchRequest.searchTerm?.trim(),
@@ -254,6 +255,7 @@ class OfficialVisitSearchIntegrationTest : IntegrationTestBase() {
         ),
         info = eq(
           SearchInfo(
+            username = MOORLAND_PRISON_USER.username,
             prisonCode = MOORLAND_PRISON_USER.activeCaseLoadId!!,
             startDate = searchRequest.startDate!!,
             searchTerm = searchRequest.searchTerm?.trim(),