Merge pull request #37 from highmobility/v1-ignore-keys

v1 ignore keys
highmobility · Jan 31, 2024 · f8d763f · f8d763f
2 parents b16bbbb + d6020db
commit f8d763f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 This is the changelog for v1 releases. See v0 changelog in the [v0 branch](https://github.com/highmobility/hmkit-fleet/tree/v0).
 
+## [1.0.4] - 2024-1-31
+
+- Fix `Json {} ignoreUnknownKeys` error
+
 ## [1.0.3] - 2023-11-29
 
 ### Added

diff --git a/gradle.properties b/gradle.properties
@@ -1,2 +1,2 @@
-version=1.0.3
+version=1.0.4
 kotlin.code.style=official
diff --git a/hmkit-fleet/src/main/kotlin/network/AccessCertificateRequests.kt b/hmkit-fleet/src/main/kotlin/network/AccessCertificateRequests.kt
@@ -66,7 +66,7 @@ internal class AccessCertificateRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_CREATED) { body ->
-            val jsonResponse = Json.parseToJsonElement(body) as JsonObject
+            val jsonResponse = jsonIg.parseToJsonElement(body) as JsonObject
             val certBytes = jsonResponse.jsonObject[apiDeviceCertKey]?.jsonPrimitive?.content
             val cert = AccessCertificate(certBytes)
             Response(cert, null)

diff --git a/hmkit-fleet/src/main/kotlin/network/AuthTokenRequests.kt b/hmkit-fleet/src/main/kotlin/network/AuthTokenRequests.kt
@@ -73,7 +73,7 @@ internal class AuthTokenRequests(
 
         return try {
             if (response.code == HttpURLConnection.HTTP_CREATED) {
-                cache.authToken = Json.decodeFromString(responseBody)
+                cache.authToken = jsonIg.decodeFromString(responseBody)
                 Response(cache.authToken)
             } else {
                 parseError(responseBody)

diff --git a/hmkit-fleet/src/main/kotlin/network/ClearanceRequests.kt b/hmkit-fleet/src/main/kotlin/network/ClearanceRequests.kt
@@ -69,11 +69,11 @@ internal class ClearanceRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
-            val jsonElement = Json.parseToJsonElement(responseBody) as JsonObject
+            val jsonElement = jsonIg.parseToJsonElement(responseBody) as JsonObject
             val statuses = jsonElement["vehicles"] as JsonArray
             for (statusElement in statuses) {
                 val status =
-                    Json.decodeFromJsonElement<RequestClearanceResponse>(statusElement)
+                    jsonIg.decodeFromJsonElement<RequestClearanceResponse>(statusElement)
                 if (status.vin == vin) {
                     return Response(status, null)
                 }
@@ -100,11 +100,11 @@ internal class ClearanceRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
-            val statuses = Json.parseToJsonElement(responseBody) as JsonArray
+            val statuses = jsonIg.parseToJsonElement(responseBody) as JsonArray
 
             val builder = Array(statuses.size) {
                 val statusElement = statuses[it]
-                val status = Json.decodeFromJsonElement<ClearanceStatus>(statusElement)
+                val status = jsonIg.decodeFromJsonElement<ClearanceStatus>(statusElement)
                 status
             }
 
@@ -130,7 +130,7 @@ internal class ClearanceRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
-            val status = Json.decodeFromString<ClearanceStatus>(responseBody)
+            val status = jsonIg.decodeFromString<ClearanceStatus>(responseBody)
             Response(status)
         }
     }
@@ -154,7 +154,7 @@ internal class ClearanceRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
-            val status = Json.decodeFromString<RequestClearanceResponse>(responseBody)
+            val status = jsonIg.decodeFromString<RequestClearanceResponse>(responseBody)
             Response(status)
         }
     }
@@ -166,14 +166,14 @@ internal class ClearanceRequests(
     ): RequestBody {
         val vehicle = buildJsonObject {
             put("vin", vin)
-            put("brand", Json.encodeToJsonElement(brand))
+            put("brand", jsonIg.encodeToJsonElement(brand))
             if (controlMeasures != null) {
                 putJsonObject("control_measures") {
                     for (controlMeasure in controlMeasures) {
                         // polymorphism adds type key to child controlmeasure classes. remove with filter
-                        val json = Json.encodeToJsonElement(controlMeasure)
+                        val json = jsonIg.encodeToJsonElement(controlMeasure)
                         val valuesWithoutType = json.jsonObject.filterNot { it.key == "type" }
-                        val jsonTrimmed = Json.encodeToJsonElement(valuesWithoutType)
+                        val jsonTrimmed = jsonIg.encodeToJsonElement(valuesWithoutType)
                         put("odometer", jsonTrimmed)
                     }
                 }

diff --git a/hmkit-fleet/src/main/kotlin/network/Requests.kt b/hmkit-fleet/src/main/kotlin/network/Requests.kt
@@ -41,6 +41,15 @@ internal open class Requests(
     val mediaType = "application/json; charset=utf-8".toMediaType()
     val baseHeaders = Headers.Builder().add("Content-Type", "application/json").build()
 
+    protected val jsonIg = Json {
+        ignoreUnknownKeys = true
+    }
+
+    private val jsonIgPr = Json {
+        ignoreUnknownKeys = true
+        prettyPrint = true
+    }
+
     inline fun <T> tryParseResponse(
         response: Response,
         expectedResponseCode: Int,
@@ -61,14 +70,12 @@ internal open class Requests(
     }
 
     fun printRequest(request: Request) {
-        val format = Json { prettyPrint = true }
-
         // parse into json, so can log it out with pretty print
         val body = request.bodyAsString()
         var bodyInPrettyPrint = ""
         if (!body.isNullOrBlank()) {
-            val jsonElement = format.decodeFromString<JsonElement>(body)
-            bodyInPrettyPrint = format.encodeToString(jsonElement)
+            val jsonElement = jsonIgPr.decodeFromString<JsonElement>(body)
+            bodyInPrettyPrint = jsonIgPr.encodeToString(jsonElement)
         }
 
         logger.debug(
@@ -85,14 +92,14 @@ internal open class Requests(
     }
 
     fun <T> parseError(responseBody: String): com.highmobility.hmkitfleet.network.Response<T> {
-        val json = Json.parseToJsonElement(responseBody)
+        val json = jsonIg.parseToJsonElement(responseBody)
         if (json is JsonObject) {
             // there are 3 error formats
             val errors = json["errors"] as? JsonArray
 
             return if (errors != null && errors.size > 0) {
                 val error =
-                    Json.decodeFromJsonElement<Error>(errors.first())
+                    jsonIg.decodeFromJsonElement<Error>(errors.first())
                 Response(null, error)
             } else {
                 val error = Error(
@@ -104,7 +111,7 @@ internal open class Requests(
             }
         } else if (json is JsonArray) {
             if (json.size > 0) {
-                val error = Json.decodeFromJsonElement<Error>(json.first())
+                val error = jsonIg.decodeFromJsonElement<Error>(json.first())
                 return Response(null, error)
             }
         }

diff --git a/hmkit-fleet/src/main/kotlin/network/TelematicsRequests.kt b/hmkit-fleet/src/main/kotlin/network/TelematicsRequests.kt
@@ -83,7 +83,7 @@ internal class TelematicsRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_CREATED) { body ->
-            val jsonResponse = Json.parseToJsonElement(body) as JsonObject
+            val jsonResponse = jsonIg.parseToJsonElement(body) as JsonObject
             val nonce = jsonResponse.jsonObject["nonce"]?.jsonPrimitive?.content
             Response(nonce, null)
         }
@@ -114,7 +114,7 @@ internal class TelematicsRequests(
 
         val responseObject = try {
             if (response.code == 200 || response.code == 400 || response.code == 404 || response.code == 408) {
-                val telematicsResponse = Json.decodeFromString<TelematicsCommandResponse>(responseBody)
+                val telematicsResponse = jsonIg.decodeFromString<TelematicsCommandResponse>(responseBody)
 
                 // Server only returns encrypted data if status is OK
                 val decryptedData = if (telematicsResponse.status == TelematicsCommandResponse.Status.OK) {
@@ -137,7 +137,7 @@ internal class TelematicsRequests(
             } else {
                 // try to parse the normal server error format.
                 // it will throw and will be caught if server returned unknown format
-                TelematicsResponse(errors = Json.decodeFromString(responseBody))
+                TelematicsResponse(errors = jsonIg.decodeFromString(responseBody))
             }
         } catch (e: Exception) {
             TelematicsResponse(errors = listOf(Error(title = "Unknown server response", detail = e.message)))

diff --git a/hmkit-fleet/src/main/kotlin/network/UtilityRequests.kt b/hmkit-fleet/src/main/kotlin/network/UtilityRequests.kt
@@ -70,7 +70,7 @@ internal class UtilityRequests(
         val response = call.await()
 
         return tryParseResponse(response, HttpURLConnection.HTTP_OK) { responseBody ->
-            val eligibilityStatus = Json.decodeFromString<EligibilityStatus>(responseBody)
+            val eligibilityStatus = jsonIg.decodeFromString<EligibilityStatus>(responseBody)
             if (eligibilityStatus.vin != vin) logger.warn("VIN in response does not match VIN in request")
             Response(eligibilityStatus, null)
         }
@@ -82,10 +82,10 @@ internal class UtilityRequests(
     ): RequestBody {
         val vehicle = buildJsonObject {
             put("vin", vin)
-            put("brand", Json.encodeToJsonElement(brand))
+            put("brand", jsonIg.encodeToJsonElement(brand))
         }
 
-        val body = Json.encodeToString(vehicle).toRequestBody(mediaType)
+        val body = jsonIg.encodeToString(vehicle).toRequestBody(mediaType)
         return body
     }
 }