@appium/base-driver 10.2.0 → 10.2.1

package/lib/express/express-logging.js

@@ -1,60 +0,0 @@
-import _ from 'lodash';
-import '@colors/colors';
-import morgan from 'morgan';
-import log from './logger';
-import {MAX_LOG_BODY_LENGTH} from '../constants';
-import {logger} from '@appium/support';
-
-// Copied the morgan compile function over so that cooler formats
-// may be configured
-function compile(fmt) {
-  // escape quotes
-  fmt = fmt.replace(/"/g, '\\"');
-  fmt = fmt.replace(/:([-\w]{2,})(?:\[([^\]]+)\])?/g, function replace(_, name, arg) {
-    return `"\n    + (tokens["${name}"](req, res, "${arg}") || "-") + "`;
-  });
-  let js = `  return "${fmt}";`;
-  return new Function('tokens, req, res', js);
-}
-
-function requestEndLoggingFormat(tokens, req, res) {
-  let status = res.statusCode;
-  let statusStr = ':status';
-  if (status >= 500) {
-    statusStr = statusStr.red;
-  } else if (status >= 400) {
-    statusStr = statusStr.yellow;
-  } else if (status >= 300) {
-    statusStr = statusStr.cyan;
-  } else {
-    statusStr = statusStr.green;
-  }
-  let fn = compile(
-    `${'<-- :method :url '.white}${statusStr} ${':response-time ms - :res[content-length]'.grey}`
-  );
-  return fn(tokens, req, res);
-}
-
-const endLogFormatter = morgan((tokens, req, res) => {
-  log.info(requestEndLoggingFormat(tokens, req, res), (res.jsonResp || '').grey);
-});
-
-const requestStartLoggingFormat = compile(`${'-->'.white} ${':method'.white} ${':url'.white}`);
-
-const startLogFormatter = morgan(
-  (tokens, req, res) => {
-    // morgan output is redirected straight to winston
-    let reqBody = '';
-    if (req.body) {
-      try {
-        reqBody = _.truncate(_.isString(req.body) ? req.body : JSON.stringify(req.body), {
-          length: MAX_LOG_BODY_LENGTH,
-        });
-      } catch {}
-    }
-    log.info(requestStartLoggingFormat(tokens, req, res), logger.markSensitive(reqBody.grey));
-  },
-  {immediate: true}
-);
-
-export {endLogFormatter, startLogFormatter};

package/lib/express/logger.js

@@ -1,4 +0,0 @@
-import {logger} from '@appium/support';
-
-const log = logger.getLogger('HTTP');
-export default log;

package/lib/express/middleware.js

