Add api kotlinx-atomicfu dependency for JS and WASM targets.

mvicsokolova · mvicsokolova · commit 19f56ab90cd9 · 2024-10-17T19:40:27.000+02:00
Fixes #448
diff --git a/atomicfu-gradle-plugin/src/main/kotlin/kotlinx/atomicfu/plugin/gradle/AtomicFUGradlePlugin.kt b/atomicfu-gradle-plugin/src/main/kotlin/kotlinx/atomicfu/plugin/gradle/AtomicFUGradlePlugin.kt
@@ -132,10 +132,14 @@ private fun Project.configureMultiplatformPluginDependencies(version: String) {
                     }
             }
         }
-    // atomicfu should also appear in apiElements config for native targets, 
+    // atomicfu should also appear in apiElements config for Kotlin/Native, JS and WASM targets,
     // otherwise the warning is triggered, see: KT-64109
     multiplatformExtension.targets
-        .matching { target -> target.platformType == KotlinPlatformType.native }
+        .matching { target ->
+            target.platformType == KotlinPlatformType.native ||
+            target.platformType == KotlinPlatformType.wasm ||
+            target.platformType == KotlinPlatformType.js
+        }
         .all { target ->
             target.compilations.all { compilation ->
                 compilation
diff --git a/integration-testing/examples/mpp-sample/build.gradle.kts b/integration-testing/examples/mpp-sample/build.gradle.kts
@@ -22,10 +22,16 @@ repositories {
 kotlin {
     jvm()
 
-    js()
+    js {
+        nodejs()
+    }
 
-    wasmJs {}
-    wasmWasi {}
+    wasmJs {
+        nodejs()
+    }
+    wasmWasi {
+        nodejs()
+    }
 
     macosArm64()
     macosX64()
diff --git a/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/cases/JvmProjectTest.kt b/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/cases/JvmProjectTest.kt
@@ -15,15 +15,17 @@ class JvmProjectTest {
     @Test
     fun testJvmWithEnabledIrTransformation() {
         jvmSample.enableJvmIrTransformation = true
-        jvmSample.checkJvmCompileOnlyDependencies()
+        jvmSample.jvmCheckAtomicfuInCompileClasspath()
+        jvmSample.jvmCheckNoAtomicfuInRuntimeConfigs()
         jvmSample.checkConsumableDependencies()
         jvmSample.buildAndCheckBytecode()
     }
 
     @Test
     fun testJvmWithDisabledIrTransformation() {
         jvmSample.enableJvmIrTransformation = false
-        jvmSample.checkJvmCompileOnlyDependencies()
+        jvmSample.jvmCheckAtomicfuInCompileClasspath()
+        jvmSample.jvmCheckNoAtomicfuInRuntimeConfigs()
         jvmSample.checkConsumableDependencies()
         jvmSample.buildAndCheckBytecode()
     }
diff --git a/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/cases/MppProjectTest.kt b/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/cases/MppProjectTest.kt
@@ -14,15 +14,17 @@ class MppProjectTest {
     @Test
     fun testMppWithEnabledJvmIrTransformation() {
         mppSample.enableJvmIrTransformation = true
-        mppSample.checkMppJvmCompileOnlyDependencies()
+        mppSample.mppCheckAtomicfuInCompileClasspath("jvm")
+        mppSample.mppCheckNoAtomicfuInRuntimeConfigs("jvm")
         mppSample.checkConsumableDependencies()
         mppSample.buildAndCheckBytecode()
     }
 
     @Test
     fun testMppWithDisabledJvmIrTransformation() {
         mppSample.enableJvmIrTransformation = false
-        mppSample.checkMppJvmCompileOnlyDependencies()
+        mppSample.mppCheckAtomicfuInCompileClasspath("jvm")
+        mppSample.mppCheckNoAtomicfuInRuntimeConfigs("jvm")
         mppSample.checkConsumableDependencies()
         mppSample.buildAndCheckBytecode()
     }
@@ -33,28 +35,42 @@ class MppProjectTest {
         mppSample.enableJsIrTransformation = true
         mppSample.cleanAndBuild()
         mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("js")
     }
 
     @Test
     fun testMppWithDisabledJsIrTransformation() {
         mppSample.enableJsIrTransformation = false
         mppSample.cleanAndBuild()
         mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("js")
     }
 
     @Test
-    fun testMppWasmBuild() {
+    fun testMppWasmJsBuild() {
         mppSample.cleanAndBuild()
-        mppSample.checkMppWasmJsImplementationDependencies()
-        mppSample.checkMppWasmWasiImplementationDependencies()
+        mppSample.mppCheckAtomicfuInCompileClasspath("wasmJs")
+        mppSample.mppCheckAtomicfuInRuntimeClasspath("wasmJs")
+        mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("wasmJs")
+    }
+
+    @Test
+    fun testMppWasmWasiBuild() {
+        mppSample.mppCheckAtomicfuInCompileClasspath("wasmWasi")
+        mppSample.mppCheckAtomicfuInRuntimeClasspath("wasmWasi")
+        mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("wasmWasi")
     }
 
     @Test
     fun testMppNativeWithEnabledIrTransformation() {
         mppSample.enableNativeIrTransformation = true
         mppSample.cleanAndBuild()
         // When Native IR transformations are applied, atomicfu-gradle-plugin still provides transitive atomicfu dependency
-        mppSample.checkMppNativeImplementationDependencies()
+        mppSample.mppNativeCheckAtomicfuInImplementation()
+        mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("macosX64")
         // TODO: klib checks are skipped for now because of this problem KT-61143
         //mppSample.buildAndCheckNativeKlib()
     }
@@ -63,7 +79,9 @@ class MppProjectTest {
     fun testMppNativeWithDisabledIrTransformation() {
         mppSample.enableNativeIrTransformation = false
         mppSample.cleanAndBuild()
-        mppSample.checkMppNativeImplementationDependencies()
+        mppSample.mppNativeCheckAtomicfuInImplementation()
+        mppSample.checkConsumableDependencies()
+        mppSample.mppCheckAtomicfuInApi("macosX64")
         // TODO: klib checks are skipped for now because of this problem KT-61143
         //mppSample.buildAndCheckNativeKlib()
     }
diff --git a/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/framework/checker/DependenciesChecker.kt b/integration-testing/src/functionalTest/kotlin/kotlinx.atomicfu.gradle.plugin.test/framework/checker/DependenciesChecker.kt
@@ -24,52 +24,47 @@ private fun GradleBuild.checkAtomicfuDependencyIsAbsent(configurations: List<Str
     val dependencies = dependencies()
     for (config in configurations) {
         val configDependencies = dependencies.getDependenciesForConfig(config)
-        check(!configDependencies.contains(atomicfuDependency)) { "Dependency $atomicfuDependency should be compileOnly, but it was found in the configuration: $config" }
+        check(!configDependencies.contains(atomicfuDependency)) { "Dependency $atomicfuDependency should not be present in the configuration: $config" }
     }
 }
 
+internal fun GradleBuild.jvmCheckAtomicfuInCompileClasspath() {
+    checkAtomicfuDependencyIsPresent(listOf("compileClasspath"), jvmAtomicfuDependency)
+}
+
+internal fun GradleBuild.mppCheckAtomicfuInCompileClasspath(targetName: String) {
+    checkAtomicfuDependencyIsPresent(listOf("${targetName}CompileClasspath"), commonAtomicfuDependency)
+}
+
+internal fun GradleBuild.mppCheckAtomicfuInRuntimeClasspath(targetName: String) {
+    checkAtomicfuDependencyIsPresent(listOf("${targetName}CompileClasspath"), commonAtomicfuDependency)
+}
+
 /**
- * For JVM there are 4 final configurations:
+ * There are 4 final configurations:
  * compileClasspath — compile dependencies
  * runtimeClasspath — runtime dependencies
  * apiElements — compile dependencies that will be included in publication
  * runtimeElements — runtime dependencies that will be included in publication
  *
- * The functions below check that `org.jetbrains.kotlinx:atomicfu` dependency is only included in compile configurations.
+ * The functions below check that `org.jetbrains.kotlinx:atomicfu` dependency is not present in the runtime configurations.
  */
 
-// Checks a simple JVM project with a single target
-internal fun GradleBuild.checkJvmCompileOnlyDependencies() {
-    checkAtomicfuDependencyIsPresent(listOf("compileClasspath"), jvmAtomicfuDependency)
+internal fun GradleBuild.jvmCheckNoAtomicfuInRuntimeConfigs() {
     checkAtomicfuDependencyIsAbsent(listOf("runtimeClasspath", "apiElements", "runtimeElements"), jvmAtomicfuDependency)
 }
 
-// Checks JVM target of an MPP project
-internal fun GradleBuild.checkMppJvmCompileOnlyDependencies() {
-    checkAtomicfuDependencyIsPresent(listOf("jvmCompileClasspath"), commonAtomicfuDependency)
-    checkAtomicfuDependencyIsAbsent(listOf("jvmRuntimeClasspath", "jvmApiElements", "jvmRuntimeElements"), commonAtomicfuDependency)
-}
-
-// Checks wasmJs target of an MPP project
-internal fun GradleBuild.checkMppWasmJsImplementationDependencies() {
-    checkAtomicfuDependencyIsPresent(listOf("wasmJsCompileClasspath", "wasmJsRuntimeClasspath"), commonAtomicfuDependency)
+internal fun GradleBuild.mppCheckNoAtomicfuInRuntimeConfigs(targetName: String) {
+    checkAtomicfuDependencyIsAbsent(listOf("${targetName}RuntimeClasspath", "${targetName}ApiElements", "${targetName}RuntimeElements"), commonAtomicfuDependency)
 }
 
-internal fun GradleBuild.checkMppWasmWasiImplementationDependencies() {
-    checkAtomicfuDependencyIsPresent(listOf("wasmWasiCompileClasspath", "wasmWasiRuntimeClasspath"), commonAtomicfuDependency)
-}
-
-// Checks Native target of an MPP project
-internal fun GradleBuild.checkMppNativeCompileOnlyDependencies() {
-    // Here the name of the native target is hardcoded because the tested mpp-sample project declares this target and
-    // KGP generates the same set of dependencies for every declared native target ([mingwX64|linuxX64|macosX64...]CompileKlibraries)
-    checkAtomicfuDependencyIsPresent(listOf("macosX64CompileKlibraries"), commonAtomicfuDependency)
-    checkAtomicfuDependencyIsAbsent(listOf("macosX64MainImplementation"), commonAtomicfuDependency)
+internal fun GradleBuild.mppCheckAtomicfuInApi(targetName: String) {
+    checkAtomicfuDependencyIsPresent(listOf("${targetName}MainApi"), commonAtomicfuDependency)
 }
 
 // Checks Native target of an MPP project
-internal fun GradleBuild.checkMppNativeImplementationDependencies() {
-    checkAtomicfuDependencyIsPresent(listOf("macosX64CompileKlibraries", "macosX64MainImplementation"), commonAtomicfuDependency)
+internal fun GradleBuild.mppNativeCheckAtomicfuInImplementation() {
+    checkAtomicfuDependencyIsPresent(listOf("macosX64MainImplementation"), commonAtomicfuDependency)
 }
 
 // Some dependencies may be not resolvable but consumable and will not be present in the output of :dependencies task,

Original file line number	Diff line number	Diff line change
`@@ -132,10 +132,14 @@ private fun Project.configureMultiplatformPluginDependencies(version: String) {`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`	`}`
`135`		`- // atomicfu should also appear in apiElements config for native targets,`
	`135`	`+ // atomicfu should also appear in apiElements config for Kotlin/Native, JS and WASM targets,`
`136`	`136`	`// otherwise the warning is triggered, see: KT-64109`
`137`	`137`	`multiplatformExtension.targets`
`138`		`- .matching { target -> target.platformType == KotlinPlatformType.native }`
	`138`	`+ .matching { target ->`
	`139`	`+ target.platformType == KotlinPlatformType.native \|\|`
	`140`	`+ target.platformType == KotlinPlatformType.wasm \|\|`
	`141`	`+ target.platformType == KotlinPlatformType.js`
	`142`	`+ }`
`139`	`143`	`.all { target ->`
`140`	`144`	`target.compilations.all { compilation ->`
`141`	`145`	`compilation`