New `TooltipBox` throws `RuntimeException: Parcel: unable to marshal value` [299500338]

Fixed

Bug

Status Update

No update yet.

Description

sp...@gmail.com

created issue #1

Sep 7, 2023 07:22PM

Jetpack Compose version: 1.6.0-alpha05
Jetpack Compose component used: TooltipBox
Android Studio Build: Android Studio Iguana | 2023.2.1 Canary 2 (AGP 8.1.1)
Kotlin version: 1.9.10

After updating to compose 1.6.0-alpha05, my app was crashing after pressing the home button to leave the app. After some testing, I think the app crashes when TooltipBox is used.

FATAL EXCEPTION: main
    Process: com.example.bugapplication, PID: 2242
    java.lang.IllegalArgumentException: Parcel: unknown type for value androidx.compose.foundation.MutatorMutex@8cf1dbd
        at android.os.Parcel.getValueType(Parcel.java:2409)
        at android.os.Parcel.writeValue(Parcel.java:2308)
        at android.os.Parcel.writeList(Parcel.java:1382)
        at android.os.Parcel.writeValue(Parcel.java:2460)
        at android.os.Parcel.writeValue(Parcel.java:2316)
        at android.os.Parcel.writeList(Parcel.java:1382)
        at android.os.Parcel.writeValue(Parcel.java:2460)
        at android.os.Parcel.writeValue(Parcel.java:2316)
        at android.os.Parcel.writeArrayMapInternal(Parcel.java:1265)
        at android.os.BaseBundle.writeToParcelInner(BaseBundle.java:1802)
        at android.os.Bundle.writeToParcel(Bundle.java:1389)
        at android.os.Parcel.writeBundle(Parcel.java:1334)
        at android.os.Parcel.writeValue(Parcel.java:2433)
        at android.os.Parcel.writeValue(Parcel.java:2323)
        at android.os.Parcel.writeArrayMapInternal(Parcel.java:1265)
        at android.os.BaseBundle.writeToParcelInner(BaseBundle.java:1802)
        at android.os.Bundle.writeToParcel(Bundle.java:1389)
        at android.os.Parcel.writeBundle(Parcel.java:1334)
        at android.os.Parcel.writeValue(Parcel.java:2433)
        at android.os.Parcel.writeValue(Parcel.java:2323)
        at android.os.BaseBundle.dumpStats(BaseBundle.java:1874)
        at android.os.BaseBundle.dumpStats(BaseBundle.java:1911)
        at android.app.servertransaction.PendingTransactionActions$StopInfo.run(PendingTransactionActions.java:150)
        at android.os.Handler.handleCallback(Handler.java:942)
        at android.os.Handler.dispatchMessage(Handler.java:99)
        at android.os.Looper.loopOnce(Looper.java:201)
        at android.os.Looper.loop(Looper.java:288)
        at android.app.ActivityThread.main(ActivityThread.java:7872)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:548)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:936)

I've attached a small app that I've been using to test the bug on different devices, but any app that uses TooltipBox should have the issue.

Steps to reproduce:

Open demo app
Use the Switch to display the Icon + Tooltip composable
Click the Home button

The app should crash with a RuntimeException. If we hide the Icon + Tooltip before clicking Home, the app won't crash.

I've tested the app on a device running SDK 30 and on three emulator images running 26, 29 and 33.

I hope this is not a problem with my TooltipBox implementation. I've used the same composable from TooltipSamples to avoid mistakes.

BugApplication.zip

108 KB

Download

Comments

ma...@google.com <ma...@google.com> Sep 8, 2023 01:24PM

Reassigned to ke...@google.com.

ad...@gmail.com <ad...@gmail.com> #2Sep 9, 2023 02:18PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

https://android-review.googlesource.com/1360099

zi...@gmail.com <zi...@gmail.com> #3Sep 10, 2023 04:02PM

I have this problem too, is there any good solution?

ki...@protonmail.com <ki...@protonmail.com> #4Sep 11, 2023 10:16AM

Same problem here, the problem is that val GlobalMutatorMutex: MutatorMutex = MutatorMutex() is trying to be saved to a bundle

            save = {
                listOf(
                    it.isVisible,
                    it.isPersistent,
                    it.mutatorMutex
                )
            },
            restore = {
                val (isVisible, isPersistent, mutatorMutex) = it as List<*>
                TooltipStateImpl(
                    initialIsVisible = isVisible as Boolean,
                    isPersistent = isPersistent as Boolean,
                    mutatorMutex = mutatorMutex as MutatorMutex,
                )
            }
        )

but the MutatorMutex class doesn't implement Parcelable nor Serializable

class MutatorMutex {}

The workaround is to modify the rememberTooltipState and provide your own implementation until fix is there.

Here is a quick fix that I created, it means that it will use the singleton's BasicTooltipDefaults.GlobalMutatorMutex instance.


