Add the ability to load and test web extensions. #50648

elijahsawyers · 2025-02-12T00:49:38Z

Validate this change by writing a few simple tests that verify that some APIs on browser.runtime behave as expected.

The RFC document can be viewed here.

tools/wptrunner/wptrunner/executors/executorwebdriver.py

tools/wptrunner/wptrunner/executors/protocol.py

tools/wptrunner/wptrunner/executors/executorwebdriver.py

tools/wptrunner/wptrunner/executors/executorchrome.py

docs/writing-tests/testharness.md

tools/wptrunner/wptrunner/executors/executorwebdriver.py

docs/writing-tests/testharness.md

OrKoN · 2025-02-13T20:04:57Z

web-extensions/resources/runtime/background.js

@@ -0,0 +1,64 @@
+async function testGetURLErrorCases() {


I think usually the actual WPT tests are added separately from the infrastructure changes and tests for the infrastructure should be added to https://github.com/web-platform-tests/wpt/tree/master/infrastructure

kiaraarose · 2025-02-17T08:07:28Z

tools/wptrunner/wptrunner/executors/executorwebdriver.py

@@ -975,6 +1009,7 @@ def on_environment_change(self, new_environment):

    def do_test(self, test):
        url = self.test_url(test)
+        self.protocol.test_path = test.path


i think there is a better way to get that path than the way i'm doing it here. open to suggestions

resources/testdriver.js

OrKoN · 2025-04-02T10:38:30Z

Would it be possible to rebase the PR?

kiaraarose · 2025-04-03T20:34:09Z

Would it be possible to rebase the PR?

Updated the branch.

OrKoN · 2025-04-04T06:12:30Z

Thanks! locally I get the same error that shows on the bots now:

self._require_webdriver_bidi = test.testdriver_features is not None and 'bidi' in test.testdriver_features or 'extensions' in test.testdriver_features
TypeError: argument of type 'NoneType' is not iterable

kiaraarose · 2025-04-15T23:16:44Z

Thanks! locally I get the same error that shows on the bots now:

self._require_webdriver_bidi = test.testdriver_features is not None and 'bidi' in test.testdriver_features or 'extensions' in test.testdriver_features
TypeError: argument of type 'NoneType' is not iterable

thanks! not sure why i wasn't seeing that locally. pushed a fix

Ms2ger · 2025-09-02T15:22:16Z

resources/web-extensions-helper.js

+
+setup({ explicit_done: true })
+
+  globalThis.runTestsWithWebExtension = function(extensionPath) {


Indentation is off here

Ms2ger · 2025-09-02T15:22:36Z

resources/web-extensions-helper.js

+        path: extensionPath
+    })
+    .then((result) => {
+      let test;


Also inconsistent 2/4 spaces

Ms2ger · 2025-09-02T15:22:53Z

resources/web-extensions-helper.js

+      if (!data.result)
+        test.set_status(test.FAIL)
+
+      if (!data.remainingTests)
+          test_driver.uninstall_web_extension(result.extension).then(() => { done() })


Please brace single-line ifs

jgraham · 2025-09-02T15:49:32Z

resources/web-extensions-helper.js

+      let test;
+
+      browser.test.onTestStarted.addListener((data) => {
+        test = async_test(data.testName)


This depends on tests always running in serial. Is that absolutely guaranteed by the web extensions API? Would we be bteer having a map from testName to test and in onTestFinished getting the relevant test out of the map? We could at least try to assert that the name is what we expect.

the tests run serially. another test will only start once the previous one finished

jgraham · 2025-09-02T15:53:55Z

resources/testdriver.js

+         * @returns {Promise} Returns the extension identifier as defined in the spec.
+         *                    Rejected if the extension fails to load.
+         */
+        install_web_extension: function(path) {


The docstring doesn't seem to match the actual implementation.

jgraham · 2025-09-02T15:54:15Z

tools/webdriver/webdriver/client.py

@@ -701,6 +701,12 @@ def print(self,
                body[prop] = value
        return self.send_session_command("POST", "print", body)

+    def install_web_extension(self, extension):


I think a more idiomatic API in this client would be to have an Extensions object with install and uninstall methods so the API would look like client.extensions.install(path=<path>). Also it's unclear what extension is; I think it's a dict, but we should have named parameters instead and assemble the dict inside the method.

jgraham · 2025-09-02T15:57:00Z

tools/wptrunner/wptrunner/executors/executorwebdriver.py

+    def setup(self):
+        self.webdriver = self.parent.webdriver
+
+    def install_web_extension(self, extension):


Similarly here, break apart the extension argument into named parameters as much as possible.

Validate this change by writing a few simple tests that verify that some APIs on browser.runtime behave as expected.

kiaraarose · 2025-09-03T17:36:54Z

@jgraham I applied your suggested changes. can you take another look?

zombie · 2025-09-04T21:12:03Z

I've just confirmed this still runs and passes the sample tests with a Firefox build from latest checkout, and also with

python wpt run --channel=nightly --install-browser firefox web-extensions --no-headless

moz-wptsync-bot added the mozilla:gecko-blocked label Feb 12, 2025

oliverdunk reviewed Feb 12, 2025

View reviewed changes

tools/wptrunner/wptrunner/executors/executorwebdriver.py Outdated Show resolved Hide resolved