Node mp #551

Ninjars · 2023-07-30T10:33:33Z

Description

Brings in the feature dev branch implementing multiplatform support for the navigation module.

Check list

I have updated CHANGELOG.md if required.
I have updated documentation if required.

…ble implementations

…d with new utilities module

Multiplatform utils

…upporting configuration

…breaks all android dependencies within

…ncerns to Android-only code

might have ramifications for testing where logcat shouldn't be referenced...

… Android lifecycle classes

…rmLifecycle

… smattering of errors and warnings

…sage

…om ParentNode Multiplatform implementations pending...

…on" terminology

…interface to compile

KovalevAndrey · 2023-07-31T19:02:28Z

appyx-navigation/android/build.gradle.kts

-    api(libs.kotlin.coroutines.android)
-    api(libs.androidx.lifecycle.common)
+    api(project(":appyx-navigation:appyx-navigation"))
+    runtimeOnly(libs.kotlin.coroutines.android)


can you explain this change, please?

this was a complaint raised by one of the build analysis tools. It wanted a change to the way the dependency was declared and it didn't appear to break anything, so who am I to question the computer?

This doesn't look right, we have attachChild, waitForChildAttached API which use coroutines

ok, will revert

KovalevAndrey · 2023-07-31T19:07:21Z

.../common/src/androidMain/kotlin/com/bumble/appyx/navigation/store/RetainedInstanceStoreExt.kt

