Allow any type of ScannableView

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

@@ -338,7 +338,6 @@ class ComposeUiTest {
     @Suppress("RemoveCurlyBracesFromTemplate")
     assertThat(hierarchy).contains(
       """
-        Box:
       $BLANK ${BLANK}Box { test-tag:"root" }
       $BLANK ${BLANK}├─Box
       $BLANK ${BLANK}├─Column
@@ -393,7 +392,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─Dialog
       |${BLANK}  ╰─CompositionLocalProvider { DIALOG }
@@ -422,7 +420,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─CustomTestDialog
       |${BLANK}  ╰─CompositionLocalProvider { DIALOG }
@@ -447,7 +444,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─SingleSubcompositionLayout { test-tag:"subcompose-layout" }
       |${BLANK}  ╰─<subcomposition of SingleSubcompositionLayout>
@@ -473,7 +469,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─SingleSubcompositionLayout { test-tag:"subcompose-layout" }
       |${BLANK}  ╰─<subcomposition of SingleSubcompositionLayout>
@@ -505,7 +500,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─MultipleSubcompositionLayout { test-tag:"subcompose-layout" }
       |${BLANK}  ├─<subcomposition of MultipleSubcompositionLayout>
@@ -537,7 +531,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}├─SingleSubcompositionLayout { test-tag:"subcompose-layout1" }
       |${BLANK}│ ╰─<subcomposition of SingleSubcompositionLayout>
@@ -565,7 +558,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─BoxWithConstraints { test-tag:"with-constraints" }
       |${BLANK}  ╰─<subcomposition of BoxWithConstraints>
@@ -595,7 +587,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { test-tag:"parent" }
       |${BLANK}╰─LazyColumn { test-tag:"list" }
       |${BLANK}  ├─<subcomposition of LazyColumn>
@@ -646,7 +637,6 @@ class ComposeUiTest {
 
     assertThat(hierarchy).isEqualTo(
       """
-      |CompositionLocalProvider:
       |${BLANK}CompositionLocalProvider { 10×30px, test-tag:"parent" }
       |${BLANK}╰─MultipleSubcompositionLayout { 10×30px, test-tag:"subcompose-layout" }
       |${BLANK}  ├─<subcomposition of MultipleSubcompositionLayout>

radiography/api/radiography.api

@@ -29,7 +29,7 @@ public final class radiography/ScanScopes {
 	public static final fun singleViewScope (Landroid/view/View;)Lradiography/ScanScope;
 }
 
-public abstract class radiography/ScannableView {
+public abstract interface class radiography/ScannableView {
 	public abstract fun getChildren ()Lkotlin/sequences/Sequence;
 	public abstract fun getDisplayName ()Ljava/lang/String;
 }

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

@@ -1,9 +1,5 @@
 package radiography
 
-import android.os.Handler
-import android.os.Looper
-import android.view.View
-import android.view.WindowManager
 import androidx.annotation.VisibleForTesting
 import radiography.Radiography.scan
 import radiography.ScanScopes.AllWindowsScope
@@ -15,17 +11,15 @@ import java.util.concurrent.TimeUnit.SECONDS
 
 /**
  * Utility class to scan through a view hierarchy and pretty print it to a [String].
- * Call [scan] or [View.scan].
+ * Call [scan] or [android.view.View.scan].
  */
 public object Radiography {
 
   /**
    * Scans the view hierarchies and pretty print them to a [String].
    *
    * You should generally call this method from the main thread, as views are meant to be accessed
-   * from a single thread. If you call this from a background thread, this will schedule a message
-   * to the main thread to retrieve the view hierarchy from there and will wait up to 5 seconds
-   * or return an error message. This method will never throw, any thrown exception will have
+   * from a single thread. This method will never throw, any thrown exception will have
    * its message included in the returned string.
    *
    * @param scanScope the [ScanScope] that determines what to scan. [AllWindowsScope] by default.
@@ -52,27 +46,11 @@ public object Radiography {
     }
 
     roots.forEach { scanRoot ->
-      // The entire view tree is single threaded, and that's typically the main thread, but
-      // it doesn't have to be, and we don't know where the passed in view is coming from.
-      val viewLooper = (scanRoot as? AndroidView)?.view?.handler?.looper
-        ?: Looper.getMainLooper()!!
-
-      if (viewLooper.thread == Thread.currentThread()) {
-        scanFromLooperThread(scanRoot, viewStateRenderers, viewFilter)
-      } else {
-        val latch = CountDownLatch(1)
-        Handler(viewLooper).post {
-          scanFromLooperThread(scanRoot, viewStateRenderers, viewFilter)
-          latch.countDown()
-        }
-        if (!latch.await(5, SECONDS)) {
-          return "Could not retrieve view hierarchy from main thread after 5 seconds wait"
-        }
-      }
+      scanSingleRoot(scanRoot, viewStateRenderers, viewFilter)
     }
   }
 
-  private fun StringBuilder.scanFromLooperThread(
+  private fun StringBuilder.scanSingleRoot(
     rootView: ScannableView,
     viewStateRenderers: List<ViewStateRenderer>,
     viewFilter: ViewFilter
@@ -83,17 +61,8 @@ public object Radiography {
       appendLine()
     }
 
-    val androidView = (rootView as? AndroidView)?.view
-    val layoutParams = androidView?.layoutParams
-    val title = (layoutParams as? WindowManager.LayoutParams)?.title?.toString()
-      ?: rootView.displayName
-    appendLine("$title:")
-
     val startPosition = length
     try {
-      androidView?.let {
-        appendLine("window-focus:${it.hasWindowFocus()}")
-      }
       renderScannableViewTree(this, rootView, viewStateRenderers, viewFilter)
     } catch (e: Throwable) {
       insert(

radiography/src/main/java/radiography/ScannableView.kt

@@ -2,6 +2,7 @@ package radiography
 
 import android.view.View
 import android.view.ViewGroup
+import android.view.WindowManager
 import androidx.compose.ui.Modifier
 import radiography.ScannableView.AndroidView
 import radiography.ScannableView.ComposeView
@@ -18,16 +19,24 @@ import radiography.internal.mightBeComposeView
  * Can either be an actual Android [View] ([AndroidView]) or a grouping of Composables that roughly
  * represents the concept of a logical "view" ([ComposeView]).
  */
-public sealed class ScannableView {
+public interface ScannableView {
 
   /** The string that be used to identify the type of the view in the rendered output. */
-  public abstract val displayName: String
+  public val displayName: String
 
   /** The children of this view. */
-  public abstract val children: Sequence<ScannableView>
+  public val children: Sequence<ScannableView>
 
-  public class AndroidView(public val view: View) : ScannableView() {
-    override val displayName: String get() = view::class.java.simpleName
+  public class AndroidView(public val view: View) : ScannableView {
+    override val displayName: String get() {
+      val classSimpleName = view::class.java.simpleName
+      val windowTitle = (view.layoutParams as? WindowManager.LayoutParams)?.title?.toString()
+      if (windowTitle != null) {
+        return "$classSimpleName in $windowTitle window-focus:${view.hasWindowFocus()}"
+      } else {
+        return classSimpleName
+      }
+    }
     override val children: Sequence<ScannableView> = view.scannableChildren()
 
     override fun toString(): String = "${AndroidView::class.java.simpleName}($displayName)"
@@ -45,7 +54,7 @@ public sealed class ScannableView {
     public val height: Int,
     public val modifiers: List<Modifier>,
     override val children: Sequence<ScannableView>
-  ) : ScannableView() {
+  ) : ScannableView {
     override fun toString(): String = "${ComposeView::class.java.simpleName}($displayName)"
   }
 
@@ -57,7 +66,7 @@ public sealed class ScannableView {
    * return the error message along with any portion of the tree that was rendered before the
    * exception was thrown.
    */
-  public class ChildRenderingError(private val message: String) : ScannableView() {
+  public class ChildRenderingError(private val message: String) : ScannableView {
     override val displayName: String get() = message
     override val children: Sequence<ScannableView> get() = emptySequence()
   }

radiography/src/test/java/radiography/RadiographyTest.kt

@@ -208,6 +208,34 @@ internal class RadiographyTest {
     assertThat(builder.toString()).isEqualTo("${BLANK}View\n")
   }
 
+  @Test fun `custom ScannableView details reported`() {
+    class Node(override val displayName: String) : ScannableView {
+      val mutableChildren = mutableListOf<Node>()
+
+      override val children: Sequence<ScannableView>
+        get() = mutableChildren.asSequence()
+    }
+
+    val root = Node("Root").apply {
+      mutableChildren += Node("Child A")
+      mutableChildren += Node("Child B")
+    }
+
+    val prettyHierarchy = Radiography.scan(
+      scanScope = ScanScope {
+        listOf(root)
+      }
+    )
+    assertThat(prettyHierarchy).isEqualTo(
+      """
+      |${BLANK}Root
+      |${BLANK}├─Child A
+      |${BLANK}╰─Child B
+      |
+      """.trimMargin()
+    )
+  }
+
   companion object {
     private const val BLANK = '\u00a0'
   }