selenium-webdriver 2.47.0 → 2.52.0

package/CHANGES.md

@@ -1,3 +1,99 @@
+## v2.52.0
+
+### 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](https://w3c.github.io/webdriver/webdriver-spec.html#handling-errors).
+* 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`.
+
+
+## v2.49-51
+
+* _Releases skipped to stay in sync with the rest of the Selenium project_
+
+
+## v2.48.2
+
+* Added `WebElement#takeScreenshot()`.
+* More adjustments to promise callback tracking.
+
+## v2.48.1
+
+* FIXED: Adjusted how the control flow tracks promise callbacks to avoid a
+    potential deadlock.
+
+## v2.48.0
+
+* 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.
+
 ## v2.47.0
 
 ### Notice

package/NOTICE

@@ -1,2 +1,2 @@
-Copyright 2011-2015 Software Freedom Conservancy
+Copyright 2011-2016 Software Freedom Conservancy
 Copyright 2004-2011 Selenium committers

package/README.md

@@ -6,14 +6,14 @@ interaction with the browser.
 
 ## Installation
 
-Install via npm with
+Selenium may be installed via npm with
 
     npm install selenium-webdriver
 
 Out of the box, Selenium includes everything you need to work with Firefox. You
 will need to download additional components to work with the other major
-browsers. The drivers for Chrome, IE, PhantomJS, and Opera are all standalone
-executables that should be placed on your
+browsers. The drivers for Chrome, PhantomJS, Opera, and Microsoft's IE and Edge 
+web browsers are all standalone executables that should be available on your
 [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29). The SafariDriver
 browser extension should be installed in your browser before using Selenium; we
 recommend disabling the extension when using the browser without Selenium or
@@ -23,6 +23,7 @@ installing the extension in a profile only used for testing.
 | ----------------- | ---------------------------------- |
 | Chrome            | [chromedriver(.exe)][chrome]       |
 | Internet Explorer | [IEDriverServer.exe][release]      |
+| Edge              | [MicrosoftWebDriver.msi][edge]     | 
 | PhantomJS         | [phantomjs(.exe)][phantomjs]       |
 | Opera             | [operadriver(.exe)][opera]         |
 | Safari            | [SafariDriver.safariextz][release] |
@@ -109,8 +110,8 @@ script provided with `selenium-webdriver`.
 
 ## Documentation
 
-API documentation is included in the `docs` directory and is also available
-online from the [Selenium project][api]. Addition resources include
+API documentation is available online from the [Selenium project][api].
+Addition resources include
 
 - the #selenium channel on freenode IRC
 - the [selenium-users@googlegroups.com][users] list
@@ -122,6 +123,54 @@ Contributions are accepted either through [GitHub][gh] pull requests or patches
 via the [Selenium issue tracker][issues]. You must sign our
 [Contributor License Agreement][cla] before your changes will be accepted.
 
+## Node Support Policy
+
+Each version of selenium-webdriver will support the latest _semver-minor_
+version of the [LTS] and stable Node releases. All _semver-major_ &
+_semver-minor_ versions between the LTS and stable release will have "best
+effort" support. Following a Selenium release, any _semver-minor_ Node releases
+will also have "best effort" support. Releases older than the latest LTS,
+_semver-major_ releases, and all unstable release branches (e.g. "v.Next")
+are considered strictly unsupported.
+
+For example, suppose the current LTS and stable releases are v4.2.4 and v5.4.1,
+respectively. Then a Selenium release would have the following support levels:
+
+| Version | Support       |
+| ------- | ------------- |
+| <= 4.1  | _unsupported_ |
+| 4.2     | supported     |
+| 5.0-3   | best effort   |
+| 5.4     | supported     |
+| >= 5.5  | best effort   |
+| v.Next  | _unsupported_ |
+
+### Support Level Definitions
+
+- _supported:_ A selenium-webdriver release will be API compatible with the
+    platform API, without the use of runtime flags.
+
+- _best effort:_ Bugs will be investigated as time permits. API compatibility is
+    only guaranteed where required by a _supported_ release. This effectively
+    means the adoption of new JS features, such as ES2015 modules, will depend
+    on what is supported in Node's LTS.
+
+- _unsupported:_ Bug submissions will be closed as will-not-fix and API
+    compatibility is not guaranteed.
+
+### Projected Support Schedule
+
+If Node releases a new [LTS] each October and a new major version every 6
+months, the support window for selenium-webdriver will be roughly:
+
+| Date      | LTS  | Stable |
+| --------- | ---: | -----: |
+| (current) |  4.2 |    5.0 |
+| 2016-04   |  4.2 |    6.0 |
+| 2016-10   |  6.0 |    7.0 |
+| 2017-04   |  6.0 |    8.0 |
+| 2017-10   |  8.0 |    9.0 |
+
 ## Issues
 
 Please report any issues using the [Selenium issue tracker][issues]. When using
@@ -163,13 +212,15 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 
-[api]: http://selenium.googlecode.com/git/docs/api/javascript/index.html
+[LTS]: https://github.com/nodejs/LTS
+[api]: http://seleniumhq.github.io/selenium/docs/api/javascript/
 [cla]: http://goo.gl/qC50R
 [chrome]: http://chromedriver.storage.googleapis.com/index.html
 [gh]: https://github.com/SeleniumHQ/selenium/
 [issues]: https://github.com/SeleniumHQ/selenium/issues
 [opera]: https://github.com/operasoftware/operachromiumdriver/releases
 [phantomjs]: http://phantomjs.org/
+[edge]: http://go.microsoft.com/fwlink/?LinkId=619687
 [reduction]: http://www.webkit.org/quality/reduction.html
 [release]: http://selenium-release.storage.googleapis.com/index.html
 [users]: https://groups.google.com/forum/#!forum/selenium-users