refactor/qg-253: SourceItem заменён на URI

Чтобы не переизобретать велосипед для строкового представления универсальных идентификаторов ресурсов, чем SourceItem собственно и был

Author: d-r-q

app/build.gradle.kts

@@ -1,5 +1,6 @@
 import kotlinx.kover.gradle.plugin.dsl.AggregationType
 import kotlinx.kover.gradle.plugin.dsl.CoverageUnit
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
 	alias(libs.plugins.kotlin.spring)
@@ -230,3 +231,7 @@ configurations.matching { it.name == "detekt" }.all {
 		}
 	}
 }
+val compileKotlin: KotlinCompile by tasks
+compileKotlin.compilerOptions {
+    freeCompilerArgs.set(listOf("-Xannotation-default-target=param-property"))
+}

app/src/main/kotlin/pro/qyoga/app/therapist/appointments/core/edit/CreateAppointmentPageController.kt

@@ -7,6 +7,7 @@ import org.springframework.web.bind.annotation.PostMapping
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.servlet.ModelAndView
+import org.springframework.web.util.UriComponentsBuilder
 import pro.azhidkov.platform.spring.sdj.ergo.hydration.ref
 import pro.azhidkov.timezones.LocalizedTimeZone
 import pro.azhidkov.timezones.TimeZones
@@ -19,9 +20,9 @@ import pro.qyoga.app.therapist.appointments.core.edit.ops.GetAppointmentPrefillD
 import pro.qyoga.app.therapist.appointments.core.edit.view_model.appointmentPageModelAndView
 import pro.qyoga.app.therapist.appointments.core.schedule.SchedulePageController.Companion.calendarForDayWithFocus
 import pro.qyoga.core.appointments.core.commands.EditAppointmentRequest
-import pro.qyoga.core.calendar.api.SourceItem
 import pro.qyoga.core.users.auth.dtos.QyogaUserDetails
 import pro.qyoga.core.users.therapists.ref
+import java.net.URI
 import java.time.LocalDateTime
 
 @Controller
