Crash when drawing ComposeView on a software canvas (Recording currently in progress) [232625913]

Infeasible

Bug

Status Update

No update yet.

Description

dm...@gmail.com

created issue #1

May 15, 2022 10:38AM

Jetpack Compose version: 1.1.1

Jetpack Compose component used: AndroidView

Android Studio Build: Android Studio Chipmunk | 2021.2.1

Build #AI-212.5712.43.2112.8512546, built on April 28, 2022

Kotlin version: 1.6.10

Steps to Reproduce or Code Sample to Reproduce:

Code sample - https://github.com/Dimezis/JetpackComposeCanvasCrash

Steps:

Have an AndroidView in a Compose hierarchy
Wrap a custom View in AndroidView, that draws the ComposeView on a software canvas inside of the onDraw call
Crash - java.lang.IllegalStateException: Recording currently in progress - missing #endRecording() call?

Even though the example is weird, it's based on a real problem - https://github.com/Dimezis/BlurView/issues/157

I'm trying to obtain a hierarchy snapshot on a software canvas backed by a bitmap, but unlike the regular View system, Compose crashes on it, for some reason. Judging by the internals of the AndroidComposeView.dispatchDraw, it can be fixed. I haven't tried building a fixed version of Compose, but it seems to me that updateDisplayList should not be called when dispatchDraw is called with a software canvas as an argument.

Stack trace:

    java.lang.IllegalStateException: Recording currently in progress - missing #endRecording() call?
        at android.graphics.RenderNode.beginRecording(RenderNode.java:372)
        at android.graphics.RenderNode.beginRecording(RenderNode.java:391)
        at androidx.compose.ui.platform.RenderNodeApi29.record(RenderNodeApi29.android.kt:163)
        at androidx.compose.ui.platform.RenderNodeLayer.updateDisplayList(RenderNodeLayer.android.kt:245)
        at androidx.compose.ui.platform.AndroidComposeView.dispatchDraw(AndroidComposeView.android.kt:760)
        at android.view.View.draw(View.java:22353)
        at android.view.View.draw(View.java:22223)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22221)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22221)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22221)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22353)
        at com.android.internal.policy.DecorView.draw(DecorView.java:806)
        at com.example.composeblur.SomeView.onDraw(MainActivity.kt:56)
        at android.view.View.draw(View.java:22350)
        at android.view.View.updateDisplayListIfDirty(View.java:21226)
        at android.view.View.draw(View.java:22081)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22353)
        at androidx.compose.ui.platform.AndroidViewsHandler.drawView(AndroidViewsHandler.android.kt:72)
        at androidx.compose.ui.platform.AndroidComposeView.drawAndroidView(AndroidComposeView.android.kt:540)
        at androidx.compose.ui.viewinterop.AndroidViewHolder$layoutNode$1$coreModifier$1.invoke(AndroidViewHolder.android.kt:257)
        at androidx.compose.ui.viewinterop.AndroidViewHolder$layoutNode$1$coreModifier$1.invoke(AndroidViewHolder.android.kt:254)
        at androidx.compose.ui.draw.DrawBackgroundModifier.draw(DrawModifier.kt:101)
        at androidx.compose.ui.node.ModifiedDrawNode.performDraw(ModifiedDrawNode.kt:102)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.ModifiedLayoutNode.performDraw(ModifiedLayoutNode.kt:98)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.ModifiedLayoutNode.performDraw(ModifiedLayoutNode.kt:98)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:828)
        at androidx.compose.ui.node.InnerPlaceable.performDraw(InnerPlaceable.kt:137)
        at androidx.compose.ui.node.LayoutNodeWrapper$invoke$1.invoke(LayoutNodeWrapper.kt:267)
        at androidx.compose.ui.node.LayoutNodeWrapper$invoke$1.invoke(LayoutNodeWrapper.kt:266)
        at androidx.compose.runtime.snapshots.Snapshot$Companion.observe(Snapshot.kt:1798)
        at androidx.compose.runtime.snapshots.SnapshotStateObserver.observeReads(SnapshotStateObserver.kt:121)
        at androidx.compose.ui.node.OwnerSnapshotObserver.observeReads$ui_release(OwnerSnapshotObserver.kt:88)
        at androidx.compose.ui.node.LayoutNodeWrapper.invoke(LayoutNodeWrapper.kt:266)
        at androidx.compose.ui.node.LayoutNodeWrapper.invoke(LayoutNodeWrapper.kt:59)
