Fix background color covering content and bottom sheet / dialogs rendering for accessibility #1637

geoff-powell · 2024-10-15T19:47:00Z

Closes #1634. Related to #1577 and #1414.

…lity

geoff-powell · 2024-10-16T11:16:09Z

paparazzi/src/main/java/app/cash/paparazzi/internal/ComposeViewAdapter.kt

+    /**
+     * Needed as [android.view.WindowManagerImpl] uses the view root background color to set the WindowManagerImpl view's background color.
+     * If we set this as transparent, the WindowManagerImpl view will be transparent as well and correctly renders the window above content.
+     */
+    setBackgroundColor(Color.TRANSPARENT)


Change is needed due to a view ordering change in WindowManagerImpl in 14.0.11.

(line 105) https://www.diffchecker.com/fHBDkOTq/
AS diff: https://android.googlesource.com/platform/frameworks/layoutlib/+/f86a9059e4e0fbc6908c32aa88bddc640de86831%5E%21/bridge/src/android/view/WindowManagerImpl.java

The timestamp of that change is dated 2021, so I am skeptic of this being the root cause since we have been on later layoutlib versions. What am I missing?

update: I had only clicked on the AS diff per my comment above. I just viewed the diffcheck link and that makes more sense. Is it possible you posted the wrong AS diff?

yes the one I posted isn't correct but according to the cs.android.com that is the last revision with that line change.

Here's the history for WindowManagerImpl: https://cs.android.com/android/platform/superproject/main/+/main:frameworks/layoutlib/bridge/src/android/view/WindowManagerImpl.java;bpv=1

in case there is something we can learn from their changes!

BrianGardnerAtl

Nice! I noticed in the updated snapshot it seems like the whole screen is tinted pink for the "close sheet" accessibility label, and the highlights around the drag handle and text 2 seem to be missing. Either that or it's just being colored over by the close sheet highlight. Is this something we're fine with for now and can fix later or should we try to get that resolved in this PR?

geoff-powell · 2024-10-16T16:56:26Z

Nice! I noticed in the updated snapshot it seems like the whole screen is tinted pink for the "close sheet" accessibility label, and the highlights around the drag handle and text 2 seem to be missing. Either that or it's just being colored over by the close sheet highlight. Is this something we're fine with for now and can fix later or should we try to get that resolved in this PR?

Nice find!! this is most likely due to the same change of WindowManager index in the parent (boxes in overlay are rendered behind content)

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtension.kt

jrodbx · 2024-10-16T17:48:01Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtension.kt

+        // Window manager is rendered at the root of the view hierarchy, rendering it full width.
+        // We need to restrict it when taking accessibility snapshots.
+        (windowManager as WindowManagerImpl).currentRootView?.let {
+          layoutParams = FrameLayout.LayoutParams(contentView.measuredWidth, MATCH_PARENT, Gravity.START)


interesting, is this how layoutlib does it?

question: will this layout change affect subsequent non-accessibility tests, i.e., do we need to revert back to full width in some sort of shutdown?

interesting, is this how layoutlib does it?
No this is specifically to get AccessibilityRenderExtension to render as expected.

question: will this layout change affect subsequent non-accessibility tests, i.e., do we need to revert back to full width in some sort of shutdown?

Hmm, we can I guess. I hadn't thought about that. Whats the use case where this is needed?

Oh, I don't know if this is needed per se, thus the question.

I'm thinking of scenarios where you run two tests, an accessibility test and a non-accessibility test, in that order, and whether the second test may render incorrectly.

Actually, since this is mutating the currentRootView, which is presumably detached/re-attached to between tests, then this shouldn't be a problem?

Yes exactly the window manager impl view is only attached when needed. So it will be removed on window detach

jrodbx · 2024-10-16T17:49:51Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtension.kt

@@ -70,6 +81,7 @@ public class AccessibilityRenderExtension : RenderExtension {
    }
  }

+  @SuppressLint("VisibleForTests")


nit: revert

You may recall this is because we should be moving away from ViewRootForTest

jrodbx · 2024-10-16T17:52:07Z

paparazzi/src/main/java/app/cash/paparazzi/internal/ComposeViewAdapter.kt

+    /**
+     * Needed as [android.view.WindowManagerImpl] uses the view root background color to set the WindowManagerImpl view's background color.
+     * If we set this as transparent, the WindowManagerImpl view will be transparent as well and correctly renders the window above content.
+     */
+    setBackgroundColor(Color.TRANSPARENT)


