Skip to content

Find KSP Configurations that are Added Later #881

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

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Find KSP Configurations that are Added Later #881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3775e74
find ksp configurations as they are added
mgroth0 Sep 23, 2024
ac8f23c
ktlintFormat
mgroth0 Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions ...plugin/src/main/kotlin/org/jetbrains/dataframe/gradle/ConvenienceSchemaGeneratorPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package org.jetbrains.dataframe.gradle
import com.google.devtools.ksp.gradle.KspExtension
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.artifacts.UnknownConfigurationException
import org.gradle.kotlin.dsl.getByType
import java.util.Properties

Expand Down Expand Up @@ -67,19 +66,27 @@ class ConvenienceSchemaGeneratorPlugin : Plugin<Project> {
isMultiplatform -> listOf("kspJvm", "kspJvmTest")
else -> listOf("ksp", "kspTest")
}

val cfgsToAdd = configs.toMutableSet()

configs.forEach { cfg ->
try {
target.configurations.getByName(cfg).dependencies.add(
target.configurations.named { it == cfg }.configureEach {
Copy link
Collaborator

@Jolanrensen Jolanrensen Sep 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

It may be clearer to use .findByName(cfg) (which is the nullable version of .getByName()). I was a bit confused by configureEach since there's no possibility there are ever multiple configurations with the same name, is there?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reason I used configureEach is because it is live. Meaning configureEach will continue to search for the configuration with the target name and run the operation on the new configuration when it is added even if that configuration is added after this plugin is applied. Using findByName is not live, so it wouldn't solve the issue that this PR is trying to solve. Or am I misunderstanding?

Copy link
Contributor Author

@mgroth0 mgroth0 Sep 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

By the way, your point is well taken that configuraitons.named will continue searching even after it found the configuration. This is undesirable in terms of performance and code cleanness but shouldn't cause any further issues I think. named { it == cfg } will just run for each configuration and return false, which should take a negligible amount of time ... Though I do think gradle suffers in terms of performance from all of these observers because gradle introduces lots of overhead into a lot of its operations (like sending events to the IDE for example).

See gradle/gradle#16543 , which is the same issue but for tasks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Gradle ought to eventually implement something like gradle/gradle#16543 but for any live collection (like the live colleciton of configurations). It would replace the technique I used here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Alright,thanks for the clarification :)

cfgsToAdd.remove(cfg)
dependencies.add(
target.dependencies.create(
"org.jetbrains.kotlinx.dataframe:symbol-processor-all:$preprocessorVersion",
),
)
} catch (e: UnknownConfigurationException) {
}
}
target.gradle.projectsEvaluated {
cfgsToAdd.forEach { cfg ->
target.logger.warn(
"Configuration '$cfg' not found. Please make sure the KSP plugin is applied.",
"Configuration '$cfg' was never found. Please make sure the KSP plugin is applied.",
)
}
}

target.logger.info("Added DataFrame dependency to the KSP plugin.")
target.extensions.getByType<KspExtension>().arg(
"dataframe.resolutionDir",
Expand Down
Loading