summaryrefslogtreecommitdiffstats
path: root/mobile/android/modules/test/AppUiTestDelegate.sys.mjs
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/modules/test/AppUiTestDelegate.sys.mjs')
-rw-r--r--mobile/android/modules/test/AppUiTestDelegate.sys.mjs127
1 files changed, 127 insertions, 0 deletions
diff --git a/mobile/android/modules/test/AppUiTestDelegate.sys.mjs b/mobile/android/modules/test/AppUiTestDelegate.sys.mjs
new file mode 100644
index 0000000000..8f880251ef
--- /dev/null
+++ b/mobile/android/modules/test/AppUiTestDelegate.sys.mjs
@@ -0,0 +1,127 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+const lazy = {};
+
+ChromeUtils.defineESModuleGetters(lazy, {
+ EventDispatcher: "resource://gre/modules/Messaging.sys.mjs",
+ GeckoViewTabBridge: "resource://gre/modules/GeckoViewTab.sys.mjs",
+ mobileWindowTracker: "resource://gre/modules/GeckoViewWebExtension.sys.mjs",
+});
+
+const TEST_SUPPORT_EXTENSION_ID = "test-runner-support@tests.mozilla.org";
+
+/**
+ * The implementation of AppUiTestDelegate. All implementations need to be kept
+ * in sync. For details, see:
+ * testing/specialpowers/content/AppTestDelegateParent.sys.mjs
+ *
+ * This implementation mostly forwards calls to TestRunnerApiEngine in
+ * mobile/android/test_runner/src/main/java/org/mozilla/geckoview/test_runner/TestRunnerApiEngine.java
+ */
+class Delegate {
+ _sendMessageToApp(data) {
+ // "GeckoView:WebExtension:Message" with the "nativeApp" property set is a
+ // message usually emitted by the runtime.sendNativeMessage implementation.
+ //
+ // Although a dummy extension with ID TEST_SUPPORT_EXTENSION_ID is installed
+ // by TestRunnerActivity, the sendNativeMessage API is not used directly.
+ // Instead, we forge a message in the same (internal) format here.
+ //
+ // The message is ultimately received and handled by TestRunnerApiEngine at
+ // mobile/android/test_runner/src/main/java/org/mozilla/geckoview/test_runner/TestRunnerApiEngine.java
+ const message = {
+ type: "GeckoView:WebExtension:Message",
+ sender: {
+ envType: "addon_child",
+ url: "test-runner-support:///",
+ },
+ data,
+ extensionId: TEST_SUPPORT_EXTENSION_ID,
+ nativeApp: "test-runner-support",
+ };
+
+ return lazy.EventDispatcher.instance.sendRequestForResult(message);
+ }
+
+ clickPageAction(window, extensionId) {
+ return this._sendMessageToApp({ type: "clickPageAction", extensionId });
+ }
+
+ clickBrowserAction(window, extensionId) {
+ return this._sendMessageToApp({ type: "clickBrowserAction", extensionId });
+ }
+
+ closePageAction(window, extensionId) {
+ return this._sendMessageToApp({ type: "closePageAction", extensionId });
+ }
+
+ closeBrowserAction(window, extensionId) {
+ return this._sendMessageToApp({ type: "closeBrowserAction", extensionId });
+ }
+
+ awaitExtensionPanel(window, extensionId) {
+ return this._sendMessageToApp({ type: "awaitExtensionPanel", extensionId });
+ }
+
+ async removeTab(tab) {
+ const window = tab.browser.ownerGlobal;
+ await lazy.GeckoViewTabBridge.closeTab({
+ window,
+ extensionId: TEST_SUPPORT_EXTENSION_ID,
+ });
+ }
+
+ async openNewForegroundTab(window, url, waitForLoad = true) {
+ const tab = await lazy.GeckoViewTabBridge.createNewTab({
+ extensionId: TEST_SUPPORT_EXTENSION_ID,
+ createProperties: {
+ url,
+ active: true,
+ },
+ });
+
+ const { browser } = tab;
+ const triggeringPrincipal =
+ Services.scriptSecurityManager.createContentPrincipal(
+ Services.io.newURI(url),
+ {}
+ );
+
+ browser.fixupAndLoadURIString(url, {
+ flags: Ci.nsIWebNavigation.LOAD_FLAGS_NONE,
+ triggeringPrincipal,
+ });
+
+ const newWindow = browser.ownerGlobal;
+ lazy.mobileWindowTracker.setTabActive(newWindow, true);
+
+ if (!waitForLoad) {
+ return tab;
+ }
+
+ return new Promise(resolve => {
+ const listener = ev => {
+ const { browsingContext, internalURL } = ev.detail;
+
+ // Sometimes we arrive here without an internalURL. If that's the
+ // case, just keep waiting until we get one.
+ if (!internalURL || internalURL == "about:blank") {
+ return;
+ }
+
+ // Ignore subframes
+ if (browsingContext !== browsingContext.top) {
+ return;
+ }
+
+ resolve(tab);
+ browser.removeEventListener("AppTestDelegate:load", listener, true);
+ };
+ browser.addEventListener("AppTestDelegate:load", listener, true);
+ });
+ }
+}
+
+export var AppUiTestDelegate = new Delegate();