gecko-dev/testing/geckodriver/CHANGES.md

Change log

All notable changes to this program is documented in this file.

Unreleased

Added

• Support for WebDriver web element, web frame, and web window identifiers from Firefox.

0.21.0 (2018-06-15)

Note that with this release of geckodriver the minimum recommended Firefox and Selenium versions have changed:

• Firefox 57 (and greater)
• Selenium 3.11 (and greater)

Added

• Support for the chrome element identifier from Firefox.

• The unhandledPromptBehavior capability now accepts accept and notify, dismiss and notify, and ignore options.

  Note that the unhandled prompt handler is not fully supported in Firefox at the time of writing.

Changed

• Firefox will now be started with the -foreground and -no-remote flags if they have not already been specified by the user in moz:firefoxOptions.

  -foreground will ensure the application window gets focus when Firefox is started, and -no-remote will prevent remote commands to this instance of Firefox and also ensure we always start a new instance.

• WebDriver commands that do not have a return value now correctly return {value: null} instead of an empty dictionary.

• The HTTP server now accepts Keep-Alive connections.

• Firefox remote protocol command mappings updated.

  All Marionette commands changed to make use of the WebDriver: prefixes introduced with Firefox 56.

• Overhaul of Firefox preferences.

  Already deprecated preferences in Firefox versions earlier than 57 got removed.

• webdriver crate upgraded to 0.36.0.

Fixed

• Force use of IPv4 network stack.

  On certain system configurations, where localhost resolves to an IPv6 address, geckodriver would attempt to connect to Firefox on the wrong IP stack, causing the connection attempt to time out after 60 seconds. We now ensure that geckodriver uses IPv4 consistently to both connect to Firefox and for allocating a free port.

• geckodriver failed to locate the correct Firefox binary if it was found under a firefox or firefox-bin directory, depending on the system, because it thought the parent directory was the executable.

• On Unix systems (macOS, Linux), geckodriver falsely reported non-executable files as valid binaries.

• When stdout and stderr is redirected by geckodriver, a bug prevented the redirections from taking effect.

0.20.1 (2018-04-06)

Fixed

• Avoid attempting to kill Firefox process that has stopped.

  With the change to allow Firefox enough time to shut down in 0.20.0, geckodriver started unconditionally killing the process to reap its exit status. This caused geckodriver to inaccurately report a successful Firefox shutdown as a failure.

  The regression should not have caused any functional problems, but the termination cause and the exit status are now reported correctly.

0.20.0 (2018-03-08)

Added

• New --jsdebugger flag to open the Browser Toolbox when Firefox launches. This is useful for debugging Marionette internals.

• Introduced the temporary, boolean capability moz:useNonSpecCompliantPointerOrigin to disable the WebDriver conforming behavior of calculating the Pointer Origin.

Changed

• HTTP status code for the StaleElementReference error changed from 400 (Bad Request) to 404 (Not Found).

• Backtraces from geckodriver no longer substitute for missing Marionette stacktraces.

• webdriver crate upgraded to 0.35.0.

Fixed

• The Firefox process is now given ample time to shut down, allowing enough time for the Firefox shutdown hang monitor to kick in.

  Firefox has an integrated background monitor that observes long-running threads during shutdown. These threads will be killed after 63 seconds in the event of a hang. To allow Firefox to shut down these threads on its own, geckodriver has to wait that time and some additional seconds.

• Grapheme clusters are now accepted as input for keyboard input to actions.

  Input to the value field of the keyDown and keyUp action primitives used to only accept single characters, which means geckodriver would error when a valid grapheme cluster was sent in, for example with the tamil nadu character U+0BA8 U+0BBF.

  Thanks to Greg Fraley for fixing this bug.

• Improved error messages for malformed capability values.

0.19.1 (2017-10-30)

Changed

• Search suggestions in the location bar turned off as not to trigger network connections

• Block addons incompatible with E10s

Fixed

• Marionette stacktraces are now correctly propagated

