Make deviceDisplayName optional in DeviceRegistration

cph-cachet · Oct 20, 2024 · 708248e · 708248e
1 parent 5ce4f58
commit 708248e
Show file tree

Hide file tree

Showing 26 changed files with 4,031 additions and 15 deletions.
diff --git a/carp.common/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/AltBeacon.kt b/carp.common/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/AltBeacon.kt
@@ -78,7 +78,6 @@ data class AltBeaconDeviceRegistration(
      * This value is constrained from -127 to 0.
      */
     val referenceRssi: Short,
-    @Required
     override val deviceDisplayName: String? = null, // TODO: We could map known manufacturerId's to display names.
     override val additionalSpecifications: ApplicationData? = null
 ) : DeviceRegistration()

diff --git a/...ain/kotlin/dk/cachet/carp/common/application/devices/BLESerialNumberDeviceRegistration.kt b/...ain/kotlin/dk/cachet/carp/common/application/devices/BLESerialNumberDeviceRegistration.kt
@@ -15,7 +15,6 @@ import kotlin.js.JsExport
 @JsExport
 data class BLESerialNumberDeviceRegistration(
     val serialNumber: String,
-    @Required
     override val deviceDisplayName: String? = null,
     override val additionalSpecifications: ApplicationData? = null
 ) : DeviceRegistration()

