Selenium.WebDriver

• Bump version to a better approximation of pi.
• Refined W3C-compliant ActionBuilder API for .NET.
• Updated .NET RemoteSessionSettings to properly return capabilities by index.
• Fixed RemoteWebElement.Equals to use remote call only if not W3C compliant.
• Added WebDriverException for mouse move out of bounds error.
• Modified the .NET test suite to properly ignore and unignore passing . and failing tests.
• Adding method for executing Chrome DevTools command with result.
• Added ability to use chromedriver in spec-compliant mode.

• Refactored .NET capability handling. This version introduces a large and intrusive refactor of the .NET bindings' capability handling. It introduces a new class, RemoteSessionSettings, for use with creating remote sessions via RemoteWebDriver. Additionally, the DesiredCapabilities class is now marked as deprecated and will generate a compile warning on its use.

  Almost without exception, users should not be using DesiredCapabilities in .NET. The browser-specific options classes provide functionality for adding any additional capabilities that would need to be sent to a remote end. One possible exception is when using RemoteWebDriver to connect to a remote server implementation, where the ToCapabilites method has been called, but the user wants to add additional capabilities, even though they could and should have been added before calling the method. In a future release, calling ToCapabilities will result in a read-only capabilities object, but recognizing that many users already have existing code that does this, moving immediately to make the returned object read-only is premature. For the moment, then, the SetCapabilty method is now marked as deprecated on DesiredCapabilities. In the next version of the .NET bindings, the return from ToCapabilities will be changed to return a read-only object.

  The RemoteSessionSettings class is designed for use cases where the user wants to create a remote session using RemoteWebDriver where all of the nodes in the session creation support the W3C WebDriver Specification dialect of the wire protocol. This class is designed to be used in conjunction with the browser-specific driver options classes for matching capabilities on the remote end.

  For single-browser cases, it is still possible (though unnecessary) to use a browser-specific driver options class (ChromeOptions, FirefoxOptions, etc.) by calling the ToCapabilities() method, but as previously mentioned, in the future, the capabilities returned will be read-only, and will not be able to be added to. Users who feel the need to modify the options class after converting to capabilities are encouraged to add the additional capabilities to the options class before the conversion by appropriate use of the AddAdditionalCapability method.

• Exposed additional extension points to better control HTTP communications between the language bindings and the remote end implementation. For the .NET implementation of HttpCommandExecutor, we now expose a Proxy property for proxying requests between the .NET code and the remote end WebDriver implementation. Note carefully that this is entirely separate from the proxy used by the browser for monitoring communications between the browser and the server hosting the page being automated.

  Additionally, this change exposes the IsKeepAliveEnabled property to make it easier to set whether or not the "keep alive" header is sent when communicating between the language bindings and the remote end WebDriver implementation.

  Finally, for local use, the DriverServiceCommandExecutor now exposes a property to allow the user to set tho newly-exposed properties by allowing access to the internal HttpCommandExecutor of the driver service.

• Added a workaround for Safari Tech Preview to send the proper browser name to the driver.

• Added type-safe properties for Safari capabilities in .NET SafariOptions.

• Marked .NET hardware manipulation interfaces deprecated. The Mouse Keyboard, and TouchScreen properties were never intended for direct use in users' code. These interfaces, and the properties that reference them, are now being marked as deprecated. The correct way to simulate advanced user input is to use the Actions or ActionBuilder classes.

• Removed long-deprecated local PhantomJS support from .NET, as well as other deprecated code.

• Updated to fully remove use of internal CreateElement method in favor of a factory object.

• (on behalf of Jake Durand) Replaced Chrome with Firefox in .NET documentation comments.
• (on behalf of Michael Keeley) Modified to allow extension of RemoteWebElement for caching properties. This approach is not one with which the Selenium development team is entirely comfortable, and downstream projects are strongly encouraged to prefer composition over inheritance.
• Reinstated ICommandExecutor descending from IDisposable. Now that the Appium project has implemented the methods required by an implementation of IDisposable, this change can be made upstream in the Selenium project. As this change has been rolled back once before to accommodate downstream projects, it will be incumbent upon them to update their libraries now, as it will not be rolled back again. In the case of Appium, this is merely awaiting a binary release; other downstream projects will be responsible for managing their own code changes and release schedule.
• Removed legacy WebDriver extension when using Geckodriver. When a FirefoxProfile object is created in the .NET bindings, the legacy WebDriver extension is included in that profile by default. This includes the case where the user is using Geckodriver. When using Geckodriver, the legacy extension is doing nothing more than taking up space. This commit adds an internal method to detect when a FirefoxProfile object is being used with geckodriver, and removes the extension from the list of extensions in the profile before the profile is serialized to disk, and subsequently to a base64-encoded string for transmission over the wire to geckodriver. Fixes issue #6043.
• Updated EdgeOptions to include type-safe properties for Edge-specific capabilities.
• Added property to force use of legacy protocol for Safari. Starting with Safari Technology Preview 58, and continuing with the driver released with Safari 12, the driver executable uses the W3C Specification dialect of the prototcol by default. It includes a command-line switch, however, to force the use of the legacy open-source project dialect of the protocol. This commit adds a property to the SafariDriverService object allowing users to set that command-line switch. Note that if this property (false by default) is set to true for a version of the driver that does not support the switch, it will cause errors. If set to false, the .NET bindings do not modify the safaridriver command line at all.
• Fixed mouse movement in .NET. The previous commit to the mouse movement for .NET changed the optional element ID from null to the empty string. This is incorrect. If no element is specified in the move (for non-spec-compliant driver), omit the ID altogether.
• Fixed null pointer exception for .NET on Safari with mouse movements.
• (on behalf of Clay Martin) Fixed quit command for default state of Edge driver.