@@ -35,14 +36,9 @@ class CreateAppointmentPageController(
     @GetMapping
     fun getAppointmentPage(
         @RequestParam(DATE_TIME) dateTime: LocalDateTime?,
-        @RequestParam(SOURCE_ITEM_TYPE) sourceItemType: String?,
-        @RequestParam(SOURCE_ITEM_ID) sourceItemId: String?,
+        @RequestParam(SOURCE_ITEM) sourceItem: URI?,
         @AuthenticationPrincipal therapist: QyogaUserDetails
     ): ModelAndView {
-        val sourceItem = when {
-            sourceItemType != null && sourceItemId != null -> SourceItem(sourceItemType, sourceItemId)
-            else -> null
-        }
         val prefillData = getAppointmentPrefillData(therapist.ref, sourceItem, dateTime)
         return appointmentPageModelAndView(
             pageMode = EntityPageMode.CREATE,
@@ -77,17 +73,19 @@ class CreateAppointmentPageController(
     companion object {
         const val PATH = "/therapist/appointments/new"
         const val DATE_TIME = "dateTime"
-        const val SOURCE_ITEM_TYPE = "sourceItemType"
-        const val SOURCE_ITEM_ID = "sourceItemId"
+        const val SOURCE_ITEM = "sourceItem"
         const val CREATE_AT_DATE_TIME_URI = "/therapist/appointments/new?$DATE_TIME={$DATE_TIME}"
         private const val CREATE_FROM_SOURCE_ITEM_URI =
-            "/therapist/appointments/new?$DATE_TIME={$DATE_TIME}&$SOURCE_ITEM_TYPE={$SOURCE_ITEM_TYPE}&$SOURCE_ITEM_ID={$SOURCE_ITEM_ID}"
+            "/therapist/appointments/new"
 
-        fun addFromSourceItemUri(dateTime: LocalDateTime, sourceItem: SourceItem): String =
-            CREATE_FROM_SOURCE_ITEM_URI
-                .replace("{$DATE_TIME}", dateTime.toString())
-                .replace("{$SOURCE_ITEM_TYPE}", sourceItem.type)
-                .replace("{$SOURCE_ITEM_ID}", sourceItem.id)
+        fun addFromSourceItemUri(dateTime: LocalDateTime, sourceItem: URI): String =
+            UriComponentsBuilder
+                .fromPath(CREATE_FROM_SOURCE_ITEM_URI)
+                .queryParam("dateTime", dateTime)
+                .queryParam("sourceItem", sourceItem.toString())
+                .encode()
+                .build()
+                .toUriString()
     }
 
 }

app/src/main/kotlin/pro/qyoga/app/therapist/appointments/core/edit/forms/CreateAppointmentForm.kt

@@ -6,6 +6,7 @@ import pro.qyoga.core.calendar.api.CalendarItem
 import pro.qyoga.core.calendar.api.CalendarItemId
 import pro.qyoga.core.clients.cards.model.ClientRef
 import pro.qyoga.core.therapy.therapeutic_tasks.model.TherapeuticTaskRef
+import java.net.URI
 import java.time.Duration
 import java.time.LocalDateTime
 import java.time.ZoneId
@@ -28,7 +29,7 @@ data class CreateAppointmentForm(
     val payed: Boolean?,
     val appointmentStatus: AppointmentStatus?,
     val comment: String?,
-    val externalId: String?
+    val externalId: URI?
 ) {
 
     constructor(
@@ -37,7 +38,7 @@ data class CreateAppointmentForm(
         timeZone: ZoneId,
         timeZoneTitle: String?
     ) : this(
-        externalId = externalEvent?.id?.toQueryParamStr(),
+        externalId = externalEvent?.id?.toUri(),
         dateTime = dateTime,
         timeZone = timeZone,
         timeZoneTitle = timeZoneTitle,

app/src/main/kotlin/pro/qyoga/app/therapist/appointments/core/edit/ops/GetAppointmentPrefillDataOp.kt

@@ -3,11 +3,11 @@ package pro.qyoga.app.therapist.appointments.core.edit.ops
 import org.springframework.stereotype.Component
 import pro.azhidkov.timezones.TimeZones
 import pro.qyoga.app.therapist.appointments.core.edit.forms.CreateAppointmentForm
-import pro.qyoga.core.calendar.api.SourceItem
 import pro.qyoga.core.calendar.gateways.CalendarItemsResolver
 import pro.qyoga.core.users.auth.model.UserRef
 import pro.qyoga.core.users.settings.UserSettingsRepo
 import pro.qyoga.core.users.therapists.TherapistRef
+import java.net.URI
 import java.time.LocalDateTime
 
 
@@ -16,16 +16,16 @@ class GetAppointmentPrefillDataOp(
     private val calendarItemsResolver: CalendarItemsResolver,
     private val userSettingsRepo: UserSettingsRepo,
     private val timeZones: TimeZones,
-) : (TherapistRef, SourceItem?, LocalDateTime?) -> CreateAppointmentForm {
+) : (TherapistRef, URI?, LocalDateTime?) -> CreateAppointmentForm {
 
     override fun invoke(
         therapistRef: TherapistRef,
-        sourceItem: SourceItem?,
+        sourceItem: URI?,
         dateTime: LocalDateTime?
     ): CreateAppointmentForm {
         val currentUserTimeZone = userSettingsRepo.getUserTimeZone(UserRef(therapistRef))
 
-        val sourceEvent = calendarItemsResolver.findCalendarItem(therapistRef, sourceItem!!)
+        val sourceEvent = sourceItem?.let { calendarItemsResolver.findCalendarItem(therapistRef, it) }
 
         val timeZoneTitle = timeZones.findById(currentUserTimeZone)?.displayName
 

app/src/main/kotlin/pro/qyoga/app/therapist/appointments/core/schedule/CalendarPageModel.kt

@@ -17,7 +17,6 @@ import pro.qyoga.core.appointments.core.model.AppointmentStatus
 import pro.qyoga.core.appointments.core.views.LocalizedAppointmentSummary
 import pro.qyoga.core.calendar.api.CalendarItem
 import pro.qyoga.core.calendar.api.CalendarItemId
-import pro.qyoga.core.calendar.api.SourceItem
 import pro.qyoga.l10n.russianDayOfMonthLongFormat
 import pro.qyoga.l10n.russianTimeFormat
 import pro.qyoga.l10n.systemLocale
@@ -267,7 +266,7 @@ private fun CalendarItem<*, LocalDateTime>.editUri() =
         is UUID -> EditAppointmentPageController.editUri(id as UUID)
         is CalendarItemId -> CreateAppointmentPageController.addFromSourceItemUri(
             dateTime,
-            SourceItem(id as CalendarItemId)
+            (id as CalendarItemId).toUri()
         )
         else -> error("Unsupported type: $id")
     }

app/src/main/kotlin/pro/qyoga/core/calendar/api/CalendarItem.kt

@@ -1,13 +1,61 @@
 package pro.qyoga.core.calendar.api
 
+import org.springframework.util.MultiValueMap
+import org.springframework.web.util.UriComponentsBuilder
+import org.springframework.web.util.UriTemplate
+import java.net.URI
 import java.time.Duration
 import java.time.temporal.Temporal
 
+data class CalendarItemUri(
+    val type: String,
+    val params: Map<String, String?>
+) {
+
+    companion object {
+
+        private const val SCHEMA = "qyoga"
+        private const val HOST = "calendars"
+        private const val PATH = "{type}/events"
+        const val TEMPLATE = "$SCHEMA://$HOST/$PATH"
+
+        private val pathTemplate = UriTemplate("/$PATH")
+
+        fun parseOrNull(uri: URI): CalendarItemUri? {
+            if (uri.scheme != SCHEMA) {
+                return null
+            }
+            if (uri.host != HOST) {
+                return null
+            }
+
+            val comps = UriComponentsBuilder.fromUri(uri).build()
+            if (!pathTemplate.matches(comps.path)) {
+                return null
+            }
+
+            val type = comps.pathSegments.getOrNull(0)
+                ?: return null
+
+            val params: Map<String, String?> = comps.queryParams.toSingleValueMap()
+
+            return CalendarItemUri(type, params)
+        }
+
+    }
+
+}
+
 interface CalendarItemId {
 
     val type: CalendarType
 
-    fun toQueryParamStr(): String
+    fun toUri(): URI = UriComponentsBuilder.fromUriString(CalendarItemUri.TEMPLATE)
+        .queryParams(MultiValueMap.fromSingleValue(toMap()))
+        .buildAndExpand(type.name)
+        .toUri()
+
+    fun toMap(): Map<String, String?>
 
 }
 

app/src/main/kotlin/pro/qyoga/core/calendar/api/CalendarsService.kt

@@ -22,6 +22,6 @@ interface CalendarsService<ID> {
 
     fun findById(therapistRef: TherapistRef, eventId: ID): CalendarItem<ID, ZonedDateTime>?
 
-    fun parseStringId(sourceItem: SourceItem): ID
+    fun createItemId(itemId: Map<String, String?>): ID
 
 }

app/src/main/kotlin/pro/qyoga/core/calendar/api/SourceItem.kt

@@ -3,9 +3,10 @@ package pro.qyoga.core.calendar.gateways
 import org.springframework.stereotype.Service
 import pro.qyoga.core.calendar.api.CalendarItem
 import pro.qyoga.core.calendar.api.CalendarItemId
+import pro.qyoga.core.calendar.api.CalendarItemUri
 import pro.qyoga.core.calendar.api.CalendarsService
-import pro.qyoga.core.calendar.api.SourceItem
 import pro.qyoga.core.users.therapists.TherapistRef
+import java.net.URI
 import java.time.ZonedDateTime
 
 @Service
@@ -17,11 +18,14 @@ class CalendarItemsResolver(
 
     fun findCalendarItem(
         therapistRef: TherapistRef,
-        sourceItem: SourceItem
+        sourceItem: URI
     ): CalendarItem<CalendarItemId, ZonedDateTime>? {
+        val calendarItemUri = CalendarItemUri.parseOrNull(sourceItem)
+            ?: throw IllegalArgumentException("Invalid calendar item URI: $sourceItem")
+
         @Suppress("UNCHECKED_CAST")
-        val service = services[sourceItem.type] as CalendarsService<CalendarItemId>
-        val id = service.parseStringId(sourceItem)
+        val service = services[calendarItemUri.type] as CalendarsService<CalendarItemId>
+        val id = service.createItemId(calendarItemUri.params)
         return service.findById(therapistRef, id)
     }
 

app/src/main/kotlin/pro/qyoga/core/calendar/gateways/CalendarItemsResolver.kt

@@ -16,8 +16,10 @@ data class GoogleCalendarItemId(
 
     override val type: CalendarType = GoogleCalendar.Type
 
-    override fun toQueryParamStr(): String =
-        "$calendarId,$itemId"
+    override fun toMap(): Map<String, String> = mapOf(
+        "cid" to calendarId,
+        "eid" to itemId
+    )
 
 }