diff --git a/.../commonMain/kotlin/dk/cachet/carp/common/application/devices/DefaultDeviceRegistration.kt b/.../commonMain/kotlin/dk/cachet/carp/common/application/devices/DefaultDeviceRegistration.kt
@@ -15,7 +15,6 @@ import kotlin.js.JsExport
 @Serializable
 @JsExport
 data class DefaultDeviceRegistration(
-    @Required
     override val deviceDisplayName: String? = null,
     override val additionalSpecifications: ApplicationData? = null,
     @Required

diff --git a/...mon/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/DeviceRegistration.kt b/...mon/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/DeviceRegistration.kt
@@ -38,7 +38,6 @@ abstract class DeviceRegistration
      * An optional concise textual representation for display purposes describing the key specifications of the device.
      * E.g., device manufacturer, name, and operating system version.
      */
-    @Required
     abstract val deviceDisplayName: String?
 
     @Required

diff --git a/...mmonMain/kotlin/dk/cachet/carp/common/application/devices/MACAddressDeviceRegistration.kt b/...mmonMain/kotlin/dk/cachet/carp/common/application/devices/MACAddressDeviceRegistration.kt
@@ -14,7 +14,6 @@ import kotlin.js.JsExport
 @JsExport
 data class MACAddressDeviceRegistration(
     val macAddress: MACAddress,
-    @Required
     override val deviceDisplayName: String? = null,
     override val additionalSpecifications: ApplicationData? = null
 ) : DeviceRegistration()

diff --git a/carp.common/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/Website.kt b/carp.common/src/commonMain/kotlin/dk/cachet/carp/common/application/devices/Website.kt
@@ -51,7 +51,6 @@ data class WebsiteDeviceRegistration(
      * The HTTP User-Agent header of the user agent which made the HTTP request to [url].
      */
     val userAgent: String,
-    @Required
     override val deviceDisplayName: String? = userAgent,
     override val additionalSpecifications: ApplicationData? = null
 ) : DeviceRegistration()

diff --git a/...ain/kotlin/dk/cachet/carp/common/infrastructure/serialization/UnknownDeviceSerializers.kt b/...ain/kotlin/dk/cachet/carp/common/infrastructure/serialization/UnknownDeviceSerializers.kt
@@ -179,7 +179,7 @@ data class CustomDeviceRegistration internal constructor(
     @Serializable
     private data class BaseMembers(
         override val deviceId: String,
-        override val deviceDisplayName: String?,
+        override val deviceDisplayName: String? = null,
         override val additionalSpecifications: ApplicationData? = null
     ) : DeviceRegistration()
 

diff --git a/...ts.core/src/commonMain/kotlin/dk/cachet/carp/deployments/application/DeploymentService.kt b/...ts.core/src/commonMain/kotlin/dk/cachet/carp/deployments/application/DeploymentService.kt
@@ -18,7 +18,7 @@ import kotlinx.serialization.*
  */
 interface DeploymentService : ApplicationService<DeploymentService, DeploymentService.Event>
 {
-    companion object { val API_VERSION = ApiVersion( 1, 1 ) }
+    companion object { val API_VERSION = ApiVersion( 1, 3 ) }
 
     @Serializable
     sealed class Event( override val aggregateId: String? ) : IntegrationEvent<DeploymentService>

diff --git a/...tlin/dk/cachet/carp/deployments/infrastructure/versioning/DeploymentServiceApiMigrator.kt b/...tlin/dk/cachet/carp/deployments/infrastructure/versioning/DeploymentServiceApiMigrator.kt
@@ -1,13 +1,11 @@
 package dk.cachet.carp.deployments.infrastructure.versioning
 
 import dk.cachet.carp.common.application.services.ApiVersion
-import dk.cachet.carp.common.infrastructure.versioning.ApiResponse
-import dk.cachet.carp.common.infrastructure.versioning.ApplicationServiceApiMigrator
-import dk.cachet.carp.common.infrastructure.versioning.Major1Minor0To1Migration
+import dk.cachet.carp.common.infrastructure.versioning.*
 import dk.cachet.carp.deployments.application.DeploymentService
 import dk.cachet.carp.deployments.infrastructure.DeploymentServiceInvoker
 import dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest
-import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.*
 
 
 private val major1Minor0To1Migration =
@@ -29,10 +27,46 @@ private val major1Minor0To1Migration =
     }
 
 
+private val major1Minor1To3Migration =
+    object : ApiMigration( 1, 3 )
+    {
+        override fun migrateRequest( request: JsonObject ) = request
+
+        override fun migrateResponse( request: JsonObject, response: ApiResponse, targetVersion: ApiVersion ) =
+            when ( request.getType( ) )
+            {
+                "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.GetDeviceDeploymentFor" ->
+                {
+                    val responseObject = (response.response as? JsonObject)?.migrate {
+                        requiredDeviceDisplayName( "registration" )
+
+                        updateOptionalObject( "connectedDeviceRegistrations" )
+                        {
+                            for ( connectedDevice in json.keys ) requiredDeviceDisplayName( connectedDevice )
+                        }
+                    }
+                    ApiResponse( responseObject, response.ex )
+                }
+                else -> response
+            }
+
+        /**
+         * The `deviceDisplayName` field in `DeviceRegistration`, with default value `null`, was changed from required
+         * into optional. So, if it isn't set, it needs to bet set to `null` explicitly.
+         */
+        private fun ApiJsonObjectMigrationBuilder.requiredDeviceDisplayName( fieldName: String ) =
+            updateObject( fieldName ) {
+                json.getOrPut( "deviceDisplayName" ) { JsonNull }
+            }
+
+        override fun migrateEvent( event: JsonObject ) = event
+    }
+
+
 val DeploymentServiceApiMigrator = ApplicationServiceApiMigrator(
     DeploymentService.API_VERSION,
     DeploymentServiceInvoker,
     DeploymentServiceRequest.Serializer,
     DeploymentService.Event.serializer(),
-    listOf( major1Minor0To1Migration )
+    listOf( major1Minor0To1Migration, major1Minor1To3Migration )
 )
diff --git a/...loymentService/1.3/DeploymentServiceTest/createStudyDeployment_fails_for_existing_id.json b/...loymentService/1.3/DeploymentServiceTest/createStudyDeployment_fails_for_existing_id.json
@@ -0,0 +1,194 @@
+[
+    {
+        "outcome": "Succeeded",
+        "request": {
+            "__type": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.CreateStudyDeployment",
+            "apiVersion": "1.3",
+            "id": "6a4ff16c-cafc-4392-836a-503fe0b81127",
+            "protocol": {
+                "id": "e55bf62d-56e1-4596-ad12-4868475d5398",
+                "createdOn": "2024-10-09T08:17:33.762380Z",
+                "version": 0,
+                "ownerId": "27879e75-ccc1-4866-9ab3-4ece1b735052",
+                "name": "Test protocol",
+                "description": "Test description",
+                "primaryDevices": [
+                    {
+                        "__type": "dk.cachet.carp.common.infrastructure.test.StubPrimaryDeviceConfiguration",
+                        "isPrimaryDevice": true,
+                        "roleName": "Primary"
+                    }
+                ],
+                "connectedDevices": [
+                    {
+                        "__type": "dk.cachet.carp.common.infrastructure.test.StubDeviceConfiguration",
+                        "roleName": "Connected"
+                    }
+                ],
+                "connections": [
+                    {
+                        "roleName": "Connected",
+                        "connectedToRoleName": "Primary"
+                    }
+                ]
+            },
+            "invitations": [
+                {
+                    "participantId": "bc2b736f-fbc0-434d-8e07-736f56396335",
+                    "assignedRoles": {
+                        "__type": "dk.cachet.carp.common.application.users.AssignedTo.All"
+                    },
+                    "identity": {
+                        "__type": "dk.cachet.carp.common.application.users.UsernameAccountIdentity",
+                        "username": "Test"
+                    },
+                    "invitation": {
+                        "name": "Some study"
+                    }
+                }
+            ]
+        },
+        "precedingEvents": [],
+        "publishedEvents": [
+            {
+                "__type": "dk.cachet.carp.deployments.application.DeploymentService.Event.StudyDeploymentCreated",
+                "aggregateId": "6a4ff16c-cafc-4392-836a-503fe0b81127",
+                "apiVersion": "1.3",
+                "studyDeploymentId": "6a4ff16c-cafc-4392-836a-503fe0b81127",
+                "protocol": {
+                    "id": "e55bf62d-56e1-4596-ad12-4868475d5398",
+                    "createdOn": "2024-10-09T08:17:33.762380Z",
+                    "version": 0,
+                    "ownerId": "27879e75-ccc1-4866-9ab3-4ece1b735052",
+                    "name": "Test protocol",
+                    "description": "Test description",
+                    "primaryDevices": [
+                        {
+                            "__type": "dk.cachet.carp.common.infrastructure.test.StubPrimaryDeviceConfiguration",
+                            "isPrimaryDevice": true,
+                            "roleName": "Primary"
+                        }
+                    ],
+                    "connectedDevices": [
+                        {
+                            "__type": "dk.cachet.carp.common.infrastructure.test.StubDeviceConfiguration",
+                            "roleName": "Connected"
+                        }
+                    ],
+                    "connections": [
+                        {
+                            "roleName": "Connected",
+                            "connectedToRoleName": "Primary"
+                        }
+                    ]
+                },
+                "invitations": [
+                    {
+                        "participantId": "bc2b736f-fbc0-434d-8e07-736f56396335",
+                        "assignedRoles": {
+                            "__type": "dk.cachet.carp.common.application.users.AssignedTo.All"
+                        },
+                        "identity": {
+                            "__type": "dk.cachet.carp.common.application.users.UsernameAccountIdentity",
+                            "username": "Test"
+                        },
+                        "invitation": {
+                            "name": "Some study"
+                        }
+                    }
+                ],
+                "connectedDevicePreregistrations": {}
+            }
+        ],
+        "response": {
+            "__type": "dk.cachet.carp.deployments.application.StudyDeploymentStatus.Invited",
+            "createdOn": "1970-01-01T00:00:00Z",
+            "studyDeploymentId": "6a4ff16c-cafc-4392-836a-503fe0b81127",
+            "deviceStatusList": [
+                {
+                    "__type": "dk.cachet.carp.deployments.application.DeviceDeploymentStatus.Unregistered",
+                    "device": {
+                        "__type": "dk.cachet.carp.common.infrastructure.test.StubPrimaryDeviceConfiguration",
+                        "isPrimaryDevice": true,
+                        "roleName": "Primary"
+                    },
+                    "canBeDeployed": true,
+                    "remainingDevicesToRegisterToObtainDeployment": [
+                        "Primary"
+                    ],
+                    "remainingDevicesToRegisterBeforeDeployment": [
+                        "Primary",
+                        "Connected"
+                    ]
+                },
+                {
+                    "__type": "dk.cachet.carp.deployments.application.DeviceDeploymentStatus.Unregistered",
+                    "device": {
+                        "__type": "dk.cachet.carp.common.infrastructure.test.StubDeviceConfiguration",
+                        "roleName": "Connected"
+                    },
+                    "canBeDeployed": false,
+                    "remainingDevicesToRegisterToObtainDeployment": [
+                        "Connected"
+                    ],
+                    "remainingDevicesToRegisterBeforeDeployment": [
+                        "Connected"
+                    ]
+                }
+            ],
+            "participantStatusList": [
+                {
+                    "participantId": "bc2b736f-fbc0-434d-8e07-736f56396335",
+                    "assignedParticipantRoles": {
+                        "__type": "dk.cachet.carp.common.application.users.AssignedTo.All"
+                    },
+                    "assignedPrimaryDeviceRoleNames": [
+                        "Primary"
+                    ]
+                }
+            ],
+            "startedOn": null
+        }
+    },
+    {
+        "outcome": "Failed",
+        "request": {
+            "__type": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.CreateStudyDeployment",
+            "apiVersion": "1.3",
+            "id": "6a4ff16c-cafc-4392-836a-503fe0b81127",
+            "protocol": {
+                "id": "d3d68082-69c7-4eda-8e60-3c134727bb84",
+                "createdOn": "2024-10-09T08:17:33.763129Z",
+                "version": 0,
+                "ownerId": "27879e75-ccc1-4866-9ab3-4ece1b735052",
+                "name": "Test protocol",
+                "description": "Test description",
+                "primaryDevices": [
+                    {
+                        "__type": "dk.cachet.carp.common.infrastructure.test.StubPrimaryDeviceConfiguration",
+                        "isPrimaryDevice": true,
+                        "roleName": "Test device"
+                    }
+                ]
+            },
+            "invitations": [
+                {
+                    "participantId": "3528a538-279d-4871-8d03-de6b3d5722f8",
+                    "assignedRoles": {
+                        "__type": "dk.cachet.carp.common.application.users.AssignedTo.All"
+                    },
+                    "identity": {
+                        "__type": "dk.cachet.carp.common.application.users.UsernameAccountIdentity",
+                        "username": "User"
+                    },
+                    "invitation": {
+                        "name": "Some study"
+                    }
+                }
+            ]
+        },
+        "precedingEvents": [],
+        "publishedEvents": [],
+        "exceptionType": "IllegalArgumentException"
+    }
+]