Make Klib-related Gradle tasks public #204

fzhinkin · 2024-03-26T16:19:42Z

What was done:

cleaned up klib-related tasks API
rewrote code gluing up tasks together to utilize Gradle properties for proper dependency tracking
made tasks public
made some programmatic API classes used as tasks inputs serializable

Fixed #203

…asks

shanshin · 2024-05-13T06:33:57Z

src/main/kotlin/-Utils.kt

+     * Path to a resulting dump file.
+     */
+    @get:InputFiles
+    @get:SkipWhenEmpty


Can there be situations where dumpFile is not specified for the target?

shanshin · 2024-05-13T06:34:21Z

src/main/kotlin/-Utils.kt

+    /**
+     * Path to a resulting dump file.
+     */
+    @get:InputFiles


A rather ad-hoc way)
I think in such cases it is worth writing that InputFiles is used for a single file if it may not be present or the file may be empty

Updated KDoc with the details on why a file could be missing and what to expect then

src/main/kotlin/-Utils.kt

shanshin · 2024-05-13T06:43:23Z

src/main/kotlin/KotlinApiBuildTask.kt

 import java.util.jar.JarFile
 import javax.inject.Inject

 public open class KotlinApiBuildTask @Inject constructor(
 ) : BuildTaskBase() {
+    @OutputFile
+    public lateinit var outputApiFile: File


Why File but not RegularFileProperty?
It seems that because of this, lateinit looks very unusual

This change moves the property back from BuildTaskBase, so I left the same type. However, as this PR will break binary compatibility for the Compare task, it might be worth breaking it here as well and providing a more robust implementation in return.

You can try to add a reliable field, but maintain backward compatibility.
In BuildTaskBase

@get:Internal public abstract var outputApiFile: File

In KotlinApiBuildTask

@get:OutputFile ... public val realOutputApiFile: RegularFileProperty = project.objects.fileProperty() @get:Internal public override var outputApiFile: File get() = realOutputApiFile.get().asFile set(value) = realOutputApiFile.set(value)

I didn 't check it )

The main issue here is that we definitely want to phase these old properties out and ask users to migrate to realXXX ones, but old properties already claimed good names :(

shanshin · 2024-05-13T06:44:38Z

src/main/kotlin/KotlinApiCompareTask.kt

-    @PathSensitive(PathSensitivity.RELATIVE)
-    public lateinit var projectApiFile: File
+    @get:InputFiles
+    @get:SkipWhenEmpty


File can be empty or not specified?

shanshin · 2024-05-13T13:47:26Z

src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt

-        onlyIf("There are no klibs compiled for the project") { hasCompilableTargets.get() }
+        strictValidation.set(extension.klib.strictValidation)
+        requiredTargets.addAll(supportedTargets())
+        inputAbiFile.set(klibApiDir.get().resolve(klibDumpFileName))


klibApiDir.map { it.resolve(...) } ?

shanshin · 2024-05-13T13:52:55Z

src/main/kotlin/-Utils.kt

+     */
+    @get:InputFiles
+    @get:SkipWhenEmpty
+    public val dumpFile: RegularFileProperty


Provider<File>?
Properties is not very often used in nested types, in this case, you will not need to call objects.fileProperty()

shanshin · 2024-05-13T13:54:56Z

src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt

-            signatureVersion = SerializableSignatureVersion(extension.klib.signatureVersion)
-            outputApiFile = apiBuildDir.resolve(klibDumpFileName)
+            this.target.set(target)
+            klibFile.from(project.provider { compilation.output.classesDirs })


ConfigurableFileCollection is a live collection, try use it directly klibFile.from(compilation.output.classesDirs )

shanshin · 2024-05-13T13:56:02Z

src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt

@@ -636,29 +592,21 @@ private class KlibValidationPipelineBuilder(
    }

    private fun Project.unsupportedTargetDumpProxy(
-        compilation: KotlinCompilation<KotlinCommonOptions>,
+        @Suppress("UNUSED_PARAMETER") compilation: KotlinCompilation<KotlinCommonOptions>,


Why unused parameter is still present?

shanshin · 2024-05-13T13:57:37Z

src/main/kotlin/BinaryCompatibilityValidatorPlugin.kt

-            dumpFileName = klibDumpFileName
-            dependsOn(project.tasks.withType(KotlinKlibAbiBuildTask::class.java))
+            target.set(unsupportedTarget)
+            oldMergedKlibDump.set(klibApiDir.get().resolve(klibDumpFileName))


oldMergedKlibDump.fileProvider(klibApiDir.map { it.resolve(...) }

fzhinkin force-pushed the make-tasks-public branch from e94154b to bb48561 Compare March 27, 2024 09:13

fzhinkin added enhancement New feature or request klib labels Mar 27, 2024

fzhinkin linked an issue Mar 27, 2024 that may be closed by this pull request

Make KLib validation related tasks public #203

Open

fzhinkin marked this pull request as ready for review March 27, 2024 09:20

fzhinkin requested a review from shanshin March 27, 2024 09:20

Base automatically changed from 199-disable-tasks-for-empty-projects to develop March 27, 2024 14:36

fzhinkin force-pushed the make-tasks-public branch from bb48561 to 25efc08 Compare March 27, 2024 14:40

fzhinkin mentioned this pull request Mar 28, 2024

Use the Gradle Provider API to allow for lazy configuration #207

Open

fzhinkin added 11 commits April 4, 2024 15:57

Cleanup build task

3c56062

Cleanup merge task

bd51c07

Cleanup extract and infer tasks

c76f31f

Continue cleaning tasks up

7b851b4

Renamed tasks and its properties

1045ae6

Use properties for task inputs and outputs

80476fb

Make tasks public

0a489fa

Use properties in CopyFile task

1d20461

Renamed a class holding target name and path to a dump

8e689ce

Use all supported targets when extracting dump

42abf7b

Avoid using hasAnySourcesPredicate-predicate to filter klib-related t…

5a03695

…asks

fzhinkin force-pushed the make-tasks-public branch from 25efc08 to 5a03695 Compare April 5, 2024 10:36

fzhinkin added 3 commits April 5, 2024 15:46

Use RegularFileProperties instead of File vars in the check task

741554c

Cleanup

5976a21

Enable conf cache for JVM tests

c8aa6ee

fzhinkin mentioned this pull request Apr 25, 2024

Enable KLib ABI validation Kotlin/kotlinx.collections.immutable#180

Open

shanshin reviewed May 13, 2024

View reviewed changes

fzhinkin added 3 commits May 13, 2024 18:10

Added missing annotations, cleaned up the code

73503cb

Update KDoc

ae50867

Replaced ListProperties with SetProperties

2b7b900

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make Klib-related Gradle tasks public #204

Make Klib-related Gradle tasks public #204

fzhinkin commented Mar 26, 2024 •

edited

shanshin May 13, 2024

shanshin May 13, 2024

fzhinkin May 13, 2024 •

edited

shanshin May 13, 2024

fzhinkin May 13, 2024

shanshin May 13, 2024

fzhinkin May 14, 2024

shanshin May 13, 2024

shanshin May 13, 2024

shanshin May 13, 2024

shanshin May 13, 2024

shanshin May 13, 2024

shanshin May 13, 2024

Make Klib-related Gradle tasks public #204

Are you sure you want to change the base?

Make Klib-related Gradle tasks public #204

Conversation

fzhinkin commented Mar 26, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fzhinkin May 13, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fzhinkin commented Mar 26, 2024 •

edited

fzhinkin May 13, 2024 •

edited