• Updated .NET escaping of CSS selectors for the find-by-ID and find-by-name cases. This is especially important for drivers that adhere to the W3C WebDriver Specification.
• The .NET bindings no longer swallow exceptions for navigation to malformed URLs.
• Added inadvertently omitted FirefoxDriver constructor for .NET. To maintain consistency with other drivers, we are adding a constructor that takes a FirefoxDriverService and a FirefoxOptions. All other drivers have a "service and options" constructor, making Firefox the outlier.
• Updated use of command-line args for protocol selection for Edge in .NET. The UseSpecCompliantProtocol property of the EdgeDriverService object now is a nullable boolean instead of just a boolean. If the property is assigned a value (true or false), it will add the appropriate command-line argument ("--w3c" or "--jwp", respectively) to the executable command line. Users using versions of MicrosoftWebDriver.exe that do not support those command-line arguments should leave the property unset (as a null value).

• Updated unhandled JavaScript errors to throw WebDriverException in .NET.
• Added option for .NET EdgeDriverService to use W3C protocol dialect. The Microsoft Edge driver specifies the use of the W3C WebDriver Specification dialect of the JSON wire protocol via a command-line switch. This commit exposes that behavior in the form of a property on the EdgeDriverService object. Note that this command-line switch is only valid for versions of the driver executable for Windows 10 versions later than the 2018 Fall Creators' Update version (this is the code-named "Redstone 4", or "RS4" builds). Attempting to use this property with versions of MicrosoftWebDriver.exe before RS4 will result in errors, as the driver executable will not start properly with an unknown command-line switch. This commit also makes use of the fact that in RS4 and beyond, the driver executable is a feature that is installed in the OS, not a separate download, so the test projects have been updated to reflect this.
• Added default value to .NET IE element scroll behavior option.
• Changed 'unhandled error' status code to throw WebDriverException in .NET. Previously, this error code would throw an InvalidOperationException.
• (on behalf of Christopher Wood) Fixed ExecuteScript and Actions to handle IWrapsElement appropriately. Using EventFiringWebDriver, element targets and args throw exceptions when calling ExecuteScript or Actions methods. This is fixed by casting as IWrapsElement and checking for wrapped elements first. Fixes issue #5810.
• Refactored creation of RemoteWebElement to use a factory. Previously, the RemoteWebDriver class had a protected method called CreateElement that took the element ID as a parameter and returned a RemoteWebElement object. That approach is not flexible enough for some downstream projects that implement their own subclasses of RemoteWebDriver and RemoteWebElement. To rectify that, this commit replaces the calling of CreateElement with the use of a RemoteWebElementFactory class that handles the creation of RemoteWebElements. Note carefully that the CreateElement method still exists, so as to prevent compile-time errors for downstream consumers, that method is no longer called. If you are a user who has overridden that method as part of your project, you'll need to create an implementation of RemoteWebElementFactory that creates your custom subclass of RemoteWebElement.
• (on behalf of Jacob Kiesel) Fixed obscure window switching bug. This change fixes searching by window name if the current window handle becomes invalid and the name being switched to does not exist.
• Fixed .NET HttpCommandExecutor event for RemoteWebDriver. This change moves the firing of the event raised before sending a remote HTTP request to before the setting of the request body. This allows the request settings to be properly set without throwing an exception. This commit also renames the event and event args object to SendingReomteHttpRequest and SendingRemoteHttpRequestEventArgs, respectively. The previous event and event args are marked as deprecated for removal in a future release, and the previously named event is now a no-op, and will never be fired, even if a handler is attached.

• Reverted change of ICommandExecutor interface to extend IDisposable. This change will reappear at some point. Downstream projects will need to implement a public void Dispose() method on any classes that implement ICommandExecutor to prevent breaking when this interface change is added again. Fixes issue #5768.

• Added option to tell ChromeDriver to use the W3C WebDriver protocol dialect instead of the legacy open-source dialect.

• (on behalf of Phillip Haydon) Updated doc strings for FirefoxDriver to no longer refer to ChromeDriver

• Corrected remote URL for IWebElement.GetScreenshot() method.

• Made ICommandExecutor interface extend IDisposable.

• Fixed serialization of proxy autoconfig URLs. Fixes issue #5050.

• Reverted .NET bindings to send spec-compliant new session for all browsers. Now that the Java remote server will correctly handle spec-compliant new session payload, even for browsers that are not yet spec-compliant, we can revert to the original behavior of sending both "capabilities" and "desiredCapabilities" properties with new session requests. Reverts commit 4ce57f6.

• Modified to guard against assembly location being empty. When looking for supporting files on disk, the bindings look in the "current working directory" where the assembly is written. However, if the assembly has been embedded in an executable as a resource, and extracted into memory at runtime, the location will be blank. This commit prevents the exception being thrown, at the expense of possibly looking in the wrong directory.

• Added locking for lazy-load of static dictionary. When running in parallel, there is a chance that multiple threads could attempt to populate a static dictionary used for translating error codes. This commit adds locking around the initialization of the static dictionary. Note that we are not using "double-check" locking, but the locking we use should be good enough. Fixes issue #3166.

• (On behalf of John Chen) Fixed ChromeDriver NetworkConditions setter. The JSON object generated by the .NET version of ChromeDriver NetworkConditions setter had incorrect format, and was rejected by ChromeDriver.

• Added sending a user-agent string for .NET remote HTTP requests to a remote end (Java standalone server, IEDriverServer.exe, chromedriver.exe, geckodriver.exe, etc.). Addresses #5657 for .NET.

• Fixed .NET ChromeDriver network conditions commands URLs. Fixes issue #5693.

