[testdriver.js] Don't expose testdriver-internal messages to tests

Fixes web-platform-tests#48326
jonathan-j-lee · Oct 2, 2024 · d43eccd · d43eccd
1 parent 5e053f0
commit d43eccd
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 6 deletions.
diff --git a/infrastructure/testdriver/actions/crossOrigin.sub.html b/infrastructure/testdriver/actions/crossOrigin.sub.html
@@ -15,7 +15,9 @@
     if (msg.data === "PASS") {
         done();
     } else if (msg.data === "FAIL") {
-        assert_unreached("actions failed")
+        assert_unreached("actions failed");
+    } else {
+        assert_unreached("testdriver.js-internal messages should not be exposed to tests");
     }
 });
 </script>
diff --git a/infrastructure/testdriver/actions/popup.html b/infrastructure/testdriver/actions/popup.html
@@ -13,6 +13,8 @@
         resolve();
       } else if (msg.data === "FAIL") {
         reject("actions failed");
+      } else {
+        reject("testdriver.js-internal messages should not be exposed to tests");
       }
     });
     addEventListener("click", (event) => {

diff --git a/infrastructure/testdriver/click_iframe_crossorigin.sub.html b/infrastructure/testdriver/click_iframe_crossorigin.sub.html
@@ -12,7 +12,9 @@
     if (msg.data === "PASS") {
         done();
     } else if (msg.data === "FAIL") {
-        assert_unreached("click failed")
+        assert_unreached("click failed");
+    } else {
+        assert_unreached("testdriver.js-internal messages should not be exposed to tests");
     }
 });
 </script>

diff --git a/infrastructure/testdriver/click_nested_crossorigin.sub.html b/infrastructure/testdriver/click_nested_crossorigin.sub.html
@@ -19,7 +19,9 @@
     if (msg.data === "PASS") {
         done();
     } else if (msg.data === "FAIL") {
-        assert_unreached("click failed")
+        assert_unreached("click failed");
+    } else {
+        assert_unreached("testdriver.js-internal messages should not be exposed to tests");
     }
 });
 </script>
diff --git a/tools/wptrunner/wptrunner/testdriver-extra.js b/tools/wptrunner/wptrunner/testdriver-extra.js
@@ -43,10 +43,19 @@
         } else if (data.type === "testdriver-event") {
             const event_data = JSON.parse(data.message);
             const event_name = event_data.method;
-            const event = new Event(event_name);
-            event.payload = event_data.params;
-            event_target.dispatchEvent(event);
+            const testdriver_event = new Event(event_name);
+            testdriver_event.payload = event_data.params;
+            event_target.dispatchEvent(testdriver_event);
+        } else {
+            return;
         }
+
+        // Don't expose testdriver.js-internal messages to tests. Because
+        // `testdriver.js` precedes test scripts in the markup, this "message"
+        // listener should be registered and run first [0].
+        //
+        // [0]: https://html.spec.whatwg.org/multipage/webappapis.html#event-handler-attributes
+        event.stopImmediatePropagation();
     });
 
     function is_test_context() {