Bundle kotlinx serialization ProGuard rules into the Compose plugin#5314
Merged
Merged
Conversation
Reasoning to bundle: - Compose Gradle plugin should support Compose and all support libraries (androidx, components) - `androidx.navigation` exposes `kotlinx.serialization` as API Fixes https://youtrack.jetbrains.com/issue/CMP-8050 ## Testing ``` import androidx.compose.ui.window.singleWindowApplication import androidx.navigation.compose.NavHost import androidx.navigation.compose.composable import androidx.navigation.compose.rememberNavController fun main() = singleWindowApplication { NavHost( navController = rememberNavController(), startDestination = LoginRoute() ) { composable<LoginRoute> {} } } sealed interface Route @kotlinx.serialization.Serializable data class LoginRoute(val id: Long? = null) : Route ``` Doesn't crash ## Release Notes ### Fixes - Desktop - Fix "Serializer for class is not found" using `androidx.navigation` and running `./gradlew runRelease`
Ivan Matkov (MatkovIvan)
left a comment
Contributor
There was a problem hiding this comment.
Should we track such rules per-module bases?
Can we re-use ones from AOSP (automatically)?
Konstantin (terrakok)
approved these changes
May 12, 2025
Collaborator
Author
I am not aware of androidx-specific rules besides small https://youtrack.jetbrains.com/issue/CMP-7777/Support-ProGuard-rules-bundled-in-libraries should allow to read the bundled rules. |
Igor Demin (igordmn)
added a commit
that referenced
this pull request
May 12, 2025
…5314) When users use `androidx.navigation`, they see `@Serialization` annotation they can use, without explictly adding `kotlinx.serialization`. They see, because it is added as an `api` dependency. The Compose Gradle plugin on the other hand provide `./gradlew runRelease` task that uses ProGuard to minify binaries. Because the plugin should support not only Compose, but also all support libraries (androidx, components), we should bundle serialization ProGuard rules into it. Fixes https://youtrack.jetbrains.com/issue/CMP-8050 ## Testing ``` import androidx.compose.ui.window.singleWindowApplication import androidx.navigation.compose.NavHost import androidx.navigation.compose.composable import androidx.navigation.compose.rememberNavController fun main() = singleWindowApplication { NavHost( navController = rememberNavController(), startDestination = LoginRoute() ) { composable<LoginRoute> {} } } sealed interface Route @kotlinx.serialization.Serializable data class LoginRoute(val id: Long? = null) : Route ``` Doesn't crash when run `./gradlew runRelease` ## Release Notes ### Fixes - Desktop - Fix "Serializer for class is not found" using `androidx.navigation` and running `./gradlew runRelease` - `kotlinx.serialization` ProGuard rules are bundled in the Compose Gradle plugin (cherry picked from commit bffb159)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
When users use
androidx.navigation, they see@Serializationannotation they can use, without explictly addingkotlinx.serialization. They see, because it is added as anapidependency.The Compose Gradle plugin on the other hand provide
./gradlew runReleasetask that uses ProGuard to minify binaries. Because the plugin should support not only Compose, but also all support libraries (androidx, components), we should bundle serialization ProGuard rules into it.Fixes https://youtrack.jetbrains.com/issue/CMP-8050
Testing
Doesn't crash when run
./gradlew runReleaseRelease Notes
Fixes - Desktop
androidx.navigationand running./gradlew runReleasekotlinx.serializationProGuard rules are bundled in the Compose Gradle plugin