• Added BeforeRemoteHttpRequest event to .NET RemoteWebDriver. This commit adds the ability for advanced users of the .NET bindings RemoteWebDriver class to modify the HTTP command sent from the .NET WebDriver code to the remote WebDriver server. Note carefully that this DOES NOT modify the HTTP request between the browser and the web server, and is not a mechanism for getting access to that HTTP request. Usage of this new event would look something like this:

  public void StartDriver() { HttpCommandExecutor executor = new HttpCommandExecutor( new Url("http://localhost:4444/wd/hub"), TimeSpan.FromSeconds(60)); executor.BeforeRemoteHttpRequest += BeforeRemoteHttpRequestHandler; ICapabilities capabilities = new ChromeOptions().ToCapabilities(); IWebDriver driver = new RemoteWebDriver(executor, capabilities); }

  public void BeforeRemoteHttpRequestHandler( object sender, BeforeRemoteHttpRequestEventArgs e) { // Note: WebRequest.DefaultWebProxy is an IWebProxy implementation. // This could be anything, from adding additional headers, to modifying // the content of the request. Use with extreme caution. e.Request.Proxy = WebRequest.DefaultWebProxy; e.Request.AutomaticDecompression = DecompressionMethods.GZip }

• (On behalf of Samuel Bétrisey) Add support for Basic Access Authentication in .NET RemoteWebDriver. The username and password of the Uri wasn't used by the HttpWebRequest. Usage example:

  new RemoteWebDriver(new Uri("http://user:pass@example.com/wd/hub"), DesiredCapabilities.Chrome());

• (On behalf of "granak") Null cookie value fix. Cookies with empty string values would throw exceptions.

• Enabled reconstitution of .NET FirefoxOptions from raw capabilities. This is a temporary measure until DesiredCapabilities is done away with for good. Fixes issue #4855.

• Modified to write screenshots using the Save overload that takes a System.IO.FileStream object. Rather than using the Image.Save overload that takes a string containing the file name, we should use a FileStream. The FileStream object handles validating the existence of the path to which one is attempting to write, so this will avoid the cryptic GDI+ error that occurs if the file already exists. Additionally, the SaveAsFile method now does what it says on the tin, that the file will be overwritten if it already exists. Fixes issue #4645.

• (On behalf of Sean Rand) Added overload argument to the SelectElement.SelectByText method. The XML summary informs that the method provides partial match ability on the options by Text. However this wasn't fully implemented so pushed the ability via a boolean to perform such a partial match on an options list. Fixes issue #3575.

• (On behalf of Sean Rand) Added test playlists for each .NET test project in the repo. This is to help aid running of all tests in a specific project. Originally, this was intended to simply add a playlist for the support tests but adding playlists for all of the test projects is a better approach. Fixes issue #3805.

• (On behalf of Arnon Axelrod) Added the new value of the element to the ElementValueChanged and ElementValueChanging event args. This commit also creates a new overload of OnElementChanging and OnElementChanged but also keeps the original overloads to preserve backward compatibility. Additionally, the original overloads are marked with the [Obsolete] attribute to let users know they should migrate to the new overloads.

• Fixed proxy bypass address serialization for legacy .NET drivers. The W3C WebDriver Specification states that the list of addresses to bypass in a proxy configuration should be an array. The legacy OSS dialect of the protocol specifies it must be a string. This commit fixes the serialization for the non-spec-compliant case, serializing it as a semicolon-separated list. Fixes issue #5645.

• Updating .NET to not propagate non-W3C compliant capability names. Fixes issue #5646.

• Added new property for geckodriver --jsdebugger command line switch to FirefoxDriverService object.

• (On behalf of Christopher Buttkus) Added LeftShift, LeftAlt, LeftControl, Command, and Meta as KeyDown/Up events for .NET

• (On behalf of "vflame") Added ability to install Firefox addon using manifest.json. Firefox addons/extensions built with WebExtensions API have a manifest.json instead of install.rdf. When Selenium extract the addon/ extension id, it only looked for install.rdf. This fix adds extracting the addon/extension id from the manifest.json in addition to install.rdf. Fixes issue #4093.

• (On behalf of Yevgeniy Shunevych) Fixed AddEncodedExtension methods of ChromeOptions and OperaOptions

• Updated .NET strong-named assembly build to correct package references. Fixes issue #5511.

• Updated WebDriverBackedSelenium .csproj file to embed resources. This step was omitted when the build process for the .NET bindings was migrated from crazy-fun to Buck. Fixes issue #5528.

• Streamlined Actions class. The Actions class will now throw an exception on instantiation if the IWebDriver instance passed into the constructor does not also implement IActionExecutor. This will help folks who wrap the standard WebDriver driver classes to be able to continue to work with the Actions class.

• Added support for intercepted element clicks. This adds a new exception, ElementClickInterceptedException to indicate when an element is obscured by another element. This allows users to distinguish between different causes of elements not being clickable.
• Marked .NET ExpectedConditions obsolete. Using the ExpectedConditions class provides no benefit over directly using lambda functions (anonymous methods) directly in one's code. Since the community appears to believe that an "official" repository of wait conditions is desirable, the existing code has been migrated to a new repository under a new organization on GitHub (https://github.com/DotNetSeleniumTools/DotNetSeleniumExtras). It is hoped that this will encourage a volunteer from the community to take ownership of this code. Users should update their references and migrate their code to use SeleniumExtras.ExpectedConditions. This implementation will be removed from the .NET language bindings in a future release
• Marked .NET PageFactory obsolete. The .NET implementation of PageFactory is deeply flawed. Additionally, using the PageFactory provides no benefit over other methods of Page Object creation in .NET. This is true for code verbosity as well, which is often the reason cited for wanting to use the PageFactory in .NET. The existing code has been migrated to a new repository under a new organization on GitHub (https://github.com/DotNetSeleniumTools/DotNetSeleniumExtras). It is hoped that this will encourage a volunteer from the community to take ownership of this code. Users should update their references and migrate their code to use SeleniumExtras.PageFactory. The implementation will be removed
• Updated .NET Actions class to change element offsets for W3C mouse move. When the Actions class performs a mouse move that includes a reference to an element and an x-y offset, the offsets are calculated differently depending on whether the remote end adheres to the W3C WebDriver Specification. In the W3C case, the offsets are calculated from the center of the element. This differs from the legacy behavior, which calculates offsets from the top-left corner of the element. This change uses the language bindings to allow the user to optionally choose which origin to use, and by default calculates all offsets from the upper-left, if not specified. This normalizes the mouse move behavior across all types of remote ends.

• Removed Proxy property from instance of HttpWebRequest in .NET. This fixes the case for .NET Core when running RemoteWebDriver by avoiding a platform-specific property of the ServicePoint object. This obviates the need for creating a custom IWebProxy implementation simply for fixing this issue, and prevents a bloat of the number of RemoteWebDriver constructors for creating an instance of that proxy object. While there may be a compelling use case for supporting an IWebProxy implementation for use with WebDriver to proxy communication between the language bindings and the driver, this use case is not it. Fixes issue #4770.
• (on behalf of dnknitro) Added no-cache header to HTTP GET command of RemoteWebDriver. When Selenium RemoteWebDriver is connecting to Selenium Server (e.g. SauceLabs) through HTTP proxy, same/repetitive HTTP commands can be cached by the proxy. This leads to unexpected and unwanted behavior that HTTP commands return cached and outdated data from the server (e.g. screenshots). Fixes issue #5404.
• Removed support for timeline perf logging preference in .NET ChromeDriver. According to chromedriver bug #2034 (https://bugs.chromium.org/p/chromedriver/issues/detail?id=2034), the enableTimeline performance logging preference is no longer accepted by chromedriver.exe. The .NET language bindings will no longer send that preference to the driver executable. Additionally, the property setting the preference has been deprecated, and will generate a compile-time warning. The property will be removed in a future release. Fixes issue #5481.

• Updated build process and packaging to correctly distribute strongly- named releases. Fixes issue #5254 (for real, this time). No functional changes whatsoever.

• Added commands to get and set network conditions for Chrome in .NET. To get or set the network conditions, use the NetworkConditions property of the ChromeDriver object. This property gets or sets a ChromeNetworkConditions object which contains the proper values. Fixes issue #5338.
• Re-added CLSCompliant attribute to .NET assemblies. When converting from the prior build system to using Buck and the dotnet build tools, the assembly-level CLSCompliant attribute was removed. This commit restores the CLSCompliant attribute to the assembly manifests. Fixes issue #5324.
• Removed check for leading hyphens in .NET FirefoxOptions AddArgument. In prior releases of geckodriver, it was a requirement that all arguments be preceded by double hyphens ("--"). Geckodriver has now relaxed that restriction, and the .NET bindings need to keep up with that change. This commit removes the check for leading hyphens when calling AddArgument.
• Fixed strong-named assembly references. In the move to using the dotnet build tools instead of calling the C# compiler directly, the creation of strong-named assemblies was broken with incorrect references being created. This commit fixes that problem. Fixes issue #5254.
• Exposed HostName property for .NET DriverService class. Previously, the host name for a DriverService was hard-coded to be "localhost." This is normally acceptable, as a DriverService is only intended to be used locally, and most executables that are represented by a DriverService (chromedriver, geckodriver, IEDriverServer.exe, etc.) do not even allow connections from external machines for security reasons. However, there is a legitimate use case (.NET Standard 2.0) where a local IP address ("127.0.0.1" or "::1") is preferable to using the "localhost" moniker. This HostName property allows the user to specify that IP address. Note that the property defaults to "localhost," preserving previous behavior.

• Updating .NET bindings setting of timeouts for spec-compliance. This also removes some obsolete API entry points that have been marked as deprecated for some months now. The properties of the ITimeouts object should be used.
• Updated .NET Options classes to better support W3C Capabilities.
• Added .NET constructors to FirefoxDriver to align with other browser drivers

• Made .NET Interactions device classes public. Fixes issue #3989.
• Reversed the default for whether a generated capabilities payload when creating a new session is a spec compliant payload. Fixes issue #4758.

Bug Fixes

• The Capabilities factory methods should only specify the name of the browser.
• Protect against the remote end sometimes not returning a list to findElements commands.
• Properly reset state in remote.DriverService#kill()
• The firefox module will no longer apply the preferences required by the legacy FirefoxDriver. These preferences were only required when using the legacy driver, support for which was dropped in v3.5.0.

API Changes

• Added new methods to selenium-webdriver/firefox.Options:
  • addArguments()
  • headless()
  • windowSize()
• Deprecated selenium-webdriver/firefox/binary.Binary
• Removed selenium-webdriver/firefox.Options#useGeckoDriver()
• Removed the unused selenium-webdriver/firefox/profile.decode()
• Removed methods from selenium-webdriver/firefox/profile.Profile that had no effect since support for the legacy FirefoxDriver was dropped in 3.5.0:
  • setNativeEventsEnabled
  • nativeEventsEnabled
  • getPort
  • setPort
• Removed selenium-webdriver/firefox.ServiceBuilder#setFirefoxBinary(); custom binaries should be configured through the firefox.Options class.
• Removed selenium-webdriver/firefox.Capability. These hold overs from the legacy FirefoxDriver are no longer supported.

Changes for W3C WebDriver Spec Compliance

• Deprecated error.ElementNotVisibleError in favor of the more generic error.ElementNotInteractableError.
• Support the httpOnly option when adding a cookie.

• Changed .NET ChromeOptions to use "goog:chromeOptions" as property name. This aligns with current chromedriver.exe expectations as well as with the W3C WebDriver Specification. It also means that the .NET bindings will now require 2.31 or later of chromedriver.exe.
• Guarding against null return value from FindElements. Fixes issue #4555 for .NET.
• Updating serialization of Proxy for W3C-compliant drivers in .NET. Fixes issue #4574 for .NET.
• Added support for W3C 'invalid argument' error code.
• Added GetProperty method to IWebElement.
• Added support for new new window commands (Minimize and FullScreen).
• Updated .NET FirefoxOptions to not force specifying binary location. In the Marionette/Geckodriver case, the service executable can locate the Firefox executable on its own when looking in default installation locations. There is no need for the language bindings to go spelunking through the registry in that case any longer because the bindings do not have to directly launch the Firefox executable.
• Committed initial support for .NET Core. This is only committed to the source repository; it is not yet released in any consumable binary form. This support will likely change significantly between now and when it is officially released. Please do not rely on it yet.

• Added ability to detect spec-compliant capabilities in .NET. This release updates the .NET DesiredCapabilities class to allow the language bindings to construct the correct type of payload for the new session command before sending the command to the remote end. This will remove the burden from intermediate nodes (like the Java standalone server and grid) from incorrectly parsing a driver using the legacy protocol dialect (Edge, Safari, Chrome) and throwing an error on session creation. Fixes issue #4443.
• Deprecated the static methods on the DesiredCapabilities class's methods for specific browsers in .NET. For over a year, the guidance for .NET users has been to use a browser-specific options class (FirefoxOptions, InternetExplorerOptions, etc.) to set specific capabilities for the driver to be instaniated. To use the options classes with the Java standalone remote server or grid, call the ToCapabilities method on the options object.
• Removed deprecated screenshot methods. These have been deprecated since 3.1.0.
• Removed IsJavaScriptEnabled property from DesiredCapabilities. Since virtually all driver implementations and all browsers support JavaScript and cannot run properly without it being enabled, this property is nearly useless. Use SetCapability("javascriptEnabled", true) if you require this functionality.

Notice

Native support for Firefox 45 (ESR) has been removed. Users will have to connect to a remote Selenium server that supports Firefox 45.

Changes

• Removed native support for Firefox 46 and older.
  • The SELENIUM_MARIONETTE environment variable no longer has an effect.
  • selenium-webdriver/firefox.Capability.MARIONETTE is deprecated.
  • selenium-webdriver/firefox.Options#useGeckoDriver() is deprecated and now a no-op.
• firefox.Options will no longer discard the "moz:firefoxOptions" set in user provided capabilities (via Builder.withCapabilities({})). When both are used, the settings in firefox.Options will be applied last.
• Added chrome.Options#headless() and chrome.Options#windowSize(), which may be used to start Chrome in headless mode (requires Chrome 59+) and to set the initial window size, respectively.

Changes for W3C WebDriver Spec Compliance

• Added error.WebDriverError#remoteStacktrace to capture the stacktrace reported by a remote WebDriver endpoint (if any).
• Fixed WebElement#sendKeys to send text as a string instead of an array of strings.

Notice

This release requires geckodriver 0.15.0 or newer.

API Changes

• Added Options#getTimeouts() for retrieving the currently configured session timeouts (i.e. implicit wait). This method will only work with W3C compatible WebDriver implementations.
• Deprecated the Timeouts class in favor of Options#setTimeouts(), which supports setting multiple timeouts at once.
• Added support for emulating different network conditions (e.g., offline, 2G, WiFi) on Chrome.

Changes for W3C WebDriver Spec Compliance

• Fixed W3C response parsing, which expects response data to always be a JSON object with a value key.
• Added W3C endpoints for interacting with various types of user prompts.
• Added W3C endpoints for remotely executing scripts.
• Added W3C endpoints to get current window handle and all windows handles.

• Added warning log messages when the user creates new managed promises, or schedules unchained tasks. Users may opt in to printing these log messages with

  const { logging } = require('selenium-webdriver')
  logging.installConsoleHandler()
  logging.getLogger('promise.ControlFlow').setLevel(logging.Level.WARNING)
  

• If the JAVA_HOME environment variable is set, use it to locate java.exe.

• Release skipped to stay in sync with the main Selenium project.

• The lib package is once again platform agnostic (excluding lib/devmode).
• Deprecated promise.when(value, callback, errback). Use promise.fulfilled(value).then(callback, errback)
• Changed promise.fulfilled(value), promise.rejected(reason) and promise.defer() to all use native promises when the promise manager is disabled.
• Properly handle W3C error responses to new session commands.
• Updated selenium-webdriver/testing to export describe.only along with describe.skip.
• Fixed selenium-webdriver/lib/until.ableToSwitchToFrame. It was previously dropping arguments and would never work.
• Added the ability to use Firefox Nightly
• If Firefox cannot be found in the default location, look for it on the PATH
• Allow SafariDriver to use Safari Technology Preview.
• Use the proper wire command for WebElement.getLocation() and WebElement.getSize() for W3C compliant drivers.

• More API adjustments to align with native Promises
  • Deprecated promise.fulfilled(value), use promise.Promise#resolve(value)
  • Deprecated promise.rejected(reason), use promise.Promise#reject(reason)
• When a wait() condition times out, the returned promise will now be rejected with an error.TimeoutError instead of a generic Error object.
• WebDriver#wait() will now throw a TypeError if an invalid wait condition is provided.
• Properly catch unhandled promise rejections with an action sequence (only impacts when the promise manager is disabled).

• (NOTICE) The minimum supported version of Node is now 6.9.0 LTS

• Removed support for the SafariDriver browser extension. This has been replaced by Apple's safaridriver, which is included with Safari 10 (available on OS X El Capitan and macOS Sierra).

  To use Safari 9 or older, users will have to use an older version of Selenium.

• geckodriver v0.11.0 or newer is now required for Firefox.

• Fixed potential reference errors in selenium-webdriver/testing when users create a cycle with mocha by running with mocha's --hook flag.

• Fixed WebDriver.switchTo().activeElement() to use the correct HTTP method for compatibility with the W3C spec.

• Update the selenium-webdriver/firefox module to use geckodriver's "moz:firefoxOptions" dictionary for Firefox-specific configuration values.

• Extending the selenium-webdriver/testing module to support tests defined using generator functions.

• The promise manager can be disabled by setting an environment variable: SELENIUM_PROMISE_MANAGER=0. This is part of a larger plan to remove the promise manager, as documented at https://github.com/SeleniumHQ/selenium/issues/2969

• When communicating with a W3C-compliant remote end, use the atoms library for the WebElement.getAttribute() and WebElement.isDisplayed() commands. This behavior is consistent with the java, .net, python, and ruby clients.

API Changes

• Removed safari.Options#useLegacyDriver()
• Reduced the API on promise.Thenable for compatibility with native promises:
  • Removed #isPending()
  • Removed #cancel()
  • Removed #finally()
• Changed all subclasses of webdriver.WebDriver to overload the static function WebDriver.createSession() instead of doing work in the constructor. All constructors now inherit the base class' function signature. Users are still encouraged to use the Builder class instead of creating drivers directly.
• Builder#build() now returns a "thenable" WebDriver instance, allowing users to immediately schedule commands (as before), or issue them through standard promise callbacks. This is the same pattern already employed for WebElements.
• Removed Builder#buildAsync() as it was redundant with the new semantics of build().

• Modified to use automation atoms for getAttribute and isDisplayed in .NET for W3C remote ends
• Added ability to set additional command line arguments for geckodriver

• Updated GetAttribute shim for GetAttribute method for W3C protocol remote ends.
• Modified parameter name in SendKeys to alert for W3C protocol remote ends.

• The Mozilla-provided Marionette-based FirefoxDriver is now the default implementation for automating Firefox. Additionally, this aligns the FirefoxDriver class with other browser-specific implementations, using a FirefoxOptions class for setting options for the browser session. Constructors of FirefoxDriver directly referencing FirefoxProfile or FirefoxBinary have been marked as deprecated, and will be removed in a future release.

• FIXED: for consistency with the other language bindings, remote.FileDetector will ignore paths that refer to a directory.

Change Summary

• Added preliminary support for Marionette, Mozilla's WebDriver implementation for Firefox. Marionette may be enabled via the API, firefox.Options#useMarionette, or by setting the SELENIUM_MARIONETTE environment variable.

• Moved all logic for parsing and interpreting responses from the remote end into the individual command.Executor implementations.

• For consistency with the other Selenium language bindings, WebDriver#isElementPresent() and WebElement#isElementPresent() have been deprecated. These methods will be removed in v3.0. Use the findElements command to test for the presence of an element:

  driver.findElements(By.css('.foo')).then(found => !!found.length);
  

• Added support for W3C-spec compliant servers.

• For consistent naming, deprecating error.InvalidSessionIdError in favor of error.NoSuchSessionError.

• Moved the error module to lib/error so all core modules are co-located. The top-level error module will be removed in v3.0.

• Moved until.Condition and until.WebElementCondition to the webdriver module to break a circular dependency.

• Added support for setting the username and password in basic auth pop-up dialogs (currently IE only).

• Deprecated WebElement#getInnerHtml() and WebEleemnt#getOuterHtml()

• Deprecated Promise#thenCatch() - use Promise#catch() instead

• Deprecated Promise#thenFinally() - use promise.thenFinally() instead

• FIXED: io.findInPath() will no longer match against directories that have the same basename as the target file.

• FIXED: phantomjs.Driver now takes a third argument that defines the path to a log file to use for the phantomjs executable's output. This may be quickly set at runtime with the SELENIUM_PHANTOMJS_LOG environment variable.

Changes for W3C WebDriver Spec Compliance

• Changed element.sendKeys(...) to send the key sequence as an array where each element defines a single key. The legacy wire protocol permits arrays where each element is a string of arbitrary length. This change is solely at the protocol level and should have no user-visible effect.

Notice

Starting with v2.52.0, each release of selenium-webdriver will support the latest minor LTS and stable Node releases. All releases between the LTS and stable release will have best effort support. Further details are available in the selenium-webdriver package README.

Change Summary

• Add support for Microsoft's Edge web browser
• Added webdriver.Builder#buildAsync(), which returns a promise that will be fulfilled with the newly created WebDriver instance once the associated browser has been full initialized. This is purely a convenient alternative to the existing build() method as the WebDriver class will always defer commands until it has a fully created browser.
• Added firefox.Profile#setHost() which may be used to set the host that the FirefoxDriver's server listens for commands on. The server uses "localhost" by default.
• Added promise.Promise#catch() for API compatibility with native Promises. promise.Promise#thenCatch() is not yet deprecated, but it simply delegates to catch.
• Changed some io operations to use native promises.
• Changed command.Executor#execute() and HttpClient#send() to return promises instead of using callback passing.
• Replaced the Serializable class with an internal, Symbol-defined method.
• Changed the Capabilities class to extend the native Map type.
• Changed the Capabilities.has(key) to only test if a capability has been set (Map semantics). To check whether the value is true, use get(key).
• Deprecated executors.DeferredExecutor in favor of lib/command.DeferredExecutor.
• API documentation is no longer distributed with the npm package, but remains available at http://seleniumhq.github.io/selenium/docs/api/javascript/
• Rewrote the error module to export an Error subtype for each type of error defined in the W3C WebDriver spec.
• Changed the http.Request and http.Response classes to store headers in maps instead of object literals.
• Updated ws dependency to version 1.0.1.
• Removed fluent predicates "is" and "not" from the experimental testing/assert module.
• Wait conditions that locate an element, or that wait on an element's state, will return a WebElementPromise.
• Lots of internal clean-up to break selenium-webdriver's long standing dependency on Google's Closure library.

Changes for W3C WebDriver Spec Compliance

• Updated the By locators that are not in the W3C spec to delegated to using CSS selectors: By.className, By.id, By.name, and By.tagName.

• Updated Firefox driver which includes fixes for the clicking in overlapped elements. In keeping with project support policy for Firefox, This driver has been tested with Firefox 44 (current release), 43 (immediately prior release), 38 (current ESR release), and 31 (immediately prior ESR release).
• Refactoring .NET driver Options classes to descend from common class. This commit introduces a common base class for driver-specific type-safe Options classes (e.g., ChromeOptions, InternetExplorerOptions, etc.). This will help pave the way to eliminate needing to know the name or expected type of arbitrary capabilities in a future release.
• Removed the incorrect ChromeOptions method introduced in 2.50.0.
• Added ability to add traceCategories to performance logging preferences in ChromeOptions. Fixes issue #1591.

• Changed ChromeOptions to have correct EnableMobileEmulation API.

• Updated embedded Firefox driver with new click algorithm
• Added type-safe options .NET for recently added Chrome capabilities. This includes adding type-safe capabilities for 'mobileEmulation', 'perfLoggingPrefs', and 'windowTypes' to ChromeOptions class.
• (on behalf Edward Ned Harvey) Updated ChromeDriverService to locate Chrome driver executable in a cross-platform way.
• Removed deprecated PageFactory code.
• Updated implementations of EWebDriver.PageSource property and IAlert.SendKeys method for spec-compliant browsers.
• Updated implementations for finding by ID, class name, and tag name for consistency between languages and for compatibility with spec- compliant drivers.
• Removed the redundant IllegalLocatorException.

• Updated .NET PageFactory to allow frame switching with located elements. Previously, if you located a <frame> or <iframe> element using the PageFactory attributes, you could not switch to it. This change allows one to use driver.SwitchTo().Frame(element) with the element found via the PageFactory.
• Added workaround for Windows 10 major version number encountered when executing via NUnit 3.
• Issue #1316: (on behalf of Chris Block) Enhance check for value types to exclude Nullable in extension methods. The System.Nullable type is a value type that can be assigned the null value. This change checks for types wrapped with Nullable and does not throw when they are encountered.
• Exposed session ID property on RemoteWebDriver. Users can now cast their driver instance to IHasSessionId to access the SessionId property, which returns a SessionId object. To use the SessionId object with external tools, simply call the ToString() method on the instance. Note that relying on the SessionId for anything is probably a Bad Thing, because it introduces a leak in the abstraction of a driver. Please do not use this property; its introduction is the Wrong Approach, but it's being exposed at the insistence of a selection of users.
• Adding support for whitelisted-ips argument for Chrome and IE driver executables.

• Added WebElement#takeScreenshot().
• More adjustments to promise callback tracking.

• FIXED: Adjusted how the control flow tracks promise callbacks to avoid a potential deadlock.

• Node v0.12.x users must run with --harmony. This is the last release that will support v0.12.x

• FIXED: (Promise/A+ compliance) When a promise is rejected with a thenable, the promise adopts the thenable as its rejection reason instead of waiting for it to settle. The previous (incorrect) behavior was hidden by bugs in the promises-aplus-tests compliance test suite that were fixed in version 2.1.1.

• FIXED: the webdriver.promise.ControlFlow now has a consistent execution order for tasks/callbacks scheduled in different turns of the JS event loop. Refer to the webdriver.promise documentation for more details.

• FIXED: do not drop user auth from the WebDriver server URL.

• FIXED: a single firefox.Binary instance may be used to configure and launch multiple FirefoxDriver sessions.

  var binary = new firefox.Binary();
  var options = new firefox.Options().setBinary(binary);
  var builder = new Builder().setFirefoxOptions(options);
  
  var driver1 = builder.build();
  var driver2 = builder.build();
  

• FIXED: zip files created for transfer to a remote WebDriver server are no longer compressed. If the zip contained a file that was already compressed, the server would return an "invalid code lengths set" error.

• FIXED: Surfaced the loopback option to remote/SeleniumServer. When set, the server will be accessed using the current host's loopback address.

Notice

This is the last release for selenium-webdriver that will support ES5. Subsequent releases will depend on ES6 features that are enabled by default in Node v4.0.0. Node v0.12.x will continue to be supported, but will require setting the --harmony flag.

Change Summary

• Add support for Node v4.0.0
  • Updated ws dependency from 0.7.1 to 0.8.0
• Bumped the minimum supported version of Node from 0.10.x to 0.12.x. This is in accordance with the Node support policy established in v2.45.0.

• Exposed a new logging API via the webdriver.logging module. For usage, see example/logging.js.
• Added support for using a proxy server for WebDriver commands. See Builder#usingWebDriverProxy() for more info.
• Removed deprecated functions:
  • Capabilities#toJSON()
  • UnhandledAlertError#getAlert()
  • chrome.createDriver()
  • phantomjs.createDriver()
  • promise.ControlFlow#annotateError()
  • promise.ControlFlow#await()
  • promise.ControlFlow#clearHistory()
  • promise.ControlFlow#getHistory()
• Removed deprecated enum values: ErrorCode.NO_MODAL_DIALOG_OPEN and ErrorCode.MODAL_DIALOG_OPENED. Use ErrorCode.NO_SUCH_ALERT and ErrorCode.UNEXPECTED_ALERT_OPEN, respectively.
• FIXED: The promise.ControlFlow will maintain state for promise chains generated in a loop.
• FIXED: Correct serialize target elements used in an action sequence.
• FIXED: promise.ControlFlow#wait() now has consistent semantics for an omitted or 0-timeout: it will wait indefinitely.
• FIXED: remote.DriverService#start() will now fail if the child process dies while waiting for the server to start accepting requests. Previously, start would continue to poll the server address until the timeout expired.
• FIXED: Skip launching Firefox with the -silent flag to preheat the profile. Starting with Firefox 38, this would cause the browser to crash. This step, which was first introduced for Selenium's java client back with Firefox 2, no longer appears to be required.
• FIXED: 8564: firefox.Driver#quit() will wait for the Firefox process to terminate before deleting the temporary webdriver profile. This eliminates a race condition where Firefox would write profile data during shutdown, causing the rm -rf operation on the profile directory to fail.

Important Policy Change

Starting with the 2.45.0 release, selenium-webdriver will support the last two stable minor releases for Node. For 2.45.0, this means Selenium will support Node 0.10.x and 0.12.x. Support for the intermediate, un-stable release (0.11.x) is "best-effort". This policy will be re-evaluated once Node has a major version release (i.e. 1.0.0).

Change Summary

• Added native browser support for Internet Explorer, Opera 26+, and Safari

• With the release of Node 0.12.0 (finally!), the minimum supported version of Node is now 0.10.x.

• The promise module is now Promises/A+ compliant. The biggest compliance change is that promise callbacks are now invoked in a future turn of the JS event loop. For example:

    var promise = require('selenium-webdriver').promise;
    console.log('start');
    promise.fulfilled().then(function() {
      console.log('middle');
    });
    console.log('end');
  
    // Output in selenium-webdriver@2.44.0
    // start
    // middle
    // end
    //
    // Output in selenium-webdriver@2.45.0
    // start
    // end
    // middle
  

  The promise.ControlFlow class has been updated to track the asynchronous breaks required by Promises/A+, so there are no changes to task execution order.

• Updated how errors are annotated on failures. When a task fails, the stacktrace from when that task was scheduled is appended to the rejection reason with a From: prefix ( if it is an Error object). For example:

    var driver = new webdriver.Builder().forBrowser('chrome').build();
    driver.get('http://www.google.com/ncr');
    driver.call(function() {
      driver.wait(function() {
        return driver.isElementPresent(webdriver.By.id('not-there'));
      }, 2000, 'element not found');
    });
  

  This code will fail an error like:

    Error: element not found
    Wait timed out after 2002ms
        at <stack trace>
    From: Task: element not found
        at <stack trace>
    From: Task: WebDriver.call(function)
        at <stack trace>
  

• Changed the format of strings returned by promise.ControlFlow#getSchedule. This function now accepts a boolean to control whether the returned string should include the stacktraces for when each task was scheduled.

• Deprecating promise.ControlFlow#getHistory, promise.ControlFlow#clearHistory, and promise.ControlFlow#annotateError. These functions were all intended for internal use and are no longer necessary, so they have been made no-ops.

• WebDriver.wait() may now be used to wait for a promise to resolve, with an optional timeout. Refer to the API documentation for more information.

• Added support for copying files to a remote Selenium via sendKeys to test file uploads. Refer to the API documentation for more information. Sample usage included in test/upload_test.js

• Expanded the interactions API to include touch actions. See WebDriver.touchActions().

• FIXED: 8380: firefox.Driver will delete its temporary profile on quit.

• FIXED: 8306: Stack overflow in promise callbacks eliminated.

• FIXED: 8221: Added support for defining custom command mappings. Includes support for PhantomJS's executePhantomJS (requires PhantomJS 1.9.7 or GhostDriver 1.1.0).

• FIXED: 8128: When the FirefoxDriver marshals an object to the page for executeScript, it defines additional properties (required by the driver's implementation). These properties will no longer be enumerable and should be omitted (i.e. they won't show up in JSON.stringify output).

• FIXED: 8094: The control flow will no longer deadlock when a task returns a promise that depends on the completion of sub-tasks.

• Added the until module, which defines common explicit wait conditions. Sample usage:

    var firefox = require('selenium-webdriver/firefox'),
        until = require('selenium-webdriver/until');
  
    var driver = new firefox.Driver();
    driver.get('http://www.google.com/ncr');
    driver.wait(until.titleIs('Google Search'), 1000);
  

• FIXED: 8000: Builder.forBrowser() now accepts an empty string since some WebDriver implementations ignore the value. A value must still be specified, however, since it is a required field in WebDriver's wire protocol.

• FIXED: 7994: The stacktrace module will not modify stack traces if the initial parse fails (e.g. the user defined Error.prepareStackTrace)

• FIXED: 5855: Added a module (until) that defines several common conditions for use with explicit waits. See updated examples for usage.

• Fixed an issue with flakiness when setting up the Firefox profile that could prevent the driver from initializing properly.

• Added native support for Firefox - the Java Selenium server is no longer required.

• Added support for generator functions to ControlFlow#execute and ControlFlow#wait. For more information, see documentation on webdriver.promise.consume. Requires harmony support (run with node --harmony-generators in v0.11.x).

• Various improvements to the Builder API. Notably, the build() function will no longer default to attempting to use a server at http://localhost:4444/wd/hub if it cannot start a browser directly - you must specify the WebDriver server with usingServer(url). You can also set the target browser and WebDriver server through a pair of environment variables. See the documentation on the Builder constructor for more information.

• For consistency with the other language bindings, added browser specific classes that can be used to start a browser without the builder.

    var webdriver = require('selenium-webdriver')
        chrome = require('selenium-webdriver/chrome');
  
    // The following are equivalent.
    var driver1 = new webdriver.Builder().forBrowser('chrome').build();
    var driver2 = new chrome.Driver();
  

• Promise A+ compliance: a promise may no longer resolve to itself.

• For consistency with other language bindings, deprecated UnhandledAlertError#getAlert and added #getAlertText. getAlert will be removed in 2.45.0.

• FIXED: 7641: Deprecated ErrorCode.NO_MODAL_DIALOG_OPEN and ErrorCode.MODAL_DIALOG_OPENED in favor of the new ErrorCode.NO_SUCH_ALERT and ErrorCode.UNEXPECTED_ALERT_OPEN, respectively.

• FIXED: 7563: Mocha integration no longer disables timeouts. Default Mocha timeouts apply (2000 ms) and may be changed using this.timeout(ms).

• FIXED: 7470: Make it easier to create WebDriver instances in custom flows for parallel execution.

• Removed deprecated functions Promise#addCallback(), Promise#addCallbacks(), Promise#addErrback(), and Promise#addBoth().
• Fail with a more descriptive error if the server returns a malformed redirect
• FIXED: 7300: Connect to ChromeDriver using the loopback address since ChromeDriver 2.10.267517 binds to localhost by default.
• FIXED: 7339: Preserve wrapped test function's string representation for Mocha' s BDD interface.

• FIXED: 7138: export logging API from webdriver module.
• FIXED: 7105: beforeEach/it/afterEach properly bind this for Mocha tests.

• API documentation is now included in the docs directory.
• Added utility functions for working with an array of promises: promise.all, promise.map, and promise.filter
• Introduced Promise#thenCatch() and Promise#thenFinally().
• Deprecated Promise#addCallback(), Promise#addCallbacks(), Promise#addErrback(), and Promise#addBoth().
• Removed deprecated function webdriver.WebDriver#getCapability.
• FIXED: 6826: Added support for custom locators.

• Version bump to stay in sync with the Selenium project.

• When a promise is rejected, always annotate the stacktrace with the parent flow state so users can identify the source of an error.
• Updated tests to reflect features not working correctly in the SafariDriver (cookie management and proxy support; see issues 5051, 5212, and 5503)
• FIXED: 6284: For mouse moves, correctly omit the x/y offsets if not specified as a function argument (instead of passing (0,0)).
• FIXED: 6471: Updated documentation on webdriver.WebElement#getAttribute
• FIXED: 6612: On Unix, use the default IANA ephemeral port range if unable to retrieve the current system's port range.
• FIXED: 6617: Avoid triggering the node debugger when initializing the stacktrace module.
• FIXED: 6627: Safely rebuild chrome.Options from a partial JSON spec.

• FIXED: 6346: The remote.SeleniumServer class now accepts JVM arguments using the jvmArgs option.

• Release skipped to stay in sync with main Selenium project.