Changeset 275187 in webkit

Timestamp:

Mar 29, 2021 3:55:49 PM (16 months ago)

Author:

Devin Rousso

Message:

Propagate user gestures through requestAnimationFrame just like setTimeout
​https://bugs.webkit.org/show_bug.cgi?id=223775
<rdar://problem/75860868>

Reviewed by Geoffrey Garen.

Source/WebCore:

setTimeout and requestAnimationFrame are used somewhat interchangeably on the web.
There should be similar features/affordances for both so that if a developer decides to use
a display-linked animation "loop" instead of a strictly time-based delay (or even a "loop")
they're able to do similar things in the callback/handler.

Test: fast/animation/request-animation-frame-propagate-user-gesture.html

• dom/ScriptedAnimationController.h:
• dom/ScriptedAnimationController.cpp:

(WebCore::ScriptedAnimationController::resume):
(WebCore::ScriptedAnimationController::registerCallback):
(WebCore::ScriptedAnimationController::cancelCallback):
(WebCore::ScriptedAnimationController::serviceRequestAnimationFrameCallbacks):
Create a private struct for holding more data in the list of callbacks than just the
callback itself. For now, the only other data saved is a RefPtr<UserGestureToken>.

• testing/Internals.idl:
• testing/Internals.h:
• testing/Internals.cpp:

(WebCore::Internals::withoutUserGesture): Added.
Add a way for tests to guaranteed run arbitrary code without a user gesture.

LayoutTests:

