Use KotlinHierarchyTemplate for structuring source sets #4044
Conversation
| val jsAndWasmSharedTest by creating { | ||
| dependsOn(commonTest) | ||
| @OptIn(ExperimentalKotlinGradlePluginApi::class) | ||
| val ktorTargetsHierarchy = KotlinHierarchyTemplate { |
There was a problem hiding this comment.
just curious: is there a reason to extract this into a separate variable instead of just calling applyHierarchyTemplate {...}?
There was a problem hiding this comment.
there is no reason. so it can be merged into one call.
| @OptIn(ExperimentalKotlinGradlePluginApi::class) | ||
| val ktorTargetsHierarchy = KotlinHierarchyTemplate { | ||
| // extract nix group so it can be reused later as `group("nix")` | ||
| group("nix") { |
There was a problem hiding this comment.
just curious[2]: is there a reason to declare it top-level and not under common? Does it make any difference?
There was a problem hiding this comment.
it can be moved under common. however then it might look not entirely correct as I don't want nix to be dependsOn common, but only on posix and jvmAndNix (but apply target hierarchy algorithm is capable to solve this problem as in this case it will not add direct dependsOn edge).
again I wasn't doing that with much of a through thinking of where exactly to place this group.
There was a problem hiding this comment.
but apply target hierarchy algorithm is capable to solve this problem as in this case it will not add direct dependsOn edge
or maybe not, I need to double check
There was a problem hiding this comment.
or maybe not, I need to double check
checked. it is alright. here is the source set structure I get via this script:
tasks.register("printKMPSourceSetStructure") {
doFirst {
println("digraph {")
kotlin.sourceSets.forEach { sourceSet ->
sourceSet.dependsOn.forEach { dependsOn ->
println(" \"${sourceSet.name}\" -> \"${dependsOn.name}\"")
}
}
println("}")
}
}
There was a problem hiding this comment.
cool, thanks for explaining and checking :)
| getByName("${it}Test").dependsOn(windowsTest) | ||
| } | ||
| } | ||
| if (hasJvmAndNix) { jvm(); nixTargets(); } |
There was a problem hiding this comment.
just minor unrelated remark: those functions (nixTargets/posixTargets/etc) are extensions on Project - so it would be more clear to call them at least at kotlin extension level (because of jvm function call).
Even better to refactor them to be extensions on KotlinMultiplatformExtension - but of course it's out of scope here :)
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
antohaby
force-pushed
the
alakotka/kotlin-community/dev
branch
from
463a5db to
0552f54
Compare
|
Ok I pushed changed based on Oleg's input. There are few interesting pictures I'd like to show: This is how SourceSet structure looked like in :ktor-network project. Impossible to read. But here is normalized version where all redundant dependsOn edges is removed. And it is much cleaner But take a look for example at iosTest you can see that it doesn't connect neither to commonTest nor to jvmAndNixTest. With applyTargetHierarchy it look now like this. Much better and comprehendable. And I don't have to normalize this version either. So it is already in a good shape. |
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.