Handle deprecated InvisibleToUser semantics property.

Author: zach-klippenstein

compose-tests/src/androidTest/java/radiography/test/compose/ComposeUiTest.kt

@@ -27,6 +27,7 @@ import androidx.compose.ui.semantics.SemanticsProperties.ContentDescription
 import androidx.compose.ui.semantics.SemanticsProperties.Disabled
 import androidx.compose.ui.semantics.SemanticsProperties.Focused
 import androidx.compose.ui.semantics.SemanticsProperties.Heading
+import androidx.compose.ui.semantics.SemanticsProperties.HideFromAccessibility
 import androidx.compose.ui.semantics.SemanticsProperties.HorizontalScrollAxisRange
 import androidx.compose.ui.semantics.SemanticsProperties.ImeAction
 import androidx.compose.ui.semantics.SemanticsProperties.InvisibleToUser
@@ -131,14 +132,13 @@ class ComposeUiTest {
       Box(Modifier.semantics { set(Disabled, Unit) })
       Box(Modifier.semantics { set(Focused, true) })
       Box(Modifier.semantics { set(Focused, false) })
-      Box(Modifier.semantics { set(InvisibleToUser, Unit) })
+      Box(Modifier.semantics { set(HideFromAccessibility, Unit) })
       Box(Modifier.semantics { set(IsDialog, Unit) })
       Box(Modifier.semantics { set(IsPopup, Unit) })
       Box(Modifier.semantics { set(ProgressBarRangeInfo, ProgressBarRangeInfo(.2f, 0f..0.5f)) })
       Box(Modifier.semantics { set(PaneTitle, "pane title") })
       Box(Modifier.semantics { set(SelectableGroup, Unit) })
       Box(Modifier.semantics { set(Heading, Unit) })
-      Box(Modifier.semantics { set(InvisibleToUser, Unit) })
       Box(Modifier.semantics {
         set(
           HorizontalScrollAxisRange,
@@ -186,6 +186,24 @@ class ComposeUiTest {
     assertThat(hierarchy).contains("Box { PASSWORD }")
   }
 
+  /**
+   * Copy of [semanticsAreReported] but for deprecated properties that are reported with the same
+   * tags as their replacements.
+   */
+  @Suppress("DEPRECATION")
+  @OptIn(ExperimentalComposeUiApi::class)
+  @Test fun deprecatedSemanticsAreReported() {
+    composeRule.setContentWithExplicitRoot {
+      Box(Modifier.semantics { set(InvisibleToUser, Unit) })
+    }
+
+    val hierarchy = composeRule.runOnIdle {
+      Radiography.scan()
+    }
+
+    assertThat(hierarchy).contains("Box { INVISIBLE-TO-USER }")
+  }
+
   @Test fun checkableChecked() {
     composeRule.setContentWithExplicitRoot {
       Checkbox(checked = true, onCheckedChange = {})

radiography/api/radiography.api

@@ -200,6 +200,11 @@ public final class radiography/internal/SemanticsKt {
 	public static final fun findTestTags (Lradiography/ScannableView$ComposeView;)Lkotlin/sequences/Sequence;
 }
 
+public final class radiography/internal/SemanticsPropertiesHelpers {
+	public static final field INSTANCE Lradiography/internal/SemanticsPropertiesHelpers;
+	public final fun getHideFromAccessibility ()Landroidx/compose/ui/semantics/SemanticsPropertyKey;
+}
+
 public final class radiography/internal/StringsKt {
 	public static final fun ellipsize (Ljava/lang/CharSequence;I)Ljava/lang/CharSequence;
 	public static final fun formatPixelDimensions (II)Ljava/lang/String;

radiography/src/main/java/radiography/Radiography.kt

@@ -98,7 +98,7 @@ public object Radiography {
     } catch (e: Throwable) {
       insert(
         startPosition,
-        "Exception when going through view hierarchy: ${e.message}\n"
+        "Exception when going through view hierarchy:\n" + e.stackTraceToString()
       )
     }
   }

radiography/src/main/java/radiography/ViewStateRenderers.kt

@@ -14,6 +14,7 @@ import androidx.compose.ui.semantics.SemanticsProperties.Text
 import androidx.compose.ui.semantics.getOrNull
 import radiography.ScannableView.AndroidView
 import radiography.ScannableView.ComposeView
+import radiography.internal.SemanticsPropertiesHelpers
 import radiography.internal.ellipsize
 import radiography.internal.formatPixelDimensions
 import radiography.internal.isComposeAvailable
@@ -77,6 +78,7 @@ public object ViewStateRenderers {
         .flatten()
         .sortedBy { it.key.name }
         .forEach { (key, value) ->
+          @Suppress("DEPRECATION")
           when (key) {
             SemanticsProperties.TestTag -> appendLabeledValue("test-tag", value)
             SemanticsProperties.ContentDescription -> appendLabeledValue(
@@ -95,7 +97,8 @@ public object ViewStateRenderers {
             SemanticsProperties.PaneTitle -> appendLabeledValue("pane-title", value)
             SemanticsProperties.SelectableGroup -> append("SELECTABLE-GROUP")
             SemanticsProperties.Heading -> append("HEADING")
-            SemanticsProperties.InvisibleToUser -> append("INVISIBLE-TO-USER")
+            SemanticsProperties.InvisibleToUser, // InvisibleToUser is deprecated.
+            SemanticsPropertiesHelpers.HideFromAccessibility -> append("INVISIBLE-TO-USER")
             SemanticsProperties.HorizontalScrollAxisRange ->
               appendLabeledValue(
                 "horizontal-scroll-axis-range",

radiography/src/main/java/radiography/internal/SemanticsPropertiesHelpers.kt

@@ -0,0 +1,24 @@
+package radiography.internal
+
+import androidx.compose.ui.semantics.SemanticsProperties
+import androidx.compose.ui.semantics.SemanticsPropertyKey
+
+internal object SemanticsPropertiesHelpers {
+  private var _HideFromAccessibility: Any? = UNINITIALIZED
+  val HideFromAccessibility: SemanticsPropertyKey<Unit>?
+    get() {
+      if (_HideFromAccessibility === UNINITIALIZED) {
+        _HideFromAccessibility = try {
+          SemanticsProperties.HideFromAccessibility
+        } catch (_: NoSuchMethodError) {
+          // Actual compose version is too old to have this property.
+          null
+        }
+      }
+
+      @Suppress("UNCHECKED_CAST")
+      return _HideFromAccessibility as SemanticsPropertyKey<Unit>?
+    }
+
+  private object UNINITIALIZED
+}