From 5507c02e6ea6ff201f4a381908871af613b4ad63 Mon Sep 17 00:00:00 2001 From: Diego Molina Date: Thu, 19 Sep 2024 17:19:51 +0200 Subject: [PATCH] [ci] Run format script --- javascript/node/selenium-webdriver/CHANGES.md | 368 +++++++++--------- 1 file changed, 184 insertions(+), 184 deletions(-) diff --git a/javascript/node/selenium-webdriver/CHANGES.md b/javascript/node/selenium-webdriver/CHANGES.md index 086546730f532..765a6a53a8cb3 100644 --- a/javascript/node/selenium-webdriver/CHANGES.md +++ b/javascript/node/selenium-webdriver/CHANGES.md @@ -54,9 +54,9 @@ - Implement fullPageScreenshot functionality for Firefox (#13301) - Nightly JS builds are now pushed to GitHub packages - Making Selenium Manager a thin wrapper (#13853) - - This change has been made to make it easier to maintain and improve, the interface has - changed and if users were invoking it, they might experience issues. Selenium Manager is - still in beta and these type of changes are expected. + - This change has been made to make it easier to maintain and improve, the interface has + changed and if users were invoking it, they might experience issues. Selenium Manager is + still in beta and these type of changes are expected. - [bidi] Update browsing context create method (#13766) ## 4.19.0 @@ -339,15 +339,15 @@ fix: iedriver download with selenium-manager #11579 #### :rocket: New Feature - Adds 'Select' support package - - selectByIndex - - selectByValue - - selectByVisibleText - - getAllSelectedOptions - - getFirstSelectedOption - - deselectAll - - deselectByVisibleText - - deselectByIndex - - deselectByValue + - selectByIndex + - selectByValue + - selectByVisibleText + - getAllSelectedOptions + - getFirstSelectedOption + - deselectAll + - deselectByVisibleText + - deselectByIndex + - deselectByValue - Add support for Actions API sendKeys to designated element - Adds mouse button enum for forward and backward navigation @@ -519,7 +519,7 @@ fix: iedriver download with selenium-manager #11579 ## v4.0.0-beta.1 - JS Binding support for WebDriver Bidi in Firefox - - This requires Firefox 87 and Geckodriver 0.29 to be able to work + - This requires Firefox 87 and Geckodriver 0.29 to be able to work - Update the supported CDP versions - Update tmp package version (#9155) - Adding support for /computedlabel (getAccessibleName) (#9073) @@ -534,12 +534,12 @@ fix: iedriver download with selenium-manager #11579 - Rolling back native support for Opera Browser - Added new ieOptions capabilities: - - fileUploadDialogTimeout - - setEdgePath - - setEdgeChromium - - setScrollBehavior - - For consistent naming, deprecating `addArguments(...args)` in favor - of `addBrowserCommandSwitches(...args)` + - fileUploadDialogTimeout + - setEdgePath + - setEdgeChromium + - setScrollBehavior + - For consistent naming, deprecating `addArguments(...args)` in favor + of `addBrowserCommandSwitches(...args)` - Added relative locators - Added Chrome DevTools Protocol (CDP) support @@ -623,11 +623,11 @@ mode (see `example/headless.js`) ### API Changes - The core WebDriver API no longer uses promise manager - - Removed `index.Builder#setControlFlow()` - - The following thenable types no longer have a `cancel()` method: - - The dynamically generated thenable WebDrivers created by `index.Builder` - - `lib/webdriver.AlertPromise` - - `lib/webdriver.WebElementPromise` + - Removed `index.Builder#setControlFlow()` + - The following thenable types no longer have a `cancel()` method: + - The dynamically generated thenable WebDrivers created by `index.Builder` + - `lib/webdriver.AlertPromise` + - `lib/webdriver.WebElementPromise` - Removed `remote/index.DriverService.prototype.stop()` (use `#kill()` instead) - Removed the `lib/actions` module - Removed the `lib/events` module @@ -636,137 +636,137 @@ mode (see `example/headless.js`) - Removed the promise manager from `lib/promise`, which includes the removal of the following exported names (replacements, if any, in parentheses): - - CancellableThenable - - CancellationError - - ControlFlow - - Deferred - - LONG_STACK_TRACES - - MultipleUnhandledRejectionError - - Promise (use native Promises) - - Resolver - - Scheduler - - Thenable - - USE_PROMISE_MANAGER - - all (use Promise.all) - - asap (use Promise.resolve) - - captureStackTrace (use Error.captureStackTrace) - - consume (use async functions) - - controlFlow - - createPromise (use new Promise) - - defer - - fulfilled (use Promise.resolve) - - isGenerator - - rejected (use Promise.reject) - - setDefaultFlow - - when (use Promise.resolve) + - CancellableThenable + - CancellationError + - ControlFlow + - Deferred + - LONG_STACK_TRACES + - MultipleUnhandledRejectionError + - Promise (use native Promises) + - Resolver + - Scheduler + - Thenable + - USE_PROMISE_MANAGER + - all (use Promise.all) + - asap (use Promise.resolve) + - captureStackTrace (use Error.captureStackTrace) + - consume (use async functions) + - controlFlow + - createPromise (use new Promise) + - defer + - fulfilled (use Promise.resolve) + - isGenerator + - rejected (use Promise.reject) + - setDefaultFlow + - when (use Promise.resolve) - Changes to the `Builder` class: - - Added setChromeService, setEdgeService, & setFirefoxService - - Removed setEnableNativeEvents - - Removed setScrollBehavior + - Added setChromeService, setEdgeService, & setFirefoxService + - Removed setEnableNativeEvents + - Removed setScrollBehavior - Changes to `chrome.Driver` - - Added sendDevToolsCommand - - Added setDownloadPath + - Added sendDevToolsCommand + - Added setDownloadPath - Changes to `chrome.Options` - - Now extends the `Capabilities` class - - Removed from/toCapabilities + - Now extends the `Capabilities` class + - Removed from/toCapabilities - Changes to `edge.Options` - - Now extends the `Capabilities` class - - Removed from/toCapabilities + - Now extends the `Capabilities` class + - Removed from/toCapabilities - Changes to `ie.Options` - - Now extends the `Capabilities` class - - Removed from/toCapabilities + - Now extends the `Capabilities` class + - Removed from/toCapabilities - Removed the `firefox.Binary` class. Custom binaries can still be selected using `firefox.Options#setBinary()`. Likewise, custom binary arguments can be specified with `firefox.Options#addArguments()`. - Changes to `firefox.Driver` - - Added installAddon(path) - - Added uninstallAddon(id) + - Added installAddon(path) + - Added uninstallAddon(id) - Changes to `firefox.Options` - - Now extends the `Capabilities` class - - Removed from/toCapabilities - - Removed setLoggingPreferences (was a no-op) - - setProfile now only accepts a path to an existing profile - - Added addExtensions - - Added setPreference + - Now extends the `Capabilities` class + - Removed from/toCapabilities + - Removed setLoggingPreferences (was a no-op) + - setProfile now only accepts a path to an existing profile + - Added addExtensions + - Added setPreference - Removed the `firefox.Profile` class. All of its functionality is now provided directly by `firefox.Options` - Removed the `firefox/binary` module - Removed the `firefox/profile` module - Changes to `safari.Options` - - Now extends the `Capabilities` class - - Removed from/toCapabilities - - Removed setCleanSession (was a no-op) + - Now extends the `Capabilities` class + - Removed from/toCapabilities + - Removed setCleanSession (was a no-op) - Changes to `lib/capabilities.Browser`: - - Removed several enum values. - - ANDROID (use Chrome for Android; see docs on the chrome module) - - IPAD (no support available) - - IPHONE (no support available) - - OPERA (use Chrome) - - PHANTOM_JS (use Chrome or Firefox in headless mode) - - HTMLUNIT (use Chrome or Firefox in headless mode) + - Removed several enum values. + - ANDROID (use Chrome for Android; see docs on the chrome module) + - IPAD (no support available) + - IPHONE (no support available) + - OPERA (use Chrome) + - PHANTOM_JS (use Chrome or Firefox in headless mode) + - HTMLUNIT (use Chrome or Firefox in headless mode) - Changes to `lib/capabilities.Capabilities`: - - Removed static factory methods android(), ipad(), iphone(), opera(), - phantomjs(), htmlunit(), - and htmlunitwithjs(). Users can still manually configure capabilities for - these, but their use - is not recommended and they will no longer be surfaced in the API. + - Removed static factory methods android(), ipad(), iphone(), opera(), + phantomjs(), htmlunit(), + and htmlunitwithjs(). Users can still manually configure capabilities for + these, but their use + is not recommended and they will no longer be surfaced in the API. - Changes to `lib/error`: - - Added - - ElementClickInterceptedError - - InsecureCertificateError - - InvalidCoordinatesError - - NoSuchCookieError - - Removed - - ElementNotVisibleError - - InvalidElementCoordinatesError + - Added + - ElementClickInterceptedError + - InsecureCertificateError + - InvalidCoordinatesError + - NoSuchCookieError + - Removed + - ElementNotVisibleError + - InvalidElementCoordinatesError - Changes to `lib/webdriver.WebDriver`: - - Dropped support for "requiredCapabilities" from WebDriver.createSession - - actions() now returns the new `lib/input.Actions` class - - Removed touchActions - - Renamed schedule to execute - - Removed the `WebDriver.attachToSession()` factory method. Users can just - the `WebDriver` - constructor directly instead. - - Removed the `call()` method. This was used to inject custom function calls - into the control - flow. Now that the promise manager is no longer used, this method is no - longer necessary. - Users are now responsible for coordinating actions (ideally with async - functions) and can just - call functions directly instead of through `driver.call()`. + - Dropped support for "requiredCapabilities" from WebDriver.createSession + - actions() now returns the new `lib/input.Actions` class + - Removed touchActions + - Renamed schedule to execute + - Removed the `WebDriver.attachToSession()` factory method. Users can just + the `WebDriver` + constructor directly instead. + - Removed the `call()` method. This was used to inject custom function calls + into the control + flow. Now that the promise manager is no longer used, this method is no + longer necessary. + Users are now responsible for coordinating actions (ideally with async + functions) and can just + call functions directly instead of through `driver.call()`. - Changes to `lib/webdriver.WebElement`: - - Replaced getSize & getLocation with getRect + - Replaced getSize & getLocation with getRect - Changes to `lib/webdriver.Alert`: - - Removed authenticateAs + - Removed authenticateAs - Changes to `lib/webdriver.Options` (`driver.manage()`): - - Removed timeouts (use get/setTimeouts) + - Removed timeouts (use get/setTimeouts) - Changes to `lib/webdriver.Window` (`driver.manage().window()`): - - Added - - getRect - - setRect - - fullscreen - - minimize - - Removed (use the getRect/setRect methods) - - getPosition - - setPosition - - getSize - - setSize + - Added + - getRect + - setRect + - fullscreen + - minimize + - Removed (use the getRect/setRect methods) + - getPosition + - setPosition + - getSize + - setSize - Removed the `testing/assert` module - Changes to `testing/index` - - Since the promise manager has been removed, it is no longer necessary to - wrap the Mocha test - hooks; instead, users can simply use async functions. The following have all - been removed: - - describe - - before - - beforeEach - - after - - afterEach - - it - - Added the `suite` function. For details, refer to the jsdoc or - `example/google_search_test.js` + - Since the promise manager has been removed, it is no longer necessary to + wrap the Mocha test + hooks; instead, users can simply use async functions. The following have all + been removed: + - describe + - before + - beforeEach + - after + - afterEach + - it + - Added the `suite` function. For details, refer to the jsdoc or + `example/google_search_test.js` ## v3.6.0 @@ -785,19 +785,19 @@ mode (see `example/headless.js`) ### API Changes - Added new methods to `selenium-webdriver/firefox.Options`: - - addArguments() - - headless() - - windowSize() + - 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 + - setNativeEventsEnabled + - nativeEventsEnabled + - getPort + - setPort - Removed `selenium-webdriver/firefox.ServiceBuilder#setFirefoxBinary()`; custom binaries should be configured through the `firefox.Options` class. @@ -821,10 +821,10 @@ to a remote Selenium server that supports Firefox 45. ### Changes - Removed native support for Firefox 46 and older. - - The `SELENIUM_MARIONETTE` enviornment 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. + - The `SELENIUM_MARIONETTE` enviornment 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 @@ -915,8 +915,8 @@ or newer. ## v3.0.1 - 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)` + - 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. @@ -962,9 +962,9 @@ or newer. - Removed `safari.Options#useLegacyDriver()` - Reduced the API on `promise.Thenable` for compatibility with native promises: - - Removed `#isPending()` - - Removed `#cancel()` - - Removed `#finally()` + - 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 @@ -1064,34 +1064,34 @@ or newer. returned in seconds. - Renamed `firefox.Options#useMarionette` to `firefox.Options#useGeckoDriver` - Removed deprecated modules: - - `selenium-webdriver/error` (use `selenium-webdriver/lib/error`,\ - or the `error` property exported by `selenium-webdriver`) - - `selenium-webdriver/executors` — this was not previously deprecated, but is - no longer used. + - `selenium-webdriver/error` (use `selenium-webdriver/lib/error`,\ + or the `error` property exported by `selenium-webdriver`) + - `selenium-webdriver/executors` — this was not previously deprecated, but is + no longer used. - Removed deprecated types: - - `command.DeferredExecutor` — this was not previously deprecated, but is no - longer used. It can - be trivially implemented by clients should it be needed. - - `error.InvalidSessionIdError` (use `error.NoSuchSessionError`) - - `executors.DeferredExecutor` - - `until.Condition` (use `webdriver.Condition`) - - `until.WebElementCondition` (use `webdriver.WebElementCondition`) - - `webdriver.UnhandledAlertError` (use `error.UnexpectedAlertOpenError`) + - `command.DeferredExecutor` — this was not previously deprecated, but is no + longer used. It can + be trivially implemented by clients should it be needed. + - `error.InvalidSessionIdError` (use `error.NoSuchSessionError`) + - `executors.DeferredExecutor` + - `until.Condition` (use `webdriver.Condition`) + - `until.WebElementCondition` (use `webdriver.WebElementCondition`) + - `webdriver.UnhandledAlertError` (use `error.UnexpectedAlertOpenError`) - Removed deprecated functions: - - `Deferred#cancel()` - - `Deferred#catch()` - - `Deferred#finally()` - - `Deferred#isPending()` - - `Deferred#then()` - - `Promise#thenCatch()` - - `Promise#thenFinally()` - - `WebDriver#isElementPresent()` - - `WebElement#getInnerHtml()` - - `WebElement#getOuterHtml()` - - `WebElement#getRawId()` - - `WebElement#isElementPresent()` + - `Deferred#cancel()` + - `Deferred#catch()` + - `Deferred#finally()` + - `Deferred#isPending()` + - `Deferred#then()` + - `Promise#thenCatch()` + - `Promise#thenFinally()` + - `WebDriver#isElementPresent()` + - `WebElement#getInnerHtml()` + - `WebElement#getOuterHtml()` + - `WebElement#getRawId()` + - `WebElement#isElementPresent()` - Removed deprecated properties: - - `WebDriverError#code` + - `WebDriverError#code` ## v2.53.2 @@ -1287,7 +1287,7 @@ continue to be supported, but will require setting the `--harmony` flag. ### Change Summary - Add support for [Node v4.0.0](https://nodejs.org/en/blog/release/v4.0.0/) - - Updated `ws` dependency from `0.7.1` to `0.8.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`. @@ -1306,14 +1306,14 @@ continue to be supported, but will require setting the `--harmony` flag. 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() + - 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. @@ -1679,15 +1679,15 @@ major version release (i.e. 1.0.0). rejections were always Error objects. Rejection reasons are now left as is. - Removed deprecated functions originally scheduled for removal in 2.31.0 - - promise.Application.getInstance() - - promise.ControlFlow#schedule() - - promise.ControlFlow#scheduleTimeout() - - promise.ControlFlow#scheduleWait() + - promise.Application.getInstance() + - promise.ControlFlow#schedule() + - promise.ControlFlow#scheduleTimeout() + - promise.ControlFlow#scheduleWait() - Renamed some functions for consistency with Promises/A+ terminology. The original functions have been deprecated and will be removed in 2.34.0: - - promise.resolved() -> promise.fulfilled() - - promise.Deferred#resolve() -> promise.Deferred#fulfill() + - promise.resolved() -> promise.fulfilled() + - promise.Deferred#resolve() -> promise.Deferred#fulfill() - FIXED: remote.SeleniumServer#stop now shuts down within the active control flow, allowing scripts to finish. Use #kill to shutdown immediately.