Skip to content

Commit

Permalink
[javascript] Deprecating Channel
Browse files Browse the repository at this point in the history 
[skip ci]
  • Loading branch information
@diemol
diemol committed Dec 22, 2023
1 parent eeaebe6 commit 6c3110a
Showing 1 changed file with 49 additions and 55 deletions.
104 changes: 49 additions & 55 deletions javascript/node/selenium-webdriver/firefox.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,28 +63,19 @@
*
* For Linux, Firefox will always be located on the PATH: `$(where firefox)`.
*
* Several methods are provided for starting Firefox with a custom executable.
* First, on Windows and MacOS, you may configure WebDriver to check the default
* install location for a non-release channel. If the requested channel cannot
* be found in its default location, WebDriver will fallback to searching your
* PATH. _Note:_ on Linux, Firefox is _always_ located on your path, regardless
* of the requested channel.
* You can provide a custom location for Firefox by setting the binary in the
* {@link Options}:setBinary method.
*
* const {Builder} = require('selenium-webdriver');
* const firefox = require('selenium-webdriver/firefox');
*
* let options = new firefox.Options().setBinary(firefox.Channel.NIGHTLY);
* let options = new firefox.Options()
* .setBinary('/my/firefox/install/dir/firefox');
* let driver = new Builder()
* .forBrowser('firefox')
* .setFirefoxOptions(options)
* .build();
*
* On all platforms, you may configure WebDriver to use a Firefox specific
* executable:
*
* let options = new firefox.Options()
* .setBinary('/my/firefox/install/dir/firefox-bin');
*
* __Remote Testing__
*
* You may customize the Firefox binary and profile when running against a
Expand All @@ -102,7 +93,7 @@
*
* let options = new firefox.Options()
* .setProfile('/profile/path/on/remote/host')
* .setBinary('/install/dir/on/remote/host/firefox-bin');
* .setBinary('/install/dir/on/remote/host/firefox');
*
* let driver = new Builder()
* .forBrowser('firefox')
Expand Down Expand Up @@ -136,7 +127,7 @@ const FIREFOX_CAPABILITY_KEY = 'moz:firefoxOptions'
*/
class AddonFormatError extends Error {
/** @param {string} msg The error message. */
constructor(msg) {
constructor (msg) {
super(msg)
/** @override */
this.name = this.constructor.name
Expand All @@ -150,7 +141,7 @@ class AddonFormatError extends Error {
* @return {!Promise<string>} A promise for the add-on ID once
* installed.
*/
async function installExtension(extension, dir) {
async function installExtension (extension, dir) {
const ext = extension.slice(-4)
if (ext !== '.xpi' && ext !== '.zip') {
throw Error('File name does not end in ".zip" or ".xpi": ' + ext)
Expand Down Expand Up @@ -188,23 +179,23 @@ async function installExtension(extension, dir) {
}

class Profile {
constructor() {
constructor () {
/** @private {?string} */
this.template_ = null

/** @private {!Array<string>} */
this.extensions_ = []
}

addExtensions(/** !Array<string> */ paths) {
addExtensions (/** !Array<string> */ paths) {
this.extensions_ = this.extensions_.concat(...paths)
}

/**
* @return {(!Promise<string>|undefined)} a promise for a base64 encoded
* profile, or undefined if there's no data to include.
*/
[Symbols.serialize]() {
[Symbols.serialize] () {
if (this.template_ || this.extensions_.length) {
return buildProfile(this.template_, this.extensions_)
}
Expand All @@ -218,7 +209,7 @@ class Profile {
* profile.
* @return {!Promise<string>} a promise for the base64 encoded profile.
*/
async function buildProfile(template, extensions) {
async function buildProfile (template, extensions) {
let dir = template

if (extensions.length) {
Expand Down Expand Up @@ -254,7 +245,7 @@ class Options extends Capabilities {
* @param {(Capabilities|Map<string, ?>|Object)=} other Another set of
* capabilities to initialize this instance from.
*/
constructor(other) {
constructor (other) {
super(other)
this.setBrowserName(Browser.FIREFOX)
}
Expand All @@ -263,7 +254,7 @@ class Options extends Capabilities {
* @return {!Object}
* @private
*/
firefoxOptions_() {
firefoxOptions_ () {
let options = this.get(FIREFOX_CAPABILITY_KEY)
if (!options) {
options = {}
Expand All @@ -276,7 +267,7 @@ class Options extends Capabilities {
* @return {!Profile}
* @private
*/
profile_() {
profile_ () {
let options = this.firefoxOptions_()
if (!options.profile) {
options.profile = new Profile()
Expand All @@ -291,7 +282,7 @@ class Options extends Capabilities {
* @param {...(string|!Array<string>)} args The arguments to include.
* @return {!Options} A self reference.
*/
addArguments(...args) {
addArguments (...args) {
if (args.length) {
let options = this.firefoxOptions_()
options.args = options.args ? options.args.concat(...args) : args
Expand All @@ -307,12 +298,13 @@ class Options extends Capabilities {
* @throws {TypeError} if width or height is unspecified, not a number, or
* less than or equal to 0.
*/
windowSize({ width, height }) {
function checkArg(arg) {
windowSize ({ width, height }) {
function checkArg (arg) {
if (typeof arg !== 'number' || arg <= 0) {
throw TypeError('Arguments must be {width, height} with numbers > 0')
}
}

checkArg(width)
checkArg(height)
return this.addArguments(`--width=${width}`, `--height=${height}`)
Expand All @@ -324,7 +316,7 @@ class Options extends Capabilities {
* @param {...string} paths The paths to the extension XPI files to install.
* @return {!Options} A self reference.
*/
addExtensions(...paths) {
addExtensions (...paths) {
this.profile_().addExtensions(paths)
return this
}
Expand All @@ -335,7 +327,7 @@ class Options extends Capabilities {
* @return {!Options} A self reference.
* @throws {TypeError} if either the key or value has an invalid type.
*/
setPreference(key, value) {
setPreference (key, value) {
if (typeof key !== 'string') {
throw TypeError(`key must be a string, but got ${typeof key}`)
}
Expand Down Expand Up @@ -363,7 +355,7 @@ class Options extends Capabilities {
* @return {!Options} A self reference.
* @throws {TypeError} if profile is not a string.
*/
setProfile(profile) {
setProfile (profile) {
if (typeof profile !== 'string') {
throw TypeError(`profile must be a string, but got ${typeof profile}`)
}
Expand All @@ -373,18 +365,18 @@ class Options extends Capabilities {

/**
* Sets the binary to use. The binary may be specified as the path to a
* Firefox executable or a desired release {@link Channel}.
* Firefox executable.
*
* @param {(string|!Channel)} binary The binary to use.
* @param {(string)} binary The binary to use.
* @return {!Options} A self reference.
* @throws {TypeError} If `binary` is an invalid type.
*/
setBinary(binary) {
setBinary (binary) {
if (binary instanceof Channel || typeof binary === 'string') {
this.firefoxOptions_().binary = binary
return this
}
throw TypeError('binary must be a string path or Channel object')
throw TypeError('binary must be a string path ')
}

/**
Expand All @@ -393,7 +385,7 @@ class Options extends Capabilities {
* @param {string} androidPackage The package to use
* @return {!Options} A self reference
*/
enableMobile(
enableMobile (
androidPackage = 'org.mozilla.firefox',
androidActivity = null,
deviceSerial = null
Expand All @@ -412,15 +404,15 @@ class Options extends Capabilities {
/**
* Enables moz:debuggerAddress for firefox cdp
*/
enableDebugger() {
enableDebugger () {
return this.set('moz:debuggerAddress', true)
}

/**
* Enable bidi connection
* @returns {!Capabilities}
*/
enableBidi() {
enableBidi () {
return this.set('webSocketUrl', true)
}
}
Expand All @@ -446,7 +438,7 @@ const Context = {
* @return {!Promise<?string>} A promise for the located executable.
* The promise will resolve to {@code null} if Firefox was not found.
*/
function findInProgramFiles(file) {
function findInProgramFiles (file) {
let files = [
process.env['PROGRAMFILES'] || 'C:\\Program Files',
process.env['PROGRAMFILES(X86)'] || 'C:\\Program Files (x86)',
Expand All @@ -455,8 +447,8 @@ function findInProgramFiles(file) {
return exists
? files[0]
: io.exists(files[1]).then(function (exists) {
return exists ? files[1] : null
})
return exists ? files[1] : null
})
})
}

Expand All @@ -473,7 +465,7 @@ const ExtensionCommand = {
* @param {!Promise<string>} serverUrl The server's URL.
* @return {!command.Executor} The new command executor.
*/
function createExecutor(serverUrl) {
function createExecutor (serverUrl) {
let client = serverUrl.then((url) => new http.HttpClient(url))
let executor = new http.Executor(client)
configureExecutor(executor)
Expand All @@ -484,7 +476,7 @@ function createExecutor(serverUrl) {
* Configures the given executor with Firefox-specific commands.
* @param {!http.Executor} executor the executor to configure.
*/
function configureExecutor(executor) {
function configureExecutor (executor) {
executor.defineCommand(
ExtensionCommand.GET_CONTEXT,
'GET',
Expand Down Expand Up @@ -520,7 +512,7 @@ class ServiceBuilder extends remote.DriverService.Builder {
* @param {string=} opt_exe Path to the server executable to use. If omitted,
* the builder will attempt to locate the geckodriver on the system PATH.
*/
constructor(opt_exe) {
constructor (opt_exe) {
super(opt_exe)
this.setLoopback(true) // Required.
}
Expand All @@ -532,7 +524,7 @@ class ServiceBuilder extends remote.DriverService.Builder {
* default, only debug logging is enabled.
* @return {!ServiceBuilder} A self reference.
*/
enableVerboseLogging(opt_trace) {
enableVerboseLogging (opt_trace) {
return this.addArguments(opt_trace ? '-vv' : '-v')
}
}
Expand Down Expand Up @@ -563,7 +555,7 @@ class Driver extends webdriver.WebDriver {
* configured to use the legacy FirefoxDriver from the Selenium project.
* @return {!Driver} A new driver instance.
*/
static createSession(opt_config, opt_executor) {
static createSession (opt_config, opt_executor) {
let caps =
opt_config instanceof Capabilities ? opt_config : new Options(opt_config)

Expand Down Expand Up @@ -612,14 +604,14 @@ class Driver extends webdriver.WebDriver {
* implementation.
* @override
*/
setFileDetector() {}
setFileDetector () {}

/**
* Get the context that is currently in effect.
*
* @return {!Promise<Context>} Current context.
*/
getContext() {
getContext () {
return this.execute(new command.Command(ExtensionCommand.GET_CONTEXT))
}

Expand All @@ -637,7 +629,7 @@ class Driver extends webdriver.WebDriver {
*
* @param {!Promise<void>} ctx The context to switch to.
*/
setContext(ctx) {
setContext (ctx) {
return this.execute(
new command.Command(ExtensionCommand.SET_CONTEXT).setParameter(
'context',
Expand All @@ -660,7 +652,7 @@ class Driver extends webdriver.WebDriver {
* newly installed addon.
* @see #uninstallAddon
*/
async installAddon(path, temporary = false) {
async installAddon (path, temporary = false) {
let stats = fs.statSync(path)
let buf
if (stats.isDirectory()) {
Expand All @@ -685,7 +677,7 @@ class Driver extends webdriver.WebDriver {
* completed.
* @see #installAddon
*/
async uninstallAddon(id) {
async uninstallAddon (id) {
id = await Promise.resolve(id)
return this.execute(
new command.Command(ExtensionCommand.UNINSTALL_ADDON).setParameter(
Expand All @@ -700,15 +692,17 @@ class Driver extends webdriver.WebDriver {
* Provides methods for locating the executable for a Firefox release channel
* on Windows and MacOS. For other systems (i.e. Linux), Firefox will always
* be located on the system PATH.
*
* @deprecated Instead of using this class, you should configure the
* {@link Options} with the appropriate binary location or let Selenium
* Manager handle it for you.
* @final
*/
class Channel {
/**
* @param {string} darwin The path to check when running on MacOS.
* @param {string} win32 The path to check when running on Windows.
*/
constructor(darwin, win32) {
constructor (darwin, win32) {
/** @private @const */ this.darwin_ = darwin
/** @private @const */ this.win32_ = win32
/** @private {Promise<string>} */
Expand All @@ -724,7 +718,7 @@ class Channel {
* @return {!Promise<string>} A promise for the location of the located
* Firefox executable.
*/
locate() {
locate () {
if (this.found_) {
return this.found_
}
Expand Down Expand Up @@ -759,7 +753,7 @@ class Channel {
}

/** @return {!Promise<string>} */
[Symbols.serialize]() {
[Symbols.serialize] () {
return this.locate()
}
}
Expand All @@ -782,7 +776,7 @@ Channel.DEV = new Channel(
* @see <https://www.mozilla.org/en-US/firefox/channel/desktop/#beta>
*/
Channel.BETA = new Channel(
'/Applications/Firefox.app/Contents/MacOS/firefox-bin',
'/Applications/Firefox.app/Contents/MacOS/firefox',
'Mozilla Firefox\\firefox.exe'
)

Expand All @@ -792,7 +786,7 @@ Channel.BETA = new Channel(
* @see <https://www.mozilla.org/en-US/firefox/desktop/>
*/
Channel.RELEASE = new Channel(
'/Applications/Firefox.app/Contents/MacOS/firefox-bin',
'/Applications/Firefox.app/Contents/MacOS/firefox',
'Mozilla Firefox\\firefox.exe'
)

Expand Down

0 comments on commit 6c3110a

Please sign in to comment.