How to tackle lifecycle issues?

[OliverO2]

Description

I'm using this function to configure build-logic plugins which build upon each other. Not ideal, but it works.

I tried to change this to make Compat-Patrouille check dependencies:

fun Project.configureWithCompatPatrouille() {
    configureJavaCompatibility(versionFromCatalog("jdk").toInt())
    configureKotlinCompatibility(versionFromCatalog("org.jetbrains.kotlin"))

    extensions.configure<CompatPatrouilleExtension>("compatPatrouille") {
        // The next line is for debugging only
        project.configurations.forEach { println("$project: configuration '$it'") }
        checkApiDependencies(Severity.ERROR)
        checkRuntimeDependencies(Severity.ERROR)
    }
}

Now I'm getting

FAILURE: Build failed with an exception.

* Where:
Build file '/home/oliver/Repositories/open-source/infix/testBalloon/experiments/build.gradle.kts' line: 3

* What went wrong:
An exception occurred applying plugin request [id: 'buildLogic.multiplatform']
> Failed to apply plugin 'buildLogic.multiplatform'.
   > Configuration with name 'jvmApiElements' not found.

Apparently, the experiments project configuration is incomplete at the time checkApiDependencies() runs. What would be the ideal way to avoid such lifecycle issues?

[martinbonnin]

Those lifecycle issues are a massive pain in Gradle-land. Maybe I can change compat-patrouille to be more lazy, I'll try something and report in a bit.

[martinbonnin]

Can you try version 0.0.2-SNAPSHOT-9db58208006529b35beae1fc317b51c74360a182 from https://storage.googleapis.com/gradleup/m2 ?

[OliverO2]

Wow, that was quick! The snapshot version solves the configuration issue 🎉, but tries to create its tasks more than once:

FAILURE: Build failed with an exception.

* Where:
Build file '/home/oliver/Repositories/open-source/infix/testBalloon/testBalloon-framework-core/build.gradle.kts' line: 1

* What went wrong:
An exception occurred applying plugin request [id: 'buildLogic.multiplatform-plus-android-library']
> Failed to apply plugin 'buildLogic.multiplatform-plus-android-library'.
   > Cannot add task 'compatPatrouilleCheckmainRuntimeDependencies' as a task with that name already exists.

If that's all, it could be solved by registering instead of creating those tasks, right?

In case you want to try: https://github.com/infix-de/testBalloon/tree/reproducers/compat-patrouille-19

[martinbonnin]

Almost sure this was #21. Sorry about this, I'm mostly testing this with JVM-only projects, should add more KMP tests. Thanks for the bug report ❤️ !

It's the end of the day here but once CI has passed, the new snapshot should be 0.0.2-SNAPSHOT-09a649af0d143e9b5983758132426771b5611d2e.

[OliverO2]

Tried the new snapshot. Project now configures. 🎉

What I'm seeing now when I run the check task on testBalloon-framework-core (using Kotlin 2.2.20-RC):

Execution failed for task ':testBalloon-framework-core:compatPatrouilleCheckApiDependencies'.
> A failure occurred while executing compat.patrouille.task.CheckApiDependenciesWorkAction
   > Provided Metadata instance has version 2.2.0, while maximum supported version is 2.1.0. To support newer versions, update the kotlinx-metadata-jvm library.

Am I supposed to upgrade anything?

I wonder why Compat Patrouille is using org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.9.0 while the Kotlin docs say that starting with Kotlin 2.0 we should be using org.jetbrains.kotlin:kotlin-metadata-jvm:$kotlin_version.

[martinbonnin]

I wonder why Compat Patrouille is using org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.9.0 while the Kotlin docs say that starting with Kotlin 2.0 we should be using org.jetbrains.kotlin:kotlin-metadata-jvm:$kotlin_version.

Probably because I missed that information 🙈 . Upgrading the lib, we'll get there !

[martinbonnin]

Note you can upgrade that depenendency on your side in the meantime by adding it to your build-logic implementation dependencies.

[martinbonnin]

#22 fixes this but there's yet another one with BuildServices. I'll do the patch in testBalloon once it's all working, it'll be easier. Thanks for providing a nice test bed :)

[OliverO2]

Thank you for just letting me draw two circles and you doing the whole rest of the owl! ❤️

I have updated https://github.com/infix-de/testBalloon/tree/reproducers/compat-patrouille-19, so you can try with that.

[OliverO2]

Note you can upgrade that depenendency on your side in the meantime by adding it to your build-logic implementation dependencies.

Can I? The name has changed (dropping the "x" in "kotlinx") for the artifact and its imports.

[martinbonnin]

You're right of course. It's not just the version. You would "just" have to rewrite the bytecode 😅

[OliverO2]

Resolved by compat-patrouille v0.0.2. Yay! 🎉