• editing/pasteboard/dom-paste/dom-paste-requires-user-gesture.html:
• fast/animation/request-animation-frame-propagate-user-gesture.html: Added.
• fast/animation/request-animation-frame-propagate-user-gesture-expected.txt: Added.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/editing/pasteboard/dom-paste/dom-paste-requires-user-gesture.html (modified) (1 diff)
• LayoutTests/fast/animation/request-animation-frame-propagate-user-gesture-expected.txt (added)
• LayoutTests/fast/animation/request-animation-frame-propagate-user-gesture.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/dom/ScriptedAnimationController.cpp (modified) (8 diffs)
• Source/WebCore/dom/ScriptedAnimationController.h (modified) (2 diffs)
• Source/WebCore/testing/Internals.cpp (modified) (1 diff)
• Source/WebCore/testing/Internals.h (modified) (1 diff)
• Source/WebCore/testing/Internals.idl (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2021-03-29  Devin Rousso  <drousso@apple.com>
+
+        Propagate user gestures through `requestAnimationFrame` just like `setTimeout`
+        https://bugs.webkit.org/show_bug.cgi?id=223775
+        <rdar://problem/75860868>
+
+        Reviewed by Geoffrey Garen.
+
+        * editing/pasteboard/dom-paste/dom-paste-requires-user-gesture.html:
+        * fast/animation/request-animation-frame-propagate-user-gesture.html: Added.
+        * fast/animation/request-animation-frame-propagate-user-gesture-expected.txt: Added.
+
 2021-03-29  Robert Jenner  <jenner@apple.com>
 

trunk/LayoutTests/editing/pasteboard/dom-paste/dom-paste-requires-user-gesture.html

@@ -55 +55 @@
     editor.focus();
     shouldBe("document.execCommand('Paste')", "true");
-    requestAnimationFrame(() => {
+    internals.withoutUserGesture(() => {
         shouldBe("document.execCommand('Paste')", "false")
         shouldBeEqualToString("editor.textContent", "Click here to copy");

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-03-29  Devin Rousso  <drousso@apple.com>
+
+        Propagate user gestures through `requestAnimationFrame` just like `setTimeout`
+        https://bugs.webkit.org/show_bug.cgi?id=223775
+        <rdar://problem/75860868>
+
+        Reviewed by Geoffrey Garen.
+
+        `setTimeout` and `requestAnimationFrame` are used somewhat interchangeably on the web.
+        There should be similar features/affordances for both so that if a developer decides to use
+        a display-linked animation "loop" instead of a strictly time-based delay (or even a "loop")
+        they're able to do similar things in the callback/handler.
+
+        Test: fast/animation/request-animation-frame-propagate-user-gesture.html
+
+        * dom/ScriptedAnimationController.h:
+        * dom/ScriptedAnimationController.cpp:
+        (WebCore::ScriptedAnimationController::resume):
+        (WebCore::ScriptedAnimationController::registerCallback):
+        (WebCore::ScriptedAnimationController::cancelCallback):
+        (WebCore::ScriptedAnimationController::serviceRequestAnimationFrameCallbacks):
+        Create a private struct for holding more data in the list of callbacks than just the
+        callback itself. For now, the only other data saved is a `RefPtr<UserGestureToken>`.
+
+        * testing/Internals.idl:
+        * testing/Internals.h:
+        * testing/Internals.cpp:
+        (WebCore::Internals::withoutUserGesture): Added.
+        Add a way for tests to guaranteed run arbitrary code without a user gesture.
+
 2021-03-29  Said Abou-Hallawa  <said@apple.com>
 

trunk/Source/WebCore/dom/ScriptedAnimationController.cpp

@@ -33 +33 @@
 #include "RequestAnimationFrameCallback.h"
 #include "Settings.h"
+#include "UserGestureIndicator.h"
 #include <wtf/Ref.h>
 #include <wtf/SystemTracing.h>
@@ -62 +63 @@
         --m_suspendCount;
 
-    if (!m_suspendCount && m_callbacks.size())
+    if (!m_suspendCount && m_callbackDataList.size())
         scheduleAnimation();
 }
@@ -112 +113 @@
     callback->m_firedOrCancelled = false;
     callback->m_id = callbackId;
-    m_callbacks.append(WTFMove(callback));
+    m_callbackDataList.append({ WTFMove(callback), UserGestureIndicator::currentUserGesture() });
 
     if (m_document)
@@ -124 +125 @@
 void ScriptedAnimationController::cancelCallback(CallbackId callbackId)
 {
-    bool cancelled = m_callbacks.removeFirstMatching([callbackId](auto& callback) {
-        if (callback->m_id != callbackId)
+    bool cancelled = m_callbackDataList.removeFirstMatching([callbackId](auto& data) {
+        if (data.callback->m_id != callbackId)
             return false;
-        callback->m_firedOrCancelled = true;
+        data.callback->m_firedOrCancelled = true;
         return true;
     });
@@ -137 +138 @@
 void ScriptedAnimationController::serviceRequestAnimationFrameCallbacks(ReducedResolutionSeconds timestamp)
 {
-    if (!m_callbacks.size() || m_suspendCount || !requestAnimationFrameEnabled())
+    if (!m_callbackDataList.size() || m_suspendCount || !requestAnimationFrameEnabled())
         return;
 
@@ -153 +154 @@
     // First, generate a list of callbacks to consider.  Callbacks registered from this point
     // on are considered only for the "next" frame, not this one.
-    CallbackList callbacks(m_callbacks);
+    Vector<CallbackData> callbackDataList(m_callbackDataList);
 
     // Invoking callbacks may detach elements from our document, which clears the document's
@@ -160 +161 @@
     Ref<Document> protectedDocument(*m_document);
 
-    for (auto& callback : callbacks) {
+    for (auto& [callback, userGestureTokenToForward] : callbackDataList) {
         if (callback->m_firedOrCancelled)
             continue;
         callback->m_firedOrCancelled = true;
+
+        if (userGestureTokenToForward && userGestureTokenToForward->hasExpired(UserGestureToken::maximumIntervalForUserGestureForwarding))
+            userGestureTokenToForward = nullptr;
+        UserGestureIndicator gestureIndicator(userGestureTokenToForward);
 
         InspectorInstrumentation::willFireAnimationFrame(protectedDocument, callback->m_id);
@@ -171 +176 @@
 
     // Remove any callbacks we fired from the list of pending callbacks.
-    m_callbacks.removeAllMatching([](auto& callback) {
-        return callback->m_firedOrCancelled;
+    m_callbackDataList.removeAllMatching([](auto& data) {
+        return data.callback->m_firedOrCancelled;
     });
 
     m_lastAnimationFrameTimestamp = timestamp;
 
-    if (m_callbacks.size())
+    if (m_callbackDataList.size())
         scheduleAnimation();
 }

trunk/Source/WebCore/dom/ScriptedAnimationController.h

@@ -40 +40 @@
 class Page;
 class RequestAnimationFrameCallback;
+class UserGestureToken;
 
 class ScriptedAnimationController : public RefCounted<ScriptedAnimationController>
@@ -75 +76 @@
     void scheduleAnimation();
 
-    using CallbackList = Vector<RefPtr<RequestAnimationFrameCallback>>;
-    CallbackList m_callbacks;
+    struct CallbackData {
+        Ref<RequestAnimationFrameCallback> callback;
+        RefPtr<UserGestureToken> userGestureTokenToForward;
+    };
+    Vector<CallbackData> m_callbackDataList;
 
     WeakPtr<Document> m_document;

trunk/Source/WebCore/testing/Internals.cpp

@@ -4853 +4853 @@
 }
 
+void Internals::withoutUserGesture(RefPtr<VoidCallback>&& callback)
+{
+    UserGestureIndicator gestureIndicator(NotProcessingUserGesture, contextDocument());
+    callback->handleEvent();
+}
+
 bool Internals::userIsInteracting()
 {

trunk/Source/WebCore/testing/Internals.h

@@ -746 +746 @@
 
     void withUserGesture(RefPtr<VoidCallback>&&);
+    void withoutUserGesture(RefPtr<VoidCallback>&&);
 
     bool userIsInteracting();

trunk/Source/WebCore/testing/Internals.idl

@@ -783 +783 @@
 
     undefined withUserGesture(VoidCallback callback);
+    undefined withoutUserGesture(VoidCallback callback);
 
     boolean userIsInteracting();