Add binary-compatibility-validator and API dumps for desktop #803
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also remove `testDesktop`, `desktopTest` should be used instead. This task will be run on CI, and we will add other tasks to it (such as API checks).
https://github.com/Kotlin/binary-compatibility-validator This plugin dumps all API for JVM modules to files (in the future - for other targets). If API changed, we should call: ``` ./gradlew desktopApiDump ``` to commit a new API, otherwise CI will fail (`./gradlew desktopCICheck` will be called on CI`). If you see that some strings are deleted in the API dump, most probably it means an incompatible API change (the plugin doesn't check itself, unfortunately). - For Desktop API is constructed from desktopMain + skikoMain + commonMain sourceSets - For Android API is constructed from desktopMain + commonMain (but it is disabled for now, because Android is in a broke state). The plan is to fix the Android target, and dump Android API as well. It will help us to track new API that we need to port more easily. [The workflow](https://github.com/Kotlin/binary-compatibility-validator#workflow) Example of error: ``` Execution failed for task ':compose:material3:material3:desktopApiCheck'. > API check failed for project material3. --- D:\Work\compose-multiplatform-core\compose\material3\material3\api\desktop\material3.api +++ D:\Work\compose-multiplatform-core\out\androidx\compose\material3\material3\build\api\desktop\material3.api @@ -552,6 +552,11 @@ public abstract interface annotation class androidx/compose/material3/ExperimentalMaterial3Api : java/lang/annotation/Annotation { } +public final class androidx/compose/material3/FF { + public static final field $stable I + public fun <init> ()V +} + public final class androidx/compose/material3/FabPosition { public static final field Companion Landroidx/compose/material3/FabPosition$Companion; public static final synthetic fun box-impl (I)Landroidx/compose/material3/FabPosition; You can run :material3:apiDump task to overwrite API declarations ``` One disadvantage that error shows `apiDump` instead of `desktopApiDump`. `apiDump` doesn't work because of the broken Android target, and to fix it properly we need to do a lot of changes. Just disabling the tasks doesn't work. P.S. Jetpack Compose sources has its own API generator (Metalava), but it won't be applicable to other Kotlin targets in the future, but binary-compatibility-validator [will](Kotlin/binary-compatibility-validator#149) ## Test 1. call desktopCICheck - it succeeds 2. change/add API 3. call desktopCICheck - it fails
igordmn
force-pushed
the
igor.demin/make-api-file
branch
from
05740dd to
518a8f2
Compare
MatkovIvan
reviewed
Sep 11, 2023
|
|
||
| public final class androidx/compose/material3/AlertDialog_skikoKt { | ||
| public static final fun AlertDialog (Lkotlin/jvm/functions/Function0;Landroidx/compose/ui/Modifier;Landroidx/compose/ui/window/DialogProperties;Lkotlin/jvm/functions/Function2;Landroidx/compose/runtime/Composer;II)V | ||
| public static final fun AlertDialog-Oix01E0 (Lkotlin/jvm/functions/Function0;Lkotlin/jvm/functions/Function2;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Landroidx/compose/ui/graphics/Shape;JJJJFLandroidx/compose/ui/window/DialogProperties;Landroidx/compose/runtime/Composer;III)V |
There was a problem hiding this comment.
- What
-Oix01E0mean here? - It looks like this validator doesn't handle values of default parameters, right?
There was a problem hiding this comment.
-
It is how Kotlin compiles a fun with value classes (Color, for example):
-
Kotlin compiles such functions to
Foo$default:
There was a problem hiding this comment.
- And it seems, yes, we can't track default values changes. But it is a behaviour change, not API change
Co-authored-by: Ivan Matkov <[email protected]>
Co-authored-by: Ivan Matkov <[email protected]>
MatkovIvan
approved these changes
Sep 12, 2023
Merged
|
Added a readme |
Walingar
approved these changes
Sep 12, 2023
Walingar
reviewed
Sep 12, 2023
MULTIPLATFORM.md
Outdated
| @@ -26,6 +26,38 @@ Run tests for UIKit: | |||
| ./gradlew :mpp:testUIKit | |||
| ``` | |||
|
|
|||
| ### API checks | |||
| Compose Multiplatform stores all public API in *.api files. If any API is added/changed, `./gradlew desktopCICheck` will fail with an error that API is changed (it runs on CI). Example: | |||
There was a problem hiding this comment.
desktopCICheck -> checkDesktop
igordmn
added a commit
that referenced
this pull request
Jan 30, 2024
https://github.com/Kotlin/binary-compatibility-validator This plugin dumps all API for JVM modules to files (in the future - for other targets). If API changed, we should call: ``` ./gradlew desktopApiDump ``` to commit a new API, otherwise CI will fail (`./gradlew desktopCICheck` will be called on CI`). If you see that some strings are deleted in the API dump, most probably it means an incompatible API change (the plugin doesn't check itself, unfortunately). See [the official workflow guide](https://github.com/Kotlin/binary-compatibility-validator#workflow) to understand it more. Example of error: ``` Execution failed for task ':compose:material3:material3:desktopApiCheck'. > API check failed for project material3. --- D:\Work\compose-multiplatform-core\compose\material3\material3\api\desktop\material3.api +++ D:\Work\compose-multiplatform-core\out\androidx\compose\material3\material3\build\api\desktop\material3.api @@ -552,6 +552,11 @@ public abstract interface annotation class androidx/compose/material3/ExperimentalMaterial3Api : java/lang/annotation/Annotation { } +public final class androidx/compose/material3/FF { + public static final field $stable I + public fun <init> ()V +} + public final class androidx/compose/material3/FabPosition { public static final field Companion Landroidx/compose/material3/FabPosition$Companion; public static final synthetic fun box-impl (I)Landroidx/compose/material3/FabPosition; You can run :material3:apiDump task to overwrite API declarations ``` One disadvantage that error shows `apiDump` instead of `desktopApiDump`. `apiDump` doesn't work because of the broken Android target, and to fix it properly we need to do a lot of changes. Just disabling the tasks doesn't work. - Desktop API is constructed from desktopMain + skikoMain + commonMain sourceSets - Android API is constructed from desktopMain + commonMain. It is disabled for now, because Android build is broken. The plan is to fix the Android target, and dump Android API as well. It will help us to track new API that we need to port more easily. P.S. Jetpack Compose sources has its own API generator (Metalava), but it won't be applicable to other Kotlin targets in the future, but binary-compatibility-validator [will](Kotlin/binary-compatibility-validator#149) ## Test 1. call desktopCICheck - it succeeds 2. change/add API 3. call desktopCICheck - it fails --------- Co-authored-by: Ivan Matkov <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://github.com/Kotlin/binary-compatibility-validator
This plugin dumps all API for JVM modules to files (in the future - for other targets). If API changed, we should call:
to commit a new API, otherwise CI will fail (
./gradlew desktopCICheckwill be called on CI`).If you see that some strings are deleted in the API dump, most probably it means an incompatible API change (the plugin doesn't check itself, unfortunately).
See the official workflow guide to understand it more.
Example of error:
One disadvantage that error shows
apiDumpinstead ofdesktopApiDump.apiDumpdoesn't work because of the broken Android target, and to fix it properly we need to do a lot of changes. Just disabling the tasks doesn't work.Desktop API is constructed from desktopMain + skikoMain + commonMain sourceSets
Android API is constructed from desktopMain + commonMain. It is disabled for now, because Android build is broken. The plan is to fix the Android target, and dump Android API as well. It will help us to track new API that we need to port more easily.
P.S. Jetpack Compose sources has its own API generator (Metalava), but it won't be applicable to other Kotlin targets in the future, but binary-compatibility-validator will
Test