Spoilers: Keep non-overlapping bodyRanges separate

ts/components/conversation/MessageBody.stories.tsx

@@ -278,7 +278,19 @@ export function FormattingSpoiler(): JSX.Element {
     bodyRanges: [
       {
         start: 8,
-        length: 89,
+        length: 60,
+        style: BodyRange.Style.SPOILER,
+      },
+      // This is touching, but not overlapping; they should not reveal together
+      {
+        start: 68,
+        length: 29,
+        style: BodyRange.Style.SPOILER,
+      },
+      // Note: in overlaps, the last spoiler wins
+      {
+        start: 94,
+        length: 6,
         style: BodyRange.Style.SPOILER,
       },
       {
@@ -322,7 +334,11 @@ export function FormattingSpoiler(): JSX.Element {
       <hr />
       <MessageBody {...props} disableLinks />
       <hr />
-      <MessageBody {...props} isSpoilerExpanded={{}} />
+      <MessageBody
+        {...props}
+        onExpandSpoiler={() => null}
+        isSpoilerExpanded={{}}
+      />
       <hr />
       <MessageBody {...props} disableLinks isSpoilerExpanded={{}} />
     </>

ts/components/conversation/MessageTextRenderer.tsx

@@ -75,8 +75,22 @@ export function MessageTextRenderer({
 
     // Create range tree, dropping bodyRanges that don't apply. Read More means truncated
     //   strings.
+    let spoilerCount = 0;
     const tree = sortedRanges.reduce<ReadonlyArray<RangeNode>>(
       (acc, range) => {
+        if (
+          BodyRange.isFormatting(range) &&
+          range.style === BodyRange.Style.SPOILER
+        ) {
+          spoilerCount += 1;
+          return insertRange(
+            {
+              ...range,
+              spoilerId: spoilerCount,
+            },
+            acc
+          );
+        }
         if (range.start < textLength) {
           return insertRange(range, acc);
         }
@@ -139,7 +153,7 @@ function renderNode({
 
   if (node.isSpoiler && node.spoilerChildren?.length) {
     const isSpoilerHidden = Boolean(
-      node.isSpoiler && !isSpoilerExpanded[node.spoilerIndex || 0]
+      node.isSpoiler && !isSpoilerExpanded[node.spoilerId || 0]
     );
     const content = node.spoilerChildren?.map(spoilerNode =>
       renderNode({
@@ -193,7 +207,7 @@ function renderNode({
                   event.stopPropagation();
                   onExpandSpoiler({
                     ...isSpoilerExpanded,
-                    [node.spoilerIndex || 0]: true,
+                    [node.spoilerId || 0]: true,
                   });
                 }
               }
@@ -209,7 +223,7 @@ function renderNode({
                 event.stopPropagation();
                 onExpandSpoiler?.({
                   ...isSpoilerExpanded,
-                  [node.spoilerIndex || 0]: true,
+                  [node.spoilerId || 0]: true,
                 });
               }
         }

ts/types/BodyRange.ts

@@ -44,6 +44,7 @@ export namespace BodyRange {
   };
   export type Formatting = {
     style: Style;
+    spoilerId?: number;
   };
   export type DisplayOnly = {
     displayStyle: DisplayStyle;
@@ -356,8 +357,8 @@ export type DisplayNode = {
   // DisplayOnly
   isKeywordHighlight?: boolean;
 
-  // Only for spoilers, only to represent contiguous groupings
+  // Only for spoilers, only to make sure we honor original spoiler breakdown
-  spoilerIndex?: number;
+  spoilerId?: number;
   spoilerChildren?: ReadonlyArray<DisplayNode>;
 };
 type PartialDisplayNode = Omit<
@@ -381,7 +382,7 @@ function rangeToPartialNode(
       return { isMonospace: true };
     }
     if (range.style === BodyRange.Style.SPOILER) {
-      return { isSpoiler: true };
+      return { isSpoiler: true, spoilerId: range.spoilerId };
     }
     if (range.style === BodyRange.Style.STRIKETHROUGH) {
       return { isStrikethrough: true };
@@ -482,25 +483,29 @@ export function groupContiguousSpoilers(
   const result: Array<DisplayNode> = [];
 
   let spoilerContainer: DisplayNode | undefined;
-  let spoilerIndex = 0;
 
   nodes.forEach(node => {
     if (node.isSpoiler) {
-      if (!spoilerContainer) {
+      if (
-        spoilerContainer = {
+        spoilerContainer &&
-          ...node,
+        isNumber(spoilerContainer.spoilerId) &&
-          spoilerIndex,
+        spoilerContainer.spoilerId === node.spoilerId
-          isSpoiler: true,
+      ) {
-          spoilerChildren: [],
-        };
-        spoilerIndex += 1;
-        result.push(spoilerContainer);
-      }
-      if (spoilerContainer) {
         spoilerContainer.spoilerChildren = [
           ...(spoilerContainer.spoilerChildren || []),
           node,
         ];
+      } else {
+        spoilerContainer = undefined;
+      }
+
+      if (!spoilerContainer) {
+        spoilerContainer = {
+          ...node,
+          isSpoiler: true,
+          spoilerChildren: [node],
+        };
+        result.push(spoilerContainer);
       }
     } else {
       spoilerContainer = undefined;