import androidx.compose.animation.core.MutableTransitionState
import androidx.compose.foundation.BasicTooltipDefaults
import androidx.compose.foundation.BasicTooltipState
import androidx.compose.foundation.MutatePriority
import androidx.compose.foundation.MutatorMutex
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.TooltipState
import androidx.compose.runtime.Composable
import androidx.compose.runtime.Stable
import androidx.compose.runtime.saveable.Saver
import androidx.compose.runtime.saveable.rememberSaveable
import kotlinx.coroutines.CancellableContinuation
import kotlinx.coroutines.suspendCancellableCoroutine
import kotlinx.coroutines.withTimeout

//https://issuetracker.google.com/issues/299500338
@Composable
@ExperimentalMaterial3Api
fun rememberTooltipStateFix(
    initialIsVisible: Boolean = false,
    isPersistent: Boolean = false
): TooltipState {
    return rememberSaveable(
        isPersistent,
        saver = TooltipStateImpl.Saver
    ) {
        TooltipStateImpl(
            initialIsVisible = initialIsVisible,
            isPersistent = isPersistent,
            mutatorMutex = BasicTooltipDefaults.GlobalMutatorMutex
        )
    }
}

@Stable
private class TooltipStateImpl(
    initialIsVisible: Boolean,
    override val isPersistent: Boolean,
    private val mutatorMutex: MutatorMutex
) : TooltipState {
    override val transition: MutableTransitionState<Boolean> =
        MutableTransitionState(initialIsVisible)

    override val isVisible: Boolean
        get() = transition.currentState || transition.targetState

    /**
     * continuation used to clean up
     */
    private var job: (CancellableContinuation<Unit>)? = null

    /**
     * Show the tooltip associated with the current [BasicTooltipState].
     * When this method is called, all of the other tooltips associated
     * with [mutatorMutex] will be dismissed.
     *
     * @param mutatePriority [MutatePriority] to be used with [mutatorMutex].
     */
    override suspend fun show(
        mutatePriority: MutatePriority
    ) {
        val cancellableShow: suspend () -> Unit = {
            suspendCancellableCoroutine { continuation ->
                transition.targetState = true
                job = continuation
            }
        }

        // Show associated tooltip for [TooltipDuration] amount of time
        // or until tooltip is explicitly dismissed depending on [isPersistent].
        mutatorMutex.mutate(mutatePriority) {
            try {
                if (isPersistent) {
                    cancellableShow()
                } else {
                    withTimeout(BasicTooltipDefaults.TooltipDuration) {
                        cancellableShow()
                    }
                }
            } finally {
                // timeout or cancellation has occurred
                // and we close out the current tooltip.
                dismiss()
            }
        }
    }

    /**
     * Dismiss the tooltip associated with
     * this [TooltipState] if it's currently being shown.
     */
    override fun dismiss() {
        transition.targetState = false
    }

    /**
     * Cleans up [mutatorMutex] when the tooltip associated
     * with this state leaves Composition.
     */
    override fun onDispose() {
        job?.cancel()
    }

    companion object {
        /**
         * The default [Saver] implementation for [TooltipStateImpl].
         */
        val Saver = Saver<TooltipStateImpl, Any>(
            save = {
                listOf(
                    it.isVisible,
                    it.isPersistent,
                )
            },
            restore = {
                val (isVisible, isPersistent) = it as List<*>
                TooltipStateImpl(
                    initialIsVisible = isVisible as Boolean,
                    isPersistent = isPersistent as Boolean,
                    mutatorMutex = BasicTooltipDefaults.GlobalMutatorMutex,
                )
            }
        )
    }
}

Message last modified on Sep 11, 2023 11:34AM

ap...@google.com <ap...@google.com> #5Sep 11, 2023 08:22PM

Project: platform/frameworks/support
Branch: androidx-main

commit 6bb2ebba14f7f98b3a82e7f7869e248b47d97953
Author: Kevin Truong <kevinctruong@google.com>
Date: Mon Sep 11 09:13:03 2023

[Tooltip] Removing savedInstanceState for tooltips

Removing the use of savedInstanceState for tooltips since the changes that need to be made to support this outweigh the benefit of supporting it.
We initially used a Saver for tooltip, so that a shown tooltip would remain showing even on device rotation. However, MutatorMutex is not a saveable type.
To make it work, we would need to make MutatorMutex saveable. For now, users will just need to reopen closed tooltips on device rotation or app closure.

Bug: 299500338
Test: N/A
Relnote: remove the use of rememberSaveable for tooltips.
Change-Id: Icc131c852cc3b3c722954aecb0a002711e13ca96

M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/BasicTooltip.kt
M compose/material3/material3/src/commonMain/kotlin/androidx/compose/material3/Tooltip.kt

https://android-review.googlesource.com/2747573

ke...@google.com <ke...@google.com> Sep 11, 2023 08:53PM

Marked as fixed.

na...@google.com <na...@google.com> #6Sep 20, 2023 07:16PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.compose.foundation:foundation:1.6.0-alpha06
androidx.compose.foundation:foundation-android:1.6.0-alpha06
androidx.compose.material3:material3:1.2.0-alpha08
androidx.compose.material3:material3-android:1.2.0-alpha08