Use kotlinx.serialization for JSON deserialization

Author: aaronlehmann

build.gradle.kts

@@ -11,6 +11,7 @@ plugins {
     alias(libs.plugins.changelog) // Gradle Changelog Plugin
     alias(libs.plugins.qodana) // Gradle Qodana Plugin
     alias(libs.plugins.kover) // Gradle Kover Plugin
+    kotlin("plugin.serialization") version "2.1.10"
 }
 
 group = properties("pluginGroup").get()
@@ -24,7 +25,7 @@ repositories {
 // Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog
 dependencies {
 //    implementation(libs.annotations)
-    implementation("org.json:json:20210307")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.0")
 }
 
 // Set the JVM language level used to build the project.

src/main/kotlin/com/coder/jetbrains/services/CoderPortForwardService.kt

@@ -17,7 +17,8 @@ import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import java.io.File
-import org.json.JSONObject
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.ExperimentalSerializationApi
 import com.coder.jetbrains.settings.CoderBackendSettings
 
 /**
@@ -56,41 +57,43 @@ class CoderPortForwardService(
         poller?.cancel()
     }
 
-    class InvalidJsonTypeException(message: String) : Exception(message)
+    companion object {
+    @OptIn(ExperimentalSerializationApi::class)
+        private val json = Json {
+            ignoreUnknownKeys = true
+            allowTrailingComma = true
+            allowComments = true
+        }
+    }
 
     private fun start() {
         val devcontainerFile = CoderBackendSettings.getDevcontainerFile()
         if (devcontainerFile.exists()) {
             try {
-                val json = devcontainerFile.readText()
-                val obj = JSONObject(json)
+                val jsonContent = devcontainerFile.readText()
+                val config = json.decodeFromString<DevContainerConfig>(jsonContent)
 
-                val portsAttributes = obj.optJSONObject("portsAttributes") ?: JSONObject()
-                portsAttributes.keys().forEach { spec ->
-                    portsAttributes.optJSONObject(spec)?.let { attrs ->
-                        val onAutoForward = attrs.opt("onAutoForward")
-                        if (!isValidString(onAutoForward)) {
-                            throw InvalidJsonTypeException("onAutoForward for port $spec is not a string value")
-                        }
-                        val onAutoForwardStr = onAutoForward as String
-                        if (onAutoForwardStr == "ignore") {
+                // Process port attributes
+                config.portsAttributes.forEach { (spec, attrs) ->
+                    when (attrs.onAutoForward) {
+                        "ignore" -> {
                             logger.info("found ignored port specification $spec in devcontainer.json")
                             rules.add(0, PortRule(PortMatcher(spec), false))
-                        } else if (onAutoForwardStr != "") {
+                        }
+                        "" -> {}
+                        else -> {
                             logger.info("found auto-forward port specification $spec in devcontainer.json")
                             rules.add(0, PortRule(PortMatcher(spec), true))
                         }
                     }
                 }
 
-                val otherPortsAttributes = obj.optJSONObject("otherPortsAttributes") ?: JSONObject()
-                val otherPortsAutoForward = otherPortsAttributes.opt("onAutoForward")
-                if (!isValidString(otherPortsAutoForward)) {
-                    throw InvalidJsonTypeException("otherPortsAttributes.onAutoForward is not a string value")
-                }
-                if ((otherPortsAutoForward as String) == "ignore") {
-                    logger.info("found ignored setting for otherPortsAttributes in devcontainer.json")
-                    defaultForward = false
+                // Process other ports attributes
+                config.otherPortsAttributes?.let {
+                    if (it.onAutoForward == "ignore") {
+                        logger.info("found ignored setting for otherPortsAttributes in devcontainer.json")
+                        defaultForward = false
+                    }
                 }
             } catch (e: Exception) {
                 logger.warn("Failed to parse devcontainer.json", e)
@@ -151,8 +154,4 @@ class CoderPortForwardService(
             }
         }
     }
-
-    private fun isValidString(value: Any?): Boolean {
-        return value != null && value is String
-    }
 }

src/main/kotlin/com/coder/jetbrains/services/DevContainerConfig.kt

@@ -0,0 +1,24 @@
+package com.coder.jetbrains.services
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class DevContainerConfig(
+    @SerialName("portsAttributes")
+    val portsAttributes: Map<String, PortAttributes> = mapOf(),
+    @SerialName("otherPortsAttributes")
+    val otherPortsAttributes: OtherPortsAttributes? = null
+)
+
+@Serializable
+data class PortAttributes(
+    @SerialName("onAutoForward")
+    val onAutoForward: String = ""
+)
+
+@Serializable
+data class OtherPortsAttributes(
+    @SerialName("onAutoForward")
+    val onAutoForward: String = ""
+)