@@ -1,171 +0,0 @@
-import _ from 'lodash';
-import log from './logger';
-import {errors} from '../protocol';
-export {handleIdempotency} from './idempotency';
-import {match} from 'path-to-regexp';
-import {util} from '@appium/support';
-import {calcSignature} from '../helpers/session';
-import {getResponseForW3CError} from '../protocol/errors';
-
-const SESSION_ID_PATTERN = /\/session\/([^/]+)/;
-
-/**
- *
- * @param {import('express').Request} req
- * @param {import('express').Response} res
- * @param {import('express').NextFunction} next
- * @returns {any}
- */
-export function allowCrossDomain(req, res, next) {
-  res.header('Access-Control-Allow-Origin', '*');
-  res.header('Access-Control-Allow-Methods', 'GET, POST, PUT, OPTIONS, DELETE');
-  res.header(
-    'Access-Control-Allow-Headers',
-    'Cache-Control, Pragma, Origin, X-Requested-With, Content-Type, Accept, User-Agent'
-  );
-
-  // need to respond 200 to OPTIONS
-  if ('OPTIONS' === req.method) {
-    return res.sendStatus(200);
-  }
-  next();
-}
-
-/**
- * @param {string} basePath
- * @returns {import('express').RequestHandler}
- */
-export function allowCrossDomainAsyncExecute(basePath) {
-  return (req, res, next) => {
-    // there are two paths for async responses, so cover both
-    // https://regex101.com/r/txYiEz/1
-    const receiveAsyncResponseRegExp = new RegExp(
-      `${_.escapeRegExp(basePath)}/session/[a-f0-9-]+/(appium/)?receive_async_response`
-    );
-    if (!receiveAsyncResponseRegExp.test(req.url)) {
-      return next();
-    }
-    allowCrossDomain(req, res, next);
-  };
-}
-
-/**
- *
- * @param {import('express').Request} req
- * @param {import('express').Response} res
- * @param {import('express').NextFunction} next
- * @returns {any}
- */
-export function handleLogContext(req, res, next) {
-  const requestId = fetchHeaderValue(req, 'x-request-id') || util.uuidV4();
-
-  const sessionId = SESSION_ID_PATTERN.exec(req.url)?.[1];
-  const sessionInfo = sessionId ? {sessionId, sessionSignature: calcSignature(sessionId)} : {};
-  const isSensitiveHeaderValue = fetchHeaderValue(req, 'x-appium-is-sensitive');
-
-  log.updateAsyncContext({
-    requestId,
-    ...sessionInfo,
-    isSensitive: ['true', '1', 'yes'].includes(_.toLower(isSensitiveHeaderValue)),
-  }, true);
-
-  return next();
-}
-
-/**
- *
- * @param {import('express').Request} req
- * @param {import('express').Response} res
- * @param {import('express').NextFunction} next
- * @returns {any}
- */
-export function defaultToJSONContentType(req, res, next) {
-  if (!req.headers['content-type']) {
-    req.headers['content-type'] = 'application/json; charset=utf-8';
-  }
-  next();
-}
-
-/**
- * Core function to handle WebSocket upgrade requests by matching the request path
- * against registered WebSocket handlers in the webSocketsMapping.
- *
- * @param {import('http').IncomingMessage} req - The HTTP request
- * @param {import('stream').Duplex} socket - The network socket
- * @param {Buffer} head - The first packet of the upgraded stream
- * @param {import('@appium/types').StringRecord<import('@appium/types').WSServer>} webSocketsMapping - Mapping of paths to WebSocket servers
- * @returns {boolean} - Returns true if the upgrade was handled, false otherwise
- */
-export function tryHandleWebSocketUpgrade(req, socket, head, webSocketsMapping) {
-  if (_.toLower(req.headers?.upgrade) !== 'websocket') {
-    return false;
-  }
-
-  let currentPathname;
-  try {
-    currentPathname = new URL(req.url ?? '', 'http://localhost').pathname;
-  } catch {
-    currentPathname = req.url ?? '';
-  }
-  for (const [pathname, wsServer] of _.toPairs(webSocketsMapping)) {
-    if (match(pathname)(currentPathname)) {
-      wsServer.handleUpgrade(req, socket, head, (ws) => {
-        wsServer.emit('connection', ws, req);
-      });
-      return true;
-    }
-  }
-  log.info(`Did not match the websocket upgrade request at ${currentPathname} to any known route`);
-  return false;
-}
-
-/**
- *
- * @param {import('@appium/types').StringRecord<import('@appium/types').WSServer>} webSocketsMapping
- * @returns {import('express').RequestHandler}
- */
-export function handleUpgrade(webSocketsMapping) {
-  return (req, res, next) => {
-    if (tryHandleWebSocketUpgrade(req, req.socket, Buffer.from(''), webSocketsMapping)) {
-      return;
-    }
-    next();
-  };
-}
-
-/**
- * @param {Error} err
- * @param {import('express').Request} req
- * @param {import('express').Response} res
- * @param {import('express').NextFunction} next
- */
-export function catchAllHandler(err, req, res, next) {
-  if (res.headersSent) {
-    return next(err);
-  }
-
-  log.error(`Uncaught error: ${err.message}`);
-  const [status, body] = getResponseForW3CError(err);
-  res.status(status).json(body);
-}
-
-/**
- * @param {import('express').Request} req
- * @param {import('express').Response} res
- */
-export function catch404Handler(req, res) {
-  log.debug(`No route found for ${req.url}`);
-  const [status, body] = getResponseForW3CError(new errors.UnknownCommandError());
-  res.status(status).json(body);
-}
-
-/**
- * @param {import('express').Request} req
- * @param {string} name
- * @returns {string | undefined}
- */
-function fetchHeaderValue(req, name) {
-  return _.isArray(req.headers[name])
-    ? req.headers[name][0]
-    : req.headers[name];
-}

package/lib/express/static.js

