Morph MORPH
SIGN IN SIGN UP
SeleniumHQ / selenium UNCLAIMED

A browser automation framework and ecosystem.

0 0 1280 Java
Normal View History Raw
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
/**
* @fileoverview Contains several classes for handling commands.
*/
'use strict';
/**
* Describes a command to execute.
* @final
*/
class Command {
/** @param {string} name The name of this command. */
constructor(name) {
/** @private {string} */
this.name_ = name;
/** @private {!Object<*>} */
this.parameters_ = {};
}
/** @return {string} This command's name. */
getName() {
return this.name_;
}
/**
* Sets a parameter to send with this command.
* @param {string} name The parameter name.
* @param {*} value The parameter value.
* @return {!Command} A self reference.
*/
setParameter(name, value) {
this.parameters_[name] = value;
return this;
}
/**
* Sets the parameters for this command.
* @param {!Object<*>} parameters The command parameters.
* @return {!Command} A self reference.
*/
setParameters(parameters) {
this.parameters_ = parameters;
return this;
}
/**
* Returns a named command parameter.
* @param {string} key The parameter key to look up.
* @return {*} The parameter value, or undefined if it has not been set.
*/
getParameter(key) {
return this.parameters_[key];
}
/**
* @return {!Object<*>} The parameters to send with this command.
*/
getParameters() {
return this.parameters_;
}
}
/**
* Enumeration of predefined names command names that all command processors
* will support.
* @enum {string}
*/
// TODO: Delete obsolete command names.
const Name = {
GET_SERVER_STATUS: 'getStatus',
NEW_SESSION: 'newSession',
GET_SESSIONS: 'getSessions',
CLOSE: 'close',
QUIT: 'quit',
GET_CURRENT_URL: 'getCurrentUrl',
GET: 'get',
GO_BACK: 'goBack',
GO_FORWARD: 'goForward',
REFRESH: 'refresh',
ADD_COOKIE: 'addCookie',
GET_COOKIE: 'getCookie',
GET_ALL_COOKIES: 'getCookies',
DELETE_COOKIE: 'deleteCookie',
DELETE_ALL_COOKIES: 'deleteAllCookies',
GET_ACTIVE_ELEMENT: 'getActiveElement',
FIND_ELEMENT: 'findElement',
FIND_ELEMENTS: 'findElements',
[js] Add relative locators This adds the ability to do relative locators to the JS Bindings to find elements that are relative to another element.
2020-04-25 09:10:55 +01:00
FIND_ELEMENTS_RELATIVE: "findElementsRelative",
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
FIND_CHILD_ELEMENT: 'findChildElement',
FIND_CHILD_ELEMENTS: 'findChildElements',
CLEAR_ELEMENT: 'clearElement',
CLICK_ELEMENT: 'clickElement',
SEND_KEYS_TO_ELEMENT: 'sendKeysToElement',
SUBMIT_ELEMENT: 'submitElement',
GET_CURRENT_WINDOW_HANDLE: 'getCurrentWindowHandle',
GET_WINDOW_HANDLES: 'getWindowHandles',
GET_WINDOW_POSITION: 'getWindowPosition',
SET_WINDOW_POSITION: 'setWindowPosition',
GET_WINDOW_SIZE: 'getWindowSize',
SET_WINDOW_SIZE: 'setWindowSize',
[js] Implement the window getRect and setRect commands
2017-10-14 19:47:12 -07:00
GET_WINDOW_RECT: 'getWindowRect',
SET_WINDOW_RECT: 'setWindowRect',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
MAXIMIZE_WINDOW: 'maximizeWindow',
[js] Minimize window and fullscreen window APIs For #4290
2017-10-08 21:14:28 -07:00
MINIMIZE_WINDOW: 'minimizeWindow',
FULLSCREEN_WINDOW: 'fullscreenWindow',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
SWITCH_TO_WINDOW: 'switchToWindow',
[node] Adding support for opening a new window. Referencing existing implementations. Signed-off-by: Alexei Barantsev <barancev@gmail.com>
2019-02-20 17:01:52 +02:00
SWITCH_TO_NEW_WINDOW: 'newWindow',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
SWITCH_TO_FRAME: 'switchToFrame',
[js] Clean-up command mappings to better track W3C compliance. Also add missing commands: GET /session/{session id}/cookie/{name} POST /session/{session id}/frame/parent
2017-12-27 15:12:04 -08:00
SWITCH_TO_FRAME_PARENT: 'switchToFrameParent',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
GET_PAGE_SOURCE: 'getPageSource',
GET_TITLE: 'getTitle',
EXECUTE_SCRIPT: 'executeScript',
EXECUTE_ASYNC_SCRIPT: 'executeAsyncScript',
GET_ELEMENT_TEXT: 'getElementText',
GET_ELEMENT_TAG_NAME: 'getElementTagName',
IS_ELEMENT_SELECTED: 'isElementSelected',
IS_ELEMENT_ENABLED: 'isElementEnabled',
IS_ELEMENT_DISPLAYED: 'isElementDisplayed',
GET_ELEMENT_LOCATION: 'getElementLocation',
GET_ELEMENT_LOCATION_IN_VIEW: 'getElementLocationOnceScrolledIntoView',
[js] Replace WebElement.getSize/getLocation with a single getRect
2018-01-07 18:55:16 -08:00
GET_ELEMENT_RECT: 'getElementRect',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
GET_ELEMENT_SIZE: 'getElementSize',
GET_ELEMENT_ATTRIBUTE: 'getElementAttribute',
GET_ELEMENT_VALUE_OF_CSS_PROPERTY: 'getElementValueOfCssProperty',
Add: Add support to get property of referenced web element (#7839) * Add: Add support to get 'property' of referenced element Signed-off-by: Sri Harsha <sri_harsha509@hotmail.com> * Updating the identifier to 'name'
2019-12-04 00:11:19 +05:30
GET_ELEMENT_PROPERTY: 'getElementProperty',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
SCREENSHOT: 'screenshot',
TAKE_ELEMENT_SCREENSHOT: 'takeElementScreenshot',
SET_SCRIPT_TIMEOUT: 'setScriptTimeout',
[js] Use the W3C set timeouts format. If this fails, fallback to the legacy format. This commit also updates the API to expose getTimeouts() and setTimeouts() methods off of the Options class. The current Timeouts class is deprecated in favor of setTimeouts(), which allows setting multiple timeouts at once. For #3607
2017-03-08 19:54:54 -08:00
GET_TIMEOUT: 'getTimeout',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
SET_TIMEOUT: 'setTimeout',
ACCEPT_ALERT: 'acceptAlert',
DISMISS_ALERT: 'dismissAlert',
GET_ALERT_TEXT: 'getAlertText',
SET_ALERT_TEXT: 'setAlertValue',
GET_AVAILABLE_LOG_TYPES: 'getAvailableLogTypes',
GET_LOG: 'getLog',
GET_SESSION_LOGS: 'getSessionLogs',
// Non-standard commands used by the standalone Selenium server.
[js] Revamp the actions API to support the W3C spec and drop support for legacy actions. This is going to hurt users one way or the other: chrome currently only supports legacy actions and firefox only supports W3C. Since all JS changes are now targeting 4.0 (a major version bump), we're dropping support for legacy and moving forward with W3C only. For #4564, #4662
2017-10-08 20:05:35 -07:00
UPLOAD_FILE: 'uploadFile',
[js] remove remnants of commands that are no longer supported
2017-10-08 20:26:39 -07:00
[js] Revamp the actions API to support the W3C spec and drop support for legacy actions. This is going to hurt users one way or the other: chrome currently only supports legacy actions and firefox only supports W3C. Since all JS changes are now targeting 4.0 (a major version bump), we're dropping support for legacy and moving forward with W3C only. For #4564, #4662
2017-10-08 20:05:35 -07:00
ACTIONS: 'actions',
CLEAR_ACTIONS: 'clearActions',
[js] If the remote end indicates it does not support the new actions API, translate actions to a command sequence against the legacy API and try again. This change only supports translating mouse and keyboard actions. A subsequent change will add support for translating touch pointers. (For #4564)
2017-12-20 20:31:14 -08:00
[js] Actions API changes - Update documentation - Resurrect the legacy API (too difficult to accurately translate touch actions in the new API to legacy commands). The legacy API will be removed once Chrome and Edge support the new API. For #4564
2017-12-27 11:56:08 -08:00
LEGACY_ACTION_CLICK: 'legacyAction:click',
LEGACY_ACTION_DOUBLE_CLICK: 'legacyAction:doubleclick',
[js] If the remote end indicates it does not support the new actions API, translate actions to a command sequence against the legacy API and try again. This change only supports translating mouse and keyboard actions. A subsequent change will add support for translating touch pointers. (For #4564)
2017-12-20 20:31:14 -08:00
LEGACY_ACTION_MOUSE_DOWN: 'legacyAction:mouseDown',
LEGACY_ACTION_MOUSE_UP: 'legacyAction:mouseUp',
LEGACY_ACTION_MOUSE_MOVE: 'legacyAction:mouseMove',
LEGACY_ACTION_SEND_KEYS: 'legacyAction:sendKeys',
[js] Actions API changes - Update documentation - Resurrect the legacy API (too difficult to accurately translate touch actions in the new API to legacy commands). The legacy API will be removed once Chrome and Edge support the new API. For #4564
2017-12-27 11:56:08 -08:00
LEGACY_ACTION_TOUCH_DOWN: 'legacyAction:touchDown',
LEGACY_ACTION_TOUCH_UP: 'legacyAction:touchUp',
LEGACY_ACTION_TOUCH_MOVE: 'legacyAction:touchMove',
LEGACY_ACTION_TOUCH_SCROLL: 'legacyAction:touchScroll',
LEGACY_ACTION_TOUCH_LONG_PRESS: 'legacyAction:touchLongPress',
LEGACY_ACTION_TOUCH_FLICK: 'legacyAction:touchFlick',
LEGACY_ACTION_TOUCH_SINGLE_TAP: 'legacyAction:singleTap',
LEGACY_ACTION_TOUCH_DOUBLE_TAP: 'legacyAction:doubleTap',
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
};
/**
* Handles the execution of WebDriver {@link Command commands}.
[js] Expand on ActionSequence documentation and make it easier to define and execute a single device sequence. For #4564
2017-12-20 22:07:25 -08:00
* @record
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
*/
class Executor {
/**
* Executes the given {@code command}. If there is an error executing the
* command, the provided callback will be invoked with the offending error.
* Otherwise, the callback will be invoked with a null Error and non-null
* response object.
*
* @param {!Command} command The command to execute.
[js] Replace uses of managed-promises with native promises where the promise manager isn't required.
2016-06-08 08:26:34 -07:00
* @return {!Promise<?>} A promise that will be fulfilled with the command
* result.
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
*/
[js] Fix a bunch of type errors found by the closure compiler Most are just bad annotations, but there are a handful of legit bug fixes.
2016-02-08 21:43:09 -08:00
execute(command) {}
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
}
[js] Move the DeferredExecutor class to the command module
2016-01-20 16:59:35 -08:00
[js] Migrate the webdriver.Command* types to a node module
2016-01-20 15:19:04 -08:00
// PUBLIC API
[js] Improve integration with ES6 modules and type checking with the closure compiler.
2016-03-12 11:49:57 -08:00
module.exports = {
Command: Command,
Name: Name,
[js] The http.Executor class now accepts a promised client. The builder will now use this instead of command.DeferredExecutor when creating WebDriver instances, so http.Executors.prototype.defineCommand is exposed for users to define additional commands. The executors module and command.DeferredExecutor class are no longer used anywhere, so they have been removed.
2016-08-06 08:37:25 -07:00
Executor: Executor
[js] Improve integration with ES6 modules and type checking with the closure compiler.
2016-03-12 11:49:57 -08:00
};
Reference in New Issue Copy Permalink