selenium-webdriver 3.3.0 → 4.0.0-alpha.1

package/lib/command.js

@@ -90,7 +90,6 @@ const Name = {
 
   NEW_SESSION: 'newSession',
   GET_SESSIONS: 'getSessions',
-  DESCRIBE_SESSION: 'getSessionCapabilities',
 
   CLOSE: 'close',
   QUIT: 'quit',
@@ -124,10 +123,15 @@ const Name = {
   SET_WINDOW_POSITION: 'setWindowPosition',
   GET_WINDOW_SIZE: 'getWindowSize',
   SET_WINDOW_SIZE: 'setWindowSize',
+  GET_WINDOW_RECT: 'getWindowRect',
+  SET_WINDOW_RECT: 'setWindowRect',
   MAXIMIZE_WINDOW: 'maximizeWindow',
+  MINIMIZE_WINDOW: 'minimizeWindow',
+  FULLSCREEN_WINDOW: 'fullscreenWindow',
 
   SWITCH_TO_WINDOW: 'switchToWindow',
   SWITCH_TO_FRAME: 'switchToFrame',
+  SWITCH_TO_FRAME_PARENT: 'switchToFrameParent',
   GET_PAGE_SOURCE: 'getPageSource',
   GET_TITLE: 'getTitle',
 
@@ -141,81 +145,55 @@ const Name = {
   IS_ELEMENT_DISPLAYED: 'isElementDisplayed',
   GET_ELEMENT_LOCATION: 'getElementLocation',
   GET_ELEMENT_LOCATION_IN_VIEW: 'getElementLocationOnceScrolledIntoView',
+  GET_ELEMENT_RECT: 'getElementRect',
   GET_ELEMENT_SIZE: 'getElementSize',
   GET_ELEMENT_ATTRIBUTE: 'getElementAttribute',
   GET_ELEMENT_VALUE_OF_CSS_PROPERTY: 'getElementValueOfCssProperty',
-  ELEMENT_EQUALS: 'elementEquals',
 
   SCREENSHOT: 'screenshot',
   TAKE_ELEMENT_SCREENSHOT: 'takeElementScreenshot',
   IMPLICITLY_WAIT: 'implicitlyWait',
   SET_SCRIPT_TIMEOUT: 'setScriptTimeout',
+
+  GET_TIMEOUT: 'getTimeout',
   SET_TIMEOUT: 'setTimeout',
 
   ACCEPT_ALERT: 'acceptAlert',
   DISMISS_ALERT: 'dismissAlert',
   GET_ALERT_TEXT: 'getAlertText',
   SET_ALERT_TEXT: 'setAlertValue',
-  SET_ALERT_CREDENTIALS: 'setAlertCredentials',
-
-  EXECUTE_SQL: 'executeSQL',
-  GET_LOCATION: 'getLocation',
-  SET_LOCATION: 'setLocation',
-  GET_APP_CACHE: 'getAppCache',
-  GET_APP_CACHE_STATUS: 'getStatus',
-  CLEAR_APP_CACHE: 'clearAppCache',
-  IS_BROWSER_ONLINE: 'isBrowserOnline',
-  SET_BROWSER_ONLINE: 'setBrowserOnline',
-
-  GET_LOCAL_STORAGE_ITEM: 'getLocalStorageItem',
-  GET_LOCAL_STORAGE_KEYS: 'getLocalStorageKeys',
-  SET_LOCAL_STORAGE_ITEM: 'setLocalStorageItem',
-  REMOVE_LOCAL_STORAGE_ITEM: 'removeLocalStorageItem',
-  CLEAR_LOCAL_STORAGE: 'clearLocalStorage',
-  GET_LOCAL_STORAGE_SIZE: 'getLocalStorageSize',
-
-  GET_SESSION_STORAGE_ITEM: 'getSessionStorageItem',
-  GET_SESSION_STORAGE_KEYS: 'getSessionStorageKey',
-  SET_SESSION_STORAGE_ITEM: 'setSessionStorageItem',
-  REMOVE_SESSION_STORAGE_ITEM: 'removeSessionStorageItem',
-  CLEAR_SESSION_STORAGE: 'clearSessionStorage',
-  GET_SESSION_STORAGE_SIZE: 'getSessionStorageSize',
-
-  SET_SCREEN_ORIENTATION: 'setScreenOrientation',
-  GET_SCREEN_ORIENTATION: 'getScreenOrientation',
-
-  // These belong to the Advanced user interactions - an element is
-  // optional for these commands.
-  CLICK: 'mouseClick',
-  DOUBLE_CLICK: 'mouseDoubleClick',
-  MOUSE_DOWN: 'mouseButtonDown',
-  MOUSE_UP: 'mouseButtonUp',
-  MOVE_TO: 'mouseMoveTo',
-  SEND_KEYS_TO_ACTIVE_ELEMENT: 'sendKeysToActiveElement',
-
-  // These belong to the Advanced Touch API
-  TOUCH_SINGLE_TAP: 'touchSingleTap',
-  TOUCH_DOWN: 'touchDown',
-  TOUCH_UP: 'touchUp',
-  TOUCH_MOVE: 'touchMove',
-  TOUCH_SCROLL: 'touchScroll',
-  TOUCH_DOUBLE_TAP: 'touchDoubleTap',
-  TOUCH_LONG_PRESS: 'touchLongPress',
-  TOUCH_FLICK: 'touchFlick',
 
   GET_AVAILABLE_LOG_TYPES: 'getAvailableLogTypes',
   GET_LOG: 'getLog',
   GET_SESSION_LOGS: 'getSessionLogs',
 
   // Non-standard commands used by the standalone Selenium server.
-  UPLOAD_FILE: 'uploadFile'
+  UPLOAD_FILE: 'uploadFile',
+
+  ACTIONS: 'actions',
+  CLEAR_ACTIONS: 'clearActions',
+
+  LEGACY_ACTION_CLICK: 'legacyAction:click',
+  LEGACY_ACTION_DOUBLE_CLICK: 'legacyAction:doubleclick',
+  LEGACY_ACTION_MOUSE_DOWN: 'legacyAction:mouseDown',
+  LEGACY_ACTION_MOUSE_UP: 'legacyAction:mouseUp',
+  LEGACY_ACTION_MOUSE_MOVE: 'legacyAction:mouseMove',
+  LEGACY_ACTION_SEND_KEYS: 'legacyAction:sendKeys',
+  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',
 };
 
 
 
 /**
  * Handles the execution of WebDriver {@link Command commands}.
- * @interface
+ * @record
  */
 class Executor {
   /**

package/lib/error.js

@@ -28,6 +28,27 @@ class WebDriverError extends Error {
 
     /** @override */
     this.name = this.constructor.name;
+
+    /**
+     * A stacktrace reported by the remote webdriver endpoint that initially
+     * reported this error. This property will be an empty string if the remote
+     * end did not provide a stacktrace.
+     * @type {string}
+     */
+    this.remoteStacktrace = '';
+  }
+}
+
+
+/**
+ * Indicates a {@linkplain ./webdriver.WebElement#click click command} could not
+ * completed because the click target is obscured by other elements on the
+ * page.
+ */
+class ElementClickInterceptedError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error);
   }
 }
 