@@ -1,76 +0,0 @@
-import path from 'node:path';
-import log from './logger';
-import _ from 'lodash';
-import {fs} from '@appium/support';
-import B from 'bluebird';
-
-let STATIC_DIR = path.resolve(__dirname, '..', '..', '..', 'static');
-if (_.isNull(path.resolve(__dirname).match(/build[/\\]lib[/\\]express$/))) {
-  // in some contexts we are not in the build directory,
-  // so we don't want to go back the extra level
-  STATIC_DIR = path.resolve(__dirname, '..', '..', 'static');
-}
-
-async function guineaPigTemplate(req, res, page) {
-  const delay = parseInt(req.params.delay || req.query.delay || 0, 10);
-  const throwError = req.params.throwError || req.query.throwError || '';
-  let params = {
-    throwError,
-    serverTime: new Date(),
-    userAgent: req.headers['user-agent'],
-    comment: 'None',
-  };
-  if (req.method === 'POST') {
-    params.comment = req.body.comments || params.comment;
-  }
-  log.debug(`Sending guinea pig response with params: ${JSON.stringify(params)}`);
-  if (delay) {
-    log.debug(`Waiting ${delay}ms before responding`);
-    await B.delay(delay);
-  }
-  res.set('content-type', 'text/html');
-  res.cookie('guineacookie1', 'i am a cookie value', {path: '/'});
-  res.cookie('guineacookie2', 'cookié2', {path: '/'});
-  res.cookie('guineacookie3', 'cant access this', {
-    domain: '.blargimarg.com',
-    path: '/',
-  });
-  res.send((await getTemplate(page))(params));
-}
-
-/*
- * Dynamic page mapped to /test/guinea-pig
- */
-async function guineaPig(req, res) {
-  return await guineaPigTemplate(req, res, 'guinea-pig.html');
-}
-
-/*
- * Dynamic page mapped to /test/guinea-pig-scrollable
- */
-async function guineaPigScrollable(req, res) {
-  return await guineaPigTemplate(req, res, 'guinea-pig-scrollable.html');
-}
-
-/*
- * Dynamic page mapped to /test/guinea-pig-app-banner
- */
-async function guineaPigAppBanner(req, res) {
-  return await guineaPigTemplate(req, res, 'guinea-pig-app-banner.html');
-}
-
-/*
- * Dynamic page mapped to /welcome
- */
-async function welcome(req, res) {
-  let params = {message: "Let's browse!"};
-  log.debug(`Sending welcome response with params: ${JSON.stringify(params)}`);
-  res.send((await getTemplate('welcome.html'))(params));
-}
-
-async function getTemplate(templateName) {
-  let content = await fs.readFile(path.resolve(STATIC_DIR, 'test', templateName));
-  return _.template(content.toString());
-}
-
-export {guineaPig, guineaPigScrollable, guineaPigAppBanner, welcome, STATIC_DIR};

package/lib/express/websocket.js

@@ -1,79 +0,0 @@
-
-import _ from 'lodash';
-import B from 'bluebird';
-
-const DEFAULT_WS_PATHNAME_PREFIX = '/ws';
-
-/**
- * @this {AppiumServer}
- * @type {AppiumServer['addWebSocketHandler']}
- */
-async function addWebSocketHandler(handlerPathname, handlerServer) {
-  this.webSocketsMapping[handlerPathname] = handlerServer;
-}
-
-/**
- * @this {AppiumServer}
- * @type {AppiumServer['getWebSocketHandlers']}
- */
-async function getWebSocketHandlers(keysFilter = null) {
-  return _.toPairs(this.webSocketsMapping).reduce((acc, [pathname, wsServer]) => {
-    if (!_.isString(keysFilter) || pathname.includes(keysFilter)) {
-      acc[pathname] = wsServer;
-    }
-    return acc;
-  }, {});
-}
-
-/**
- * @this {AppiumServer}
- * @type {AppiumServer['removeWebSocketHandler']}
- */
-async function removeWebSocketHandler(handlerPathname) {
-  const wsServer = this.webSocketsMapping?.[handlerPathname];
-  if (!wsServer) {
-    return false;
-  }
-
-  try {
-    wsServer.close();
-    for (const client of wsServer.clients || []) {
-      client.terminate();
-    }
-    return true;
-  } catch {
-    // ignore
-  } finally {
-    delete this.webSocketsMapping[handlerPathname];
-  }
-  return false;
-}
-
-/**
- *
- * @this {AppiumServer}
- * @type {AppiumServer['removeAllWebSocketHandlers']}
- */
-async function removeAllWebSocketHandlers() {
-  if (_.isEmpty(this.webSocketsMapping)) {
-    return false;
-  }
-
-  return _.some(
-    await B.all(
-      _.keys(this.webSocketsMapping).map((pathname) => this.removeWebSocketHandler(pathname))
-    )
-  );
-}
-
-export {
-  addWebSocketHandler,
-  removeWebSocketHandler,
-  removeAllWebSocketHandlers,
-  getWebSocketHandlers,
-  DEFAULT_WS_PATHNAME_PREFIX,
-};
-
-/**
- * @typedef {import('@appium/types').AppiumServer} AppiumServer
- */

