Update project build configuration and dependencies by dzmpr · Pull Request #514 · adrielcafe/voyager

dzmpr · 2024-12-01T13:23:25Z

Hi there!
I have some troubles with m2 bottom sheet navigator so I decided to add m3 bottom sheet navigator and solve this problem for me and for others. But when I started working on it I saw that voyager uses compose multiplatform 1.6.11 when I needed 1.7. One after another I'm ended up made some improvement to project build configuration and updated all dependencies (not only compose kmp).
So, what's have been done:

Updated gradle and dependencies.
Cleaned up project from redundant .gitignore and customer.proguard.pro files.
Got rid of buildSrc and replace it with build-config included build. With buildSrc there are problems with using version catalogs and no pros.
Split modules configuration to pluggable convention plugins to make configuration simpler and cleaner.
Removed some unused or redundant dependencies (such as appcompat, compose-runtimeSaveable, compose-compiler, compose-animations, and maybe something else). Note: this compose dependencies are not multiplatform and only used in samples.
Replaced com.benasher44:uuid dependency with kotlin stdlib implementation which is available from kotlin 2.0.
Replaced compileOnly for compose dependencies with plain implementation as now seems all working fine but with compileOnly compiler threw warnings about js targets.
Fixed js sample and some more minor fixes for samples.

What's I left behind:

I can't figure out custom target hierarchy that voyager uses, so left it as is (with jvm("desktop") target which triggers compiler warning).
Didn't update api dump, because I removed ExperimentalVoyagerApi from nonPublicMarkers (I consider this is a mistake, because it' actually public api, just experimental). So if you are okay with this I update api with additional commit.

I've tested all samples on android and following targets of multiplatform sample: js, wasm, macos (not sure what target).

So I'm waiting for review, and open for any questions if you have one.

…guration logic to convention plugins

Vodes · 2024-12-15T16:25:29Z

gradle/libs.versions.toml

+mavenPublish = "0.30.0"
+composeMultiplatform = "1.7.1"
+binaryCompatibilityValidator = "0.16.3"
+atomicfu = "0.26.1"


Fyi, this will currently cause an issue because compose expects (and forces) 0.23.2.
Seems to be a known issue https://youtrack.jetbrains.com/issue/CMP-5831

I think it's compose multiplatform problem rather than voyager. Anyway I tested voyager with cmp 1.8.0-rc01 and it seems all works fine.
I intended to update this PR when cmp 1.8.0 will be released.

hafiz013 · 2025-02-17T07:55:54Z

@Vodes why did you change from 8.2 => 8.11.1 It is to new mine one still using 8.7.2

Syer10 · 2025-02-17T15:17:50Z

@Vodes why did you change from 8.2 => 8.11.1 It is to new mine one still using 8.7.2

Because its good practice to always update dependencies, Gradle is always meant to be up-to-date for the improvements in speed and bugfixes.

hafiz013 · 2025-02-18T01:49:29Z

@Syer10 has this fork or pr merge to master repo veyoger?

# Conflicts: # samples/multiplatform/build.gradle.kts

dzmpr · 2025-05-20T06:27:11Z

Just updated this PR, what did I done more:

Renamed jvm targets group to commonJvm to make it non-ambigious with jvm target.
Disabled android resources in library modules as voyager doesn't use them. It should have positive impact on build speed.
Removed package from AndroidManifest's as from AGP 8.0 namespace should be declared in module build.gradle file.
Updated CMP to 1.8.0, Kotlin to 2.1.21, Gradle to 8.14, and other dependencies to the most actual versions. The only exception is koin as they mistakenly removed required targets from latest releases. So I'm waiting for this issue to be done to update koin.

There is still some work to be done, e.g. update ktlint and resolve problems that it finds and update samples. But this is out of scope of this PR, so I intended to do this after this PR is merged.

@devnatan, @DevSrSouza can you please take a look at this PR.

programadorthi

Can you share evidences of all samples working after the whole changes?

programadorthi · 2025-05-20T19:15:34Z

.gitignore

+
+# IntelliJ
 *.iml
-*.focus


.focus files are generated by dropbox plugin.

I think we can remove the dropbox plugin, voyager project is a small project for using the plugin honestly.

programadorthi · 2025-05-20T19:19:06Z

build-config/src/main/kotlin/configuration/configure-android.gradle.kts

