ComposeRuntimeError regression (Expected applyChanges() to have been called) [274786923]

Fixed

Bug

Status Update

No update yet.

Description

ub...@gmail.com

created issue #1

Mar 23, 2023 08:30PM

Jetpack Compose version: Compose BOM 2023.03.00, Compose Compiler 1.4.4

Jetpack Compose component used: compiler

Android Studio Build: N/A

Kotlin version: 1.8.10

This is a regression first introduced in Compose Compiler 1.4.3, it worked fine in 1.4.2. It may be related to the fixes that Chuck is working on right now, e.g. https://issuetracker.google.com/issues/264467571

Steps to Reproduce or Code Sample to Reproduce:

Minimal repro project at https://github.com/bubenheimer/composeinlinebug

@Composable
fun Screen() = MyDialog { if (false) Box {} }

@Composable
inline fun MyDialog(crossinline content: @Composable () -> Unit) = Dialog({}) { content() }

This looks a little funny only because it's a minimal repro.

Stack trace (if applicable):

androidx.compose.runtime.ComposeRuntimeError: Compose Runtime internal error. Unexpected or incorrect use of the Compose internal runtime API (Expected applyChanges() to have been called). Please report to Google or use https://goo.gle/compose-feedback
at androidx.compose.runtime.ComposerKt.composeRuntimeError(Composer.kt:4501)
at androidx.compose.runtime.ComposerImpl.recompose$runtime_release(Composer.kt:4607)
at androidx.compose.runtime.CompositionImpl.recompose(Composition.kt:772)
at androidx.compose.runtime.Recomposer.performRecompose(Recomposer.kt:1047)
at androidx.compose.runtime.Recomposer.access$performRecompose(Recomposer.kt:124)
at androidx.compose.runtime.Recomposer$runRecomposeAndApplyChanges$2$2.invoke(Recomposer.kt:541)
at androidx.compose.runtime.Recomposer$runRecomposeAndApplyChanges$2$2.invoke(Recomposer.kt:510)
at androidx.compose.ui.platform.AndroidUiFrameClock$withFrameNanos$2$callback$1.doFrame(AndroidUiFrameClock.android.kt:34)
at androidx.compose.ui.platform.AndroidUiDispatcher.performFrameDispatch(AndroidUiDispatcher.android.kt:109)
at androidx.compose.ui.platform.AndroidUiDispatcher.access$performFrameDispatch(AndroidUiDispatcher.android.kt:41)
at androidx.compose.ui.platform.AndroidUiDispatcher$dispatchCallback$1.doFrame(AndroidUiDispatcher.android.kt:69)
at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1229)
at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1239)
at android.view.Choreographer.doCallbacks(Choreographer.java:899)
at android.view.Choreographer.doFrame(Choreographer.java:827)
at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:1214)
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)
Suppressed: kotlinx.coroutines.DiagnosticCoroutineContextException: [androidx.compose.runtime.PausableMonotonicFrameClock@27cfb40, androidx.compose.ui.platform.MotionDurationScaleImpl@744aa79, StandaloneCoroutine{Cancelling}@6c3a3be, AndroidUiDispatcher@24cc1f]

Comments

ch...@google.com <ch...@google.com> #2Mar 23, 2023 09:36PM

Reassigned to ch...@google.com.

On first blush, this doesn't appear to be related to my current changes, as this is an error in the recomopser not the composer. However, the fact it requires an inline function seems suspiciously close.

ch...@google.com <ch...@google.com> #3Mar 23, 2023 10:00PM

Reassigned to as...@google.com.

The issue appears to be that, starting in 1.4.3, the composer used in the inlined lambda is the one captured from the parent. This is not the right one when a dialog is being presented as it is the composer for the dialog, not the dialog host.

ch...@google.com <ch...@google.com> #4Mar 23, 2023 10:15PM

The only change between 1.4.2 and 1.4.3 is https://android-review.googlesource.com/#/q/Ie93edb78b8427e56b4bef15b872a919b8bac0664

Handing this to Andrei to look at as this was his change.

ch...@google.com <ch...@google.com> #5Mar 23, 2023 10:20PM

Note to Andrei: After the aosp/2423347, the cross-inline lambda is capturing the $composer parameter from the caller instead of using the $composer parameter passed in to the lambda it was inlined into. This causes changes to be made to the composer that is not currently being used for composition which confused the recomposer.

ch...@google.com <ch...@google.com> #6Mar 24, 2023 05:21PM

This issue affects crossinline lambdas that are inlined into another lambda, as demonstrated by the repro case above, when the composable lambda is executed with a different composer than the function declaring the lambda. A different composer is used when a lambda is invoked in a subcomposition such as a dialog, BoxWithConstraints, and LazyColumn, amoung others.

A crossinline lambda is requred because it is illegal to invoke an non-crossinline lambda in a realized lambda (which is what crossinline allows).

The easiest work-around is to remove inline from the function which avoids the expanding of the lambda in another lambda required for this bug to manifest.

ub...@gmail.com <ub...@gmail.com> #7Mar 24, 2023 05:27PM

Thank you for the elaboration! The non-inline workaround is what I've been using since this code broke.

ap...@google.com <ap...@google.com> #8Mar 26, 2023 05:03PM

Marked as fixed.

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

commit 9a5e5b6351ecaf5b888c75dfa75aea8360afc6a9
Author: Andrei Shikov <ashikov@google.com>
Date: Fri Mar 24 19:26:38 2023

Use composer of the correct scope when realizing groups

Updates function body transform to use composer parameter from target scope to realize groups. The realize call can happen outside of such scope and composer parameter is not guaranteed to be the same between scope where groups are being realize and current scope at the time of the call.

Test: CompositionTests
Fixes: 274786923
Change-Id: I0cc3c7be151edb7cbbe4114fffbde8736f7ec428

M compose/compiler/compiler-hosted/integration-tests/src/test/java/androidx/compose/compiler/plugins/kotlin/ControlFlowTransformTests.kt
M compose/compiler/compiler-hosted/integration-tests/src/test/java/androidx/compose/compiler/plugins/kotlin/FunctionBodySkippingTransformTests.kt
M compose/compiler/compiler-hosted/integration-tests/src/test/java/androidx/compose/compiler/plugins/kotlin/TargetAnnotationsTransformTests.kt
M compose/compiler/compiler-hosted/integration-tests/src/test/java/androidx/compose/compiler/plugins/kotlin/TraceInformationTest.kt
M compose/compiler/compiler-hosted/src/main/java/androidx/compose/compiler/plugins/kotlin/lower/ComposableFunctionBodyTransformer.kt
M compose/compiler/compiler-hosted/src/main/java/androidx/compose/compiler/plugins/kotlin/lower/IrSourcePrinter.kt
M compose/runtime/runtime/src/commonTest/kotlin/androidx/compose/runtime/CompositionTests.kt

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

na...@google.com <na...@google.com> #9Apr 5, 2023 06:28PM

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

androidx.compose.runtime:runtime:1.5.0-alpha02