Convert OS and Arch during deserialization

Trying to move things away from WorkspaceAgentModel to refactor it.

Author: code-asher

src/main/kotlin/com/coder/gateway/sdk/BaseCoderRestClient.kt

@@ -3,7 +3,9 @@ package com.coder.gateway.sdk
 import com.coder.gateway.icons.CoderIcons
 import com.coder.gateway.icons.toRetinaAwareIcon
 import com.coder.gateway.models.WorkspaceAgentModel
+import com.coder.gateway.sdk.convertors.ArchConverter
 import com.coder.gateway.sdk.convertors.InstantConverter
+import com.coder.gateway.sdk.convertors.OSConverter
 import com.coder.gateway.sdk.ex.AuthenticationResponseException
 import com.coder.gateway.sdk.ex.TemplateResponseException
 import com.coder.gateway.sdk.ex.WorkspaceResponseException
@@ -19,7 +21,9 @@ import com.coder.gateway.sdk.v2.models.WorkspaceTransition
 import com.coder.gateway.sdk.v2.models.toAgentModels
 import com.coder.gateway.services.CoderSettingsState
 import com.coder.gateway.settings.CoderSettings
+import com.coder.gateway.util.Arch
 import com.coder.gateway.util.CoderHostnameVerifier
+import com.coder.gateway.util.OS
 import com.coder.gateway.util.coderSocketFactory
 import com.coder.gateway.util.coderTrustManagers
 import com.coder.gateway.util.getHeaders
@@ -59,7 +63,11 @@ open class BaseCoderRestClient(
     lateinit var buildVersion: String
 
     init {
-        val gson: Gson = GsonBuilder().registerTypeAdapter(Instant::class.java, InstantConverter()).setPrettyPrinting().create()
+        val gson: Gson = GsonBuilder()
+            .registerTypeAdapter(Instant::class.java, InstantConverter())
+            .registerTypeAdapter(Arch::class.java, ArchConverter())
+            .registerTypeAdapter(OS::class.java, OSConverter())
+            .setPrettyPrinting().create()
 
         val socketFactory = coderSocketFactory(settings.tls)
         val trustManagers = coderTrustManagers(settings.tls.caPath)

src/main/kotlin/com/coder/gateway/sdk/convertors/ArchConverter.kt

@@ -0,0 +1,25 @@
+package com.coder.gateway.sdk.convertors
+
+import com.coder.gateway.util.Arch
+import com.google.gson.JsonDeserializationContext
+import com.google.gson.JsonDeserializer
+import com.google.gson.JsonElement
+import com.google.gson.JsonParseException
+import com.google.gson.JsonPrimitive
+import com.google.gson.JsonSerializationContext
+import com.google.gson.JsonSerializer
+import java.lang.reflect.Type
+
+/**
+ * GSON serialiser/deserialiser for converting [Arch] objects.
+ */
+class ArchConverter : JsonSerializer<Arch?>, JsonDeserializer<Arch?> {
+    override fun serialize(src: Arch?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
+        return JsonPrimitive(src?.toString() ?: "")
+    }
+
+    @Throws(JsonParseException::class)
+    override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): Arch? {
+        return Arch.from(json.asString)
+    }
+}

src/main/kotlin/com/coder/gateway/sdk/convertors/OSConverter.kt

@@ -0,0 +1,25 @@
+package com.coder.gateway.sdk.convertors
+
+import com.coder.gateway.util.OS
+import com.google.gson.JsonDeserializationContext
+import com.google.gson.JsonDeserializer
+import com.google.gson.JsonElement
+import com.google.gson.JsonParseException
+import com.google.gson.JsonPrimitive
+import com.google.gson.JsonSerializationContext
+import com.google.gson.JsonSerializer
+import java.lang.reflect.Type
+
+/**
+ * GSON serialiser/deserialiser for converting [OS] objects.
+ */
+class OSConverter : JsonSerializer<OS?>, JsonDeserializer<OS?> {
+    override fun serialize(src: OS?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
+        return JsonPrimitive(src?.toString() ?: "")
+    }
+
+    @Throws(JsonParseException::class)
+    override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): OS? {
+        return OS.from(json.asString)
+    }
+}

src/main/kotlin/com/coder/gateway/sdk/v2/models/Workspace.kt