+
+        if (isAndroidLibraryModule()) {
+            val proguardFilename = "consumer-rules.pro"
+            if (layout.projectDirectory.file(proguardFilename).asFile.exists()) {


You don't need check if exists. AGP ignores the file whether it doesn't exist.

AGP will print that certain proguard files not found:

Supplied consumer proguard configuration does not exist: /Users/dzmitry/AndroidStudioProjects/voyager/voyager-bottom-sheet-navigator/consumer-rules.pro

If you ok with this I remove an if clause.

You removed the empty files. That is the reason to complain about missing it.
Is there any advantage to remove the files instead of putting the check for them?

In my opinion a project has less clutter when it doesn't have files that don't affect anything.

programadorthi · 2025-05-20T19:22:52Z

build-config/src/main/kotlin/configuration/configure-kotlin-desktop.gradle.kts

+        }
+    }
+
+    androidTarget {


Does it makes sense having androidTarget in a file that have desktop configuration?

programadorthi · 2025-05-20T19:25:48Z

build-config/src/main/kotlin/configuration/configure-ktlint.gradle.kts

+plugins.apply("org.jlleitschuh.gradle.ktlint")
+
+configure<KtlintExtension> {
+    version.set("0.47.1")


Can you get the value from version catalog?

Yes I can with hack like this

Maybe this?

programadorthi · 2025-05-20T20:07:49Z

build.gradle.kts

+        add(projects.samples.multiModule.navigation)
+    }
+    with(nonPublicMarkers) {
+        add("cafe.adriel.voyager.core.annotation.InternalVoyagerApi")


Why removed ExperimentalVoyagerApi?

Actually code marked with ExperimentalVoyagerApi is a part of public API surface of the voyager. So it shouldn't be treated as non-public and developer need to be aware about changes in this code.

The string is with spaces, does this is correct? Second is that ExperimentalVoyagerApi is meant to be not in the API Surface because it should be a API that can be change at any time, the project Binary Compatibility should try to always be incremental and not change existing APIs, this is why the annotation is not there in the first place.

I understand your reasoning but API marked with this annotation is still public. I think developer should be aware when doing changes even to this code as consumers still can depend on it.

programadorthi · 2025-05-20T20:18:08Z

gradle/samples.versions.toml

Samples is not a good name to this catalog because it'll conflicts with the samples folder and creating confusion from we're getting the dependencies. Keeping all versioning in an unique file isn't a problem.

Can you please explain what conflicts do you mean? Samples modules are accessed through projects.samples.* while dependencies just with samples.*.
Maybe libsSamples.* or samplesLibs.* or demo.* will be a better naming?

I think it's good to have more fine-grained control over what dependencies you add to the library. Now it's not possible to 'accidentally' add new dependency from common catalog. With separate catalogs you need to make a mindful decision to add it to to libs catalog and it's becomes more clear to the reviewer when new dependency were added to library.

Maybe samplesCatalog? I'm not good with names. For the first read I made assumptions between projects.samples and samples.*. Then a I realized that was a catalog.

programadorthi · 2025-05-20T20:20:27Z

samples/android/src/main/AndroidManifest.xml

        android:name=".App"
        android:label="@string/app_name"
-        android:theme="@style/Theme.AppCompat.Light.NoActionBar"
+        android:theme="@android:style/Theme.Material.Light.NoActionBar"


Well you can change directly to androidx.material theme.

It's a compose app which uses compose theme instead of xml one. So I removed appcompat dependency and used built-in theme.

programadorthi · 2025-05-20T20:28:11Z

settings.gradle.kts

+        gradlePluginPortal()
+        mavenLocal()


These two guys will increase the resolution. Why they are here?

Agreed, I'll remove them

programadorthi · 2025-05-20T23:26:31Z

voyager-bottom-sheet-navigator/build.gradle.kts

-        jvmTest.dependencies {
-            implementation(libs.junit.api)
-            runtimeOnly(libs.junit.engine)
+            implementation(compose.runtime)


Voyager uses compileOnly to avoid transitive dependency at compile time.

Seems using compileOnly for compose dependencies break compilation for certain targets, here the warning I get:

A compileOnly dependency is used in targets: Kotlin/JS, Kotlin/Native, Kotlin/Wasm. Dependencies: - org.jetbrains.compose.runtime:runtime-saveable:1.8.1 (source sets: iosArm64Main, iosSimulatorArm64Main, iosX64Main, jsMain, macosArm64Main, macosX64Main, wasmJsMain) - org.jetbrains.compose.runtime:runtime:1.8.1 (source sets: iosArm64Main, iosSimulatorArm64Main, iosX64Main, jsMain, macosArm64Main, macosX64Main, wasmJsMain) Using compileOnly dependencies in these targets is not currently supported, because compileOnly dependencies must be present during the compilation of projects that depend on this project. To ensure consistent compilation behaviour, compileOnly dependencies should be exposed as api dependencies.

Furthermore, it is not possible to use voyager without using compose, why we should to avoid making a transitive dependency here? We not strictly enforce compose version so consumer just will use more recent version of compose.

I also checked out decompose for reference and it using implementation without any problems as it seems.

The reason why this is showing is because of the change in the gradle.properties. There is a flag that the project had enable.

Can you hole back this? for now? This is a relative big change that I need to check with some Kotlin folks to see if the relocation of Compose KMP and Android libraries of Compose does not have the past issues anymore.

programadorthi · 2025-05-20T23:28:24Z

voyager-core/src/androidMain/kotlin/cafe/adriel/voyager/androidx/AndroidScreenLifecycleOwner.kt

    private fun getHooks(): List<ProvidedValue<*>> {
        atomicAppContext.compareAndSet(null, LocalContext.current.applicationContext)
-        atomicParentLifecycleOwner.compareAndSet(null, LocalLifecycleOwner.current)
+        atomicParentLifecycleOwner.compareAndSet(null, LocalLifecycleOwner.current) // deprecated


Remove the comment

hafizkloudius014 · 2025-05-21T06:28:47Z

When can this will merge to master?

programadorthi · 2025-05-21T20:27:17Z

I think soon it'll be merged. It's a good contribution. Just some adjustments and done.

hafizkloudius014 · 2025-05-22T01:01:48Z

@dzmpr i found bugs regarding to parseable serialize.

error : when time you off the screen and come back to screen error about parse. so i come out this solution but don't know how to constribute:

abstract class BasedActivityScreen : Screen, JavaSerializable{   //<-- without JavaSerializable will be error.
    @Composable
    override fun Content() {
        previewScreen()
    }

    @Preview
    @Composable
    open fun previewScreen(){}
}

and i hope that

public expect interface Screen { <-- can add parceable

    public open val key: ScreenKey

    @Composable
    public fun Content()
}

internal fun Screen.commonKeyGeneration() =
    this::class.multiplatformName ?: error("Default ScreenKey not found, please provide your own key")

programadorthi · 2025-05-22T17:33:00Z

@hafizkloudius014 Screen is JavaSerializable by default. More details here.

hafizkloudius014 · 2025-05-23T01:19:01Z

Is this pr good to go to merge?

DevSrSouza · 2025-06-02T20:17:58Z

settings.gradle.kts

+        eachPlugin {
+            if (requested.version == null) return@eachPlugin
+            when (requested.id.id) {
+                "com.android.tools.build" -> {
+                    useModule("${requested.id.id}:gradle:${requested.version}")
+                }
+            }
+        }
+    }


Any reason why this is needed?

By default Gradle to resolve plugin artifact by plugin id uses plugin id as group id and add .gradle.plugin suffix to plugin id to construct artifact id. So plugin "pluginId" version "1.0.0" becomes "pluginId:pluginId.gradle.plugin:1.0.0" artifact.
But AGP build plugin has custom artifact id which we need to override.

voyager-core/src/commonWebMain/kotlin/cafe.adriel.voyager.core/screen/ScreenKey.web.kt

DevSrSouza · 2025-06-02T20:27:14Z

~~Can you revert back to use compileOnly in dependencies? and add the following flag to the gradle.properties should skip the warning you are seeing.~~

# Compose dependencies currently requires to be CompileOny if we want to both
# support Android only projects and multiplatform projects.
# based on the issue below, it seems to only have issues with compileOnly
# when cache is enable, so, based on the currently state of Compose Multiplatform
# the native target also does not work propertly with caching, so, any compose project
# will require `kotlin.native.cacheKind=none` making possible to we continue using compileOnly.
# https://youtrack.jetbrains.com/issue/KT-46377
kotlin.native.ignoreIncorrectDependencies=true

edit:
I will try to run this PR locally and I will check if publishing locally with implementation and consuming in a pure Android compose project to see if there will be any issues (in the past it had), if I don't find any, we can keep the implementation() usage.

…veLast

…e collections compilation, fix Lifecycle KMP

dzmpr · 2025-06-14T18:18:48Z

I think now we ready to merge and release new version

dzmpr · 2025-06-20T13:02:30Z

@DevSrSouza Hey, did you get a chance to test the PR locally with implementation as you mentioned?

dzmpr · 2025-07-02T17:06:39Z

Since July of 2025 OSS sonatype repository is out of service so all new publications should go through cetral portal. I updated publishing configuration, now we need to migrate voyager namespace to center portal (here short instruction and here is official one) and update project secrets (SONATYPE_NEXUS_USERNAME and SONATYPE_NEXUS_PASSWORD) with newly generated ones.
@DevSrSouza @programadorthi

hafiz013 · 2025-07-02T22:38:12Z

hi it is already july, it is ok can merge this pr? thanks you.

devnatan

LGTM

hafiz013 · 2025-07-04T00:19:47Z

nice it approved. may i know what is latest version of this library? thank you

zouyonghao · 2025-07-06T17:39:56Z

Any updates?

hafizkloudius014 · 2025-07-14T03:13:24Z

hi @programadorthi and @DevSrSouza when can get the approval?

Robotxm · 2025-07-22T17:56:16Z

Any updates on this PR?

dzmpr · 2025-08-05T09:35:12Z

@DevSrSouza Hi, can you please take a look at this PR? There is one step left to release and unblock other improvements for the lib.

hafizkloudius014 · 2025-08-18T02:27:36Z

hi @programadorthi should be increase the number of version library before can merge to main?

Robotxm · 2025-08-26T18:02:04Z

Hi @programadorthi, it seems that publish of new version is failed. Will it be fixed?

hafizkloudius014 · 2025-09-01T13:35:26Z

hi @programadorthi error:

Failed to stop service 'sonatype-repository-build-service'.
> Upload failed: {"error":{"message":"Invalid token"}}

dzmpr · 2025-09-02T12:34:17Z

I think this #514 (comment) may be a problem.

hafizkloudius014 · 2025-09-02T17:29:32Z

ok then their problem not migrate the portal. @dzmpr

dzmpr added 10 commits December 1, 2024 15:04

Update gradle 8.2 => 8.11.1

7124afd

Remove redundant .gitignore's; use recommended rules from github

75ff0ad

Remove empty consumer rule files

129360a

Remove app compat dependency as only theme were used from it

f3f10c2

Update project dependencies; simplify build configuration; move confi…

88e345c

…guration logic to convention plugins

Update yarn.lock; fix js sample

7d7450f

Use implementation instead of compileOnly for compose dependencies

95db997

Remove uuid dependency and use kotlin stdlib implementation

4f5bf41

Replace deprecated API's in samples

a05ce49

Minor warning fixes

4f66d4c

dzmpr mentioned this pull request Dec 2, 2024

iOS Doesn't build with kotlin 2.1.0 and voyager 1.1.0-beta03 or lower #515

Open

Vodes reviewed Dec 15, 2024

View reviewed changes

dzmpr added 6 commits May 1, 2025 17:57

Rename common jvm group from jvm to commonJvm to make it non ambiguous

cd60348

Disable androidResources in library modules

664917d

Remove package from AndroidManifest

4bd3336

Update dependencies

2a768f1

Replace deprecated LifecycleEffect

a2fe0f7

Merge branch 'main' into dependencies_update

db76d3f

# Conflicts: # samples/multiplatform/build.gradle.kts

programadorthi reviewed May 20, 2025

View reviewed changes

Remove unused repositories

75b7ec7

Update .gitignore

b4223d7

DevSrSouza reviewed Jun 2, 2025

View reviewed changes

voyager-core/src/commonWebMain/kotlin/cafe.adriel.voyager.core/screen/ScreenKey.web.kt Show resolved Hide resolved

DevSrSouza and others added 6 commits June 2, 2025 21:44

Fixing crash causes in older versions because of removeFirst and remo…

97bf62e

…veLast

Bump JVM Target to 11 because of Compose requirements, fix Thread Saf…

910a76b

…e collections compilation, fix Lifecycle KMP

Fixing lint issues

8c3141d

Update jvm target for samples

7d3866b

Update dependencies

1bd3f50

Update voyager API dump

0738d86

Update dependencies; change publishing host to central portal

6198a48

Update API dump

85e9663

devnatan approved these changes Jul 3, 2025

View reviewed changes

dzmpr requested review from DevSrSouza and programadorthi July 11, 2025 09:09

programadorthi approved these changes Jul 22, 2025

View reviewed changes

programadorthi merged commit 670dddc into adrielcafe:main Aug 17, 2025
1 check passed

Uh oh!

Comments

Conversation

dzmpr commented Dec 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hafiz013 commented Feb 17, 2025

Uh oh!

Syer10 commented Feb 17, 2025

Uh oh!

hafiz013 commented Feb 18, 2025

Uh oh!

dzmpr commented May 20, 2025

Uh oh!

programadorthi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzmpr May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hafizkloudius014 commented May 21, 2025

Uh oh!

programadorthi commented May 21, 2025

Uh oh!

hafizkloudius014 commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dzmpr commented Dec 1, 2024 •

edited

Loading

dzmpr May 21, 2025 •

edited

Loading

hafizkloudius014 commented May 22, 2025 •

edited

Loading

DevSrSouza commented Jun 2, 2025 •

edited

Loading

dzmpr commented Jul 2, 2025 •

edited

Loading