Bug 1626015 - Implement ParentNode#ReplaceChildren. r=emilio

Differential Revision: https://phabricator.services.mozilla.com/D75891

dom/base/nsINode.cpp

@@ -2025,6 +2025,35 @@ void nsINode::Append(const Sequence<OwningNodeOrString>& aNodes,
   AppendChild(*node, aRv);
 }
 
+// https://dom.spec.whatwg.org/#dom-parentnode-replacechildren
+void nsINode::ReplaceChildren(const Sequence<OwningNodeOrString>& aNodes,
+                              ErrorResult& aRv) {
+  nsCOMPtr<Document> doc = OwnerDoc();
+  nsCOMPtr<nsINode> node = ConvertNodesOrStringsIntoNode(aNodes, doc, aRv);
+  if (aRv.Failed()) {
+    return;
+  }
+
+  EnsurePreInsertionValidity(*node, nullptr, aRv);
+  if (aRv.Failed()) {
+    return;
+  }
+
+  // Needed when used in combination with contenteditable (maybe)
+  mozAutoDocUpdate updateBatch(doc, true);
+
+  nsAutoMutationBatch mb(this, true, false);
+
+  // Replace all with node within this.
+  while (mFirstChild) {
+    RemoveChildNode(mFirstChild, true);
+  }
+  mb.RemovalDone();
+
+  AppendChild(*node, aRv);
+  mb.NodesAdded();
+}
+
 void nsINode::RemoveChildNode(nsIContent* aKid, bool aNotify) {
   // NOTE: This function must not trigger any calls to
   // Document::GetRootElement() calls until *after* it has removed aKid from

dom/base/nsINode.h

@@ -2033,6 +2033,8 @@ class nsINode : public mozilla::dom::EventTarget {
                                   ErrorResult& aRv);
   MOZ_CAN_RUN_SCRIPT void Append(const Sequence<OwningNodeOrString>& aNodes,
                                  ErrorResult& aRv);
+  MOZ_CAN_RUN_SCRIPT void ReplaceChildren(
+      const Sequence<OwningNodeOrString>& aNodes, ErrorResult& aRv);
 
   void GetBoxQuads(const BoxQuadOptions& aOptions,
                    nsTArray<RefPtr<DOMQuad>>& aResult, CallerType aCallerType,

dom/webidl/ParentNode.webidl

@@ -28,4 +28,6 @@ interface mixin ParentNode {
   void prepend((Node or DOMString)... nodes);
   [CEReactions, Throws, Unscopable]
   void append((Node or DOMString)... nodes);
+  [CEReactions, Throws, Unscopable]
+  void replaceChildren((Node or DOMString)... nodes);
 };

testing/web-platform/meta/dom/idlharness.window.js.ini

@@ -6,37 +6,3 @@
 
   [ShadowRoot interface: attribute onslotchange]
     expected: FAIL
-
-  [Element interface: element must inherit property "replaceChildren((Node or DOMString)...)" with the proper type]
-    expected: FAIL
-
-  [Document interface: calling replaceChildren((Node or DOMString)...) on xmlDoc with too few arguments must throw TypeError]
-    expected: FAIL
-
-  [Document interface: calling replaceChildren((Node or DOMString)...) on new Document() with too few arguments must throw TypeError]
-    expected: FAIL
-
-  [DocumentFragment interface: document.createDocumentFragment() must inherit property "replaceChildren((Node or DOMString)...)" with the proper type]
-    expected: FAIL
-
-  [DocumentFragment interface: operation replaceChildren((Node or DOMString)...)]
-    expected: FAIL
-
-  [Element interface: operation replaceChildren((Node or DOMString)...)]
-    expected: FAIL
-
-  [Document interface: operation replaceChildren((Node or DOMString)...)]
-    expected: FAIL
-
-  [Element interface: calling replaceChildren((Node or DOMString)...) on element with too few arguments must throw TypeError]
-    expected: FAIL
-
-  [Document interface: new Document() must inherit property "replaceChildren((Node or DOMString)...)" with the proper type]
-    expected: FAIL
-
-  [DocumentFragment interface: calling replaceChildren((Node or DOMString)...) on document.createDocumentFragment() with too few arguments must throw TypeError]
-    expected: FAIL
-
-  [Document interface: xmlDoc must inherit property "replaceChildren((Node or DOMString)...)" with the proper type]
-    expected: FAIL
-

testing/web-platform/meta/dom/nodes/ParentNode-replaceChildren.html.ini

@@ -1,76 +0,0 @@
-[ParentNode-replaceChildren.html]
-  [DocumentFragment.replaceChildren() with null as an argument, on a parent having a child.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() with only text as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [Element.replaceChildren() with null as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [Element.replaceChildren() without any argument, on a parent having no child.]
-    expected: FAIL
-
-  [If node is a host-including inclusive ancestor of parent, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [If node is an Element and parent is a document with another element, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() with null as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() with one element and text as argument, on a parent having a child.]
-    expected: FAIL
-
-  [Element.replaceChildren() with null as an argument, on a parent having a child.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() with only one element as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [Element.replaceChildren() should move nodes in the right order]
-    expected: FAIL
-
-  [If node is a Text node and parent is a document, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [If node is a DocumentFragment with an element and parent is a document with another element, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() with undefined as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [If node is a doctype and parent is not a document, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [If node is a doctype and parent is a document with another doctype, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [If node is a DocumentFragment with multiple elements and parent is a document, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [Element.replaceChildren() with undefined as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [Element.replaceChildren() with only one element as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [Element.replaceChildren() with one element and text as argument, on a parent having a child.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() should move nodes in the right order]
-    expected: FAIL
-
-  [If node is a doctype and parent is a document with an element, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-
-  [Element.replaceChildren() with only text as an argument, on a parent having no child.]
-    expected: FAIL
-
-  [DocumentFragment.replaceChildren() without any argument, on a parent having no child.]
-    expected: FAIL
-
-  [If node is not a DocumentFragment, DocumentType, Element, Text, ProcessingInstruction, or Comment node, then throw a HierarchyRequestError DOMException.]
-    expected: FAIL
-

testing/web-platform/tests/dom/nodes/ParentNode-replaceChildren.html

@@ -94,14 +94,14 @@
 
       const observer = new MutationObserver(mutations => {
         t.step(() => {
-          assert_equals(phase, 1);
-          assert_equals(mutations.length, 1);
+          assert_equals(phase, 1, "phase");
+          assert_equals(mutations.length, 1, "mutations.length");
           const mutation = mutations[0];
-          assert_equals(mutation.type, "childList");
-          assert_equals(mutation.addedNodes.length, 2);
-          assert_array_equals([...mutation.addedNodes], insertions);
-          assert_equals(mutation.removedNodes.length, 2);
-          assert_array_equals([...mutation.removedNodes], children);
+          assert_equals(mutation.type, "childList", "mutation.type");
+          assert_equals(mutation.addedNodes.length, 2, "added nodes length");
+          assert_array_equals([...mutation.addedNodes], insertions, "added nodes");
+          assert_equals(mutation.removedNodes.length, 2, "removed nodes length");
+          assert_array_equals([...mutation.removedNodes], children, "removed nodes");
         });
         t.done();
       });