@@ -3,11 +3,9 @@ package com.coder.gateway.sdk.v2.models
 import com.coder.gateway.models.WorkspaceAgentModel
 import com.coder.gateway.models.WorkspaceAndAgentStatus
 import com.coder.gateway.models.WorkspaceVersionStatus
-import com.coder.gateway.util.Arch
-import com.coder.gateway.util.OS
 import com.google.gson.annotations.SerializedName
 import java.time.Instant
-import java.util.UUID
+import java.util.*
 
 /**
  * Represents a deployment of a template. It references a specific version and can be updated.
@@ -47,8 +45,8 @@ fun Workspace.toAgentModels(resources: List<WorkspaceResource> = this.latestBuil
             this.latestBuild.status,
             WorkspaceAndAgentStatus.from(this, agent),
             this.latestBuild.transition,
-            OS.from(agent.operatingSystem),
-            Arch.from(agent.architecture),
+            agent.operatingSystem,
+            agent.architecture,
             agent.expandedDirectory ?: agent.directory,
         )
 

src/main/kotlin/com/coder/gateway/sdk/v2/models/WorkspaceAgent.kt

@@ -1,8 +1,10 @@
 package com.coder.gateway.sdk.v2.models
 
+import com.coder.gateway.util.Arch
+import com.coder.gateway.util.OS
 import com.google.gson.annotations.SerializedName
 import java.time.Instant
-import java.util.UUID
+import java.util.*
 
 data class WorkspaceAgent(
     @SerializedName("id") val id: UUID,
@@ -15,9 +17,9 @@ data class WorkspaceAgent(
     @SerializedName("name") val name: String,
     @SerializedName("resource_id") val resourceID: UUID,
     @SerializedName("instance_id") val instanceID: String?,
-    @SerializedName("architecture") val architecture: String,
+    @SerializedName("architecture") val architecture: Arch?,
     @SerializedName("environment_variables") val envVariables: Map<String, String>,
-    @SerializedName("operating_system") val operatingSystem: String,
+    @SerializedName("operating_system") val operatingSystem: OS?,
     @SerializedName("startup_script") val startupScript: String?,
     @SerializedName("directory") val directory: String?,
     @SerializedName("expanded_directory") val expandedDirectory: String?,

src/test/kotlin/com/coder/gateway/sdk/DataGen.kt

@@ -3,8 +3,23 @@ package com.coder.gateway.sdk
 import com.coder.gateway.models.WorkspaceAgentModel
 import com.coder.gateway.models.WorkspaceAndAgentStatus
 import com.coder.gateway.models.WorkspaceVersionStatus
-import com.coder.gateway.sdk.v2.models.*
-import com.google.gson.annotations.SerializedName
+import com.coder.gateway.sdk.v2.models.BuildReason
+import com.coder.gateway.sdk.v2.models.ProvisionerJob
+import com.coder.gateway.sdk.v2.models.ProvisionerJobStatus
+import com.coder.gateway.sdk.v2.models.ProvisionerType
+import com.coder.gateway.sdk.v2.models.Template
+import com.coder.gateway.sdk.v2.models.User
+import com.coder.gateway.sdk.v2.models.UserStatus
+import com.coder.gateway.sdk.v2.models.Workspace
+import com.coder.gateway.sdk.v2.models.WorkspaceAgent
+import com.coder.gateway.sdk.v2.models.WorkspaceAgentLifecycleState
+import com.coder.gateway.sdk.v2.models.WorkspaceAgentStatus
+import com.coder.gateway.sdk.v2.models.WorkspaceBuild
+import com.coder.gateway.sdk.v2.models.WorkspaceResource
+import com.coder.gateway.sdk.v2.models.WorkspaceStatus
+import com.coder.gateway.sdk.v2.models.WorkspaceTransition
+import com.coder.gateway.util.Arch
+import com.coder.gateway.util.OS
 import java.time.Instant
 import java.util.*
 
@@ -58,9 +73,9 @@ class DataGen {
                     agentName,
                     resourceID = UUID.randomUUID(),
                     instanceID = null,
-                    architecture = "arch",
+                    architecture = Arch.from("amd64"),
                     envVariables = emptyMap(),
-                    operatingSystem = "os",
+                    operatingSystem = OS.from("linux"),
                     startupScript = null,
                     directory = null,
                     expandedDirectory = null,