• Some error messages have been clarified

Removed

• Removed obsolete socksUsername and socksPassword proxy configuration keys because neither were picked up or recognised

0.19.0 (2017-09-16)

Note that with geckodriver 0.19.0 the following versions are recommended:

• Firefox 55.0 (and greater)
• Selenium 3.5 (and greater)

Added

• Added endpoint:

  • POST /session/{session id}/window/minimize for the Minimize Window command

• Added preference extensions.shield-recipe-client.api_url to disable shield studies which could unexpectedly change the behavior of Firefox

• Introduced the temporary, boolean capability moz:webdriverClick to enable the WebDriver conforming behavior of the Element Click command

• Added crashreporter environment variables to better control the browser in case of crashes

• Added preference dom.file.createInChild set to true to allow file object creation in content processes

Changed

• Log all used application arguments and not only -marionette

• Early abort connection attempts to Marionette if the Firefox process closed unexpectetly

• Removed deprecated socksProxyVersion in favor of socksVersion

• Removed ftpProxyPort, httpProxyPort, sslProxyPort, and socksProxyPort because ports have to be set for ftpProxy, httpProxy, sslProxy, and socksProxy using ":"

• The proxyType noproxy has been replaced with direct in accordance with recent WebDriver specification changes

• The WindowRectParameters have been updated to return signed 32-bit integers in accordance with the CSS and WebDriver specifications, and to be more liberal with the input types

• Mapped the FullscreenWindow to the correct Marionette command

• To make sure no browser process is left behind when the NewSession fails, the process is closed immediately now

• /moz/addon/install command accepts an addon parameter, in lieu of path, containing an addon as a Base64 string (fixed by Jason Juang)

• webdriver crate upgraded to version 0.31.0

• mozrunner crate upgraded to version 0.5.0

Removed

• Removed the following obsolete preferences for Firefox:
  • browser.safebrowsing.enabled
  • browser.safebrowsing.forbiddenURIs.enabled
  • marionette.defaultPrefs.port
  • marionette.logging

0.18.0 (2017-07-10)

Changed

• RectResponse permits returning floats for width and height fields

• New type CookieResponse for the GetNamedCookie command returns a single cookie, as opposed to an array of a single cookie

• To pick up a prepared profile from the filesystem, it is now possible to pass ["-profile", "/path/to/profile"] in the args array on moz:firefoxOptions

• geckodriver now recommends Firefox 53 and greater

• Version information (--version) contains the hash from from the commit used to build geckodriver

• geckodriver version logged on startup

• webdriver crate upgraded to version 0.27.0

• mozrunner crate upgraded to version 0.4.1

Fixed

• The SetTimeouts command maps to the Marionette setTimeouts command, which makes geckodriver compatible with Firefox 56 and greater

• Linux x86 (i686-unknown-linux-musl) builds are fixed

0.17.0 (2017-06-09)

Added

• Added endpoints:
  • POST /session/{session id}/window/fullscreen to invoke the window manager-specific full screen operation
  • POST /session/{session id}/moz/addon/install to install an extension (Gecko only)
  • POST /session/{session id}/moz/addon/uninstall to uninstall an extension (Gecko only)

Changed

• Increasing the length of the network.http.phishy-userpass-length preference will cause Firefox to not prompt when navigating to a website with a username or password in the URL

• Library dependencies upgraded to mozrunner 0.4 and mozprofile 0.3 to allow overriding of preferences via capabilities if those have been already set in the profile

• Library dependencies upgraded to mozversion 0.1.2 to only use the normalized path of the Firefox binary for version checks but not to actually start the browser, which broke several components in Firefox on Windows

Fixed

• The [SetWindowRect] command now returns the [WindowRectResponse] when it is done

• Use ASCII versions of array symbols to properly display them in the Windows command prompt

• Use SessionNotCreated error instead of UnknownError if there is no current session

0.16.1 (2017-04-26)

Fixed