The timestamp of that change is dated 2021, so I am skeptic of this being the root cause since we have been on later layoutlib versions. What am I missing?

geoff-powell · 2024-10-16T18:04:20Z

The timestamp of that change is dated 2021, so I am skeptic of this being the root cause since we have been on later layoutlib versions. What am I missing?

Unfortunately, the git history doesn't add up with the change they made. I don't see the WindowManagerImpl change in the file git history but I am looking at LL 14.0.9 WindowManagerImpl I can see at line 105 the add view passed a specific index.

geoff-powell · 2024-10-17T13:25:03Z

...c/test/projects/compose-a11y/src/test/java/app/cash/paparazzi/plugin/test/ComposeA11yTest.kt

@@ -52,7 +51,7 @@ class ComposeA11yTest {
      ) {
        Text(text = "Text 2")
      }
-      Text(text = "Text 1")
+      Text(modifier = Modifier.wrapContentSize(), text = "Text 1")


Changed to better illustrate the close scrim area

geoff-powell · 2024-10-17T21:28:40Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDrawable.kt

+import android.graphics.drawable.Drawable
+import app.cash.paparazzi.accessibility.RenderSettings.toColorInt
+
+internal class AccessibilityOverlayDrawable : Drawable() {


Ended up making this a foreground drawable instead of a view so it can be drawn overtop WindowManagerImpl

jrodbx · 2024-10-18T15:44:25Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtension.kt

-
-      val contentLayoutParams = contentView.layoutParams ?: generateLayoutParams(null)
-      addView(overlay, LinearLayout.LayoutParams(contentLayoutParams.width, contentLayoutParams.height, 1f))
+      val overlayDrawable = AccessibilityOverlayDrawable()


nit: move this down closer to the usage site

jrodbx · 2024-10-18T15:45:48Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDetailsView.kt

@@ -29,7 +29,7 @@ import app.cash.paparazzi.accessibility.RenderSettings.toColorInt
 import java.lang.Float.max

 internal class AccessibilityOverlayDetailsView(context: Context) : FrameLayout(context) {
-  private val accessibilityElements = mutableListOf<AccessibilityElement>()
+  private var accessibilityElements: Collection<AccessibilityElement> = emptySet()


Suggested change

private var accessibilityElements: Collection<AccessibilityElement> = emptySet()

private lateinit var accessibilityElements: Collection<AccessibilityElement>

avoids the alloc of an emptySet that's never used

jrodbx · 2024-10-22T17:47:21Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDrawable.kt

+  override fun setColorFilter(p0: ColorFilter) = Unit
+
+  @Deprecated("Not used", ReplaceWith("255"))
+  override fun getOpacity(): Int = 255


nit: PixelFormat.OPAQUE?

jrodbx · 2024-10-22T17:47:28Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDrawable.kt

+      canvas.drawRect(it.displayBounds, strokePaint)
+    }
+  }
+  override fun setAlpha(alpha: Int) = Unit


Suggested change

override fun setAlpha(alpha: Int) = Unit

override fun setAlpha(alpha: Int) = Unit

jrodbx · 2024-10-22T17:48:35Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDetailsView.kt

