Adding WebDriver BiDi API to prefetching tests

resources/testdriver.js

@@ -81,6 +81,74 @@
             /**
              * `bluetooth <https://webbluetoothcg.github.io/web-bluetooth>`_ module.
              */
+            /*# RFC N: Add test-only APIs to improve the speculation rules prefetch tests   
+                (*Note: N should be replaced by the PR number*)
+
+                ## Summary
+
+                Add testdriver.js support for the [Prefetch Status Updated command].
+                This will allow tests to subscribe to the `speculation.prefetch_status_updated`
+                event and verify that the prefetch status is updated correctly.
+                [Prefetch Status Updated command]: *https://w3c.github.io/webdriver-bidi/#command-speculation-prefetch-status-updated* (not real yet)
+            */
+            speculation: {
+                prefetch_status_updated: {
+                    /**
+                     * @typedef {object} PrefetchStatusUpdated
+                     * `speculation.PrefetchStatusUpdateParameters <https://w3c.github.io --->
+                     */
+
+                    /**
+                     * Subscribes to the event. Events will be emitted only if
+                     * there is a subscription for the event. This method does
+                     * not add actual listeners. To listen to the event, use the
+                     * `on` or `once` methods. The buffered events will be
+                     * emitted before the command promise is resolved.
+                     *
+                     * @param {object} [params] Parameters for the subscription.
+                     * @param {null|Array.<(Context)>} [params.contexts] The
+                     * optional contexts parameter specifies which browsing
+                     * contexts to subscribe to the event on. It should be
+                     * either an array of Context objects, or null. If null, the
+                     * event will be subscribed to globally. If omitted, the
+                     * event will be subscribed to on the current browsing
+                     * context.
+                     * @returns {Promise<void>} Resolves when the subscription
+                     * is successfully done.
+                     */
+                    subscribe: async function(params = {}) {
+                        assertBidiIsEnabled();
+                        return window.test_driver_internal.bidi.speculation
+                            .prefetch_status_updated.subscribe(params);
+                    },
+                    /**
+                     * Adds an event listener for the event.
+                     *
+                     * @param {function(PrefetchStatusUpdate): void} callback The
+                     * callback to be called when the event is emitted. The
+                     * callback is called with the event object as a parameter.
+                     * @returns {function(): void} A function that removes the
+                     * added event listener when called.
+                     */
+                    on: function(callback) {
+                        assertBidiIsEnabled();
+                        return window.test_driver_internal.bidi.speculation
+                            .prefetch_status_updated.on(callback);
+                    },
+
+                    once: function() {
+                        assertBidiIsEnabled();
+                        return new Promise(resolve => {
+                            const remove_handler =
+                                window.test_driver_internal.bidi.speculation
+                                    .prefetch_status_updated.on(event => {
+                                    resolve(event);
+                                    remove_handler();
+                                });
+                        });
+                    },
+                }
+            },
             bluetooth: {
                 /**
                  * Handle a bluetooth device prompt with the given params. Matches the
@@ -665,7 +733,7 @@
                      */
                     subscribe: async function(params = {}) {
                         assertBidiIsEnabled();
-                        return window.test_driver_internal.bidi.bluetooth
+                        return window.test_driver.bidi.bluetooth
                             .characteristic_event_generated.subscribe(params);
                     },
                     /**
@@ -679,7 +747,7 @@
                      */
                     on: function(callback) {
                         assertBidiIsEnabled();
-                        return window.test_driver_internal.bidi.bluetooth
+                        return window.test_driver.bidi.bluetooth
                             .characteristic_event_generated.on(callback);
                     },
                     /**
@@ -2182,6 +2250,18 @@
         in_automation: false,
 
         bidi: {
+            speculation: {
+                prefetch_status_updated: {
+                    async subscribe() {
+                        throw new Error(
+                            'bidi.speculation.prefetch_status_updated.subscribe is not implemented by testdriver-vendor.js');
+                    },
+                    on() {
+                        throw new Error(
+                            'bidi.speculation.prefetch_status_updated.on is not implemented by testdriver-vendor.js');
+                    }
+                },
+            },
             bluetooth: {
                 handle_request_device_prompt: function() {
                     throw new Error(

speculation-rules/prefetch/anonymous-client.https.html

@@ -5,12 +5,22 @@
 <script src="/common/utils.js"></script>
 <script src="../resources/utils.js"></script>
 <script src="resources/utils.sub.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 <script>
   setup(() => assertSpeculationRulesIsSupported());
 
   promise_test(async t => {
     let agent = await spawnWindow(t);
     let nextUrl = agent.getExecutorURL({ hostname: CROSS_ORIGIN_HOST_THAT_WORKS_WITH_ACIWCO, page: 2 });
+
+    await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
     await agent.forceSinglePrefetch(nextUrl, { requires: ["anonymous-client-ip-when-cross-origin"] });
     await agent.navigate(nextUrl);
 

speculation-rules/prefetch/clear-prefetch-cache-after-clear-site-data-cache.https.html

@@ -5,14 +5,25 @@
 <script src="/common/utils.js"></script>
 <script src="../resources/utils.js"></script>
 <script src="resources/utils.sub.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 <script>
   setup(() => assertSpeculationRulesIsSupported());
 
   // Test that Clear-Site-Data header value "prefetchCache" clears prefetch cache
   promise_test(async t => {
     let agent = await spawnWindow(t, { protocol: 'https' });
     let nextUrl = agent.getExecutorURL({protocol: 'https', page: 2 });
+
+    await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
     await agent.forceSinglePrefetch(nextUrl);
+    await statusPromise;
 
     // Open new window with url to clear cache data through Clear-Site-Data header.
     // Ensure that the cache is cleared before the navigation.
@@ -37,7 +48,16 @@
   promise_test(async t => {
     let agent = await spawnWindow(t, { protocol: 'https' });
     let nextUrl = agent.getExecutorURL({protocol: 'https', page: 2 });
+
+    await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
     await agent.forceSinglePrefetch(nextUrl);
+    await statusPromise;
 
     // Open new window with url to clear cache data through Clear-Site-Data header.
     // Ensure that the cache is cleared before the navigation.

speculation-rules/prefetch/cookie-indices.https.html

@@ -2,13 +2,14 @@
 <meta name="timeout" content="long">
 <script src="/resources/testharness.js"></script>
 <script src="/resources/testharnessreport.js"></script>
-<script src="/resources/testdriver.js"></script>
 <script src='/resources/testdriver-vendor.js'></script>
 <script src="/common/dispatcher/dispatcher.js"></script>
 <script src="/common/subset-tests-by-key.js"></script>
 <script src="/common/utils.js"></script>
 <script src="../resources/utils.js"></script>
 <script src="resources/utils.sub.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 <meta name="variant" content="?include=unchanged">
 <meta name="variant" content="?include=changed">
 <meta name="variant" content="?include=unchangedWithRedirect">
@@ -25,7 +26,16 @@
   let agent = await spawnWindow(t);
 
   let nextUrl = agent.getExecutorURL({ executor: "cookies.py", cookieindices: "1" });
+
+  await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
   await agent.forceSinglePrefetch(nextUrl);
+  await statusPromise; // Wait for prefetch status update
+
   await agent.navigate(nextUrl);
 
   assert_prefetched(await agent.getRequestHeaders());

speculation-rules/prefetch/cross-origin-cookies-anonymous-client-ip-duplicate.https.html

@@ -2,7 +2,8 @@
 <meta name="timeout" content="long">
 <script src="/resources/testharness.js"></script>
 <script src="/resources/testharnessreport.js"></script>
-<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 <script src='/resources/testdriver-vendor.js'></script>
 <script src="/common/dispatcher/dispatcher.js"></script>
 <script src="/common/utils.js"></script>
@@ -24,8 +25,17 @@
     assert_equals(response_cookies["type"], "navigate");
 
     let nextUrl = agent.getExecutorURL({ executor, hostname: CROSS_ORIGIN_HOST_THAT_WORKS_WITH_ACIWCO, page: 2 });
+
+  await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
     await agent.forceSinglePrefetch(nextUrl, { requires: ["anonymous-client-ip-when-cross-origin"] });
     await agent.forceSinglePrefetch(nextUrl);
+    await statusPromise; // Wait for prefetch status update
     await agent.navigate(nextUrl);
 
     response_cookies = await agent.getResponseCookies();

speculation-rules/prefetch/cross-origin-cookies.https.html

@@ -2,7 +2,8 @@
 <meta name="timeout" content="long">
 <script src="/resources/testharness.js"></script>
 <script src="/resources/testharnessreport.js"></script>
-<script src="/resources/testdriver.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 <script src='/resources/testdriver-vendor.js'></script>
 <script src="/common/dispatcher/dispatcher.js"></script>
 <script src="/common/utils.js"></script>
@@ -25,7 +26,16 @@
     assert_equals(response_cookies["type"], "navigate");
 
     let nextUrl = agent.getExecutorURL({ executor, hostname: get_host_info().NOTSAMESITE_HOST, page: 2 });
+
+    await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
     await agent.forceSinglePrefetch(nextUrl);
+    await statusPromise; // Wait for prefetch status update
     await agent.navigate(nextUrl);
 
     response_cookies = await agent.getResponseCookies();

speculation-rules/prefetch/different-initiators-2.https.html

@@ -2,6 +2,9 @@
 <meta name="timeout" content="long">
 <script src="/resources/testharness.js"></script>
 <script src="/resources/testharnessreport.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
+<script src="/resources/testdriver-vendor.js"></script>
 <script src="/common/utils.js"></script>
 <script src="/common/dispatcher/dispatcher.js"></script>
 <script src="../resources/utils.js"></script>
@@ -22,8 +25,14 @@
   // The Documents #2 and #4 are different, but the same RenderFrameHost is
   // used before https://crbug.com/936696 is done.
 
+  await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
   await win.forceSinglePrefetch(nextUrl);
-
+  await statusPromise; // Wait for prefetch status update
   // Register a SW for `nextUrl` -- this is a trick to make the prefetched
   // result to put in `PrefetchService::prefetches_ready_to_serve_` in
   // Chromium implementation but actually not used by this navigation.

speculation-rules/prefetch/different-initiators.sub.https.html

@@ -7,6 +7,8 @@
 <script src="../resources/utils.js"></script>
 <script src="resources/utils.sub.js"></script>
 <script src="/service-workers/service-worker/resources/test-helpers.sub.js"></script>
+<script src="/resources/testdriver.js?feature=bidi"></script>
+<script src="/resources/testdriver-extra.js"></script>
 
 <meta name="variant" content="?cross-site-1">
 <meta name="variant" content="?cross-site-2">
@@ -29,7 +31,16 @@
 
   // Start speculation rules prefetch from `initiator1`.
   const nextUrl = initiator1.getExecutorURL({ protocol: 'https', page: 2 });
+
+  await test_driver.bidi.speculation.prefetch_status_updated.subscribe();
+  let statusPromise = new Promise(resolve => {
+    test_driver.bidi.speculation.prefetch_status_updated.on(event => {
+      if (event && event.status !== undefined) resolve(event.status);
+    });
+  });
+
   await initiator1.forceSinglePrefetch(nextUrl);
+  await statusPromise; // Wait for prefetch status update
 
   // Register a SW for `nextUrl` -- this is a trick to make the prefetched
   // result to put in `PrefetchService::prefetches_ready_to_serve_` in