Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Multiplatform Support With Source Set-Based Configuration #1021

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Improve Multiplatform Support With Source Set-Based Configuration #1021

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e0f75e4
Add source set-based multiplatform configuration, fixes
OliverO2 Jun 14, 2022
1297b09
Reformat for ktlint
OliverO2 Jun 15, 2022
9cf4738
Depend on 'ksp.multiplatform.enabled', restoring Groovy compatibility
OliverO2 Jun 15, 2022
f5fd95d
Multiplatform: fix picking up sources from intermediate source sets
OliverO2 Jun 20, 2022
29f416f
Multiplatform: use task inputs instead of explicit task dependencies
OliverO2 Jun 20, 2022
91fbc76
Optionally use source set dependencies instead of task dependencies
OliverO2 Jul 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
192 changes: 125 additions & 67 deletions gradle-plugin/src/main/kotlin/com/google/devtools/ksp/gradle/KspConfigurations.kt
View file
Open in desktop
Expand Up @@ -5,7 +5,6 @@ import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.jetbrains.kotlin.gradle.dsl.*
import org.jetbrains.kotlin.gradle.plugin.*
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinCommonCompilation
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinJvmAndroidCompilation

/**
Expand All @@ -24,18 +23,17 @@ class KspConfigurations(private val project: Project) {
// The "ksp" configuration, applied to every compilations.
private val configurationForAll = project.configurations.create(PREFIX)

private fun configurationNameOf(vararg parts: String): String {
return parts.joinToString("") {
it.replaceFirstChar { it.uppercase() }
}.replaceFirstChar { it.lowercase() }
}
private val kspExtension: KspExtension = project.extensions.getByType(KspExtension::class.java)

private val resolvedSourceSetOptions = mutableMapOf<KotlinSourceSet, SourceSetOptions>()
private val compilationsConfiguredOrSkipped = mutableSetOf<KotlinCompilation<*>>()

@OptIn(ExperimentalStdlibApi::class)
private fun createConfiguration(
name: String,
readableSetName: String,
): Configuration {
// maybeCreate to be future-proof, but we should never have a duplicate with current logic
private fun maybeCreateConfiguration(name: String, readableSetName: String): Configuration {
// Configurations get created lazily
// - when decorating a Kotlin project, and
// - when creating a KSP task.
// This can occur in any order, depending on when a KSP task is referenced, so it is necessary to
// tolerate multiple invocations with idempotence.
return project.configurations.maybeCreate(name).apply {
description = "KSP dependencies for the '$readableSetName' source set."
isCanBeResolved = false // we'll resolve the processor classpath config
Expand All @@ -44,48 +42,51 @@ class KspConfigurations(private val project: Project) {
}
}

private fun maybeCreateConfiguration(compilation: KotlinCompilation<*>) {
val kspConfigurationName = getKotlinConfigurationName(compilation)
maybeCreateConfiguration(name = kspConfigurationName, readableSetName = "KSP $compilation")
}

private fun getAndroidConfigurationName(target: KotlinTarget, sourceSet: String): String {
val isMain = sourceSet.endsWith("main", ignoreCase = true)
val nameWithoutMain = when {
isMain -> sourceSet.substring(0, sourceSet.length - 4)
else -> sourceSet
}
// Note: on single-platform, target name is conveniently set to "".
return configurationNameOf(PREFIX, target.name, nameWithoutMain)
return lowerCamelCased(PREFIX, target.name, nameWithoutMain)
}

private fun getKotlinConfigurationName(compilation: KotlinCompilation<*>, sourceSet: KotlinSourceSet): String {
val isMain = compilation.name == KotlinCompilation.MAIN_COMPILATION_NAME
val isDefault = sourceSet.name == compilation.defaultSourceSetName && compilation !is KotlinCommonCompilation
// Note: on single-platform, target name is conveniently set to "".
val name = if (isMain && isDefault) {
// For js(IR), js(LEGACY), the target "js" is created.
//
// When js(BOTH) is used, target "jsLegacy" and "jsIr" are created.
// Both targets share the same source set. Therefore configurations other than main compilation
// are shared. E.g., "kspJsTest".
// For simplicity and consistency, let's not distinguish them.
when (val targetName = compilation.target.name) {
"jsLegacy", "jsIr" -> "js"
else -> targetName
private fun getKotlinConfigurationName(compilation: KotlinCompilation<*>): String {
var targetName = compilation.target.targetName

when (targetName) {
"jsIr", "jsLegacy" -> targetName = "Js"
"metadata" -> {
// This reversal of target and compilation name is unnecessarily complicated, but retains
// backward compatibility for dependency-based configuration via `dependencies { add(...) }`.
when (compilation.name) {
KotlinCompilation.MAIN_COMPILATION_NAME, "commonMain" ->
return "${PREFIX}CommonMainMetadata"
}
}
} else if (compilation is KotlinCommonCompilation) {
sourceSet.name + compilation.target.name.capitalize()
}

return if (compilation.name == KotlinCompilation.MAIN_COMPILATION_NAME) {
lowerCamelCased(PREFIX, targetName)
} else {
sourceSet.name
lowerCamelCased(PREFIX, targetName, compilation.name)
}
return configurationNameOf(PREFIX, name)
}

init {
project.plugins.withType(KotlinBasePluginWrapper::class.java).configureEach {
// 1.6.0: decorateKotlinProject(project.kotlinExtension)?
decorateKotlinProject(project.extensions.getByName("kotlin") as KotlinProjectExtension, project)
decorateKotlinProject(project)
}
}

private fun decorateKotlinProject(kotlin: KotlinProjectExtension, project: Project) {
when (kotlin) {
private fun decorateKotlinProject(project: Project) {
when (val kotlin = project.kotlinExtension) {
is KotlinSingleTargetExtension -> decorateKotlinTarget(kotlin.target)
is KotlinMultiplatformExtension -> {
kotlin.targets.configureEach(::decorateKotlinTarget)
Expand All @@ -109,68 +110,125 @@ class KspConfigurations(private val project: Project) {
}

/**
* Decorate the [KotlinSourceSet]s belonging to [target] to create one KSP configuration per source set,
* named ksp<SourceSet>. The only exception is the main source set, for which we avoid using the
* "main" suffix (so what would be "kspJvmMain" becomes "kspJvm").
* Decorate [target]'s source sets (Android) or compilations (non-Android), creating one KSP configuration
* per source set or compilation.
*
* For Android, we prefer to use AndroidSourceSets from AGP rather than [KotlinSourceSet]s.
* Even though the Kotlin Plugin does create [KotlinSourceSet]s out of AndroidSourceSets
* ( https://kotlinlang.org/docs/mpp-configure-compilations.html#compilation-of-the-source-set-hierarchy ),
* there are slight differences between the two - Kotlin creates some extra sets with unexpected word ordering,
* and things get worse when you add product flavors. So, we use AGP sets as the source of truth.
* Android configurations are named ksp<SourceSet>, stripping a "Main" suffix (so what would be "kspJvmMain"
* becomes "kspJvm").
*
* Non-Android compilations are named ksp<Target><Compilation> except for main compilations, which are
* named ksp<Target>.
*/
private fun decorateKotlinTarget(target: KotlinTarget) {
// TODO: Check whether special AGP handling is still necessary.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC this is still needed as KMP creates additional sources sets that do not map to the AGP ones.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The motivation for this comment is this: Previously, KSP could only see a subset of source sets configured. This has now changed, so it might see AGP-created source sets where it did not before, possibly enabling a unified KMP/Android handling. Would you suggest dropping this comment without further investigation?

if (target.platformType == KotlinPlatformType.androidJvm) {
AndroidPluginIntegration.forEachAndroidSourceSet(target.project) { sourceSet ->
createConfiguration(
maybeCreateConfiguration(
name = getAndroidConfigurationName(target, sourceSet),
readableSetName = "$sourceSet (Android)"
)
}
} else {
target.compilations.configureEach { compilation ->
compilation.kotlinSourceSets.forEach { sourceSet ->
createConfiguration(
name = getKotlinConfigurationName(compilation, sourceSet),
readableSetName = sourceSet.name
)
}
}
target.compilations.configureEach(::maybeCreateConfiguration)
}
}

/**
* Returns the user-facing configurations involved in the given compilation.
* We use [KotlinCompilation.kotlinSourceSets], not [KotlinCompilation.allKotlinSourceSets] for a few reasons:
* 1) consistency with how we created the configurations. For example, all* can return user-defined sets
* that don't belong to any compilation, like user-defined intermediate source sets (e.g. iosMain).
* These do not currently have their own ksp configuration.
* 2) all* can return sets belonging to other [KotlinCompilation]s
*
* See test: SourceSetConfigurationsTest.configurationsForMultiplatformApp_doesNotCrossCompilationBoundaries
* Returns the configurations relevant for [compilation].
*/
fun find(compilation: KotlinCompilation<*>): Set<Configuration> {
val results = mutableListOf<String>()
if (compilation is KotlinCommonCompilation) {
results.add(getKotlinConfigurationName(compilation, compilation.defaultSourceSet))
}
compilation.kotlinSourceSets.mapTo(results) {
getKotlinConfigurationName(compilation, it)
}
configureCompilation(compilation)

val configurationNames = mutableListOf(getKotlinConfigurationName(compilation))

// TODO: Check whether special AGP handling is still necessary.
if (compilation.platformType == KotlinPlatformType.androidJvm) {
compilation as KotlinJvmAndroidCompilation
AndroidPluginIntegration.getCompilationSourceSets(compilation).mapTo(results) {
AndroidPluginIntegration.getCompilationSourceSets(compilation).mapTo(configurationNames) {
getAndroidConfigurationName(compilation.target, it)
}
}

// Include the `ksp` configuration, if it exists, for all compilations.
if (allowAllTargetConfiguration) {
results.add(configurationForAll.name)
if (configurationNames.isNotEmpty() && allowAllTargetConfiguration) {
configurationNames.add(configurationForAll.name)
}

return results.mapNotNull {
compilation.target.project.configurations.findByName(it)
return configurationNames.mapNotNull {
project.configurations.findByName(it)
}.toSet()
}

private fun configureCompilation(compilation: KotlinCompilation<*>) {
if (compilation in compilationsConfiguredOrSkipped)
return

compilationsConfiguredOrSkipped.add(compilation)

val sourceSetOptions = resolvedSourceSetOptions(compilation)
if (sourceSetOptions.enabled == true) {
sourceSetOptions.processor?.let { processor ->
maybeCreateConfiguration(compilation)
project.dependencies.add(getKotlinConfigurationName(compilation), processor)
compilation.defaultSourceSet.kotlin.srcDir(
KspGradleSubplugin.getKspKotlinOutputDir(
project,
compilation.defaultSourceSet.name,
compilation.target.name
)
)
}
}
}

/**
* Returns the source set-dependent options for [kotlinCompilation], with hierarchically resolved inheritance.
*
* Source set options are put together by following source set dependencies in bottom-up order.
* (Inheriting incompatible KSP configurations from multiple parents is discouraged as the
* evaluation order in such cases is considered undefined.)
*
* The result's properties are guaranteed to be non-null, as each of them eventually inherits a non-null value
* from global options.
*/
internal fun resolvedSourceSetOptions(kotlinCompilation: KotlinCompilation<*>): SourceSetOptions =
resolvedSourceSetOptions.computeIfAbsent(kotlinCompilation.defaultSourceSet) { compilationSourceSet ->
val result = SourceSetOptions().inheritFrom(
kspExtension.sourceSetOptions(compilationSourceSet),
initializationMode = true
)

kotlinCompilation.parentSourceSetsBottomUp()
.map { kspExtension.sourceSetOptions(it) }
.takeWhile { it.inheritable }
.forEach { parentOptions ->
result.inheritFrom(parentOptions)
}

// Finally, complete missing options with global options (which are always inheritable).
result.inheritFrom(kspExtension.globalSourceSetOptions())
}
}

internal fun KotlinSourceSet.bottomUpDependencies(): Sequence<KotlinSourceSet> = sequence {
yield(this@bottomUpDependencies)
dependsOn.forEach {
yieldAll(it.bottomUpDependencies())
}
}

internal fun KotlinCompilation<*>.parentSourceSetsBottomUp(): Sequence<KotlinSourceSet> =
defaultSourceSet.bottomUpDependencies()
.drop(1) // exclude the compilation source set
.distinct() // avoid repetitions if multiple parents are present

internal fun lowerCamelCased(vararg parts: String): String {
return parts.joinToString("") { part ->
part.replaceFirstChar { it.uppercase() }
}.replaceFirstChar { it.lowercase() }
}