Generate unique Automatic-Module-Name for metadata JARs (#3109)

Fixes #2901

Author: fzhinkin

buildSrc/src/main/kotlin/Java9Modularity.kt

@@ -241,4 +241,28 @@ object Java9Modularity {
             )
         })
     }
+
+    /**
+     * For multiplatform Gradle modules, generate and set `Automatic-Module-Name` in metadata JAR's manifest.
+     *
+     * Generated automatic (JPMS) module name has the following format:
+     * `<Gradle module name>. artifact_disambiguating_module`.
+     *
+     * For multiplatform projects, a metadata artifact is the one without a platform-specific suffix,
+     * and it always depends on corresponding `-jvm` artifact (for convenience on build systems other than Gradle).
+     * For a JVM project depending on such an artifact and using JPMS, it may result in the automatic module name clash
+     * with a module provided by the `-jvm` artifact. By explicitly setting a non-clashing automatic module name in
+     * metadata JAR's manifest, we're mitigating this issue.
+     */
+    fun Project.configureMetadataJarAutomaticModuleName() {
+        val kotlin = extensions.findByType<KotlinMultiplatformExtension>() ?: return
+        val moduleName = project.name.replace('-', '.') + ".artifact_disambiguating_module"
+        tasks.withType<Jar>().named(kotlin.metadata().artifactsTaskName) {
+            manifest {
+                attributes(
+                    "Automatic-Module-Name" to moduleName,
+                )
+            }
+        }
+    }
 }

core/build.gradle.kts

@@ -1,4 +1,5 @@
 import Java9Modularity.configureJava9ModuleInfo
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 import org.jetbrains.kotlin.gradle.targets.js.ir.*
 
 /*
@@ -69,6 +70,7 @@ tasks.withType<Jar>().named(kotlin.jvm().artifactsTaskName) {
 }
 
 configureJava9ModuleInfo()
+configureMetadataJarAutomaticModuleName()
 
 tasks.withType<KotlinJsIrLink>().configureEach {
     compilerOptions.freeCompilerArgs.add("-Xwasm-enable-array-range-checks")

formats/cbor/build.gradle.kts

@@ -1,4 +1,5 @@
 import Java9Modularity.configureJava9ModuleInfo
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 /*
  * Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
@@ -36,3 +37,4 @@ kotlin {
 }
 
 configureJava9ModuleInfo()
+configureMetadataJarAutomaticModuleName()

formats/json-io/build.gradle.kts

@@ -2,8 +2,7 @@
  * Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
  */
 import Java9Modularity.configureJava9ModuleInfo
-import org.jetbrains.dokka.gradle.*
-import java.net.*
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 plugins {
     kotlin("multiplatform")
@@ -32,6 +31,7 @@ kotlin {
 }
 
 project.configureJava9ModuleInfo()
+project.configureMetadataJarAutomaticModuleName()
 
 dokka.dokkaSourceSets.configureEach {
     externalDocumentationLinks.register("kotlinx-io") {

formats/json-okio/build.gradle.kts

@@ -2,8 +2,7 @@
  * Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
  */
 import Java9Modularity.configureJava9ModuleInfo
-import org.jetbrains.dokka.gradle.*
-import java.net.*
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 plugins {
     kotlin("multiplatform")
@@ -33,6 +32,7 @@ kotlin {
 }
 
 project.configureJava9ModuleInfo()
+project.configureMetadataJarAutomaticModuleName()
 
 dokka.dokkaSourceSets.configureEach {
     externalDocumentationLinks.register("okio") {

formats/json/build.gradle.kts

@@ -1,5 +1,5 @@
 import Java9Modularity.configureJava9ModuleInfo
-import org.jetbrains.kotlin.gradle.tasks.*
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 /*
  * Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
@@ -53,3 +53,4 @@ kotlin {
 }
 
 configureJava9ModuleInfo()
+configureMetadataJarAutomaticModuleName()

formats/properties/build.gradle.kts

@@ -1,4 +1,5 @@
 import Java9Modularity.configureJava9ModuleInfo
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 /*
  * Copyright 2017-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
@@ -36,3 +37,4 @@ kotlin {
 }
 
 configureJava9ModuleInfo()
+configureMetadataJarAutomaticModuleName()

formats/protobuf/build.gradle.kts

@@ -2,6 +2,7 @@
  * Copyright 2017-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
  */
 import Java9Modularity.configureJava9ModuleInfo
+import Java9Modularity.configureMetadataJarAutomaticModuleName
 
 plugins {
     kotlin("multiplatform")
@@ -34,3 +35,4 @@ kotlin {
 }
 
 configureJava9ModuleInfo()
+configureMetadataJarAutomaticModuleName()