package/lib/helpers/capabilities.js

@@ -1,93 +0,0 @@
-// @ts-check
-
-import _ from 'lodash';
-
-/**
- * Determine whether the given argument is valid
- * W3C capabilities instance.
- *
- * @param {any} caps
- * @returns {caps is import('@appium/types').W3CCapabilities}
- */
-export function isW3cCaps(caps) {
-  if (!_.isPlainObject(caps)) {
-    return false;
-  }
-
-  const isFirstMatchValid = () =>
-    _.isArray(caps.firstMatch) &&
-    !_.isEmpty(caps.firstMatch) &&
-    _.every(caps.firstMatch, _.isPlainObject);
-  const isAlwaysMatchValid = () => _.isPlainObject(caps.alwaysMatch);
-  if (_.has(caps, 'firstMatch') && _.has(caps, 'alwaysMatch')) {
-    return isFirstMatchValid() && isAlwaysMatchValid();
-  }
-  if (_.has(caps, 'firstMatch')) {
-    return isFirstMatchValid();
-  }
-  if (_.has(caps, 'alwaysMatch')) {
-    return isAlwaysMatchValid();
-  }
-  return false;
-}
-
-/**
- *
- * @template {Constraints} C
- * @param {any} oldCaps
- * @param {C} desiredCapConstraints
- * @param {AppiumLogger} log
- * @returns {Capabilities<C>}
- */
-export function fixCaps(oldCaps, desiredCapConstraints, log) {
-  let caps = _.clone(oldCaps);
-
-  // boolean capabilities can be passed in as strings 'false' and 'true'
-  // which we want to translate into boolean values
-  let booleanCaps = _.keys(_.pickBy(desiredCapConstraints, (k) => k.isBoolean === true));
-  for (let cap of booleanCaps) {
-    let value = oldCaps[cap];
-    if (_.isString(value)) {
-      value = value.toLowerCase();
-      if (value === 'true' || value === 'false') {
-        log.warn(
-          `Capability '${cap}' changed from string to boolean. This may cause unexpected behavior`
-        );
-        caps[cap] = value === 'true';
-      }
-    }
-  }
-
-  // int capabilities are often sent in as strings by frameworks
-  let intCaps = /** @type {import('type-fest').KeyAsString<typeof caps>[]} */ (
-    _.keys(_.pickBy(desiredCapConstraints, (k) => k.isNumber === true))
-  );
-  for (let cap of intCaps) {
-    let value = oldCaps[cap];
-    if (_.isString(value)) {
-      value = value.trim();
-      let newValue = parseInt(value, 10);
-      if (value !== `${newValue}`) {
-        newValue = parseFloat(value);
-      }
-      log.warn(
-        `Capability '${cap}' changed from string ('${value}') to integer (${newValue}). This may cause unexpected behavior`
-      );
-      caps[cap] = newValue;
-    }
-  }
-
-  return caps;
-}
-
-/**
- * @typedef {import('@appium/types').Constraints} Constraints
- * @typedef {import('@appium/types').AppiumLogger} AppiumLogger
- * @typedef {import('@appium/types').StringRecord} StringRecord
- * @typedef {import('@appium/types').BaseDriverCapConstraints} BaseDriverCapConstraints
- */
-
-/**
- * @template {Constraints} C
- * @typedef {import('@appium/types').Capabilities<C>} Capabilities
- */