KTOR-5085: Add multiplatform support for XML serialization (#4225)

osipxd · marychatte · web-flow · commit 8127833c1671 · 2024-09-04T14:17:52.000+02:00
* Make ktor-serialization-kotlinx-xml multiplatform
* Disable JS browser target for server modules via gradle.properties

---------

Co-authored-by: Mariia Skripchenko &lt;61115099+marychatte@users.noreply.github.com&gt;
diff --git a/buildSrc/src/main/kotlin/JsConfig.kt b/buildSrc/src/main/kotlin/JsConfig.kt
@@ -27,10 +27,12 @@ fun Project.configureJs() {
 private fun Project.configureJsTasks() {
     kotlin {
         js {
-            nodejs {
-                testTask {
-                    useMocha {
-                        timeout = "10000"
+            if (project.targetIsEnabled("js.nodeJs")) {
+                nodejs {
+                    testTask {
+                        useMocha {
+                            timeout = "10000"
+                        }
                     }
                 }
             }
diff --git a/buildSrc/src/main/kotlin/NativeUtils.kt b/buildSrc/src/main/kotlin/NativeUtils.kt
@@ -38,8 +38,13 @@ fun Project.watchosTargets(): List<String> = with(kotlin) {
         watchosArm32(),
         watchosArm64(),
         watchosSimulatorArm64(),
-        // because of dependency on YAML library: https://github.com/Him188/yamlkt/issues/67
-        if (project.name != "ktor-server-config-yaml") watchosDeviceArm64() else null,
+        // ktor-server-config-yaml: because of dependency on YAML library: https://github.com/Him188/yamlkt/issues/67
+        // ktor-serialization-kotlinx-xml: because of dependency on xmlutil library: https://repo.maven.apache.org/maven2/io/github/pdvrieze/xmlutil/ // ktlint-disable max-line-length
+        if ((project.name != "ktor-server-config-yaml") && (project.name != "ktor-serialization-kotlinx-xml")) {
+            watchosDeviceArm64()
+        } else {
+            null
+        },
     ).map { it.name }
 }
 
diff --git a/buildSrc/src/main/kotlin/TargetsConfig.kt b/buildSrc/src/main/kotlin/TargetsConfig.kt
@@ -32,13 +32,8 @@ fun Project.configureTargets() {
     kotlin {
         if (hasJs) {
             js {
-                nodejs()
-                // we don't test `server` modules in a browser.
-                // there are 2 explanations why:
-                // * logical - we don't need server in browser
-                // * technical - we don't have access to files, os, etc.
-                // Also, because of the ` origin ` URL in a browser, special support in `test-host` need to be implemented
-                if (!project.name.startsWith("ktor-server")) browser()
+                if (project.targetIsEnabled("js.nodeJs")) nodejs()
+                if (project.targetIsEnabled("js.browser")) browser()
             }
 
             configureJs()
@@ -48,8 +43,7 @@ fun Project.configureTargets() {
             @OptIn(ExperimentalWasmDsl::class)
             wasmJs {
                 nodejs()
-                // we don't test `server` modules in a browser.
-                if (!project.name.startsWith("ktor-server")) browser()
+                if (project.targetIsEnabled("wasmJs.browser")) browser()
             }
 
             configureWasm()
@@ -354,3 +348,16 @@ fun Project.configureTargets() {
         }
     }
 }
+
+/**
+ * By default, all targets are enabled. To disable specific target,
+ * disable the corresponding flag in `gradle.properties` of the target project.
+ *
+ * Targets that could be disabled:
+ * - `target.js.nodeJs`
+ * - `target.js.browser`
+ * - `target.wasmJs.browser`
+ */
+internal fun Project.targetIsEnabled(target: String): Boolean {
+    return findProperty("target.$target") != "false"
+}
diff --git a/ktor-server/gradle.properties b/ktor-server/gradle.properties
@@ -0,0 +1,11 @@
+#
+# Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+#
+
+# We don't test `server` modules in a browser.
+# there are 2 explanations why:
+# * logical - we don't need server in browser
+# * technical - we don't have access to files, os, etc.
+# Also, because of the ` origin ` URL in a browser, special support in `test-host` need to be implemented
+target.js.browser=false
+target.wasmJs.browser=false
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/api/ktor-serialization-kotlinx-xml.klib.api b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/api/ktor-serialization-kotlinx-xml.klib.api
@@ -0,0 +1,12 @@
+// Klib ABI Dump
+// Targets: [iosArm64, iosSimulatorArm64, iosX64, js, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64, tvosArm64, tvosSimulatorArm64, tvosX64, wasmJs, watchosArm32, watchosArm64, watchosSimulatorArm64, watchosX64]
+// Rendering settings:
+// - Signature version: 2
+// - Show manifest properties: true
+// - Show declarations: true
+
+// Library unique name: <io.ktor:ktor-serialization-kotlinx-xml>
+final val io.ktor.serialization.kotlinx.xml/DefaultXml // io.ktor.serialization.kotlinx.xml/DefaultXml|{}DefaultXml[0]
+    final fun <get-DefaultXml>(): nl.adaptivity.xmlutil.serialization/XML // io.ktor.serialization.kotlinx.xml/DefaultXml.<get-DefaultXml>|<get-DefaultXml>(){}[0]
+
+final fun (io.ktor.serialization/Configuration).io.ktor.serialization.kotlinx.xml/xml(nl.adaptivity.xmlutil.serialization/XML = ..., io.ktor.http/ContentType = ...) // io.ktor.serialization.kotlinx.xml/xml|xml@io.ktor.serialization.Configuration(nl.adaptivity.xmlutil.serialization.XML;io.ktor.http.ContentType){}[0]
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/build.gradle.kts b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/build.gradle.kts
@@ -1,26 +1,26 @@
 /*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
 plugins {
     id("kotlinx-serialization")
 }
 
 kotlin.sourceSets {
-    jvmMain {
+    commonMain {
         dependencies {
             api(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx"))
             api(libs.xmlutil.serialization)
         }
     }
+    commonTest {
+        dependencies {
+            implementation(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx:ktor-serialization-kotlinx-tests")) // ktlint-disable max-line-length
+        }
+    }
     jvmTest {
         dependencies {
-            api(project(":ktor-client:ktor-client-tests"))
-            api(project(":ktor-server:ktor-server-test-host"))
-            api(project(":ktor-client:ktor-client-plugins:ktor-client-content-negotiation:ktor-client-content-negotiation-tests")) // ktlint-disable max-line-length
-            api(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx:ktor-serialization-kotlinx-tests"))
-
-            api(libs.logback.classic)
+            implementation(project(":ktor-client:ktor-client-plugins:ktor-client-content-negotiation:ktor-client-content-negotiation-tests")) // ktlint-disable max-line-length
         }
     }
 }
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/common/src/io/ktor/serialization/kotlinx/xml/XmlSupport.kt b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/common/src/io/ktor/serialization/kotlinx/xml/XmlSupport.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
 package io.ktor.serialization.kotlinx.xml
@@ -21,13 +21,11 @@ import nl.adaptivity.xmlutil.serialization.*
  *
  * See [XML] for more details.
  */
-@OptIn(XmlUtilInternal::class)
 public val DefaultXml: XML = XML {
     repairNamespaces = true
     xmlDeclMode = XmlDeclMode.None
     indentString = ""
     autoPolymorphic = false
-    this.xmlDeclMode
 }
 
 /**
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/common/test/XmlSerializationTest.kt b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/common/test/XmlSerializationTest.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
 import io.ktor.http.*
@@ -9,6 +9,7 @@ import io.ktor.serialization.kotlinx.*
 import io.ktor.serialization.kotlinx.xml.*
 import io.ktor.test.dispatcher.*
 import io.ktor.util.reflect.*
+import io.ktor.utils.io.charsets.*
 import kotlinx.serialization.*
 import kotlin.test.*
 
@@ -45,6 +46,14 @@ class XmlSerializationTest {
 
     private suspend inline fun <reified T : Any> ContentConverter.testSerialize(data: T): String {
         val content = serialize(ContentType.Application.Xml, Charsets.UTF_8, typeInfo<T>(), data)
-        return (content as? TextContent)?.text ?: error("Failed to get serialized $data")
+        val xml = checkNotNull((content as? TextContent)?.text) { "Failed to get serialized $data" }
+        return xml.normalizeXml()
     }
+
+    // Output of XML serializer differs on different targets, so we should normalize it before comparison.
+    // See: https://github.com/pdvrieze/xmlutil/blob/v0.90.1/serialization/src/commonTest/kotlin/nl/adaptivity/xml/serialization/TestCommon.kt#L43-L46
+    private fun String.normalizeXml(): String = replace(" />", "/>")
+        .replace(" ?>", "?>")
+        .replace("\r\n", "\n")
+        .replace("&gt;", ">")
 }
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/gradle.properties b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/gradle.properties
@@ -0,0 +1,7 @@
+#
+# Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+#
+
+# xmlutil uses DOM API under the hood so it doesn't support Node.js.
+# Issue: https://github.com/pdvrieze/xmlutil/issues/83
+target.js.nodeJs=false
diff --git a/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/jvm/test/XmlServerKotlinxSerializationTest.kt b/ktor-shared/ktor-serialization/ktor-serialization-kotlinx/ktor-serialization-kotlinx-xml/jvm/test/XmlServerKotlinxSerializationTest.kt
@@ -1,12 +1,12 @@
 /*
- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
  */
 
 import io.ktor.http.*
 import io.ktor.serialization.kotlinx.test.*
 import io.ktor.serialization.kotlinx.xml.*
 import io.ktor.server.plugins.contentnegotiation.*
-import java.nio.charset.*
+import io.ktor.utils.io.charsets.*
 import kotlin.test.*
 
 class XmlServerKotlinxSerializationTest : AbstractServerSerializationKotlinxTest() {

Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,12 @@ fun Project.configureJs() {`
`27`	`27`	`private fun Project.configureJsTasks() {`
`28`	`28`	`kotlin {`
`29`	`29`	`js {`
`30`		`- nodejs {`
`31`		`- testTask {`
`32`		`- useMocha {`
`33`		`- timeout = "10000"`
	`30`	`+ if (project.targetIsEnabled("js.nodeJs")) {`
	`31`	`+ nodejs {`
	`32`	`+ testTask {`
	`33`	`+ useMocha {`
	`34`	`+ timeout = "10000"`
	`35`	`+ }`
`34`	`36`	`}`
`35`	`37`	`}`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,26 +1,26 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2014-2021 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.`
	`2`	`+ * Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.`
`3`	`3`	`*/`
`4`	`4`
`5`	`5`	`plugins {`
`6`	`6`	`id("kotlinx-serialization")`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`kotlin.sourceSets {`
`10`		`- jvmMain {`
	`10`	`+ commonMain {`
`11`	`11`	`dependencies {`
`12`	`12`	`api(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx"))`
`13`	`13`	`api(libs.xmlutil.serialization)`
`14`	`14`	`}`
`15`	`15`	`}`
	`16`	`+ commonTest {`
	`17`	`+ dependencies {`
	`18`	`+ implementation(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx:ktor-serialization-kotlinx-tests")) // ktlint-disable max-line-length`
	`19`	`+ }`
	`20`	`+ }`
`16`	`21`	`jvmTest {`
`17`	`22`	`dependencies {`
`18`		`- api(project(":ktor-client:ktor-client-tests"))`
`19`		`- api(project(":ktor-server:ktor-server-test-host"))`
`20`		`- api(project(":ktor-client:ktor-client-plugins:ktor-client-content-negotiation:ktor-client-content-negotiation-tests")) // ktlint-disable max-line-length`
`21`		`- api(project(":ktor-shared:ktor-serialization:ktor-serialization-kotlinx:ktor-serialization-kotlinx-tests"))`
`22`		`-`
`23`		`- api(libs.logback.classic)`
	`23`	`+ implementation(project(":ktor-client:ktor-client-plugins:ktor-client-content-negotiation:ktor-client-content-negotiation-tests")) // ktlint-disable max-line-length`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`}`