@appium/base-driver 9.17.0 → 10.0.0-beta.1

package/lib/protocol/helpers.js

@@ -7,17 +7,19 @@ import {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY} from '../constants';
  * so they have keys for both W3C and JSONWP protocols.
  * The argument value is NOT mutated
  *
- * @param {?Object} resValue The actual response value
- * @returns {?Object} Either modified value or the same one if
+ * @param {Object | undefined} resValue The actual response value
+ * @returns {Object | null} Either modified value or the same one if
  * nothing has been modified
  */
-function formatResponseValue(resValue) {
+export function formatResponseValue(resValue) {
   if (_.isUndefined(resValue)) {
     // convert undefined to null
     return null;
   }
-  // If the MJSONWP element key format (ELEMENT) was provided, add a duplicate key (element-6066-11e4-a52e-4f735466cecf)
-  // If the W3C element key format (element-6066-11e4-a52e-4f735466cecf) was provided, add a duplicate key (ELEMENT)
+  // If the MJSONWP element key format (ELEMENT) was provided,
+  // add a duplicate key (element-6066-11e4-a52e-4f735466cecf)
+  // If the W3C element key format (element-6066-11e4-a52e-4f735466cecf)
+  // was provided, add a duplicate key (ELEMENT)
   return duplicateKeys(resValue, MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY);
 }
 
@@ -28,8 +30,10 @@ function formatResponseValue(resValue) {
  * @param {Object} responseBody
  * @returns {Object} The fixed response body
  */
-function formatStatus(responseBody) {
-  return _.isPlainObject(responseBody) ? _.omit(responseBody, ['status']) : responseBody;
+export function ensureW3cResponse(responseBody) {
+  return _.isPlainObject(responseBody)
+    ? _.omit(responseBody, ['status', 'sessionId'])
+    : responseBody;
 }
 
-export {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY, formatResponseValue, formatStatus};
+export {MJSONWP_ELEMENT_KEY, W3C_ELEMENT_KEY};

package/lib/protocol/protocol.js

@@ -7,10 +7,11 @@ import {
   getResponseForW3CError,
   errorFromMJSONWPStatusCode,
   errorFromW3CJsonCode,
+  BadParametersError,
 } from './errors';
 import {METHOD_MAP, NO_SESSION_ID_COMMANDS} from './routes';
 import B from 'bluebird';
-import {formatResponseValue, formatStatus} from './helpers';
+import {formatResponseValue, ensureW3cResponse} from './helpers';
 import {MAX_LOG_BODY_LENGTH, PROTOCOLS, DEFAULT_BASE_PATH} from '../constants';
 import {isW3cCaps} from '../helpers/capabilities';
 import log from '../basedriver/logger';
@@ -29,21 +30,32 @@ function determineProtocol(createSessionArgs) {
   return _.some(createSessionArgs, isW3cCaps) ? PROTOCOLS.W3C : PROTOCOLS.MJSONWP;
 }
 
+/**
+ *
+ * @param {import('../basedriver/driver').BaseDriver} driver
+ * @param {string | null} [sessionId=null]
+ * @returns {keyof PROTOCOLS}
+ */
 function extractProtocol(driver, sessionId = null) {
-  const dstDriver = _.isFunction(driver.driverForSession)
+  const dstDriver = _.isFunction(driver.driverForSession) && sessionId
     ? driver.driverForSession(sessionId)
     : driver;
   if (dstDriver === driver) {
     // Shortcircuit if the driver instance is not an umbrella driver
     // or it is Fake driver instance, where `driver.driverForSession`
     // always returns self instance
-    return driver.protocol;
+    return driver.protocol ?? PROTOCOLS.W3C;
   }
 
   // Extract the protocol for the current session if the given driver is the umbrella one
   return dstDriver?.protocol ?? PROTOCOLS.W3C;
 }
 
+/**
+ *
+ * @param {any} command
+ * @returns {boolean}
+ */
 function isSessionCommand(command) {
   return !_.includes(NO_SESSION_ID_COMMANDS, command);
 }
@@ -123,7 +135,7 @@ export function checkParams(paramSets, jsonObj, protocol) {
     if (paramSets.validate) {
       let message = paramSets.validate(jsonObj, protocol);
       if (message) {
-        throw new errors.BadParametersError(message, jsonObj);
+        throw new errors.InvalidArgumentError(message);
       }
     }
   }
@@ -154,7 +166,7 @@ export function checkParams(paramSets, jsonObj, protocol) {
       return;
     }
   }
-  throw new errors.BadParametersError(paramSets, receivedParams);
+  throw new BadParametersError(paramSets, receivedParams);
 }
 
 /*
@@ -287,9 +299,9 @@ function routeConfiguringFunction(driver) {
 }
 
 function buildHandler(app, method, path, spec, driver, isSessCmd) {
-  let asyncHandler = async (req, res) => {
+  let asyncHandler = async (/** @type {import('express').Request} */ req, /** @type {import('express').Response} */ res) => {
     let jsonObj = req.body;
-    let httpResBody = {};
+    let httpResBody = /** @type {any} */ ({});
     let httpStatus = 200;
     let newSessionId;
     let currentProtocol = extractProtocol(driver, req.params.sessionId);
@@ -489,24 +501,14 @@ function buildHandler(app, method, path, spec, driver, isSessCmd) {
 
     // decode the response, which is either a string or json
     if (_.isString(httpResBody)) {
-      res.status(httpStatus).send(httpResBody);
+      res.status(httpStatus)
+        .setHeader('content-type', 'application/json; charset=utf-8')
+        .send(httpResBody);
     } else {
-      if (newSessionId) {
-        if (currentProtocol === PROTOCOLS.W3C) {
-          httpResBody.value.sessionId = newSessionId;
-        } else {
-          httpResBody.sessionId = newSessionId;
-        }
-      } else {
-        httpResBody.sessionId = req.params.sessionId || null;
+      if (newSessionId && currentProtocol === PROTOCOLS.W3C) {
+        httpResBody.value.sessionId = newSessionId;
       }
-      // Don't include sessionId in W3C responses
-      if (currentProtocol === PROTOCOLS.W3C) {
-        delete httpResBody.sessionId;
-      }
-
-      httpResBody = formatStatus(httpResBody);
-      res.status(httpStatus).json(httpResBody);
+      res.status(httpStatus).json(ensureW3cResponse(httpResBody));
     }
   };
   // add the method to the app