@@ -44,10 +65,24 @@ class ElementNotSelectableError extends WebDriverError {
 
 
 /**
- * An element command could not be completed because the element is not visible
- * on the page.
+ * Indicates a command could not be completed because the target element is
+ * not pointer or keyboard interactable. This will often occur if an element
+ * is present in the DOM, but not rendered (i.e. its CSS style has
+ * "display: none").
+ */
+class ElementNotInteractableError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error);
+  }
+}
+
+
+/**
+ * Indicates a navigation event caused the browser to generate a certificate
+ * warning. This is usually caused by an expired or invalid TLS certificate.
  */
-class ElementNotVisibleError extends WebDriverError {
+class InsecureCertificateError extends WebDriverError {
   /** @param {string=} opt_error the error message, if any. */
   constructor(opt_error) {
     super(opt_error);
@@ -81,7 +116,7 @@ class InvalidCookieDomainError extends WebDriverError {
 /**
  * The coordinates provided to an interactions operation are invalid.
  */
-class InvalidElementCoordinatesError extends WebDriverError {
+class InvalidCoordinatesError extends WebDriverError {
   /** @param {string=} opt_error the error message, if any. */
   constructor(opt_error) {
     super(opt_error);
@@ -158,6 +193,18 @@ class NoSuchAlertError extends WebDriverError {
 }
 
 
+/**
+ * Indicates a named cookie could not be found in the cookie jar for the
+ * currently selected document.
+ */
+class NoSuchCookieError extends WebDriverError {
+  /** @param {string=} opt_error the error message, if any. */
+  constructor(opt_error) {
+    super(opt_error);
+  }
+}
+
+
 /**
  * An element could not be located on the page using the given search
  * parameters.
@@ -332,6 +379,7 @@ class UnsupportedOperationError extends WebDriverError {
  */
 const ErrorCode = {
   SUCCESS: 0,
+  NO_SUCH_SESSION: 6,
   NO_SUCH_ELEMENT: 7,
   NO_SUCH_FRAME: 8,
   UNKNOWN_COMMAND: 9,
@@ -359,16 +407,21 @@ const ErrorCode = {
   SQL_DATABASE_ERROR: 35,
   INVALID_XPATH_SELECTOR: 51,
   INVALID_XPATH_SELECTOR_RETURN_TYPE: 52,
+  ELEMENT_NOT_INTERACTABLE: 60,
+  INVALID_ARGUMENT: 61,
+  NO_SUCH_COOKIE: 62,
+  UNABLE_TO_CAPTURE_SCREEN: 63,
+  ELEMENT_CLICK_INTERCEPTED: 64,
   METHOD_NOT_ALLOWED: 405
 };
 
 
 const LEGACY_ERROR_CODE_TO_TYPE = new Map([
+    [ErrorCode.NO_SUCH_SESSION, NoSuchSessionError],
     [ErrorCode.NO_SUCH_ELEMENT, NoSuchElementError],
     [ErrorCode.NO_SUCH_FRAME, NoSuchFrameError],
     [ErrorCode.UNSUPPORTED_OPERATION, UnsupportedOperationError],
     [ErrorCode.STALE_ELEMENT_REFERENCE, StaleElementReferenceError],
-    [ErrorCode.ELEMENT_NOT_VISIBLE, ElementNotVisibleError],
     [ErrorCode.INVALID_ELEMENT_STATE, InvalidElementStateError],
     [ErrorCode.UNKNOWN_ERROR, WebDriverError],
     [ErrorCode.ELEMENT_NOT_SELECTABLE, ElementNotSelectableError],
@@ -381,28 +434,36 @@ const LEGACY_ERROR_CODE_TO_TYPE = new Map([
     [ErrorCode.UNEXPECTED_ALERT_OPEN, UnexpectedAlertOpenError],
     [ErrorCode.NO_SUCH_ALERT, NoSuchAlertError],
     [ErrorCode.SCRIPT_TIMEOUT, ScriptTimeoutError],
-    [ErrorCode.INVALID_ELEMENT_COORDINATES, InvalidElementCoordinatesError],
+    [ErrorCode.INVALID_ELEMENT_COORDINATES, InvalidCoordinatesError],
     [ErrorCode.INVALID_SELECTOR_ERROR, InvalidSelectorError],
     [ErrorCode.SESSION_NOT_CREATED, SessionNotCreatedError],
     [ErrorCode.MOVE_TARGET_OUT_OF_BOUNDS, MoveTargetOutOfBoundsError],
     [ErrorCode.INVALID_XPATH_SELECTOR, InvalidSelectorError],
     [ErrorCode.INVALID_XPATH_SELECTOR_RETURN_TYPE, InvalidSelectorError],
+    [ErrorCode.ELEMENT_NOT_INTERACTABLE, ElementNotInteractableError],
+    [ErrorCode.INVALID_ARGUMENT, InvalidArgumentError],
+    [ErrorCode.NO_SUCH_COOKIE, NoSuchCookieError],
+    [ErrorCode.UNABLE_TO_CAPTURE_SCREEN, UnableToCaptureScreenError],
+    [ErrorCode.ELEMENT_CLICK_INTERCEPTED, ElementClickInterceptedError],
     [ErrorCode.METHOD_NOT_ALLOWED, UnsupportedOperationError]]);
 
 
 const ERROR_CODE_TO_TYPE = new Map([
     ['unknown error', WebDriverError],
+    ['element click intercepted', ElementClickInterceptedError],
+    ['element not interactable', ElementNotInteractableError],
     ['element not selectable', ElementNotSelectableError],
-    ['element not visible', ElementNotVisibleError],
+    ['insecure certificate', InsecureCertificateError],
     ['invalid argument', InvalidArgumentError],
     ['invalid cookie domain', InvalidCookieDomainError],
-    ['invalid element coordinates', InvalidElementCoordinatesError],
+    ['invalid coordinates', InvalidCoordinatesError],
     ['invalid element state', InvalidElementStateError],
     ['invalid selector', InvalidSelectorError],
     ['invalid session id', NoSuchSessionError],
     ['javascript error', JavascriptError],
     ['move target out of bounds', MoveTargetOutOfBoundsError],
     ['no such alert', NoSuchAlertError],
+    ['no such cookie', NoSuchCookieError],
     ['no such element', NoSuchElementError],
     ['no such frame', NoSuchFrameError],
     ['no such window', NoSuchWindowError],
@@ -486,7 +547,14 @@ function isErrorResponse(data) {
 function throwDecodedError(data) {
   if (isErrorResponse(data)) {
     let ctor = ERROR_CODE_TO_TYPE.get(data.error) || WebDriverError;
-    throw new ctor(data.message);
+    let err = new ctor(data.message);
+    // TODO(jleyba): remove whichever case is excluded from the final W3C spec.
+    if (typeof data.stacktrace === 'string') {
+      err.remoteStacktrace = data.stacktrace;
+    } else if (typeof data.stackTrace === 'string') {
+      err.remoteStacktrace = data.stackTrace;
+    }
+    throw err;
   }
   throw new WebDriverError('Unknown error: ' + JSON.stringify(data));
 }
@@ -532,37 +600,40 @@ function checkLegacyResponse(responseObj) {
 
 
 module.exports = {
-  ErrorCode: ErrorCode,
-
-  WebDriverError: WebDriverError,
-  ElementNotSelectableError: ElementNotSelectableError,
-  ElementNotVisibleError: ElementNotVisibleError,
-  InvalidArgumentError: InvalidArgumentError,
-  InvalidCookieDomainError: InvalidCookieDomainError,
-  InvalidElementCoordinatesError: InvalidElementCoordinatesError,
-  InvalidElementStateError: InvalidElementStateError,
-  InvalidSelectorError: InvalidSelectorError,
-  JavascriptError: JavascriptError,
-  MoveTargetOutOfBoundsError: MoveTargetOutOfBoundsError,
-  NoSuchAlertError: NoSuchAlertError,
-  NoSuchElementError: NoSuchElementError,
-  NoSuchFrameError: NoSuchFrameError,
-  NoSuchSessionError: NoSuchSessionError,
-  NoSuchWindowError: NoSuchWindowError,
-  ScriptTimeoutError: ScriptTimeoutError,
-  SessionNotCreatedError: SessionNotCreatedError,
-  StaleElementReferenceError: StaleElementReferenceError,
-  TimeoutError: TimeoutError,
-  UnableToSetCookieError: UnableToSetCookieError,
-  UnableToCaptureScreenError: UnableToCaptureScreenError,
-  UnexpectedAlertOpenError: UnexpectedAlertOpenError,
-  UnknownCommandError: UnknownCommandError,
-  UnknownMethodError: UnknownMethodError,
-  UnsupportedOperationError: UnsupportedOperationError,
-
-  checkResponse: checkResponse,
-  checkLegacyResponse: checkLegacyResponse,
-  encodeError: encodeError,
-  isErrorResponse: isErrorResponse,
-  throwDecodedError: throwDecodedError,
+  ErrorCode,
+
+  WebDriverError,
+  ElementClickInterceptedError,
+  ElementNotInteractableError,
+  ElementNotSelectableError,
+  InsecureCertificateError,
+  InvalidArgumentError,
+  InvalidCookieDomainError,
+  InvalidCoordinatesError,
+  InvalidElementStateError,
+  InvalidSelectorError,
+  JavascriptError,
+  MoveTargetOutOfBoundsError,
+  NoSuchAlertError,
+  NoSuchCookieError,
+  NoSuchElementError,
+  NoSuchFrameError,
+  NoSuchSessionError,
+  NoSuchWindowError,
+  ScriptTimeoutError,
+  SessionNotCreatedError,
+  StaleElementReferenceError,
+  TimeoutError,
+  UnableToSetCookieError,
+  UnableToCaptureScreenError,
+  UnexpectedAlertOpenError,
+  UnknownCommandError,
+  UnknownMethodError,
+  UnsupportedOperationError,
+
+  checkResponse,
+  checkLegacyResponse,
+  encodeError,
+  isErrorResponse,
+  throwDecodedError,
 };