Introduce CommonKspSettingsPlugin
#58
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors KSP plugin configuration by extracting common settings into a dedicated CommonKspSettingsPlugin. Previously, common KSP settings were applied using a synchronized mechanism with build services that proved fragile in multi-project builds with separate ClassLoaders. The new approach leverages Gradle's built-in plugin application semantics to ensure settings are applied exactly once per project.
Key changes:
- Introduced
CommonKspSettingsPluginto encapsulate all common KSP configuration logic - Simplified
KspBasedPluginto delegate settings application to the new plugin - Updated project version from
2.0.0-SNAPSHOT.029to2.0.0-SNAPSHOT.030
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
version.gradle.kts |
Bumped version to 2.0.0-SNAPSHOT.030 |
pom.xml |
Updated version and protoc dependency to 4.33.1 |
ksp/src/main/kotlin/io/spine/tools/core/jvm/ksp/gradle/KspBasedPlugin.kt |
Removed synchronization logic and delegated common settings to new plugin |
ksp/src/main/kotlin/io/spine/tools/core/jvm/ksp/gradle/CommonKspSettingsPlugin.kt |
New plugin containing extracted common KSP settings logic |
dependencies.md |
Updated to reflect new version and protoc dependency changes |
config |
Updated subproject commit reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
|
|
||
| /** | ||
| * The function replaces default destination directory defied by |
There was a problem hiding this comment.
Corrected spelling of 'defied' to 'defined'.
| * The function replaces default destination directory defied by | |
| * The function replaces default destination directory defined by |
| sourceSet.run { | ||
| // KSP Gradle Plugin already added its output to source sets. | ||
| // We need to add the replacement manually because we filtered | ||
| // it before in `Project.makeKspIgnoreGeneratedSourceProtoDir()`. |
There was a problem hiding this comment.
The referenced function name Project.makeKspIgnoreGeneratedSourceProtoDir() doesn't match the actual function name makeKspIgnoreProtocOutputDir() in the codebase. Update the comment to reference the correct function name.
| // it before in `Project.makeKspIgnoreGeneratedSourceProtoDir()`. | |
| // it before in `Project.makeKspIgnoreProtocOutputDir()`. |
armiol
left a comment
armiol
left a comment
There was a problem hiding this comment.
@alexander-yevsyukov LGTM in general. Please see my comments.
| import org.gradle.api.file.DirectoryProperty | ||
| import org.gradle.kotlin.dsl.findByType | ||
|
|
||
| public class CommonKspSettingsPlugin : Plugin<Project> { |
| val path = protobufExtension?.generatedFilesBaseDir | ||
| return path?.let { File(it) } | ||
| } | ||
|
|
| makeKspTasksDependOnSpineCompiler() | ||
| makeCompileKotlinTasksDependOnKspTasks() | ||
| replaceKspOutputDirs() | ||
|
|
There was a problem hiding this comment.
This line is also redundant.
| ) | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
And this one is also redundant.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR simplifies applying common KSP plugin settings. KSP plugins working in the Spine environment need to apply common settings once. Previously, the status of applying the settings was checked using the Build services feature. It proved to be fragile in the environments where plugins are applied in
subprojectsblock where these blocks are not related to each other and do not have commonClassLoader.This PR aims to solve this issue, pulling out the common settings into a plugin, which
KspBasedPluginapplies via the class name. This makes Gradle to apply the plugin once, which was the intention of the previous arrangement with build services.