Add spannables into view hierarchy dump

Summary:
### Context

I wanted to write an E2E test for the SEV S499191

I noticed this is not possible as spannable aren't exposed to Jest E2E
{F1977521046}

While looking around, I found it's been done earlier this month on WA
https://fb.workplace.com/groups/watai.fyi/permalink/2107714926342676/
In diffs D70791455 / D71190837

### This diff

Implement something similar to expose Spannables in view dump, so Jest E2E can leverage it

Reviewed By: zielinskimz

Differential Revision: D73817242

fbshipit-source-id: 6b4431b0369c812b159dc2a4448eb7376eed1032

Author: David Bertet

litho-core/src/main/java/com/facebook/litho/DebugComponentDescriptionHelper.kt

@@ -18,6 +18,7 @@ package com.facebook.litho
 
 import android.view.View
 import com.facebook.litho.DebugComponentDescriptionHelper.ExtraDescription
+import com.facebook.litho.LithoRenderUnit.Companion.getRenderUnit
 import com.facebook.litho.annotations.Prop
 import com.facebook.litho.annotations.ResType
 import java.lang.Exception
@@ -66,6 +67,22 @@ object DebugComponentDescriptionHelper {
     addViewDescription(debugComponent, sb, leftOffset, topOffset, embedded, withProps, null)
   }
 
