Skip to content

Commit

Permalink
Bug 1691446 - [remote] Add support for handling WebDriverSession to W…
Browse files Browse the repository at this point in the history 
…ebDriver BiDi. r=webdriver-reviewers,jdescottes,jgraham

Differential Revision: https://phabricator.services.mozilla.com/D119552
  • Loading branch information
@whimboo
whimboo committed Jul 16, 2021
1 parent b49bc42 commit 02977a7
Show file tree
Hide file tree
Showing 7 changed files with 382 additions and 196 deletions.
2 changes: 1 addition & 1 deletion remote/cdp/CDPConnection.jsm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class CDPConnection extends WebSocketConnection {
/**
* @param {WebSocket} webSocket
* The WebSocket server connection to wrap.
* @param {HttpServer} httpdConnection
* @param {Connection} httpdConnection
* Reference to the httpd.js's connection needed for clean-up.
*/
constructor(webSocket, httpdConnection) {
Expand Down
261 changes: 77 additions & 184 deletions remote/marionette/driver.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ XPCOMUtils.defineLazyModuleGetters(this, {
atom: "chrome://remote/content/marionette/atom.js",
browser: "chrome://remote/content/marionette/browser.js",
capture: "chrome://remote/content/marionette/capture.js",
clearActionInputState:
"chrome://remote/content/marionette/actors/MarionetteCommandsChild.jsm",
clearElementIdCache:
"chrome://remote/content/marionette/actors/MarionetteCommandsParent.jsm",
Context: "chrome://remote/content/marionette/browser.js",
Expand All @@ -44,6 +46,7 @@ XPCOMUtils.defineLazyModuleGetters(this, {
"chrome://remote/content/marionette/actors/MarionetteCommandsParent.jsm",
registerEventsActor:
"chrome://remote/content/marionette/actors/MarionetteEventsParent.jsm",
RemoteAgent: "chrome://remote/content/components/RemoteAgent.jsm",
TimedPromise: "chrome://remote/content/marionette/sync.js",
Timeouts: "chrome://remote/content/shared/webdriver/Capabilities.jsm",
UnhandledPromptBehavior:
Expand Down Expand Up @@ -108,7 +111,7 @@ this.GeckoDriver = function(server) {
this._server = server;

// WebDriver Session
this.currentSession = null;
this._currentSession = null;

this.browsers = {};

Expand Down Expand Up @@ -139,6 +142,19 @@ Object.defineProperty(GeckoDriver.prototype, "context", {
},
});

/**
* The current WebDriver Session.
*/
Object.defineProperty(GeckoDriver.prototype, "currentSession", {
get() {
if (RemoteAgent.webdriverBiDi) {
return RemoteAgent.webdriverBiDi.session;
}

return this._currentSession;
},
});

/**
* Returns the current URL of the ChromeWindow or content browser,
* depending on context.
Expand Down Expand Up @@ -375,100 +391,10 @@ GeckoDriver.prototype.registerBrowser = function(browserElement) {
/**
* Create a new WebDriver session.
*
* It is expected that the caller performs the necessary checks on
* the requested capabilities to be WebDriver conforming. The WebDriver
* service offered by Marionette does not match or negotiate capabilities
* beyond type- and bounds checks.
*
* <h3>Capabilities</h3>
*
* <dl>
* <dt><code>pageLoadStrategy</code> (string)
* <dd>The page load strategy to use for the current session. Must be
* one of "<tt>none</tt>", "<tt>eager</tt>", and "<tt>normal</tt>".
*
* <dt><code>acceptInsecureCerts</code> (boolean)
* <dd>Indicates whether untrusted and self-signed TLS certificates
* are implicitly trusted on navigation for the duration of the session.
*
* <dt><code>timeouts</code> (Timeouts object)
* <dd>Describes the timeouts imposed on certian session operations.
*
* <dt><code>proxy</code> (Proxy object)
* <dd>Defines the proxy configuration.
*
* <dt><code>moz:accessibilityChecks</code> (boolean)
* <dd>Run a11y checks when clicking elements.
*
* <dt><code>moz:useNonSpecCompliantPointerOrigin</code> (boolean)
* <dd>Use the not WebDriver conforming calculation of the pointer origin
* when the origin is an element, and the element center point is used.
*
* <dt><code>moz:webdriverClick</code> (boolean)
* <dd>Use a WebDriver conforming <i>WebDriver::ElementClick</i>.
* </dl>
*
* <h4>Timeouts object</h4>
*
* <dl>
* <dt><code>script</code> (number)
* <dd>Determines when to interrupt a script that is being evaluates.
*
* <dt><code>pageLoad</code> (number)
* <dd>Provides the timeout limit used to interrupt navigation of the
* browsing context.
*
* <dt><code>implicit</code> (number)
* <dd>Gives the timeout of when to abort when locating an element.
* </dl>
*
* <h4>Proxy object</h4>
*
* <dl>
* <dt><code>proxyType</code> (string)
* <dd>Indicates the type of proxy configuration. Must be one
* of "<tt>pac</tt>", "<tt>direct</tt>", "<tt>autodetect</tt>",
* "<tt>system</tt>", or "<tt>manual</tt>".
*
* <dt><code>proxyAutoconfigUrl</code> (string)
* <dd>Defines the URL for a proxy auto-config file if
* <code>proxyType</code> is equal to "<tt>pac</tt>".
*
* <dt><code>httpProxy</code> (string)
* <dd>Defines the proxy host for HTTP traffic when the
* <code>proxyType</code> is "<tt>manual</tt>".
*
* <dt><code>noProxy</code> (string)
* <dd>Lists the adress for which the proxy should be bypassed when
* the <code>proxyType</code> is "<tt>manual</tt>". Must be a JSON
* List containing any number of any of domains, IPv4 addresses, or IPv6
* addresses.
*
* <dt><code>sslProxy</code> (string)
* <dd>Defines the proxy host for encrypted TLS traffic when the
* <code>proxyType</code> is "<tt>manual</tt>".
*
* <dt><code>socksProxy</code> (string)
* <dd>Defines the proxy host for a SOCKS proxy traffic when the
* <code>proxyType</code> is "<tt>manual</tt>".
*
* <dt><code>socksVersion</code> (string)
* <dd>Defines the SOCKS proxy version when the <code>proxyType</code> is
* "<tt>manual</tt>". It must be any integer between 0 and 255
* inclusive.
* </dl>
*
* <h3>Example</h3>
*
* Input:
*
* <pre><code>
* {"capabilities": {"acceptInsecureCerts": true}}
* </code></pre>
*
* @param {Object.<string, *>=} capabilities
* JSON Object containing any of the recognised capabilities listed
* above.
* @param {Object} cmd
* @param {Object.<string, *>=} cmd.parameters
* JSON Object containing any of the recognised capabilities as listed
* on the `WebDriverSession` class.
*
* @return {Object}
* Session ID and capabilities offered by the WebDriver service.
Expand All @@ -481,107 +407,68 @@ GeckoDriver.prototype.newSession = async function(cmd) {
throw new error.SessionNotCreatedError("Maximum number of active sessions");
}

this.currentSession = new WebDriverSession(cmd.parameters);
const { parameters: capabilities } = cmd;

registerCommandsActor();
registerEventsActor();
try {
const win = await windowManager.waitForInitialApplicationWindow();

// Wait until the initial application window has been loaded
await new TimedPromise(
resolve => {
const waitForWindow = () => {
let windowTypes;
if (AppInfo.isThunderbird) {
windowTypes = ["mail:3pane"];
} else {
// We assume that an app either has GeckoView windows, or
// Firefox/Fennec windows, but not both.
windowTypes = ["navigator:browser", "navigator:geckoview"];
}
if (MarionettePrefs.clickToStart) {
Services.prompt.alert(
win,
"",
"Click to start execution of marionette tests"
);
}

let win;
for (const windowType of windowTypes) {
win = Services.wm.getMostRecentWindow(windowType);
if (win) {
break;
}
}
this.addBrowser(win);
this.mainFrame = win;

if (!win) {
// if the window isn't even created, just poll wait for it
let checkTimer = Cc["@mozilla.org/timer;1"].createInstance(
Ci.nsITimer
);
checkTimer.initWithCallback(
waitForWindow,
100,
Ci.nsITimer.TYPE_ONE_SHOT
);
} else if (win.document.readyState != "complete") {
// otherwise, wait for it to be fully loaded before proceeding
let listener = ev => {
// ensure that we proceed, on the top level document load event
// (not an iframe one...)
if (ev.target != win.document) {
return;
}
win.removeEventListener("load", listener);
waitForWindow();
};
win.addEventListener("load", listener, true);
} else {
if (MarionettePrefs.clickToStart) {
Services.prompt.alert(
win,
"",
"Click to start execution of marionette tests"
);
}
this.addBrowser(win);
this.mainFrame = win;
resolve();
}
};

waitForWindow();
},
{
throws: error.SessionNotCreatedError,
errorMessage: "No applicable application windows found",
// If the WebDriver BiDi protocol is active always use the Remote Agent
// to handle the WebDriver session. If it's not the case Marionette itself
// needs to handle it.
if (RemoteAgent.webdriverBiDi) {
RemoteAgent.webdriverBiDi.createSession(capabilities);
} else {
this._currentSession = new WebDriverSession(capabilities);
}
);

for (let win of windowManager.windows) {
const tabBrowser = browser.getTabBrowser(win);
registerCommandsActor();
registerEventsActor();

if (tabBrowser) {
for (const tab of tabBrowser.tabs) {
const contentBrowser = browser.getBrowserForTab(tab);
this.registerBrowser(contentBrowser);
for (let win of windowManager.windows) {
const tabBrowser = browser.getTabBrowser(win);

if (tabBrowser) {
for (const tab of tabBrowser.tabs) {
const contentBrowser = browser.getBrowserForTab(tab);
this.registerBrowser(contentBrowser);
}
}
}

this.registerListenersForWindow(win);
}
this.registerListenersForWindow(win);
}

if (this.mainFrame) {
this.currentSession.chromeBrowsingContext = this.mainFrame.browsingContext;
this.mainFrame.focus();
}
if (this.mainFrame) {
this.currentSession.chromeBrowsingContext = this.mainFrame.browsingContext;
this.mainFrame.focus();
}

if (this.curBrowser.tab) {
this.currentSession.contentBrowsingContext = this.curBrowser.contentBrowser.browsingContext;
this.curBrowser.contentBrowser.focus();
}
if (this.curBrowser.tab) {
this.currentSession.contentBrowsingContext = this.curBrowser.contentBrowser.browsingContext;
this.curBrowser.contentBrowser.focus();
}

// Setup observer for modal dialogs
this.dialogObserver = new modal.DialogObserver(() => this.curBrowser);
this.dialogObserver.add(this.handleModalDialog.bind(this));
// Setup observer for modal dialogs
this.dialogObserver = new modal.DialogObserver(() => this.curBrowser);
this.dialogObserver.add(this.handleModalDialog.bind(this));

// Check if there is already an open dialog for the selected browser window.
this.dialog = modal.findModalDialogs(this.curBrowser);
// Check if there is already an open dialog for the selected browser window.
this.dialog = modal.findModalDialogs(this.curBrowser);

Services.obs.addObserver(this, "browser-delayed-startup-finished");
Services.obs.addObserver(this, "browser-delayed-startup-finished");
} catch (e) {
throw new error.SessionNotCreatedError(e);
}

return {
sessionId: this.currentSession.id,
Expand Down Expand Up @@ -1432,6 +1319,7 @@ GeckoDriver.prototype.setTimeouts = function(cmd) {
this.currentSession.timeouts.toJSON(),
cmd.parameters
);

this.currentSession.timeouts = Timeouts.fromJSON(merged);
};

Expand Down Expand Up @@ -2244,15 +2132,20 @@ GeckoDriver.prototype.deleteSession = function() {

Services.obs.removeObserver(this, "browser-delayed-startup-finished");

clearActionInputState();
clearElementIdCache();

// Always unregister actors after all other observers
// and listeners have been removed.
unregisterCommandsActor();
unregisterEventsActor();

this.currentSession.destroy();
this.currentSession = null;
if (RemoteAgent.webdriverBiDi) {
RemoteAgent.webdriverBiDi.deleteSession();
} else {
this.currentSession.destroy();
this._currentSession = null;
}
};

/**
Expand Down
2 changes: 1 addition & 1 deletion remote/shared/WebSocketConnection.jsm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class WebSocketConnection {
/**
* @param {WebSocket} webSocket
* The WebSocket server connection to wrap.
* @param {HttpServer} httpdConnection
* @param {Connection} httpdConnection
* Reference to the httpd.js's connection needed for clean-up.
*/
constructor(webSocket, httpdConnection) {
Expand Down
Loading

0 comments on commit 02977a7

Please sign in to comment.