Fix edge case where oldChild can become detach causing the recursive function to end early

Author: arivyiii

.changeset/new-plants-exercise.md

@@ -0,0 +1,5 @@
+---
+"rrdom": patch
+---
+
+Fix early termination of recursive loop in diffChilren when a node mismatch is found

packages/rrdom/src/diff.ts

@@ -527,7 +527,23 @@ function diffChildren(
   let oldChild = oldTree.firstChild;
   let newChild = newTree.firstChild;
   while (oldChild !== null && newChild !== null) {
+    const isMismatch = !nodeMatching(oldChild, newChild, replayer.mirror, rrnodeMirror);
+
+    // If oldChild and newChild don't match due to changes or misalignment, a new DOM node is created for newChild and inserted before oldChild.
+    if (isMismatch) {
+      const newNode = createOrGetNode(newChild, replayer.mirror, rrnodeMirror);
+    
+      // Insert the new node before the current oldChild to preserve correct order.
+      oldTree.insertBefore(newNode, oldChild);
+    
+      diff(newNode, newChild, replayer, rrnodeMirror);
+    
+      newChild = newChild.nextSibling;
+      continue;
+    }
+
     diff(oldChild, newChild, replayer, rrnodeMirror);
+
     oldChild = oldChild.nextSibling;
     newChild = newChild.nextSibling;
   }

packages/rrdom/test/diff.test.ts

@@ -12,6 +12,7 @@ import {
   Mirror as RRNodeMirror,
   RRDocument,
   RRMediaElement,
+  RRElement,
   printRRDom,
 } from '../src';
 import {
@@ -1183,6 +1184,72 @@ describe('diff algorithm for rrdom', () => {
       expect(node.childNodes[0].childNodes.length).toEqual(1);
       expect(mirror.getId(node.childNodes[0].childNodes[0])).toEqual(2);
     });
+
+    it('should maintain correct order when duplicate node is found causing nextSibling traversal desync', () => {
+        const oldList = [
+          { tagName: 'STYLE',    id: 1 },
+          { tagName: 'STYLE',    id: 2 },
+          { tagName: 'BASE',     id: 3 },
+          { tagName: 'META',     id: 4 },
+          { tagName: 'META',     id: 5 },
+          { tagName: 'META',     id: 6 },
+          { tagName: 'TITLE',    id: 7 },
+          { tagName: 'STYLE',    id: 8 },
+          { tagName: 'STYLE',    id: 9 },
+          { tagName: 'LINK',     id: 10 },
+          { tagName: 'STYLE',    id: 11 },
+          { tagName: 'LINK',     id: 12 },
+          { tagName: 'NOSCRIPT', id: 13 },
+        ];
+      
+        // Duplicate STYLE#1 at index 1
+        const newList = [...oldList];
+        newList.splice(1, 0, { tagName: 'STYLE', id: 1 });
+      
+        const mirror = createMirror();
+        const oldHead = createTree(
+          { tagName: 'head', id: 0, children: oldList },
+          undefined,
+          mirror,
+        ) as Node;
+        expect(oldHead.childNodes.length).toBe(oldList.length);
+      
+        const rrdom = new RRDocument();
+        const newHead = createTree(
+          { tagName: 'head', id: 0, children: newList },
+          rrdom
+        ) as RRNode;
+      
+        // Add test attributes to each node in newHead
+        Array.from(newHead.childNodes).forEach((node, index) => {
+          if (node instanceof RRElement) {
+            node.setAttribute('data-test-id', `${newList[index].id}`);
+            node.setAttribute('data-test-tag', node.tagName);
+          }
+        });
+      
+        const replayer: ReplayerHandler = {
+          mirror,
+          applyCanvas: () => {},
+          applyInput: () => {},
+          applyScroll: () => {},
+          applyStyleSheetMutation: () => {},
+        };
+      
+        // Run diff
+        diff(oldHead, newHead, replayer);
+      
+        // Extract final IDs from real DOM
+        const finalIds = Array.from(oldHead.childNodes)
+          .filter((n): n is Element => n.nodeType === Node.ELEMENT_NODE)
+          .map((el) => el.getAttribute('data-test-id') || el.getAttribute('id'));
+      
+        // Assert the real DOM now matches the RR DOM list
+        expect(finalIds).toEqual(oldList.map(n => String(n.id)));
+      });
+      
+      
+      
   });
 
   describe('diff shadow dom', () => {