• Read Firefox version number from stdout when failing to look for the application .ini file (fixes Selenium #3884)

• Session is now ended when closing the last Firefox window (fixes #613)

0.16.0 (2017-04-21)

Note that geckodriver v0.16.0 is only compatible with Selenium 3.4 and greater.

Added

• Support for WebDriver-conforming New Session negotiation, with desiredCapabilities/requiredCapabilities negotiation as fallback

• Added two new endpoints:

  • GET /session/{session id}/window/rect for Get Window Rect
  • POST /session/{session id}/window/rect for Set Window Rect

• Align errors with the WebDriver errors:

  • Introduces new errors ElementClickIntercepted, ElementNotInteractable, InvalidCoordinates, NoSuchCookie, UnableToCaptureScreen, and UnknownCommand
  • Removes ElementNotVisible and InvalidElementCoordinates errors

Removed

• Removed following list of unused endpoints:
  • GET /session/{session id}/alert_text
  • POST /session/{session id}/alert_text
  • POST /session/{session id}/accept_alert
  • POST /session/{session id}/dismiss_alert
  • GET /session/{session id}/window_handle
  • DELETE /session/{session id}/window_handle
  • POST /session/{session id}/execute_async
  • POST /session/{session id}/execute

Changed

• SendKeysParameters, which is used for the [Element Send Keys] and Send Alert Text commands, has been updated to take a string text field

• CookieResponse and CloseWindowResponse fixed to be properly wrapped in a value field, like other responses

• Allow negative numbers for x and y fields in pointerMove action

• Disable Flash and the plugin container in Firefox by default, which should help mitigate the “Plugin Container for Firefox has stopped wroking” problems many users were reporting when deleting a session

• Preferences passed in a profile now take precedence over set of default preferences defined by geckodriver (fixed by Marc Fisher)

  • The exceptions are the marionette.port and marionette.log.level preferences and their fallbacks, which are set unconditionally and cannot be overriden

• Remove default preference that disables unsafe CPOW checks

• WebDriver library updated to 0.25.2

Fixed

• Fix for the “corrupt deflate stream” exception that sometimes occured when trying to write an empty profile by @kirhgoph

• Recognise sslProxy and sslProxyPort entries in the proxy configuration object (fixed by Jason Juang)

• Fix “httpProxyPort was not an integer” error (fixed by Jason Juang)

• Fix broken unmarshaling of Get Timeouts response format from Firefox 52 and earlier (fixed by Jason Juang)

• Allow preferences in moz:firefoxOptions to be both positive- and negative integers (fixed by Jason Juang)

• Allow IPv6 hostnames in the proxy configuration object

• i686-unknown-linux-musl (Linux 32-bit) build fixed

• Log messages from other Rust modules are now ignored

• Improved log messages to the HTTPD

0.15.0 (2017-03-08)

Added

• Added routing and parsing for the Get Timeouts command

Changed

• All HTTP responses are now wrapped in {value: …} objects per the WebDriver specification; this may likely require you to update your client library

• Pointer move action’s element key changed to origin, which lets pointer actions originate within the context of the viewport, the pointer’s current position, or from an element

• Now uses about:blank as the new tab document; this was previously disabled due to bug 1333736 in Marionette

• WebDriver libary updated to 0.23.0

Fixed

• Aligned the data structure accepted by the Set Timeouts command with the WebDriver specification

0.14.0 (2017-01-31)

Changed

• Firefox process is now terminated and session ended when the last window is closed

• WebDriver library updated to version 0.20.0

Fixed

• Stacktraces are now included when the error originates from within the Rust stack

• HTTPD now returns correct response headers for Content-Type and Cache-Control thanks to Mike Pennisi

0.13.0 (2017-01-06)

Changed

• When navigating to a document with an insecure- or otherwise invalid TLS certificate, an insecure certificate error will be returned

• On macOS, deducing Firefox’ location on the system will look for firefox-bin on the system path (PATH environmental variable) before looking in the applications folder

• Window position coordinates are allowed to be negative numbers, to cater for maximised window positioning on Windows

• WebDriver library updated to version 0.18.0

Fixed

• Check for single-character key codes in action sequences now counts characters instead of bytes

0.12.0 (2017-01-03)

Added

• Added Take Element Screenshot command

• Added new Status command

• Added routing for the Get Timeouts command, but it is not yet implemented in Marionette, and will return an unsupported operation error until it is

• Implemented routing for new actions API, but it too is not yet fully implemented in Marionette

Changed

• Synced Firefox preferences with those used in Mozilla automation

• Default log level for debug builds of Firefox, which used to be DEBUG, changed to INFO-level

• WebDriver library dependency upgraded to 0.17.1

• Using session not created error when failing to start session

• geckodriver will exit with exit code 69 to indicate that the port is unavailable

Fixed

• Improved logging when starting Firefox

• Reverted to synchronous logging, which should address cases of inconsistent output when failing to bind to port

• Clarified in README that geckodriver is not supported on Windows XP

• Added documentation of supported capabilities to README

• Included capabilities example in the README

0.11.1 (2016-10-10)

Fixed

• Version number in binary now reflects the release version

0.11.0 (2016-10-10)

Added

• Introduced continous integration builds for Linux- and Windows 32-bit binaries

• Added commands for setting- and getting the window position

• Added new extension commands for finding an element’s anonymous children and querying its attributes; accessible through the /session/{sessionId}/moz/xbl/{elementId}/anonymous_children to return all anonymous children and /session/{sessionId}/moz/xbl/{elementId}/anonymous_by_attribute to return an anonymous element by a name and attribute query

• Introduced a moz:firefoxOptions capability to customise a Firefox session:

  • The binary, args, and profile entries on this dictionary is equivalent to the old firefox_binary, firefox_args, and firefox_profile capabilities, which have now all been removed

  • The log capability takes a dictionary such as {log: "trace"} to enable trace level verbosity in Gecko

  • The prefs capability lets you define Firefox preferences through capabilities

• Re-introduced the --webdriver-port argument as a hidden alias to --port

Changed

• firefox_binary, firefox_args, and firefox_profile capabilities removed in favour of the moz:firefoxOptions dictionary detailed above and in the README

• Removed --no-e10s flag, and geckodriver will from now rely on the Firefox default multiprocessing settings (override using preferences)

• Disable pop-up blocker in the default profile by @juangj

• Changed Rust compiler version to 1.12 (beta) temporarily because of trouble linking Musl binaries

• Replaced env_logger logging facility with the slog package, causing the RUST_LOG environment variable to no longer have any affect

• Updated the WebDriver Rust library to version 0.15

Fixed

• Corrected link to repository in Cargo metadata

• Verbosity shorthand flag -v[v] now works again, following the replacement of the argument parsing library in the previous release

• When the HTTPD fails to start, errors are propagated to the user

• Disabled the additional welcome URL (startup.homepage_welcome_url.additional) so that officially branded Firefox builds do not start with two open tabs in fresh profiles

• Disabled homepage override URL redirection on milestone upgrades, which means a tab with an upgrade notice is not displayed when launching a new Firefox version

0.10.0 (2016-08-02)

Changed

• Use multi-process Firefox (e10s) by default, added flag --no-e10s to disable it and removed --e10s flag

• Disable autofilling of forms by default by Sven Jost

• Replace argparse with clap for arguments parsing

Fixed

• Attempt to deploy a single file from Travis when making a release

• Grammar fix in README

0.9.0 (2016-06-30)

Added

• Add ability to use firefox_binary capability to define location of Firefox to use

• Automatically detect the default Firefox path if one is not given

• Cross-compile to Windows and ARMv7 (HF) in CI

• Add Musl C library-backed static binaries in CI

• Add -v, -vv, and --log LEVEL flags to increase Gecko verbosity

• Add Get Element Property endpoint

• Add new --version flag showing copying information and a link to the repository

Changed

• Now connects to a Marionette on a random port by default

• Update webdriver-rust library dependency

• Migrated to use Travis to deploy new releases

• Reduced amount of logging

• Introduced a changelog (this)

0.8.0 (2016-06-07)

Added

• Allow specifying array of arguments to the Firefox binary through the firefox_args capability

• Pass parameters with New Session command

Changed

• Change product name to geckodriver

• Make README more exhaustive

• Quit Firefox when deleting a session

• Update webdriver-rust library

• Update dependencies

Fixed

• Fix tests

• FIx typo in error message for parsing errors

0.7.1 (2016-04-27)

Added

• Add command line flag for using e10s enabled Firefox by Kalpesh Krishna

• Allow providing custom profiles

Changed

• Allow binding to an IPv6 address by Jason Juang

• By default, connect to host-agnostic localhost by Jason Juang

• Make GeckoContextParameters public

• Update dependencies

Fixed

• Squash rustc 1.6 warnings by using std::thread::sleep(dur: Duration)

0.6.2 (2016-01-20)

Added

• Add LICENSE file from [Joshua Burning]

• Schedule builds in CI on pushes and pull requests

Changed

• Enable CPOWs in Marionette

0.6.0 (2016-01-12)

Added

• Add Get Page Source endpoint

Changed

• Handle arrays being sent from Marionette

• Correct build steps in README

• Update what properties are read from errors sent by Marionette

• Update dependencies

0.5.0 (2015-12-10)

Changed

• Update argparse dependency to use Cargo

• Update to the latest version of the Marionette wire protocol

• Update to latest webdriver-rust library

• Update dependencies

0.4.2 (2015-10-02)

Changed

• Skip compiling optional items in hyper

0.4.1 (2015-10-02)

Changed

• Update webdriver-rust library

• Update dependencies

0.4.0 (2015-09-28)

Added

• Add command extensions for switching between content- and chrome contexts

• Add more documentation from Vlad Filippov

Changed

• Update Cargo.lock with new dependencies for building

• Update for protocol updates that flatten commands

• Update to new protocol error handling

• Update for Marionette protocol version 3 changes

• Strip any leading and trailing {} from the sessionId Marionette returns

• Update dependencies

Fixed

• Fix GetCSSValue message to send correct key propertyName

• Fix example in documentation from @vladikoff

0.3.0 (2015-08-17)

Added

• Add support for finding elements in subtrees

0.2.0 (2015-05-20)

Added

• Extra debug messages

• Add ability to set WebDriver port

• Add support for getting the active element

• Add support for GetCookies and DeleteCookie/DeleteCookies

• Add preferences that switch off certain features not required for WebDriver tests

Changed

• Make failing to communicate with Firefox a fatal error that closes the session

• Shut down session only when loosing connection

• Better handling of missing command line flags

• Poll for connection every 100ms rather than every 100s

• Switch to string-based error codes

• Switch webdriver-rust library dependency to be pulled from git

• Update dependencies

Fixed

• Handle null id for switching to frame more correctly

0.1.0 (2015-04-09)

Added

• Add proxy for converting WebDriver HTTP protocol to Marionette protocol

• Add endpoints for modal dialogue support

• Allow connecting to a running Firefox instance

• Add explicit Cargo.lock file

• Start Firefox when we get a [NewSession] command

• Add flag parsing and address parsing

• Add basic error handling

Changed

• Update for Rust beta

• Switch to new IO libraries

• Pin webdriver-rust commit so we can upgrade rustc versions independently

• Set preferences when starting Firefox

• Improve some error messages

• Re-enable environment variable based logging

Fixed

• Fix Get Element Rect command to return floats instead of integers

• Fix passing of web elements to Switch To Frame command

• Fix serialisation of script commands

• Fix assorted bugs found by the Selenium test suite

• Fix conversion of Find Element/Find Elements responses from Marionette to WebDriver

• Fixed build by updating Cargo.lock with new dependencies for building

• Squash compile warnings