+  private fun writeViewFlags(
+      sb: StringBuilder,
+      layout: DebugLayoutNode?,
+      lithoView: BaseMountingView?
+  ) {
+    sb.append(" ")
+    sb.append(if (lithoView != null && lithoView.visibility == View.VISIBLE) "V" else ".")
+    sb.append(if (layout != null && layout.focusable) "F" else ".")
+    sb.append(if (lithoView != null && lithoView.isEnabled) "E" else ".")
+    sb.append(".")
+    sb.append(if (lithoView != null && lithoView.isHorizontalScrollBarEnabled) "H" else ".")
+    sb.append(if (lithoView != null && lithoView.isVerticalScrollBarEnabled) "V" else ".")
+    sb.append(if (layout?.clickHandler != null) "C" else ".")
+    sb.append(". ..")
+  }
+
   /**
    * Appends a compact description of a [DebugComponent] for debugging purposes.
    *
@@ -100,17 +117,10 @@ object DebugComponentDescriptionHelper {
     sb.append(debugComponent.component.simpleName)
     sb.append('{')
     sb.append(Integer.toHexString(debugComponent.hashCode()))
-    sb.append(' ')
     val lithoView = debugComponent.lithoView
     val layout = debugComponent.layoutNode
-    sb.append(if (lithoView != null && lithoView.visibility == View.VISIBLE) "V" else ".")
-    sb.append(if (layout != null && layout.focusable) "F" else ".")
-    sb.append(if (lithoView != null && lithoView.isEnabled) "E" else ".")
-    sb.append(".")
-    sb.append(if (lithoView != null && lithoView.isHorizontalScrollBarEnabled) "H" else ".")
-    sb.append(if (lithoView != null && lithoView.isVerticalScrollBarEnabled) "V" else ".")
-    sb.append(if (layout?.clickHandler != null) "C" else ".")
-    sb.append(". .. ")
+    writeViewFlags(sb, layout, lithoView)
+    sb.append(' ')
     // using position relative to litho view host to handle relative position issues
     // the offset is for the parent component to create proper relative coordinates
     val bounds = debugComponent.boundsInLithoView
@@ -139,6 +149,41 @@ object DebugComponentDescriptionHelper {
     sb.append('}')
   }
 
+  fun getSyntheticViewDescriptions(debugComponent: DebugComponent): List<String> {
+    val lithoView = debugComponent.lithoView ?: return emptyList()
+    val result = mutableListOf<String>()
+    val mountDelegateTarget = lithoView.mountDelegateTarget
+    for (i in 0 until mountDelegateTarget.getMountItemCount()) {
+      val mountItem = mountDelegateTarget.getMountItemAt(i)
+      val mountItemComponent = mountItem?.let { getRenderUnit(it).component }
+      if (mountItemComponent?.id == debugComponent.component.id) {
+        val content = mountItem.content
+        if (content is TextContent) {
+          for (item in content.items) {
+            for (spannable in item.spannables) {
+              result.add(
+                  buildString {
+                    append(spannable.className)
+                    append("{")
+                    append(spannable.hash)
+                    writeViewFlags(this, debugComponent.layoutNode, lithoView)
+                    val spanBounds = spannable.bounds
+                    append(
+                        " ${spanBounds.left},${spanBounds.top}-${spanBounds.right},${spanBounds.bottom}")
+                    append(" text=\"")
+                    append(spannable.text)
+                    append("\"")
+                    append(" synthetic=\"true\"")
+                    append("}")
+                  })
+            }
+          }
+        }
+      }
+    }
+    return result
+  }
+
   private fun addExtraProps(node: Any, sb: StringBuilder) {
     val props = getExtraProps(node)
     if (props.length() > 0) {

litho-core/src/main/java/com/facebook/litho/LithoViewTestHelper.kt

@@ -161,6 +161,15 @@ object LithoViewTestHelper {
     DebugComponentDescriptionHelper.addViewDescription(
         component, sb, leftOffset, topOffset, embedded, withProps, extraDescription)
     sb.append("\n")
+
+    val spannedTextContent = DebugComponentDescriptionHelper.getSyntheticViewDescriptions(component)
+    // for each line of text, we need to add an extra indent
+    spannedTextContent.forEach { line ->
+      writeIndentByDepth(sb, depth + 1)
+      sb.append(line)
+      sb.append("\n")
+    }
+
     val bounds = component.boundsInLithoView
     for (child in component.childComponents) {
       viewToString(

litho-core/src/main/java/com/facebook/litho/TextContent.kt

@@ -16,6 +16,7 @@
 
 package com.facebook.litho
 
+import android.graphics.Rect
 import android.graphics.Typeface
 import com.facebook.proguard.annotations.DoNotStrip
 
@@ -52,5 +53,17 @@ interface TextContent {
     val color: Int
 
     val linesCount: Int
+
+    val spannables: List<SpannableItem>
+  }
+
+  interface SpannableItem {
+    val className: String
+
+    val hash: String
+
+    val text: String
+
+    val bounds: Rect
   }
 }

litho-widget/src/main/java/com/facebook/litho/widget/TextDrawable.java

@@ -51,6 +51,7 @@
 import com.facebook.litho.Touchable;
 import com.facebook.litho.config.ComponentsConfiguration;
 import com.facebook.litho.utils.VersionedAndroidApis;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import javax.annotation.Nullable;
@@ -941,6 +942,83 @@ public float getFontLineHeight() {
             public int getLinesCount() {
               return linesCount;
             }
+
+            @Override
+            public List<TextContent.SpannableItem> getSpannables() {
+              List<TextContent.SpannableItem> result = new ArrayList<>();
+              if (text instanceof Spanned) {
+                final Spanned spanned = (Spanned) text;
+                final Object[] spans = spanned.getSpans(0, text.length(), Object.class);
+                for (final Object span : spans) {
+                  final int start = spanned.getSpanStart(span);
+                  final int end = spanned.getSpanEnd(span);
+                  if (start != -1 && end != -1 && start != end) {
+                    result.add(
+                        new TextContent.SpannableItem() {
+                          @Override
+                          public String getClassName() {
+                            return span.getClass().getName();
+                          }
+
+                          @Override
+                          public String getHash() {
+                            return Integer.toHexString(span.hashCode());
+                          }
+
+                          @Override
+                          public String getText() {
+                            return text.subSequence(start, end).toString();
+                          }
+
+                          @Override
+                          public Rect getBounds() {
+                            if (mLayout == null) {
+                              return new Rect(0, 0, 0, 0);
+                            }
+                            try {
+                              final int startLine = mLayout.getLineForOffset(start);
+                              final int endLine = mLayout.getLineForOffset(end);
+
+                              final int startX = (int) mLayout.getPrimaryHorizontal(start);
+                              final int startY = mLayout.getLineTop(startLine);
+
+                              final int endX;
+                              final int endY;
+                              if (startLine == endLine) {
+                                // Spannable fits into a single line, using regular bounds
+                                endX = (int) mLayout.getPrimaryHorizontal(end);
+                                endY = mLayout.getLineBottom(endLine);
+                              } else {
+                                // Spannable does not fit into a single line and it may have a
+                                // non-rectangular shape.
+                                // Using bounds of the spannable object from the starting line to
+                                // guarantee that all
+                                // the coordinates within these bounds belong to the spannable
+                                endX =
+                                    (int)
+                                        mLayout.getPrimaryHorizontal(
+                                            mLayout.getLineEnd(startLine) - 1);
+                                endY = mLayout.getLineBottom(startLine);
+                              }
+
+                              final int absoluteStartX = startX;
+                              final int absoluteStartY = startY;
+                              final int absoluteEndX = endX;
+                              final int absoluteEndY = endY;
+
+                              return new Rect(
+                                  absoluteStartX, absoluteStartY, absoluteEndX, absoluteEndY);
+
+                            } catch (IndexOutOfBoundsException e) {
+                              return new Rect(0, 0, 0, 0);
+                            }
+                          }
+                        });
+                  }
+                }
+              }
+              return result;
+            }
           };
     }