2022-05-15 12:12:08.399 11735-11735/com.example.composeblur E/AndroidRuntime:     at androidx.compose.ui.platform.RenderNodeApi29.record(RenderNodeApi29.android.kt:168)
        at androidx.compose.ui.platform.RenderNodeLayer.updateDisplayList(RenderNodeLayer.android.kt:245)
        at androidx.compose.ui.platform.RenderNodeLayer.drawLayer(RenderNodeLayer.android.kt:226)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:250)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:828)
        at androidx.compose.ui.node.InnerPlaceable.performDraw(InnerPlaceable.kt:137)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.DelegatingLayoutNodeWrapper.performDraw(DelegatingLayoutNodeWrapper.kt:69)
        at androidx.compose.ui.node.LayoutNodeWrapper.draw(LayoutNodeWrapper.kt:255)
        at androidx.compose.ui.node.LayoutNode.draw$ui_release(LayoutNode.kt:828)
        at androidx.compose.ui.platform.AndroidComposeView.dispatchDraw(AndroidComposeView.android.kt:755)
        at android.view.View.draw(View.java:22353)
        at android.view.View.updateDisplayListIfDirty(View.java:21226)
        at android.view.View.draw(View.java:22081)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.updateDisplayListIfDirty(View.java:21217)
        at android.view.View.draw(View.java:22081)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.updateDisplayListIfDirty(View.java:21217)
        at android.view.View.draw(View.java:22081)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.updateDisplayListIfDirty(View.java:21217)
        at android.view.View.draw(View.java:22081)
        at android.view.ViewGroup.drawChild(ViewGroup.java:4516)
        at android.view.ViewGroup.dispatchDraw(ViewGroup.java:4277)
        at android.view.View.draw(View.java:22353)
        at com.android.internal.policy.DecorView.draw(DecorView.java:806)
        at android.view.View.updateDisplayListIfDirty(View.java:21226)
        at android.view.ThreadedRenderer.updateViewTreeDisplayList(ThreadedRenderer.java:559)
        at android.view.ThreadedRenderer.updateRootDisplayList(ThreadedRenderer.java:565)
        at android.view.ThreadedRenderer.draw(ThreadedRenderer.java:642)
        at android.view.ViewRootImpl.draw(ViewRootImpl.java:4101)
        at android.view.ViewRootImpl.performDraw(ViewRootImpl.java:3828)
        at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:3099)
        at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:1952)
        at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:8171)
        at android.view.Choreographer$CallbackRecord.run(Choreographer.java:972)
        at android.view.Choreographer.doCallbacks(Choreographer.java:796)
        at android.view.Choreographer.doFrame(Choreographer.java:731)
        at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:957)
        at android.os.Handler.handleCallback(Handler.java:938)
        at android.os.Handler.dispatchMessage(Handler.java:99)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)

Comments

js...@google.com <js...@google.com> May 23, 2022 01:44PM

Assigned to jr...@google.com.

jr...@google.com <jr...@google.com> Jun 29, 2022 07:04PM

Reassigned to nj...@google.com.

nj...@google.com <nj...@google.com> #2Jun 29, 2022 07:07PM

Status: Won't Fix (Not Reproducible)

Luke - am I right in thinking this already fixed in AGP at head?

nj...@google.com <nj...@google.com> #3Jun 29, 2022 07:29PM

Status: Won't Fix (Infeasible)

Yes, all Android resource inputs can now only use relative path sensitivity, apart from custom resource directories located outside the project when data binding is enabled. The mentioned inputs in the stacktrace such as resourcesComputer.resources.fastdev.sourceDirectoriesAbsolute have been removed at head.

dm...@gmail.com <dm...@gmail.com> #4Jun 29, 2022 08:26PM

Is "head" == AGP 7.3.1? or 7.3.0?
Could you please look at git history to see which version the fix is in?

nj...@google.com <nj...@google.com> #5Jun 29, 2022 08:32PM

This change will be present in AGP 8.0.0-alpha01, since this changed happened very recently.

