selenium-webdriver 3.3.0 → 4.0.0-alpha.1

package/lib/http.js

@@ -29,13 +29,13 @@ const cmd = require('./command');
 const error = require('./error');
 const logging = require('./logging');
 const promise = require('./promise');
-const Session = require('./session').Session;
-const WebElement = require('./webdriver').WebElement;
+const {Session} = require('./session');
+const {WebElement} = require('./webdriver');
 
-const {getAttribute, isDisplayed} = (function() {
+const {getAttribute, isDisplayed} = /** @suppress {undefinedVars|uselessCode} */(function() {
   try {
     return {
-      getAttribute: require('./atoms/getAttribute.js'),
+      getAttribute: require('./atoms/get-attribute.js'),
       isDisplayed: require('./atoms/is-displayed.js')
     };
   } catch (ex) {
@@ -145,7 +145,7 @@ function resource(method, path) { return {method: method, path: path}; }
 var CommandSpec;
 
 
-/** @typedef {function(!cmd.Command): !Promise<!cmd.Command>} */
+/** @typedef {function(!cmd.Command): !cmd.Command} */
 var CommandTransformer;
 
 
@@ -155,21 +155,17 @@ class InternalTypeError extends TypeError {}
 /**
  * @param {!cmd.Command} command The initial command.
  * @param {Atom} atom The name of the atom to execute.
- * @return {!Promise<!cmd.Command>} The transformed command to execute.
+ * @return {!cmd.Command} The transformed command to execute.
  */
 function toExecuteAtomCommand(command, atom, ...params) {
-  return new Promise((resolve, reject) => {
-    if (typeof atom !== 'function') {
-      reject(new InternalTypeError('atom is not a function: ' + typeof atom));
-      return;
-    }
+  if (typeof atom !== 'function') {
+    throw new InternalTypeError('atom is not a function: ' + typeof atom);
+  }
 
-    let newCmd = new cmd.Command(cmd.Name.EXECUTE_SCRIPT)
-        .setParameter('sessionId', command.getParameter('sessionId'))
-        .setParameter('script', `return (${atom}).apply(null, arguments)`)
-        .setParameter('args', params.map(param => command.getParameter(param)));
-    resolve(newCmd);
-  });
+  return new cmd.Command(cmd.Name.EXECUTE_SCRIPT)
+      .setParameter('sessionId', command.getParameter('sessionId'))
+      .setParameter('script', `return (${atom}).apply(null, arguments)`)
+      .setParameter('args', params.map(param => command.getParameter(param)));
 }
 
 
@@ -179,7 +175,6 @@ const COMMAND_MAP = new Map([
     [cmd.Name.GET_SERVER_STATUS, get('/status')],
     [cmd.Name.NEW_SESSION, post('/session')],
     [cmd.Name.GET_SESSIONS, get('/sessions')],
-    [cmd.Name.DESCRIBE_SESSION, get('/session/:sessionId')],
     [cmd.Name.QUIT, del('/session/:sessionId')],
     [cmd.Name.CLOSE, del('/session/:sessionId/window')],
     [cmd.Name.GET_CURRENT_WINDOW_HANDLE, get('/session/:sessionId/window_handle')],
@@ -211,7 +206,6 @@ const COMMAND_MAP = new Map([
     [cmd.Name.GET_ELEMENT_SIZE, get('/session/:sessionId/element/:id/size')],
     [cmd.Name.GET_ELEMENT_ATTRIBUTE, get('/session/:sessionId/element/:id/attribute/:name')],
     [cmd.Name.GET_ELEMENT_VALUE_OF_CSS_PROPERTY, get('/session/:sessionId/element/:id/css/:propertyName')],
-    [cmd.Name.ELEMENT_EQUALS, get('/session/:sessionId/element/:id/equals/:other')],
     [cmd.Name.TAKE_ELEMENT_SCREENSHOT, get('/session/:sessionId/element/:id/screenshot')],
     [cmd.Name.SWITCH_TO_WINDOW, post('/session/:sessionId/window')],
     [cmd.Name.MAXIMIZE_WINDOW, post('/session/:sessionId/window/current/maximize')],
@@ -225,50 +219,105 @@ const COMMAND_MAP = new Map([
     [cmd.Name.EXECUTE_SCRIPT, post('/session/:sessionId/execute')],
     [cmd.Name.EXECUTE_ASYNC_SCRIPT, post('/session/:sessionId/execute_async')],
     [cmd.Name.SCREENSHOT, get('/session/:sessionId/screenshot')],
+    [cmd.Name.GET_TIMEOUT, get('/session/:sessionId/timeouts')],
     [cmd.Name.SET_TIMEOUT, post('/session/:sessionId/timeouts')],
-    [cmd.Name.MOVE_TO, post('/session/:sessionId/moveto')],
-    [cmd.Name.CLICK, post('/session/:sessionId/click')],
-    [cmd.Name.DOUBLE_CLICK, post('/session/:sessionId/doubleclick')],
-    [cmd.Name.MOUSE_DOWN, post('/session/:sessionId/buttondown')],
-    [cmd.Name.MOUSE_UP, post('/session/:sessionId/buttonup')],
-    [cmd.Name.MOVE_TO, post('/session/:sessionId/moveto')],
-    [cmd.Name.SEND_KEYS_TO_ACTIVE_ELEMENT, post('/session/:sessionId/keys')],
-    [cmd.Name.TOUCH_SINGLE_TAP, post('/session/:sessionId/touch/click')],
-    [cmd.Name.TOUCH_DOUBLE_TAP, post('/session/:sessionId/touch/doubleclick')],
-    [cmd.Name.TOUCH_DOWN, post('/session/:sessionId/touch/down')],
-    [cmd.Name.TOUCH_UP, post('/session/:sessionId/touch/up')],
-    [cmd.Name.TOUCH_MOVE, post('/session/:sessionId/touch/move')],
-    [cmd.Name.TOUCH_SCROLL, post('/session/:sessionId/touch/scroll')],
-    [cmd.Name.TOUCH_LONG_PRESS, post('/session/:sessionId/touch/longclick')],
-    [cmd.Name.TOUCH_FLICK, post('/session/:sessionId/touch/flick')],
     [cmd.Name.ACCEPT_ALERT, post('/session/:sessionId/accept_alert')],
     [cmd.Name.DISMISS_ALERT, post('/session/:sessionId/dismiss_alert')],
     [cmd.Name.GET_ALERT_TEXT, get('/session/:sessionId/alert_text')],
     [cmd.Name.SET_ALERT_TEXT, post('/session/:sessionId/alert_text')],
-    [cmd.Name.SET_ALERT_CREDENTIALS, post('/session/:sessionId/alert/credentials')],
     [cmd.Name.GET_LOG, post('/session/:sessionId/log')],
     [cmd.Name.GET_AVAILABLE_LOG_TYPES, get('/session/:sessionId/log/types')],
     [cmd.Name.GET_SESSION_LOGS, post('/logs')],
     [cmd.Name.UPLOAD_FILE, post('/session/:sessionId/file')],
+    [cmd.Name.LEGACY_ACTION_CLICK, post('/session/:sessionId/click')],
+    [cmd.Name.LEGACY_ACTION_DOUBLE_CLICK, post('/session/:sessionId/doubleclick')],
+    [cmd.Name.LEGACY_ACTION_MOUSE_DOWN, post('/session/:sessionId/buttondown')],
+    [cmd.Name.LEGACY_ACTION_MOUSE_UP, post('/session/:sessionId/buttonup')],
+    [cmd.Name.LEGACY_ACTION_MOUSE_MOVE, post('/session/:sessionId/moveto')],
+    [cmd.Name.LEGACY_ACTION_SEND_KEYS, post('/session/:sessionId/keys')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_DOWN, post('/session/:sessionId/touch/down')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_UP, post('/session/:sessionId/touch/up')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_MOVE, post('/session/:sessionId/touch/move')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_SCROLL, post('/session/:sessionId/touch/scroll')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_LONG_PRESS, post('/session/:sessionId/touch/longclick')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_FLICK, post('/session/:sessionId/touch/flick')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_SINGLE_TAP, post('/session/:sessionId/touch/click')],
+    [cmd.Name.LEGACY_ACTION_TOUCH_DOUBLE_TAP, post('/session/:sessionId/touch/doubleclick')],
 ]);
 
 
 /** @const {!Map<string, (CommandSpec|CommandTransformer)>} */
 const W3C_COMMAND_MAP = new Map([
+  // Server status.
+  [cmd.Name.GET_SERVER_STATUS, get('/status')],
+  // Session management.
+  [cmd.Name.NEW_SESSION, post('/session')],
+  [cmd.Name.QUIT, del('/session/:sessionId')],
+  [cmd.Name.GET_TIMEOUT, get('/session/:sessionId/timeouts')],
+  [cmd.Name.SET_TIMEOUT, post('/session/:sessionId/timeouts')],
+  // Navigation.
+  [cmd.Name.GET_CURRENT_URL, get('/session/:sessionId/url')],
+  [cmd.Name.GET, post('/session/:sessionId/url')],
+  [cmd.Name.GO_BACK, post('/session/:sessionId/back')],
+  [cmd.Name.GO_FORWARD, post('/session/:sessionId/forward')],
+  [cmd.Name.REFRESH, post('/session/:sessionId/refresh')],
+  // Page inspection.
+  [cmd.Name.GET_PAGE_SOURCE, get('/session/:sessionId/source')],
+  [cmd.Name.GET_TITLE, get('/session/:sessionId/title')],
+  // Script execution.
+  [cmd.Name.EXECUTE_SCRIPT, post('/session/:sessionId/execute/sync')],
+  [cmd.Name.EXECUTE_ASYNC_SCRIPT, post('/session/:sessionId/execute/async')],
+  // Frame selection.
+  [cmd.Name.SWITCH_TO_FRAME, post('/session/:sessionId/frame')],
+  [cmd.Name.SWITCH_TO_FRAME_PARENT, post('/session/:sessionId/frame/parent')],
+  // Window management.
+  [cmd.Name.GET_CURRENT_WINDOW_HANDLE, get('/session/:sessionId/window')],
+  [cmd.Name.CLOSE, del('/session/:sessionId/window')],
+  [cmd.Name.SWITCH_TO_WINDOW, post('/session/:sessionId/window')],
+  [cmd.Name.GET_WINDOW_HANDLES, get('/session/:sessionId/window/handles')],
+  [cmd.Name.GET_WINDOW_RECT, get('/session/:sessionId/window/rect')],
+  [cmd.Name.SET_WINDOW_RECT, post('/session/:sessionId/window/rect')],
+  [cmd.Name.MAXIMIZE_WINDOW, post('/session/:sessionId/window/maximize')],
+  [cmd.Name.MINIMIZE_WINDOW, post('/session/:sessionId/window/minimize')],
+  [cmd.Name.FULLSCREEN_WINDOW, post('/session/:sessionId/window/fullscreen')],
+  // Actions.
+  [cmd.Name.ACTIONS, post('/session/:sessionId/actions')],
+  [cmd.Name.CLEAR_ACTIONS, del('/session/:sessionId/actions')],
+  // Locating elements.
   [cmd.Name.GET_ACTIVE_ELEMENT, get('/session/:sessionId/element/active')],
+  [cmd.Name.FIND_ELEMENT, post('/session/:sessionId/element')],
+  [cmd.Name.FIND_ELEMENTS, post('/session/:sessionId/elements')],
+  [cmd.Name.FIND_CHILD_ELEMENT, post('/session/:sessionId/element/:id/element')],
+  [cmd.Name.FIND_CHILD_ELEMENTS, post('/session/:sessionId/element/:id/elements')],
+  // Element interaction.
+  [cmd.Name.GET_ELEMENT_TAG_NAME, get('/session/:sessionId/element/:id/name')],
+  [cmd.Name.GET_ELEMENT_VALUE_OF_CSS_PROPERTY, get('/session/:sessionId/element/:id/css/:propertyName')],
+  [cmd.Name.GET_ELEMENT_RECT, get('/session/:sessionId/element/:id/rect')],
+  [cmd.Name.CLEAR_ELEMENT, post('/session/:sessionId/element/:id/clear')],
+  [cmd.Name.CLICK_ELEMENT, post('/session/:sessionId/element/:id/click')],
+  [cmd.Name.SEND_KEYS_TO_ELEMENT, post('/session/:sessionId/element/:id/value')],
+  [cmd.Name.GET_ELEMENT_TEXT, get('/session/:sessionId/element/:id/text')],
+  [cmd.Name.IS_ELEMENT_ENABLED, get('/session/:sessionId/element/:id/enabled')],
   [cmd.Name.GET_ELEMENT_ATTRIBUTE, (cmd) => {
     return toExecuteAtomCommand(cmd, Atom.GET_ATTRIBUTE, 'id', 'name');
   }],
-  [cmd.Name.GET_ELEMENT_LOCATION, get('/session/:sessionId/element/:id/rect')],
-  [cmd.Name.GET_ELEMENT_SIZE, get('/session/:sessionId/element/:id/rect')],
   [cmd.Name.IS_ELEMENT_DISPLAYED, (cmd) => {
     return toExecuteAtomCommand(cmd, Atom.IS_DISPLAYED, 'id');
   }],
-  [cmd.Name.MAXIMIZE_WINDOW, post('/session/:sessionId/window/maximize')],
-  [cmd.Name.GET_WINDOW_POSITION, get('/session/:sessionId/window/position')],
-  [cmd.Name.SET_WINDOW_POSITION, post('/session/:sessionId/window/position')],
-  [cmd.Name.GET_WINDOW_SIZE, get('/session/:sessionId/window/size')],
-  [cmd.Name.SET_WINDOW_SIZE, post('/session/:sessionId/window/size')],
+  // Cookie management.
+  [cmd.Name.GET_ALL_COOKIES, get('/session/:sessionId/cookie')],
+  [cmd.Name.ADD_COOKIE, post('/session/:sessionId/cookie')],
+  [cmd.Name.DELETE_ALL_COOKIES, del('/session/:sessionId/cookie')],
+  [cmd.Name.GET_COOKIE, get('/session/:sessionId/cookie/:name')],
+  [cmd.Name.DELETE_COOKIE, del('/session/:sessionId/cookie/:name')],
+  // Alert management.
+  [cmd.Name.ACCEPT_ALERT, post('/session/:sessionId/alert/accept')],
+  [cmd.Name.DISMISS_ALERT, post('/session/:sessionId/alert/dismiss')],
+  [cmd.Name.GET_ALERT_TEXT, get('/session/:sessionId/alert/text')],
+  [cmd.Name.SET_ALERT_TEXT, post('/session/:sessionId/alert/text')],
+  // Screenshots.
+  [cmd.Name.SCREENSHOT, get('/session/:sessionId/screenshot')],
+  [cmd.Name.TAKE_ELEMENT_SCREENSHOT, get('/session/:sessionId/element/:id/screenshot')],
 ]);
 
 
@@ -292,35 +341,13 @@ class Client {
 }
 
 
-const CLIENTS =
-    /** !WeakMap<!Executor, !(Client|IThenable<!Client>)> */new WeakMap;
-
-
-/**
- * Sends a request using the given executor.
- * @param {!Executor} executor
- * @param {!Request} request
- * @return {!Promise<Response>}
- */
-function doSend(executor, request) {
-  const client = CLIENTS.get(executor);
-  if (promise.isPromise(client)) {
-    return client.then(client => {
-      CLIENTS.set(executor, client);
-      return client.send(request);
-    });
-  } else {
-    return client.send(request);
-  }
-}
-
 
 /**
  * @param {Map<string, CommandSpec>} customCommands
  *     A map of custom command definitions.
  * @param {boolean} w3c Whether to use W3C command mappings.
  * @param {!cmd.Command} command The command to resolve.
- * @return {!Promise<!Request>} A promise that will resolve with the
+ * @return {!Request} A promise that will resolve with the
  *     command to execute.
  */
 function buildRequest(customCommands, w3c, command) {
@@ -334,8 +361,8 @@ function buildRequest(customCommands, w3c, command) {
     spec = W3C_COMMAND_MAP.get(command.getName());
     if (typeof spec === 'function') {
       LOG.finest(() => `Transforming command for W3C: ${command.getName()}`);
-      return spec(command)
-          .then(newCommand => buildRequest(customCommands, w3c, newCommand));
+      let newCommand = spec(command);
+      return buildRequest(customCommands, w3c, newCommand);
     } else if (spec) {
       return toHttpRequest(spec);
     }
@@ -345,23 +372,26 @@ function buildRequest(customCommands, w3c, command) {
   if (spec) {
     return toHttpRequest(spec);
   }
-  return Promise.reject(
-      new error.UnknownCommandError(
-          'Unrecognized command: ' + command.getName()));
+  throw new error.UnknownCommandError(
+      'Unrecognized command: ' + command.getName());
 
   /**
    * @param {CommandSpec} resource
-   * @return {!Promise<!Request>}
+   * @return {!Request}
    */
   function toHttpRequest(resource) {
     LOG.finest(() => `Building HTTP request: ${JSON.stringify(resource)}`);
     let parameters = command.getParameters();
     let path = buildPath(resource.path, parameters);
-    return Promise.resolve(new Request(resource.method, path, parameters));
+    return new Request(resource.method, path, parameters);
   }
 }
 
 
+const CLIENTS =
+    /** !WeakMap<!Executor, !(Client|IThenable<!Client>)> */new WeakMap;
+
+
 /**
  * A command executor that communicates with the server using JSON over HTTP.
  *
@@ -421,43 +451,41 @@ class Executor {
   }
 
   /** @override */
-  execute(command) {
+  async execute(command) {
     let request = buildRequest(this.customCommands_, this.w3c, command);
-    return request.then(request => {
-      this.log_.finer(() => `>>> ${request.method} ${request.path}`);
-      return doSend(this, request).then(response => {
-        this.log_.finer(() => `>>>\n${request}\n<<<\n${response}`);
-
-        let parsed =
-            parseHttpResponse(
-                command, /** @type {!Response} */ (response), this.w3c);
-
-        if (command.getName() === cmd.Name.NEW_SESSION
-            || command.getName() === cmd.Name.DESCRIBE_SESSION) {
-          if (!parsed || !parsed['sessionId']) {
-            throw new error.WebDriverError(
-                'Unable to parse new session response: ' + response.body);
-          }
-
-          // The remote end is a W3C compliant server if there is no `status`
-          // field in the response. This is not applicable for the DESCRIBE_SESSION
-          // command, which is not defined in the W3C spec.
-          if (command.getName() === cmd.Name.NEW_SESSION) {
-            this.w3c = this.w3c || !('status' in parsed);
-          }
-
-          return new Session(parsed['sessionId'], parsed['value']);
-        }
+    this.log_.finer(() => `>>> ${request.method} ${request.path}`);
 
-        if (parsed
-            && typeof parsed === 'object'
-            && 'value' in parsed) {
-          let value = parsed['value'];
-          return typeof value === 'undefined' ? null : value;
-        }
-        return parsed;
-      });
-    });
+    let client = CLIENTS.get(this);
+    if (promise.isPromise(client)) {
+      client = await client;
+      CLIENTS.set(this, client);
+    }
+
+    let response = await client.send(request);
+    this.log_.finer(() => `>>>\n${request}\n<<<\n${response}`);
+
+    let httpResponse = /** @type {!Response} */(response);
+    let {isW3C, value} = parseHttpResponse(command, httpResponse);
+
+    if (command.getName() === cmd.Name.NEW_SESSION) {
+      if (!value || !value.sessionId) {
+        throw new error.WebDriverError(
+            `Unable to parse new session response: ${response.body}`);
+      }
+
+      // The remote end is a W3C compliant server if there is no `status`
+      // field in the response.
+      if (command.getName() === cmd.Name.NEW_SESSION) {
+        this.w3c = this.w3c || isW3C;
+      }
+
+      // No implementations use the `capabilities` key yet...
+      let capabilities = value.capabilities || value.value;
+      return new Session(
+          /** @type {{sessionId: string}} */(value).sessionId, capabilities);
+    }
+
+    return typeof value === 'undefined' ? null : value;
   }
 }
 
@@ -481,40 +509,44 @@ function tryParse(str) {
  *
  * @param {!cmd.Command} command The command the response is for.
  * @param {!Response} httpResponse The HTTP response to parse.
- * @param {boolean} w3c Whether the response should be processed using the
- *     W3C wire protocol.
- * @return {?} The parsed response.
+ * @return {{isW3C: boolean, value: ?}} An object describing the parsed
+ *     response. This object will have two fields: `isW3C` indicates whether
+ *     the response looks like it came from a remote end that conforms with the
+ *     W3C WebDriver spec, and `value`, the actual response value.
  * @throws {WebDriverError} If the HTTP response is an error.
  */
-function parseHttpResponse(command, httpResponse, w3c) {
-  let parsed = tryParse(httpResponse.body);
-  if (parsed !== undefined) {
-    if (httpResponse.status < 200) {
-      // This should never happen, but throw the raw response so
-      // users report it.
-      throw new error.WebDriverError(
-          `Unexpected HTTP response:\n${httpResponse}`);
-    }
+function parseHttpResponse(command, httpResponse) {
+  if (httpResponse.status < 200) {
+    // This should never happen, but throw the raw response so users report it.
+    throw new error.WebDriverError(
+        `Unexpected HTTP response:\n${httpResponse}`);
+  }
 
-    if (w3c) {
-      if (httpResponse.status > 399) {
-        error.throwDecodedError(parsed);
+  let parsed = tryParse(httpResponse.body);
+  if (parsed && typeof parsed === 'object') {
+    let value = parsed.value;
+    let isW3C =
+        value !== null && typeof value === 'object'
+            && typeof parsed.status === 'undefined';
+
+    if (!isW3C) {
+      error.checkLegacyResponse(parsed);
+
+      // Adjust legacy new session responses to look like W3C to simplify
+      // later processing.
+      if (command.getName() === cmd.Name.NEW_SESSION) {
+        value = parsed;
       }
-      return parsed;
-    }
 
-    // If this is a new session command, we need to check for a W3C compliant
-    // error object. This is necessary since a successful new session command
-    // is what puts the executor into W3C mode.
-    if (httpResponse.status > 399
-        && (command.getName() == cmd.Name.NEW_SESSION
-            || command.getName() === cmd.Name.DESCRIBE_SESSION)
-        && error.isErrorResponse(parsed)) {
-      error.throwDecodedError(parsed);
+    } else if (httpResponse.status > 399) {
+      error.throwDecodedError(value);
     }
 
-    error.checkLegacyResponse(parsed);
-    return parsed;
+    return {isW3C, value};
+  }
+
+  if (parsed !== undefined) {
+    return {isW3C: false, value: parsed};
   }
 
   let value = httpResponse.body.replace(/\r\n/g, '\n');
@@ -527,7 +559,7 @@ function parseHttpResponse(command, httpResponse, w3c) {
     throw new error.WebDriverError(value);
   }
 
-  return value || null;
+  return {isW3C: false, value: value || null};
 }