-  fun addElements(elements: Collection<AccessibilityElement>) {
-    accessibilityElements.addAll(elements)
+  fun updateElements(elements: Collection<AccessibilityElement>) {
+    accessibilityElements = elements


keep addAll and clear on each add, if you're looking to avoid leaking memory? this allows the list to remain a val.

jrodbx · 2024-10-22T17:48:43Z

paparazzi/src/main/java/app/cash/paparazzi/accessibility/AccessibilityOverlayDrawable.kt

+import android.graphics.drawable.Drawable
+import app.cash.paparazzi.accessibility.RenderSettings.toColorInt
+
+internal class AccessibilityOverlayDrawable : Drawable() {


jrodbx · 2024-10-22T17:49:42Z

...c/test/projects/compose-a11y/src/test/java/app/cash/paparazzi/plugin/test/ComposeA11yTest.kt

@@ -52,7 +51,7 @@ class ComposeA11yTest {
      ) {
        Text(text = "Text 2")
      }
-      Text(text = "Text 1")
+      Text(modifier = Modifier.wrapContentSize(), text = "Text 1")


jrodbx · 2024-10-22T17:54:18Z

paparazzi/src/main/java/app/cash/paparazzi/internal/ComposeViewAdapter.kt

+    /**
+     * Needed as [android.view.WindowManagerImpl] uses the view root background color to set the WindowManagerImpl view's background color.
+     * If we set this as transparent, the WindowManagerImpl view will be transparent as well and correctly renders the window above content.
+     */
+    setBackgroundColor(Color.TRANSPARENT)


Here's the history for WindowManagerImpl: https://cs.android.com/android/platform/superproject/main/+/main:frameworks/layoutlib/bridge/src/android/view/WindowManagerImpl.java;bpv=1

in case there is something we can learn from their changes!

jrodbx · 2024-10-22T17:55:26Z

...napshots/images/app.cash.paparazzi.plugin.test_ComposeA11yTest_modalBottomSheetMaterial3.png

is it expected that the text centering is now different in the background view?

Ya I moved that to better capture the text bounds and the close tap area of the dialog. Before they were overlapping completely

Fix background color covering content for accessibility

f54d9be

geoff-powell requested a review from jrodbx October 15, 2024 19:47

geoff-powell changed the title ~~Fix background color covering content for accessibility~~ Fix background color covering content and bottom sheet / dialogs rendering for accessibility Oct 16, 2024

geoff-powell force-pushed the gpowell/windowmanager-temp-fix branch from 2421d19 to aadaed0 Compare October 16, 2024 10:59

Force window manager to render correctly inside content for accessibi…

acca5a7

…lity

geoff-powell force-pushed the gpowell/windowmanager-temp-fix branch from aadaed0 to acca5a7 Compare October 16, 2024 11:07

geoff-powell requested review from nak5ive, BrianGardnerAtl and gamepro65 October 16, 2024 11:08

geoff-powell commented Oct 16, 2024

View reviewed changes

BrianGardnerAtl reviewed Oct 16, 2024

View reviewed changes

jrodbx reviewed Oct 16, 2024

View reviewed changes

Cleanup

7c689fc

geoff-powell force-pushed the gpowell/windowmanager-temp-fix branch from c7575df to e6a146c Compare October 16, 2024 19:21

geoff-powell commented Oct 17, 2024

View reviewed changes

jrodbx reviewed Oct 22, 2024

View reviewed changes

More cleanup

fd0704e

geoff-powell force-pushed the gpowell/windowmanager-temp-fix branch from e6a146c to fd0704e Compare October 22, 2024 18:51

jrodbx approved these changes Oct 22, 2024

View reviewed changes

geoff-powell merged commit e413b85 into master Oct 23, 2024
14 checks passed

geoff-powell deleted the gpowell/windowmanager-temp-fix branch October 23, 2024 11:11

geoff-powell added this to the 1.3.5 milestone Oct 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix background color covering content and bottom sheet / dialogs rendering for accessibility #1637

Fix background color covering content and bottom sheet / dialogs rendering for accessibility #1637

geoff-powell commented Oct 15, 2024 •

edited by jrodbx

Loading

geoff-powell Oct 16, 2024

jrodbx Oct 16, 2024

jrodbx Oct 16, 2024

geoff-powell Oct 16, 2024

jrodbx Oct 22, 2024

BrianGardnerAtl left a comment

geoff-powell commented Oct 16, 2024

jrodbx Oct 16, 2024

jrodbx Oct 16, 2024

geoff-powell Oct 16, 2024

jrodbx Oct 16, 2024

geoff-powell Oct 16, 2024

jrodbx Oct 16, 2024

jrodbx Oct 16, 2024

geoff-powell commented Oct 16, 2024

geoff-powell Oct 17, 2024

jrodbx Oct 22, 2024

geoff-powell Oct 17, 2024

jrodbx Oct 22, 2024

jrodbx Oct 18, 2024

jrodbx Oct 18, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

jrodbx Oct 22, 2024

geoff-powell Oct 22, 2024

	private var accessibilityElements: Collection<AccessibilityElement> = emptySet()
	private lateinit var accessibilityElements: Collection<AccessibilityElement>

	override fun setAlpha(alpha: Int) = Unit

	override fun setAlpha(alpha: Int) = Unit

Fix background color covering content and bottom sheet / dialogs rendering for accessibility #1637

Fix background color covering content and bottom sheet / dialogs rendering for accessibility #1637

Conversation

geoff-powell commented Oct 15, 2024 • edited by jrodbx Loading

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

BrianGardnerAtl left a comment

Choose a reason for hiding this comment

geoff-powell commented Oct 16, 2024

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

geoff-powell commented Oct 16, 2024

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

geoff-powell commented Oct 15, 2024 •

edited by jrodbx

Loading