Changeset 234507 in webkit

Timestamp:

Aug 2, 2018 12:25:23 PM (6 years ago)

Author:

rniwa@webkit.org

Message:

Implement customElements.upgrade()
​https://bugs.webkit.org/show_bug.cgi?id=183397

Reviewed by Frédéric Wang.

LayoutTests/imported/w3c:

Rebaseline the test now that we're passing.

• web-platform-tests/custom-elements/custom-element-registry/upgrade-expected.txt:

Source/WebCore:

Added the support to upgrade custom elements directly. Ordinarily, custom elements get upgraded as they are
inserted / connected into a document but some script libraries and authors want to be able to upgrade them before that.
Also see ​https://github.com/w3c/webcomponents/issues/710

Implemented the method as specified at:
​https://html.spec.whatwg.org/multipage/custom-elements.html#dom-customelementregistry-upgrade

When invoked, the upgrade(root) method must run these steps:

1. Let candidates be a list of all of root's shadow-including inclusive descendant elements, in shadow-including tree order.
2. For each candidate of candidates, try to upgrade candidate.

Tests: imported/w3c/web-platform-tests/custom-elements/custom-element-registry/upgrade.html

• dom/CustomElementReactionQueue.cpp:

(WebCore::CustomElementReactionQueue::enqueueElementUpgradeIfDefined): Removed the assertion that the upgraded element
is connected since the whole point of this API is to upgrade a disconnected element.

• dom/CustomElementRegistry.cpp:

(WebCore::upgradeElementsInShadowIncludingdescendants): Added.
(WebCore::CustomElementRegistry::upgrade): Added.

• dom/CustomElementRegistry.h: Forward declare DeferredPromise instead of unnecessarily including JSDOMPromiseDeferred.h.
• dom/CustomElementRegistry.idl:
• dom/Element.cpp:

(WebCore::Element::insertedIntoAncestor): Moved the assertion here.

Location:

trunk

Files:

• LayoutTests/imported/w3c/ChangeLog (modified) (1 diff)
• LayoutTests/imported/w3c/web-platform-tests/custom-elements/custom-element-registry/upgrade-expected.txt (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/dom/CustomElementReactionQueue.cpp (modified) (1 diff)
• Source/WebCore/dom/CustomElementRegistry.cpp (modified) (2 diffs)
• Source/WebCore/dom/CustomElementRegistry.h (modified) (3 diffs)
• Source/WebCore/dom/CustomElementRegistry.idl (modified) (1 diff)
• Source/WebCore/dom/Element.cpp (modified) (1 diff)

trunk/LayoutTests/imported/w3c/ChangeLog

@@ +1 @@
+2018-08-01  Ryosuke Niwa  <rniwa@webkit.org>
+
+        Implement customElements.upgrade()
+        https://bugs.webkit.org/show_bug.cgi?id=183397
+
+        Reviewed by Frédéric Wang.
+
+        Rebaseline the test now that we're passing.
+
+        * web-platform-tests/custom-elements/custom-element-registry/upgrade-expected.txt:
+
 2018-07-23  Manuel Rego Casasnovas  <rego@igalia.com>
 

trunk/LayoutTests/imported/w3c/web-platform-tests/custom-elements/custom-element-registry/upgrade-expected.txt

@@ -1 +1 @@
 
-FAIL Upgrading an element directly (example from the spec) customElements.upgrade is not a function. (In 'customElements.upgrade(el)', 'customElements.upgrade' is undefined)
-FAIL Two elements as children of the upgraded node customElements.upgrade is not a function. (In 'customElements.upgrade(container)', 'customElements.upgrade' is undefined)
-FAIL Two elements as descendants of the upgraded node customElements.upgrade is not a function. (In 'customElements.upgrade(container)', 'customElements.upgrade' is undefined)
-FAIL Two elements as shadow-including descendants (and not descendants) of the upgraded node customElements.upgrade is not a function. (In 'customElements.upgrade(container)', 'customElements.upgrade' is undefined)
-FAIL Elements inside a template contents DocumentFragment node customElements.upgrade is not a function. (In 'customElements.upgrade(template)', 'customElements.upgrade' is undefined)
+PASS Upgrading an element directly (example from the spec) 
+PASS Two elements as children of the upgraded node 
+PASS Two elements as descendants of the upgraded node 
+PASS Two elements as shadow-including descendants (and not descendants) of the upgraded node 
+PASS Elements inside a template contents DocumentFragment node 
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2018-08-01  Ryosuke Niwa  <rniwa@webkit.org>
+
+        Implement customElements.upgrade()
+        https://bugs.webkit.org/show_bug.cgi?id=183397
+
+        Reviewed by Frédéric Wang.
+
+        Added the support to upgrade custom elements directly. Ordinarily, custom elements get upgraded as they are
+        inserted / connected into a document but some script libraries and authors want to be able to upgrade them before that.
+        Also see https://github.com/w3c/webcomponents/issues/710
+
+        Implemented the method as specified at:
+        https://html.spec.whatwg.org/multipage/custom-elements.html#dom-customelementregistry-upgrade
+
+            When invoked, the upgrade(root) method must run these steps:
+            1. Let candidates be a list of all of root's shadow-including inclusive descendant elements,
+               in shadow-including tree order.
+            2. For each candidate of candidates, try to upgrade candidate.
+
+        Tests: imported/w3c/web-platform-tests/custom-elements/custom-element-registry/upgrade.html
+
+        * dom/CustomElementReactionQueue.cpp:
+        (WebCore::CustomElementReactionQueue::enqueueElementUpgradeIfDefined): Removed the assertion that the upgraded element
+        is connected since the whole point of this API is to upgrade a disconnected element.
+        * dom/CustomElementRegistry.cpp:
+        (WebCore::upgradeElementsInShadowIncludingdescendants): Added.
+        (WebCore::CustomElementRegistry::upgrade): Added.
+        * dom/CustomElementRegistry.h: Forward declare DeferredPromise instead of unnecessarily including JSDOMPromiseDeferred.h.
+        * dom/CustomElementRegistry.idl:
+        * dom/Element.cpp:
+        (WebCore::Element::insertedIntoAncestor): Moved the assertion here.
+
 2018-08-02  Simon Fraser  <simon.fraser@apple.com>
 

trunk/Source/WebCore/dom/CustomElementReactionQueue.cpp

@@ -123 +123 @@
 void CustomElementReactionQueue::enqueueElementUpgradeIfDefined(Element& element)
 {
-    ASSERT(element.isConnected());
     ASSERT(element.isCustomElementUpgradeCandidate());
     auto* window = element.document().domWindow();

trunk/Source/WebCore/dom/CustomElementRegistry.cpp

@@ -36 +36 @@
 #include "QualifiedName.h"
 #include "ShadowRoot.h"
+#include "TypedElementDescendantIterator.h"
 #include <JavaScriptCore/JSCJSValueInlines.h>
 #include <wtf/text/AtomicString.h>
@@ -114 +115 @@
 }
 
+static void upgradeElementsInShadowIncludingDescendants(ContainerNode& root)
+{
+    for (auto& element : descendantsOfType<Element>(root)) {
+        if (element.isCustomElementUpgradeCandidate())
+            CustomElementReactionQueue::enqueueElementUpgradeIfDefined(element);
+        if (auto* shadowRoot = element.shadowRoot())
+            upgradeElementsInShadowIncludingDescendants(*shadowRoot);
+    }
 }
+
+void CustomElementRegistry::upgrade(Node& root)
+{
+    if (!is<ContainerNode>(root))
+        return;
+
+    if (is<Element>(root) && downcast<Element>(root).isCustomElementUpgradeCandidate())
+        CustomElementReactionQueue::enqueueElementUpgradeIfDefined(downcast<Element>(root));
+
+    upgradeElementsInShadowIncludingDescendants(downcast<ContainerNode>(root));
+}
+
+}

trunk/Source/WebCore/dom/CustomElementRegistry.h

@@ -26 +26 @@
 #pragma once
 
-#include "JSDOMPromiseDeferred.h"
 #include "QualifiedName.h"
 #include <wtf/HashMap.h>
@@ -43 +42 @@
 class CustomElementRegistry;
 class DOMWindow;
+class DeferredPromise;
 class Element;
 class JSCustomElementInterface;
+class Node;
 class QualifiedName;
 
@@ -63 +64 @@
 
     JSC::JSValue get(const AtomicString&);
+    void upgrade(Node& root);
 
     HashMap<AtomicString, Ref<DeferredPromise>>& promiseMap() { return m_promiseMap; }

trunk/Source/WebCore/dom/CustomElementRegistry.idl

@@ -32 +32 @@
     any get(DOMString name);
     [Custom, MayThrowException, ReturnsOwnPromise] Promise<void> whenDefined(DOMString name);
+    [CEReactions] void upgrade(Node root);
 };

trunk/Source/WebCore/dom/Element.cpp

@@ -1748 +1748 @@
 
     if (becomeConnected) {
-        if (UNLIKELY(isCustomElementUpgradeCandidate()))
+        if (UNLIKELY(isCustomElementUpgradeCandidate())) {
+            ASSERT(isConnected());
             CustomElementReactionQueue::enqueueElementUpgradeIfDefined(*this);
+        }
         if (UNLIKELY(isDefinedCustomElement()))
             CustomElementReactionQueue::enqueueConnectedCallbackIfNeeded(*this);