Switch from Gson to Moshi

The issue I am having with Gson is that it relies on some unsafe thing
that is not available in all cases.

Since Moshi is by the same folks that wrote the HTTP and REST clients we
are using, it seemed like the best replacement.

Thankfully, for the most part this was a simple search and replace, but
calling toJson and fromJson is a bit more burdensome as you have to call
`adapter` and include the type, and it has no built-in converter for
UUID.  On the flip side, the converters require slightly less code.

Author: code-asher

build.gradle.kts

@@ -25,7 +25,7 @@ dependencies {
     implementation("com.squareup.retrofit2:retrofit:2.9.0")
     // define a BOM and its version
     implementation(platform("com.squareup.okhttp3:okhttp-bom:4.12.0"))
-    implementation("com.squareup.retrofit2:converter-gson:2.9.0")
+    implementation("com.squareup.retrofit2:converter-moshi:2.9.0")
     implementation("com.squareup.okhttp3:okhttp")
     implementation("com.squareup.okhttp3:logging-interceptor")
 

src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt

@@ -16,11 +16,12 @@ import com.coder.gateway.util.getHeaders
 import com.coder.gateway.util.getOS
 import com.coder.gateway.util.safeHost
 import com.coder.gateway.util.sha1
-import com.google.gson.Gson
-import com.google.gson.JsonSyntaxException
 import com.intellij.openapi.diagnostic.Logger
 import com.intellij.openapi.progress.ProgressIndicator
+import com.squareup.moshi.Json
+import com.squareup.moshi.Moshi
 import org.zeroturnaround.exec.ProcessExecutor
+import java.io.EOFException
 import java.io.FileInputStream
 import java.io.FileNotFoundException
 import java.net.ConnectException
@@ -328,7 +329,7 @@ class CoderCLIManager(
      * Version output from the CLI's version command.
      */
     private data class Version(
-        val version: String,
+        @Json(name = "version") val version: String,
     )
 
     /**
@@ -338,11 +339,15 @@ class CoderCLIManager(
      */
     fun version(): SemVer {
         val raw = exec("version", "--output", "json")
-        val json = Gson().fromJson(raw, Version::class.java)
-        if (json?.version == null) {
+        try {
+            val json = Moshi.Builder().build().adapter(Version::class.java).fromJson(raw)
+            if (json?.version == null) {
+                throw MissingVersionException("No version found in output")
+            }
+            return SemVer.parse(json.version)
+        } catch (exception: EOFException) {
             throw MissingVersionException("No version found in output")
         }
-        return SemVer.parse(json.version)
     }
 
     /**
@@ -353,7 +358,6 @@ class CoderCLIManager(
             version()
         } catch (e: Exception) {
             when (e) {
-                is JsonSyntaxException,
                 is InvalidVersionException -> {
                     logger.info("Got invalid version from $localBinaryPath: ${e.message}")
                 }

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

@@ -5,6 +5,7 @@ import com.coder.gateway.icons.toRetinaAwareIcon
 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.convertors.UUIDConverter
 import com.coder.gateway.sdk.ex.AuthenticationResponseException
 import com.coder.gateway.sdk.ex.TemplateResponseException
 import com.coder.gateway.sdk.ex.WorkspaceResponseException
@@ -19,28 +20,24 @@ import com.coder.gateway.sdk.v2.models.WorkspaceResource
 import com.coder.gateway.sdk.v2.models.WorkspaceTransition
 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
 import com.coder.gateway.util.toURL
 import com.coder.gateway.util.withPath
-import com.google.gson.Gson
-import com.google.gson.GsonBuilder
 import com.intellij.openapi.util.SystemInfo
 import com.intellij.util.ImageLoader
 import com.intellij.util.ui.ImageUtil
+import com.squareup.moshi.Moshi
 import okhttp3.Credentials
 import okhttp3.OkHttpClient
 import okhttp3.logging.HttpLoggingInterceptor
 import org.imgscalr.Scalr
 import retrofit2.Retrofit
-import retrofit2.converter.gson.GsonConverterFactory
+import retrofit2.converter.moshi.MoshiConverterFactory
 import java.net.HttpURLConnection
 import java.net.URL
-import java.time.Instant
 import java.util.UUID
 import javax.net.ssl.X509TrustManager
 import javax.swing.Icon
@@ -61,11 +58,12 @@ open class BaseCoderRestClient(
     lateinit var buildVersion: String
 
     init {
-        val gson: Gson = GsonBuilder()
-            .registerTypeAdapter(Instant::class.java, InstantConverter())
-            .registerTypeAdapter(Arch::class.java, ArchConverter())
-            .registerTypeAdapter(OS::class.java, OSConverter())
-            .setPrettyPrinting().create()
+        val moshi = Moshi.Builder()
+            .add(ArchConverter())
+            .add(InstantConverter())
+            .add(OSConverter())
+            .add(UUIDConverter())
+            .build()
 
         val socketFactory = coderSocketFactory(settings.tls)
         val trustManagers = coderTrustManagers(settings.tls.caPath)
@@ -104,7 +102,7 @@ open class BaseCoderRestClient(
             .build()
 
         retroRestClient = Retrofit.Builder().baseUrl(url.toString()).client(httpClient)
-            .addConverterFactory(GsonConverterFactory.create(gson))
+            .addConverterFactory(MoshiConverterFactory.create(moshi))
             .build().create(CoderV2RestFacade::class.java)
     }
 

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

@@ -1,25 +1,13 @@
 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
+import com.squareup.moshi.FromJson
+import com.squareup.moshi.ToJson
 
 /**
- * GSON serialiser/deserialiser for converting [Arch] objects.
+ * Serializer/deserializer 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)
-    }
+class ArchConverter {
+    @ToJson fun toJson(src: Arch?): String = src?.toString() ?: ""
+    @FromJson fun fromJson(src: String): Arch? = Arch.from(src)
 }

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

@@ -1,65 +1,20 @@
 package com.coder.gateway.sdk.convertors
 
-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
+import com.squareup.moshi.FromJson
+import com.squareup.moshi.ToJson
 import java.time.Instant
 import java.time.format.DateTimeFormatter
 import java.time.temporal.TemporalAccessor
 
 /**
- * GSON serialiser/deserialiser for converting [Instant] objects.
+ * Serializer/deserializer for converting [Instant] objects.
  */
-class InstantConverter : JsonSerializer<Instant?>, JsonDeserializer<Instant?> {
-    /**
-     * Gson invokes this call-back method during serialization when it encounters a field of the
-     * specified type.
-     *
-     *
-     *
-     * In the implementation of this call-back method, you should consider invoking
-     * [JsonSerializationContext.serialize] method to create JsonElements for any
-     * non-trivial field of the `src` object. However, you should never invoke it on the
-     * `src` object itself since that will cause an infinite loop (Gson will call your
-     * call-back method again).
-     *
-     * @param src the object that needs to be converted to Json.
-     * @param typeOfSrc the actual type (fully genericized version) of the source object.
-     * @return a JsonElement corresponding to the specified object.
-     */
-    override fun serialize(src: Instant?, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement {
-        return JsonPrimitive(FORMATTER.format(src))
-    }
-
-    /**
-     * Gson invokes this call-back method during deserialization when it encounters a field of the
-     * specified type.
-     *
-     *
-     *
-     * In the implementation of this call-back method, you should consider invoking
-     * [JsonDeserializationContext.deserialize] method to create objects
-     * for any non-trivial field of the returned object. However, you should never invoke it on the
-     * the same type passing `json` since that will cause an infinite loop (Gson will call your
-     * call-back method again).
-     *
-     * @param json The Json data being deserialized
-     * @param typeOfT The type of the Object to deserialize to
-     * @return a deserialized object of the specified type typeOfT which is a subclass of `T`
-     * @throws JsonParseException if json is not in the expected format of `typeOfT`
-     */
-    @Throws(JsonParseException::class)
-    override fun deserialize(json: JsonElement, typeOfT: Type, context: JsonDeserializationContext): Instant {
-        return FORMATTER.parse(json.asString) { temporal: TemporalAccessor? -> Instant.from(temporal) }
-    }
+class InstantConverter {
+    @ToJson fun toJson(src: Instant?): String = FORMATTER.format(src)
+    @FromJson fun fromJson(src: String): Instant? = FORMATTER.parse(src) {
+        temporal: TemporalAccessor? -> Instant.from(temporal) }
 
     companion object {
-        /** Formatter.  */
         private val FORMATTER = DateTimeFormatter.ISO_INSTANT
     }
-}
+}

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

@@ -1,25 +1,13 @@
 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
+import com.squareup.moshi.FromJson
+import com.squareup.moshi.ToJson
 
 /**
- * GSON serialiser/deserialiser for converting [OS] objects.
+ * Serializer/deserializer 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)
-    }
+class OSConverter {
+    @ToJson fun toJson(src: OS?): String = src?.toString() ?: ""
+    @FromJson fun fromJson(src: String): OS? = OS.from(src)
 }

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

@@ -0,0 +1,13 @@
+package com.coder.gateway.sdk.convertors
+
+import com.squareup.moshi.FromJson
+import com.squareup.moshi.ToJson
+import java.util.UUID
+
+/**
+ * Serializer/deserializer for converting [UUID] objects.
+ */
+class UUIDConverter {
+    @ToJson fun toJson(src: UUID): String = src.toString()
+    @FromJson fun fromJson(src: String): UUID = UUID.fromString(src)
+}

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

@@ -1,6 +1,6 @@
 package com.coder.gateway.sdk.v2.models
 
-import com.google.gson.annotations.SerializedName
+import com.squareup.moshi.Json
 
 /**
  * Contains build information for a Coder instance.
@@ -12,6 +12,6 @@ import com.google.gson.annotations.SerializedName
  * @param version the semantic version of the build.
  */
 data class BuildInfo(
-    @SerializedName("external_url") val externalUrl: String,
-    @SerializedName("version") val version: String
+    @Json(name = "external_url") val externalUrl: String,
+    @Json(name = "version") val version: String
 )

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

@@ -1,20 +1,15 @@
 package com.coder.gateway.sdk.v2.models
 
-import com.google.gson.annotations.SerializedName
+import com.squareup.moshi.Json
 
 enum class BuildReason {
     // "initiator" is used when a workspace build is triggered by a user.
     // Combined with the initiator id/username, it indicates which user initiated the build.
-    @SerializedName("initiator")
-    INITIATOR,
-
+    @Json(name = "initiator") INITIATOR,
     // "autostart" is used when a build to start a workspace is triggered by Autostart.
     // The initiator id/username in this case is the workspace owner and can be ignored.
-    @SerializedName("autostart")
-    AUTOSTART,
-
+    @Json(name = "autostart") AUTOSTART,
     // "autostop" is used when a build to stop a workspace is triggered by Autostop.
     // The initiator id/username in this case is the workspace owner and can be ignored.
-    @SerializedName("autostop")
-    AUTOSTOP
-}
+    @Json(name = "autostop") AUTOSTOP
+}

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

@@ -1,31 +1,23 @@
 package com.coder.gateway.sdk.v2.models
 
-import com.google.gson.annotations.SerializedName
+import com.squareup.moshi.Json
 import java.util.UUID
 
 data class CreateParameterRequest(
-    @SerializedName("copy_from_parameter") val cloneID: UUID?,
-    @SerializedName("name") val name: String,
-    @SerializedName("source_value") val sourceValue: String,
-    @SerializedName("source_scheme") val sourceScheme: ParameterSourceScheme,
-    @SerializedName("destination_scheme") val destinationScheme: ParameterDestinationScheme
+    @Json(name = "copy_from_parameter") val cloneID: UUID?,
+    @Json(name = "name") val name: String,
+    @Json(name = "source_value") val sourceValue: String,
+    @Json(name = "source_scheme") val sourceScheme: ParameterSourceScheme,
+    @Json(name = "destination_scheme") val destinationScheme: ParameterDestinationScheme
 )
 
 enum class ParameterSourceScheme {
-    @SerializedName("none")
-    NONE,
-
-    @SerializedName("data")
-    DATA
+    @Json(name = "none") NONE,
+    @Json(name = "data") DATA
 }
 
 enum class ParameterDestinationScheme {
-    @SerializedName("none")
-    NONE,
-
-    @SerializedName("environment_variable")
-    ENVIRONMENT_VARIABLE,
-
-    @SerializedName("provisioner_variable")
-    PROVISIONER_VARIABLE
-}
+    @Json(name = "none") NONE,
+    @Json(name = "environment_variable") ENVIRONMENT_VARIABLE,
+    @Json(name = "provisioner_variable") PROVISIONER_VARIABLE
+}