dm...@gmail.com <dm...@gmail.com> #6Jun 29, 2022 09:24PM

any chance it could be cherrypicked to 7.3.1 or 7.4? Would be nice to see better remote cache hit rates.

nj...@google.com <nj...@google.com> #7Jun 30, 2022 06:15PM

It looks like in comment #1 this was tested on an older version of jetpack compose. We have added some changes to have some fallbacks for software rendering use cases but would ignore a number of graphics APIs that do not have equivalents in software backed rendering pipelines.

That being said the sample code is incorrect in that the it creates a separate Canvas from a bitmap which is software backed and attempts to draw a View + RenderNodes into it which is not supported for a software backed Canvas:

https://android.googlesource.com/platform/frameworks/base/+/refs/heads/master/graphics/java/android/graphics/Canvas.java#2317

dm...@gmail.com <dm...@gmail.com> #8Jul 1, 2022 09:00AM

It looks like in comment #1 this was tested on an older version of jetpack compose.

At the time of the report, it was the latest version - 1.1.1. I'd update it to 1.2.0, but compose.ui is still 1.1.1.

That being said the sample code is incorrect in that the it creates a separate Canvas from a bitmap which is software backed and attempts to draw a View + RenderNodes into it which is not supported for a software backed Canvas:

There's nothing incorrect about the sample code. It does exactly what I'd like to (creates a bitmap backed software canvas and draws the hierarchy there).

I'm aware that drawRenderNode works only with a hardware canvas, but my example doesn't call drawRenderNode and neither does ComposeView when drawing on a software canvas.

Here's the working version of a software canvas snapshot - https://github.com/Dimezis/JetpackComposeCanvasCrash/pull/1/files. So please, stop trying to convince me it's not supported :)

The core of the problem I'm trying to report is that the ComposeView incorrectly tries to go through a hardware rendering path when a software rendering is being performed during the hardware drawing traversal.

It doesn't happen when the software rendering is requested outside of onDraw or draw of ComposeView hierarchy. (Again, see the branch I linked above).

nj...@google.com <nj...@google.com> #9Jul 6, 2022 09:22PM

We recommend updating to the latest version of compose and trying again.

With the sample provided, I am unable to reproduce the error with the latest Compose sources.

Note that there have been a number of improvements to provide a best effort when rendering compose in a software rendering environment. This includes transformations (translation/rotation/scale and alpha effects) all other graphics facilities are ignored when rendering with a software backed canvas.

dm...@gmail.com <dm...@gmail.com> #10Jul 7, 2022 08:18AM

We recommend updating to the latest version of compose and trying again.

The sample still crashes on 1.2.0-rc3 and 1.3.0-alpha01. What version should I update to?

With the sample provided, I am unable to reproduce the error with the latest Compose sources.

The latest Compose sources (AndroidComposeView, RenderNodeLayer, RenderNodeApi29 from here https://android.googlesource.com/platform/frameworks/support/+/refs/heads/androidx-main/compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/ specifically) are identical to the androidx.compose.ui:ui:1.3.0-alpha01 I just updated to and it still crashes on them.

What kind of version are you testing with? Are you using master branch from the repo I linked? I'm also using API 30 emulator if that matters.

dm...@gmail.com <dm...@gmail.com> #11Apr 7, 2024 08:36AM

I've updated the sample (https://github.com/Dimezis/JetpackComposeCanvasCrash) to the latest Compose UI (1.6.5) and Compiler (1.5.11), and can still reproduce this crash.

nj...@google.com <nj...@google.com> #12Apr 8, 2024 03:02PM

We introduced a new API GraphicsLayer in Compose 1.7 alpha that can be used to draw portions of the composition hierarchy elsewhere. Similarly this API allows for creation of a bitmap with the content of the GraphicsLayer as well. This API leverages hardware accelerated rendering for all supported API levels. Attempts to render into an ImageBitmap from this API will be hardware accelerated from API 22+ and will fallback onto software rendering for API 21.

See GraphicsLayerSamples for details here: https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:compose/ui/ui-graphics/samples/src/main/java/androidx/compose/ui/graphics/samples/GraphicsLayerSamples.kt;l=306?q=GraphicsLayerSamples.kt