Use KotlinHierarchyTemplate for structuring source sets #4045
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KotlinHierarchyTemplate allows writing KMP source set structures with less code and without explicit dependsOn relations. There is one downside is that all source sets are created now if at least one of the target is declared. i.e. for example if JS target is declared but wasm is not. Then jsAndWasmSharedMain source set will be created anyway. It also fixes the issue with Kotlin 2.0 KT-68212 In :ktor-network jvmAndNixTest has an expect that in K1 was actualized in iosTest there was no direct or transitive dependsOn relation from iosTest to jvmAndNixTest and thus in K2 such actualization was prohibited. In this commit Source Set structure is sanitized and now dependsOn relations are in good order. ^KT-68212 Fixed
|
Hey @antohaby, thanks for the PR. I'll check it next week after the conference! |
e5l
approved these changes
May 28, 2024
|
Hey @antohaby, thanks for the PR. LGTM |
tbogdanova
added a commit
that referenced
this pull request
Jun 7, 2024
This reverts commit c03c0f0.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
KotlinHierarchyTemplate allows writing KMP source set structures with less code and without explicit dependsOn relations.
There is one downside is that all source sets are created now if at least one of the target is declared. i.e. for example if JS target is declared but wasm is not. Then jsAndWasmSharedMain source set will be created anyway.
It also fixes the issue with Kotlin 2.0
In :ktor-network jvmAndNixTest has an expect that in K1 was actualized in iosTest there was no direct or transitive dependsOn relation from iosTest to jvmAndNixTest and thus in K2 such actualization was prohibited. In this commit Source Set structure is sanitized and now dependsOn relations are in good order.
Subsystem
Gradle build
Motivation
Depends on relations between Kotlin Source Sets are messed in Ktor project. And Ktor is not to blame here, but Kotlin Multiplatform's dependsOn relations. They are error prone and very verbose. And since K2 Kotlin Compiler requires correctness in Source Set structure. i.e. in K1 due to its compilation model it was possible to violate symbols visibility and expect/actual. A bit more details you can find in related issue: https://youtrack.jetbrains.com/issue/KT-68212/K2-KMP-has-no-corresponding-expected-declaration-with-dependsOn-relationship
This is how SourceSet structure looked like in :ktor-network project. Impossible to read.
Same Source Set structure but normalized i.e. redundant depends on edges are removed
But take a look for example at iosTest you can see that it doesn't connect neither to commonTest nor to jvmAndNixTest.
And other source sets are also dongle here and there.
Solution
Apply kotlin target hierarchy template. there is some information on kotlinlang web site https://kotlinlang.org/docs/multiplatform-hierarchy.html#default-hierarchy-template
After applying the target hierarchy source set structure look much cleaner for both main and test source sets. And it doesn't have to be normalized. It is already in a good shape.
PS: kotlin-community/dev branch also has related PR (!4044)