Add consume_user_activation() to testdriver.js

web-platform-tests · Nov 28, 2022 · 81aa4c0 · 81aa4c0
1 parent 4435c35
commit 81aa4c0
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 19 deletions.
diff --git a/html/user-activation/activation-trigger-keyboard-enter.html b/html/user-activation/activation-trigger-keyboard-enter.html
@@ -27,17 +27,17 @@ <h1>Test for keyboard activation trigger for ENTER key</h1>
         await test_driver.send_keys(document.body, ENTER_KEY);
 
         await keydown_event;
-        let consumed = await consumeTransientActivation();
+        let consumed = await test_driver.consume_user_activation();
         assert_true(consumed,
                     "ENTER keydown event should result in activation");
 
         await keypress_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "ENTER keypress should have no activation after keydown consumption");
 
         await keyup_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "ENTER keyup should have no activation after keydown consumption");
     }, "Activation through ENTER keyboard event");

diff --git a/html/user-activation/activation-trigger-keyboard-escape.html b/html/user-activation/activation-trigger-keyboard-escape.html
@@ -26,12 +26,12 @@ <h1>Test for keyboard activation trigger for ESCAPE key</h1>
         await test_driver.send_keys(document.body, ESCAPE_KEY);
 
         await keydown_event;
-        let consumed = await consumeTransientActivation();
+        let consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                     "ESCAPE keydown event should not result in activation");
 
         await keyup_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "ESCAPE keyup should have no activation after keydown consumption");
     }, "Activation through ESCAPE keyboard event");

diff --git a/html/user-activation/activation-trigger-mouse-left.html b/html/user-activation/activation-trigger-mouse-left.html
@@ -25,17 +25,17 @@ <h1>Test for click activation trigger</h1>
         await test_driver.click(document.body);
 
         await mousedown_event;
-        let consumed = await consumeTransientActivation();
+        let consumed = await test_driver.consume_user_activation();
         assert_true(consumed,
                     "mousedown event should result in activation");
 
         await mouseup_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "mouseup should have no activation after mousedown consumption");
 
         await click_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "click should have no activation after mousedown consumption");
     }, "Activation through left-click mouse event");

diff --git a/html/user-activation/activation-trigger-mouse-right.html b/html/user-activation/activation-trigger-mouse-right.html
@@ -35,22 +35,22 @@ <h1>Test for right-click activation trigger</h1>
         let contextmenu_event = getEvent('contextmenu');
 
         await mousedown_event;
-        let consumed = await consumeTransientActivation();
+        let consumed = await test_driver.consume_user_activation();
         assert_true(consumed,
                     "mousedown event should result in activation");
 
         await mouseup_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "mouseup should have no activation after mousedown consumption");
 
         await auxclick_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "auxclick should have no activation after mousedown consumption");
 
         await contextmenu_event;
-        consumed = await consumeTransientActivation();
+        consumed = await test_driver.consume_user_activation();
         assert_false(consumed,
                      "contextmenu should have no activation after mousedown consumption");
     }, "Activation through right-click mouse event");

diff --git a/html/user-activation/activation-trigger-pointerevent.html b/html/user-activation/activation-trigger-pointerevent.html
@@ -36,11 +36,11 @@ <h1>Test for pointerevent click activation trigger</h1>
         let click_event = getEvent('click');
 
         await pointerdown_event;
-        let consumed_pointerdown = await consumeTransientActivation();
+        let consumed_pointerdown = await test_driver.consume_user_activation();
         await pointerup_event;
-        let consumed_pointerup = await consumeTransientActivation();
+        let consumed_pointerup = await test_driver.consume_user_activation();
         await click_event;
-        let consumed_click = await consumeTransientActivation();
+        let consumed_click = await test_driver.consume_user_activation();
 
         if (pointer_type === "mouse") {
             assert_true(consumed_pointerdown,

diff --git a/html/user-activation/resources/consumption-crossorigin-child.sub.html b/html/user-activation/resources/consumption-crossorigin-child.sub.html
@@ -1,5 +1,7 @@
 <!DOCTYPE html>
 <html>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
 <head>
   <script>
     window.top.postMessage(JSON.stringify({
@@ -8,8 +10,8 @@
         "hasBeenActive": navigator.userActivation.hasBeenActive
     }), "*");
 
-    window.addEventListener("click", event => {
-        window.open().close();
+    window.addEventListener("click", async event => {
+        await test_driver.consume_user_activation();
 
         window.top.postMessage(JSON.stringify({
             "type": "child-crossorigin-report",

diff --git a/html/user-activation/resources/consumption-sameorigin-child.html b/html/user-activation/resources/consumption-sameorigin-child.html
@@ -1,5 +1,7 @@
 <!DOCTYPE html>
 <html>
+<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
 <head>
   <script>
     window.top.postMessage(JSON.stringify({
@@ -8,8 +10,8 @@
         "hasBeenActive": navigator.userActivation.hasBeenActive
     }), "*");
 
-    window.addEventListener("click", event => {
-        window.open().close();
+    window.addEventListener("click", async event => {
+        await test_driver.consume_user_activation();
 
         window.top.postMessage(JSON.stringify({
             "type": "child-sameorigin-report",

diff --git a/resources/testdriver.js b/resources/testdriver.js
@@ -648,6 +648,28 @@
         set_spc_transaction_mode: function(mode, context=null) {
           return window.test_driver_internal.set_spc_transaction_mode(mode, context);
         },
+
+        /**
+         * Consumes the user activation
+         *
+         * Matches the `Consume User Activation of Window
+         * <https://w3c.github.io/permissions/#consume-user-activation-of-window>`
+         * WebDriver command.
+         *
+         * Which corresponds to these steps in HTML:
+         * https://html.spec.whatwg.org/#consume-user-activation
+         *
+         * @example
+         * await test_driver.consume_user_activation();
+         * await test_driver.consume_user_activation(iframe.contentWindow);
+         * 
+         * @param {WindowProxy?} [context=null] - Browsing context in which to run the
+         *                                call.
+         * @returns {Promise<boolean>} fulfilled when user activation is consumed.
+         */
+        consume_user_activation(context=null) {
+            return window.test_driver_internal.consume_user_activation(context);
+        },
     };
 
     window.test_driver_internal = {
@@ -774,5 +796,11 @@
             return Promise.reject(new Error("unimplemented"));
         },
 
+        async consume_user_activation () {
+            if (this.in_automation) {
+                throw new Error('Not implemented');
+            }
+        },
+
     };
 })();