-/**
- * Obtains or creates an instance of a class using the identifier from the BuildContext.
- */
-inline fun <reified T : Any> BuildContext.getRetainedInstance(


put the rest of ext functions to the common module?

deriving the key from the class name wasn't trivially possible in a multiplatform way, hence the functions that rely on that remaining in a jvm context.

appyx-navigation/common/src/commonMain/kotlin/com/bumble/appyx/navigation/node/Node.kt

KovalevAndrey · 2023-07-31T19:14:50Z

appyx-navigation/common/src/commonMain/kotlin/com/bumble/appyx/navigation/node/Node.kt

@@ -117,7 +113,6 @@ open class Node @VisibleForTesting internal constructor(
    fun Compose(modifier: Modifier = Modifier) {
        CompositionLocalProvider(
            LocalNode provides this,
-            LocalLifecycleOwner provides this,


let's revet this and provide lifecycle so it's available in the view

ok. This is more than a reversion: we'll need to create a multiplatform concept of LocalLifecycleOwner and provide it, and also the lifecycle we're providing is CommonLifeycleOwner not the android lifecycle so we should probably avoid name-space collisions with Jetpack Compose's own LocalLifecycleOwner.

Perhaps by declaring this in the lifecycle folder?

val LocalCommonLifecycleOwner: ProvidableCompositionLocal<CommonLifecycleOwner?> = compositionLocalOf { null }```

KovalevAndrey · 2023-07-31T19:15:44Z

appyx-navigation/common/src/commonMain/kotlin/com/bumble/appyx/navigation/node/Node.kt

    private val buildContext: BuildContext,
    val view: NodeView = EmptyNodeView,
    private val retainedInstanceStore: RetainedInstanceStore,
    plugins: List<Plugin> = emptyList()
-) : NodeLifecycle, NodeView by view, RequestCodeClient {


why is it removed?

Because request code is an Android concept that doesn't need to be entangled with a multiplatform Node. Unless I'm off-base here, android client code can supply any RequestCodeClient impl needed at the activity level, no?

No, RequestCodeClient is needed on a per Node basis. We'll have to implement RequestCodeClient in the client code for Android Nodes

in conversation with Zsolt about this there was a question as to whether we even needed this on Android for a good reason, so worth re-assessing perhaps?

KovalevAndrey · 2023-07-31T19:21:18Z

...on/src/commonMain/kotlin/com/bumble/appyx/navigation/store/RetainedInstanceStoreCommonExt.kt

+/**
+ * Obtains or creates an instance of a class using the identifier from the BuildContext.
+ */
+inline fun <reified T : Any> BuildContext.getRetainedInstance(


this one method is in common module while other similar methods in commonAndroid

KovalevAndrey · 2023-07-31T19:44:32Z

.../common/src/desktopMain/kotlin/com/bumble/appyx/navigation/store/RetainedInstanceStoreExt.kt

+ * Obtains or creates an instance of a class using the class name as the key.
+ * If you need multiple instances of an object with the same key, do not use this extension.
+ */
+inline fun <reified T : Any> RetainedInstanceStore.get(


put it in common?

T::class.java isn't available outside the jvm build targets

appyx-navigation/web/src/jsMain/kotlin/com/bumble/navigation/integrationpoint/WebNodeHost.kt

...ion/common/src/commonMain/kotlin/com/bumble/appyx/navigation/node/container/ContainerNode.kt

.../kotlin/com/bumble/appyx/navigation/node/spotlight/SpotlightObserveTransitionsExampleNode.kt

…ommon navigation module, simplifying the dependency situation

zsoltk · 2023-08-14T13:55:58Z

documentation/2.x/migrationguide.md

@@ -15,7 +15,8 @@ The library is packaged as multiple artifacts.
 - Cares about the Node structure & Android-related functionality
 - Uses `:appyx-interactions` as a dependency to implement navigation using gestures and transitions
 - Android library
- Compose multiplatform implementation is in progress, to be merged soon
+- Supports Compose multiplatform. WebNodeHost and DesktopNodeHost provide convenience wrappers for


Suggested change

- Supports Compose multiplatform. WebNodeHost and DesktopNodeHost provide convenience wrappers for

- Supports Compose Multiplatform. `WebNodeHost` and `DesktopNodeHost` provide convenience wrappers for

Ninjars and others added 30 commits May 15, 2023 11:14

created multiplatform-common utility library to hold sharable Parcela…

7486f64

…ble implementations

removed Parcelize implementation from interactions module and replace…

7c7893b

…d with new utilities module

renamed multiplatform package

6ac3040

renamed multiplatform module

4f7da38

Merge pull request #431 from Ninjars/multiplatform-utils

c880cb9

Multiplatform utils

initial refactoring of appyx-navigation module into a multiplatform-s…

9c70cca

…upporting configuration

moved code from android module to common multiplatform module - this …

37b5a10

…breaks all android dependencies within

declared common platform interfaces

d0e4ae5

made customizations a multiplatform module

ce2a498

refactored handling of IntegrationPoint, removing android specific co…

9f95ed2

…ncerns to Android-only code

updated imports

372af07

addressed class references

c2b568d

added simple multiplatform logger for use in LifecycleLogger.kt

25fef49

might have ramifications for testing where logcat shouldn't be referenced...

fixed UUID reference

53635ae

fixed interface signature

9eb7593

implemented multiplatform LifecycleRegistry

dd93329

updated functional interface signatures that aren't compatible with JS

fe60c79

reference android navigation module where appropriate

62218e0

updated IntegrationPointStub.kt

eb3f204

renamed lifecycle classes with "platform" prefix to disambiguate with…

a650fe5

… Android lifecycle classes

initial implementation of PlatformLifecycleRegistry and AndroidPlatfo…

82d0ce3

…rmLifecycle

wip cleanup - removing some incompatible annotations and addressing a…

bacbf90

… smattering of errors and warnings

inject PlatformLifecycle into NodeHost, facilitating cross-platform u…

64f7ef3

…sage

fixed LifecycleLogger

147a8f8

api change cleanup

124c109

addressed a range of compilation issues

07f9b2c

implemented PlatformBackHandler to remove back handling dependency fr…

b36e845

…om ParentNode Multiplatform implementations pending...

repackaged and renamed things for consistency of "platform" and "comm…

0910e6d

…on" terminology

simple desktop and JS PlatformLifecycleRegistry impls

dd3f250

added necessary OnBackPressedCallback interface for BackPressHandler …

c3fed19

…interface to compile

Merge branch '2.x' into node-mp

59cd54b

Ninjars added this to the 2.0 milestone Jul 30, 2023

Ninjars self-assigned this Jul 30, 2023

Ninjars linked an issue Jul 30, 2023 that may be closed by this pull request

Integrate navigation multiplatform #430

Closed

Ninjars added 4 commits July 30, 2023 11:35

Added line to CHANGELOG for multiplatform

06eab9f

Updated entry in migrationguide.md

95bdacf

fixed import path broken in merge

4c2f47e

fixed mkdocs indentation

b3c99b0

zsoltk mentioned this pull request Jul 31, 2023

Upgrade Compose Multiplatform / Kotlin #547

Closed

reverted whitespace changes in 1.x docs

99693d9

KovalevAndrey reviewed Jul 31, 2023

View reviewed changes

Ninjars added 7 commits August 7, 2023 17:18

whitespace tweaks

f6d6837

provide node lifecycle via LocalCommonLifecycleOwner composition local

21a3b35

repackaged platform helper classes

18eba90

simplified demo classes

19d903f

reverted change to Node.navigateUp()

07353f5

Merge branch '2.x' into node-mp

d939568

repackaged code from platform-specific navigation modules to within c…

4c89cec

…ommon navigation module, simplifying the dependency situation

Ninjars force-pushed the node-mp branch from 938bd67 to 4c89cec Compare August 14, 2023 13:15

zsoltk reviewed Aug 14, 2023

View reviewed changes

cleaned up dependencies

5d25d91

Ninjars force-pushed the node-mp branch from a70b822 to 5d25d91 Compare August 14, 2023 15:07

KovalevAndrey approved these changes Aug 14, 2023

View reviewed changes

Ninjars added 4 commits August 14, 2023 16:26

Merge branch '2.x' into node-mp

7f46fdd

updated changelog

d46761e

fixed merge import path issue

ca55991

fix for deprecation.md paths

f585a22

Ninjars force-pushed the node-mp branch from b090354 to f585a22 Compare August 15, 2023 11:26

zsoltk merged commit 9f95179 into 2.x Aug 15, 2023
5 checks passed

Ninjars deleted the node-mp branch August 15, 2023 13:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node mp #551

Node mp #551

Ninjars commented Jul 30, 2023 •

edited

KovalevAndrey Jul 31, 2023

Ninjars Aug 7, 2023

KovalevAndrey Aug 14, 2023

Ninjars Aug 14, 2023

KovalevAndrey Jul 31, 2023

Ninjars Aug 7, 2023

KovalevAndrey Jul 31, 2023

Ninjars Aug 7, 2023

KovalevAndrey Jul 31, 2023

Ninjars Aug 7, 2023

KovalevAndrey Aug 14, 2023

Ninjars Aug 15, 2023

KovalevAndrey Jul 31, 2023

KovalevAndrey Jul 31, 2023

Ninjars Aug 7, 2023

zsoltk Aug 14, 2023

	- Supports Compose multiplatform. WebNodeHost and DesktopNodeHost provide convenience wrappers for
	- Supports Compose Multiplatform. `WebNodeHost` and `DesktopNodeHost` provide convenience wrappers for

Node mp #551

Node mp #551

Conversation

Ninjars commented Jul 30, 2023 • edited

Description

Check list

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

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

Ninjars commented Jul 30, 2023 •

edited