When applying Kotlinx-Serialization and KMP-Native...

# multiplatform

[Kirill Zhukov]

When applying Kotlinx-Serialization and KMP-NativeCoroutines plugins in the same KMP module, getting this error during configuration:

> Cannot add task 'commonizeNativeDistribution' as a task with that name already exists.

Any ideas?

[Rick Clephas]

Interesting, KMP-NativeCoroutines doesn't use the cinterop commonizer. Do you have any more details about your setup? Any other plugins / dependencies that might affect this?

[Kirill Zhukov]

Kotlin 1.7.20
Gradle 7.5

I got a custom build logic Gradle plugin though which I add Gradle plugins to the classpath:

// build-logic/build.gradle.kts
dependencies {
  implementation(libs.agp)
  implementation(libs.kotlin.gradle.plugin)
  implementation(libs.kotlin.multiplatform.plugin)
  implementation(libs.kotlin.serialization.gradle.plugin)
  implementation(libs.kotlin.multiplatform.swiftpackage.plugin)
  implementation(libs.kotlin.coroutines.native.gradle.plugin)
  implementation(libs.sqldelight.gradle.plugin)
}

In this particular module that fails I only have the build logic plugin applied in addition to two external ones (some dependencies but it still fails if I remove those dependencies):

plugins {
  id("build.logic.kotlin.multiplatform")
  alias(libs.plugins.kotlin.coroutines.native)
  alias(libs.plugins.kotlin.serialization)
}

[Kirill Zhukov]

I saw exact same problem when applying SqlDelight Gradle plugin in KMP module in the past and I solved it by adding the plugin to the classpath. Doing so doesn’t seem to fix it here for some reason.

[Kirill Zhukov]

Not sure how to read this error message either, haven’t found much on github nor youtrack:

Cannot add task 'commonizeNativeDistribution' as a task with that name already exists.

[Kirill Zhukov]

Just applying the native coroutines plugin alone fails as well:

plugins {
  id("build.logic.kotlin.multiplatform")
  alias(libs.plugins.kotlin.coroutines.native)
}

[Rick Clephas]

Alright I think the issue is in how the dependencies are added in custom build logic plugin.
Normally you would add dependencies to your source sets, adding them at the top level would require the source set name: https://kotlinlang.org/docs/gradle-configure-project.html#set-dependencies-at-top-level

However I am also wondering why you are adding those plugins as dependencies instead of applying them?

[Kirill Zhukov]

My understanding is that it adds the plugins to the classpath which allows the project to resolve plugins

[Kirill Zhukov]

kotlin-coroutines-native-gradle-plugin = { module = "com.rickclephas.kmp.nativecoroutines:com.rickclephas.kmp.nativecoroutines.gradle.plugin", version.ref = "kotlin-coroutines-native" }

[Kirill Zhukov]

Similar to this setup https://github.com/slackhq/slack-gradle-plugin/blob/main/slack-plugin/build.gradle.kts#L62-L75

[Kirill Zhukov]

It won’t resolve the plugin without adding it to the classpath:

UnknownPluginException: Plugin [id: 'com.rickclephas.kmp.nativecoroutines'] was not found in any of the following sources:

- Gradle Core Plugins (plugin is not in 'org.gradle' namespace)
- Included Builds (None of the included builds contain this plugin)
- Plugin Repositories (plugin dependency must include a version number for this source)

[Kirill Zhukov]

That is if I use plugin alias or id without version:

alias(libs.plugins.kotlin.coroutines.native) // fails to resolve
id("com.rickclephas.kmp.nativecoroutines") // fails to resolve
id("com.rickclephas.kmp.nativecoroutines") version "0.13.2" // is able to resolve but don't want to apply plugin like this

[Rick Clephas]

Hmm haven’t used such an approach, so I am not sure how that should work. It looks like that Slack plugin is used for Android apps, so it might not work for multiplatform projects as is.

[Kirill Zhukov]

It has been working so far with Wire, SqlDelight, Serialization, etc

[Kirill Zhukov]

Even I don’t take this approach: remove the plugin from dependencies block in build-logic/build.gradle.kts , and apply plugin like so, it’s still fails with the same error 🤔

id("com.rickclephas.kmp.nativecoroutines") version "0.13.2"

[Kirill Zhukov]

Which tells me it might be unrelated to adding implementation(libs.kotlin.coroutines.native.gradle.plugin) to the build logic plugin

[Rick Clephas]

Oke. Which plugins are these?:

implementation(libs.kotlin.gradle.plugin)
implementation(libs.kotlin.multiplatform.plugin)

[Kirill Zhukov]

kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
kotlin-multiplatform-plugin = { module = "org.jetbrains.kotlin.multiplatform:org.jetbrains.kotlin.multiplatform.gradle.plugin", version.ref = "kotlin" }

[Rick Clephas]

Well I am out of ideas 😅 maybe someone who's more familiar with the custom plugin approach can provide a clue.

[Kirill Zhukov]

Thanks for helping to look into this nonetheless

[Kirill Zhukov]

To close the loop, fixed this by properly adding plugins to the classpath instead of relying on custom plugin’s dependencies 👌

Root `build.gradle.kts`:

plugins {
  alias(libs.plugins.kotlin.coroutines.native) apply false
  alias(libs.plugins.kotlin.serialization) apply false
  // ...
}

buildscript {
  repositories {
    google()
    mavenCentral()
    gradlePluginPortal()
  }

  dependencies {
    classpath(libs.kotlin.multiplatform.plugin)
    classpath(libs.kotlin.coroutines.native.gradle.plugin)
    classpath(libs.kotlin.serialization.gradle.plugin)
    // ...
  }
}