GraphicsLayer.buildLayer name is misleading. Rename it to update and don't return anything [330758155]

Fixed

Bug

Status Update

No update yet.

Description

lo...@gmail.com

created issue #1

Mar 21, 2024 10:41PM

Jetpack Compose version: 1.7.0-alpha05

Jetpack Compose component(s) used: ui-graphics

Hello!

I've tried the new GraphicsLayer API. It's nice!

There's one confusing part: the buildLayer function that takes a GraphicsLayer and returns the very same GraphicsLayer instance.

I initially called rememberGraphicsLayer() once, and tried to build multiple layers with it, which led to weird results, and it took me a while to realize that it was because each buildLayer call was actually mutating/overwriting the layer I had created with rememberGraphicsLayer().

The naming of the function led me to believe that a new layer would be returned, which wasn't the case.

If the behavior is here to stay, I think another name is necessary, to properly communicate the fact that it's touching the layer it's called on.

To avoid this misunderstanding that easily leads to sneakily unwanted behavior (aka. bugs), I suggest a different name is used.

My vote is for update, without returning the GraphicsLayer object.

The name update is already used inside Compose, it's the name of the parameter of the AndroidView composable function that updates stuff inside the View, which, just like GraphicsLayer, will keep state mutations.

I hope it helps!

Have a great day,

Louis CAD

Comments

an...@google.com <an...@google.com> Mar 22, 2024 10:03AM

Assigned to nj...@google.com.

lo...@gmail.com <lo...@gmail.com> #2Mar 29, 2024 04:35PM

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

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

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

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

nj...@google.com <nj...@google.com> #3Mar 29, 2024 05:21PM

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

lo...@gmail.com <lo...@gmail.com> #4Mar 29, 2024 05:42PM

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

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

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

ap...@google.com <ap...@google.com> #5Mar 29, 2024 07:58PM

Marked as fixed.

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

commit 6bb3dd89bf83fc4d6f2825effb2f0fc613c94774
Author: Nader Jawad <njawad@google.com>
Date: Wed Mar 27 18:43:56 2024

Update GraphicsLayer API based on Compose Design
Review feedback

Relnote: "Rename GraphicsLayer#buildLayer to
record to mirror the begin/endRecording methods of
Displaylist backed APIs like RenderNode and Picture.

Updated rememberGraphicsLayer to leverage rememberObserver."

Bug: 288494724
Fixes: 330758155
Test: re-ran compose tests
Change-Id: I312c1120358d04fccfe8a646001a883017fb0fb3

M compose/ui/ui-graphics/api/current.txt
M compose/ui/ui-graphics/api/restricted_current.txt
M compose/ui/ui-graphics/samples/src/main/java/androidx/compose/ui/graphics/samples/GraphicsLayerSamples.kt
M compose/ui/ui-graphics/src/androidInstrumentedTest/kotlin/androidx/compose/ui/graphics/layer/AndroidGraphicsLayerTest.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/AndroidGraphicsContext.android.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/layer/AndroidGraphicsLayer.android.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/layer/GraphicsLayerV23.android.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/layer/GraphicsLayerV29.android.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/layer/GraphicsViewLayer.android.kt
M compose/ui/ui-graphics/src/androidMain/kotlin/androidx/compose/ui/graphics/layer/LayerSnapshot.android.kt
M compose/ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/drawscope/DrawScope.kt
M compose/ui/ui-graphics/src/commonMain/kotlin/androidx/compose/ui/graphics/layer/GraphicsLayer.kt
M compose/ui/ui-graphics/src/desktopMain/kotlin/androidx/compose/ui/graphics/layer/GraphicsLayer.desktop.kt
M compose/ui/ui-graphics/src/desktopTest/kotlin/androidx/compose/ui/graphics/layer/DesktopGraphicsLayerTest.kt
M compose/ui/ui/api/current.txt
M compose/ui/ui/api/restricted_current.txt
M compose/ui/ui/src/androidInstrumentedTest/kotlin/androidx/compose/ui/draw/DrawModifierTest.kt
M compose/ui/ui/src/androidInstrumentedTest/kotlin/androidx/compose/ui/draw/DrawingPrebuiltGraphicsLayerTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/GraphicsLayerOwnerLayer.android.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/DrawModifier.kt
M compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/graphics/GraphicsLayerScope.kt
M compose/ui/ui/src/desktopTest/kotlin/androidx/compose/ui/draw/DesktopDrawingPrebuiltGraphicsLayerTest.kt

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

lo...@gmail.com <lo...@gmail.com> #6Mar 29, 2024 09:49PM

Thank you for fixing this!

lo...@gmail.com <lo...@gmail.com> #7Apr 15, 2024 06:11PM

Seems like it missed 1.7.0-alpha06 released on the 3rd April.

Will it be in 1.7.0-alpha07 next Wednesday the 17th?

lo...@gmail.com <lo...@gmail.com> #8Apr 16, 2024 01:09PM

Hello!

~~⚠️ ⚠️ ⚠️ I noticed that the same confusing method signature (name and return type) is used in the CacheDrawScope class in the DrawModifier.kt file.~~

~~Can you address it as well?~~

Just noticed it is fixed on https://cs.android.com too (and it was also mentioned in the gerrit summary here… 😅).

Thanks for doing that!

Message last modified on Apr 16, 2024 01:11PM

na...@google.com <na...@google.com> #9Apr 17, 2024 05:17PM

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

androidx.compose.ui:ui:1.7.0-alpha07
androidx.compose.ui:ui-android:1.7.0-alpha07
androidx.compose.ui:ui-desktop:1.7.0-alpha07
androidx.compose.ui:ui-graphics:1.7.0-alpha07
androidx.compose.ui:ui-graphics-android:1.7.0-alpha07
androidx.compose.ui:ui-graphics-desktop:1.7.0-alpha07