How to use jwproxy.proxy method in Appium Base Driver

...102      throw new Error('WinAppDriver crashed during startup.');103    }104  }105  async getStatus () {106    const resBlock = await this.jwproxy.proxy('/status', 'GET');107    if (resBlock[0].statusCode === 200) {108      log.info(`Status call returned 200. we're online and ready to run tests`);109      return true;110    }111    return false;112  }113  async startSession (caps) {114    const createSessionTimeout = caps.createSessionTimeout || this.createSessionTimeout;115    log.debug(`Starting WinAppDriver session. Will timeout in '${createSessionTimeout}' ms.`);116    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);117    let retryIteration = 0;118    let lastError;119    const condFn = async () => {120      lastError = null;...

1import _ from 'lodash';2import path from 'path';3import url from 'url';4import { JWProxy } from 'appium-base-driver';5import { fs } from 'appium-support';6import log from '../logger';7import { NoSessionProxy } from "./no-session-proxy";8import { checkForDependencies } from './utils';9import { resetXCTestProcesses, getPIDsListeningOnPort } from '../utils';10import XcodeBuild from './xcodebuild';11import iProxy from './iproxy';12import fkill from 'fkill';13const BOOTSTRAP_PATH = path.resolve(__dirname, '..', '..', '..', 'WebDriverAgent');14const WDA_BUNDLE_ID = 'com.apple.test.WebDriverAgentRunner-Runner';15const WDA_LAUNCH_TIMEOUT = 60 * 1000;16const WDA_AGENT_PORT = 8100;17const WDA_BASE_URL = 'http://localhost';18class WebDriverAgent {19  constructor (xcodeVersion, args = {}) {20    this.xcodeVersion = xcodeVersion;21    this.device = args.device;22    this.platformVersion = args.platformVersion;23    this.host = args.host;24    this.realDevice = !!args.realDevice;25    this.setWDAPaths(args.bootstrapPath, args.agentPath);26    this.wdaLocalPort = args.wdaLocalPort;27    this.prebuildWDA = args.prebuildWDA;28    this.webDriverAgentUrl = args.webDriverAgentUrl;29    this.started = false;30    this.wdaConnectionTimeout = args.wdaConnectionTimeout;31    this.useCarthageSsl = _.isBoolean(args.useCarthageSsl) && args.useCarthageSsl;32    this.useXctestrunFile = args.useXctestrunFile;33    this.xcodebuild = new XcodeBuild(this.xcodeVersion, this.device, {34      platformVersion: this.platformVersion,35      agentPath: this.agentPath,36      bootstrapPath: this.bootstrapPath,37      realDevice: this.realDevice,38      showXcodeLog: !!args.showXcodeLog,39      xcodeConfigFile: args.xcodeConfigFile,40      xcodeOrgId: args.xcodeOrgId,41      xcodeSigningId: args.xcodeSigningId,42      keychainPath: args.keychainPath,43      keychainPassword: args.keychainPassword,44      useSimpleBuildTest: args.useSimpleBuildTest,45      usePrebuiltWDA: args.usePrebuiltWDA,46      updatedWDABundleId: args.updatedWDABundleId,47      launchTimeout: args.wdaLaunchTimeout || WDA_LAUNCH_TIMEOUT,48      wdaRemotePort: this.realDevice ? WDA_AGENT_PORT : (this.wdaLocalPort || WDA_AGENT_PORT),49      useXctestrunFile : this.useXctestrunFile50    });51  }52  setWDAPaths (bootstrapPath, agentPath) {53    // allow the user to specify a place for WDA. This is undocumented and54    // only here for the purposes of testing development of WDA55    this.bootstrapPath = bootstrapPath || BOOTSTRAP_PATH;56    log.info(`Using WDA path: '${this.bootstrapPath}'`);57    // for backward compatibility we need to be able to specify agentPath too58    this.agentPath = agentPath || path.resolve(this.bootstrapPath, 'WebDriverAgent.xcodeproj');59    log.info(`Using WDA agent: '${this.agentPath}'`);60  }61  async cleanupObsoleteProcesses () {62    const pids = await getPIDsListeningOnPort(this.url.port,63      (cmdLine) => (cmdLine.includes('/WebDriverAgentRunner') || cmdLine.includes('/iproxy')) &&64        !cmdLine.toLowerCase().includes(this.device.udid.toLowerCase()));65    if (!pids.length) {66      log.debug(`No obsolete cached processes from previous WDA sessions ` +67                `listening on port ${this.url.port} have been found`);68      return;69    }70    log.info(`Detected ${pids.length} obsolete cached process${pids.length === 1 ? '' : 'es'} ` +71             `from previous WDA sessions. Cleaning up...`);72    try {73      await fkill(pids);74    } catch (e) {75      log.warn(`Failed to kill obsolete cached process${pids.length === 1 ? '' : 'es'} '${pids}'. ` +76               `Original error: ${e.message}`);77    }78  }79  async isRunning () {80    const noSessionProxy = new NoSessionProxy({81      server: this.url.hostname,82      port: this.url.port,83      base: '',84      timeout: 3000,85    });86    try {87      const status = await noSessionProxy.command('/status', 'GET');88      if (!status) {89        throw new Error(`WDA response to /status command should be defined.`);90      }91      return true;92    } catch (err) {93      log.debug(`WDA is not listening at '${this.url.href}'`);94      return false;95    }96  }97  async uninstall () {98    log.debug(`Removing WDA application from device`);99    try {100      await this.device.removeApp(WDA_BUNDLE_ID);101    } catch (e) {102      log.warn(`WebDriverAgent uninstall failed. Perhaps, it is already uninstalled? Original error: ${JSON.stringify(e)}`);103    }104  }105  async launch (sessionId) {106    if (this.webDriverAgentUrl) {107      log.info(`Using provided WebdriverAgent at '${this.webDriverAgentUrl}'`);108      this.url = this.webDriverAgentUrl;109      this.setupProxies(sessionId);110      return;111    }112    log.info('Launching WebDriverAgent on the device');113    this.setupProxies(sessionId);114    if (!this.useXctestrunFile && !await fs.exists(this.agentPath)) {115      throw new Error(`Trying to use WebDriverAgent project at '${this.agentPath}' but the ` +116                      'file does not exist');117    }118    if (!this.useXctestrunFile) {119      // make sure that the WDA dependencies have been built120      await checkForDependencies(this.bootstrapPath, this.useCarthageSsl);121    }122    // We need to provide WDA local port, because it might be occupied with123    // iproxy instance initiated by some preceeding run with a real device124    // (iproxy instances are not killed on session termination by default)125    await resetXCTestProcesses(this.device.udid, !this.realDevice, {wdaLocalPort: this.url.port});126    if (this.realDevice) {127      this.iproxy = new iProxy(this.device.udid, this.url.port, WDA_AGENT_PORT);128      await this.iproxy.start();129    }130    await this.xcodebuild.init(this.noSessionProxy);131    // Start the xcodebuild process132    if (this.prebuildWDA) {133      await this.xcodebuild.prebuild();134    }135    return await this.xcodebuild.start();136  }137  setupProxies (sessionId) {138    const proxyOpts = {139      server: this.url.hostname,140      port: this.url.port,141      base: '',142      timeout: this.wdaConnectionTimeout,143    };144    this.jwproxy = new JWProxy(proxyOpts);145    this.jwproxy.sessionId = sessionId;146    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);147    this.noSessionProxy = new NoSessionProxy(proxyOpts);148    this.noSessionProxyReqRes = this.noSessionProxy.proxyReqRes.bind(this.noSessionProxy);149  }150  async quit () {151    log.info('Shutting down sub-processes');152    if (this.iproxy) {153      await this.iproxy.quit();154    }155    await this.xcodebuild.quit();156    await this.xcodebuild.reset();157    if (this.jwproxy) {158      this.jwproxy.sessionId = null;159    }160    this.started = false;161  }162  get url () {163    if (!this._url) {164      let port = this.wdaLocalPort || WDA_AGENT_PORT;165      this._url = url.parse(`${WDA_BASE_URL}:${port}`);166    }167    return this._url;168  }169  set url (_url) {170    this._url = url.parse(_url);171  }172  get fullyStarted () {173    return this.started;174  }175  set fullyStarted (started = false) {176    // before WDA is started we expect errors from iproxy, since it is not177    // communicating with anything yet178    this.started = started;179    if (this.iproxy) {180      this.iproxy.expectIProxyErrors = !started;181    }182  }183  async retrieveDerivedDataPath () {184    return await this.xcodebuild.retrieveDerivedDataPath();185  }186}187export default WebDriverAgent;...

1import { JWProxy } from 'appium-base-driver';2import log from './logger';3import { SubProcess } from 'teen_process';4import { fs, logger, process } from 'appium-support';5import path from 'path';6const DEFAULT_A4M_HOST = '127.0.0.1';7const DEFAULT_A4M_PORT = 4622;8const REQ_A4M_APP_PATH = '/Applications/AppiumForMac.app';9const A4M_APP_BUNDLE_ID = 'com.appium.AppiumForMac';10const a4mLog = logger.getLogger('Appium4Mac');11class AppiumForMac {12  constructor (opts = {}) {13    this.proxyHost = opts.a4mHost;14    this.proxyPort = opts.a4mPort;15    this.a4mAppPath = opts.a4mAppPath;16    this.killAllA4MAppBeforeStart = opts.killAllA4MAppBeforeStart || true;17    this.proc = null;18    this.jwproxy = new JWProxy({server: this.proxyHost, port: this.proxyPort});19  }20  async start () {21    if (!await fs.exists(this.a4mAppPath)) {22      throw new Error(`Could not verify AppiumForMacDriver install in '${this.a4mAppPath}'; please install it to '${this.a4mAppPath}'`);23    }24    const startDetector = (stdout, stderr) => stderr.includes('Started HTTP server');25    let processIsAlive = false;26    try {27      if (this.killAllA4MAppBeforeStart) {28        await this.killAll();29      }30      // set up our subprocess object31      const a4mBinary = path.resolve(this.a4mAppPath, 'Contents', 'MacOS', 'AppiumForMac');32      this.proc = new SubProcess(a4mBinary, []);33      processIsAlive = true;34      // handle log output35      for (let stream of ['STDOUT', 'STDERR']) {36        this.proc.on(`lines-${stream.toLowerCase()}`, (lines) => {37          for (let l of lines) {38            a4mLog.info(`[${stream}] ${l.trim()}`);39          }40        });41      }42      // handle out-of-bound exit by simply logging43      // TODO add ability for driver to handle this gracefully and maybe44      // restart45      this.proc.on('exit', (code, signal) => {46        processIsAlive = false;47        let msg = `AppiumForMac exited unexpectedly with code ${code}, ` +48                  `signal ${signal}`;49        log.error(msg);50      });51      log.info(`Spawning AppiumForMac with: ${this.a4mAppPath}`);52      // start subproc and wait for startDetector53      await this.proc.start(startDetector);54      await this.waitForOnline();55    } catch (e) {56      this.emit(AppiumForMac.EVENT_ERROR, e);57      // just because we had an error doesn't mean the winappdriver process58      // finished; we should clean up if necessary59      if (processIsAlive) {60        await this.proc.stop();61      }62      log.errorAndThrow(e);63    }64  }65  sessionId () {66    if (this.state !== AppiumForMac.STATE_ONLINE) {67      return null;68    }69    return this.jwproxy.sessionId;70  }71  async waitForOnline () { // eslint-disable-line require-await72    // TODO: Actually check via HTTP73    return true;74  }75  async getStatus () {76    return await this.sendCommand('/status', 'GET');77  }78  async startSession (caps) {79    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);80    await this.sendCommand('/session', 'POST', {desiredCapabilities: caps});81  }82  async stop () {83    try {84      if (this.proc) {85        await this.proc.stop();86      }87    } catch (e) {88      log.error(e);89    }90  }91  async sendCommand (url, method, body) {92    let res;93    // need to cover over A4M's bad handling of responses, which sometimes94    // don't have 'value' properties95    try {96      res = await this.jwproxy.command(url, method, body);97    } catch (e) {98      if (e.message.indexOf('Did not get a valid response object') === -1 ||99          e.message.indexOf('value') !== -1) {100        throw e;101      }102    }103    return res;104  }105  async proxyReq (req, res) {106    return await this.jwproxy.proxyReqRes(req, res);107  }108  async killAll () {109    const processName = 'AppiumForMac';110    // js hint cannot handle backticks, even escaped, within template literals111    log.info(`Killing any old AppiumForMac`);112    await process.killProcess(processName);113    log.info('Successfully cleaned up old Appium4Mac servers');114  }115  async deleteSession () {116    log.debug('Deleting AppiumForMac server session');117    // rely on jwproxy's intelligence to know what we're talking about and118    // delete the current session119    try {120      await this.sendCommand('/', 'DELETE');121    } catch (err) {122      log.warn(`Did not get confirmation AppiumForMac deleteSession worked; ` +123        `Error was: ${err}`);124    }125  }126}127export { AppiumForMac, DEFAULT_A4M_HOST, DEFAULT_A4M_PORT,128  A4M_APP_BUNDLE_ID, REQ_A4M_APP_PATH };...

1import { JWProxy } from 'appium-base-driver';2import { retryInterval } from 'asyncbox';3import logger from './logger';4import path from 'path';5import { fs } from 'appium-support';6import { SE_APK_PATH, SE_MANIFEST_PATH } from './installer';7const REQD_PARAMS = [8  'adb', 'appPackage', 'appActivity', 'tmpDir', 'apk', 'host', 'systemPort',9  'devicePort',10];11class SelendroidServer {12  constructor (opts = {}) {13    for (let req of REQD_PARAMS) {14      if (!opts || !opts[req]) {15        throw new Error(`Option '${req}' is required!`);16      }17      this[req] = opts[req];18    }19    // new package name for repackaged selendroid server20    this.modServerPkg = `selendroid.${this.appPackage}`;21    // path to the repackaged selendroid server specific to this app22    this.modServerPath = path.resolve(this.tmpDir, `${this.modServerPkg}.apk`);23    this.jwproxy = new JWProxy({server: this.host, port: this.systemPort});24    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);25  }26  async prepareModifiedServer () {27    // TODO might have a race condition if we try building this with multiple28    // sessions at the same time. OTOH we probably want to share the mod29    // server...30    let needsUninstall = false;31    if (!(await fs.exists(this.modServerPath))) {32      await this.buildNewModServer();33      needsUninstall = true;34    }35    needsUninstall = await this.checkAndSignCert(this.modServerPath) || needsUninstall;36    if (needsUninstall) {37      logger.info('New server was built, uninstalling any instances of it');38      await this.adb.uninstallApk(this.modServerPkg);39    }40  }41  async installModifiedServer () {42    let installed = await this.adb.isAppInstalled(this.modServerPkg);43    if (!installed) {44      await this.adb.install(this.modServerPath);45    }46  }47  async buildNewModServer () {48    logger.info(`Repackaging selendroid for: '${this.appPackage}'`);49    let packageTmpDir = path.resolve(this.tmpDir, this.appPackage);50    let newManifestPath = path.resolve(this.tmpDir, 'AndroidManifest.xml');51    logger.info(`Creating new manifest: '${newManifestPath}'`);52    await fs.mkdir(packageTmpDir);53    await fs.copyFile(SE_MANIFEST_PATH, newManifestPath);54    await this.adb.initAapt(); // TODO this should be internal to adb55    await this.adb.compileManifest(newManifestPath, this.modServerPkg,56                                   this.appPackage);57    await this.adb.insertManifest(newManifestPath, SE_APK_PATH,58                                  this.modServerPath);59    logger.info(`Repackaged selendroid ready: '${this.modServerPath}'`);60  }61  async checkAndSignCert (apk) {62    let signed = await this.adb.checkApkCert(apk, this.appPackage);63    if (!signed) {64      await this.adb.sign(apk);65    }66    // return whether the apk was signed67    return !signed;68  }69  async startSession (caps) {70    let instrumentWith = `${this.modServerPkg}/` +71                         `io.selendroid.server.ServerInstrumentation`;72    logger.info(`Starting selendroid server with instrumentation: ` +73             `${instrumentWith}`);74    await this.adb.instrument(this.appPackage, this.appActivity, instrumentWith);75    logger.info('Waiting for Selendroid to be online...');76    // wait 20s for Selendroid to be online77    await retryInterval(20, 1000, async () => {78      await this.jwproxy.command('/status', 'GET');79    });80    await this.jwproxy.command('/session', 'POST', {desiredCapabilities: caps});81  }82  async deleteSession () {83    logger.debug('Deleting Selendroid server session');84    // rely on jwproxy's intelligence to know what we're talking about and85    // delete the current session86    try {87      await this.jwproxy.command('/', 'DELETE');88    } catch (err) {89      logger.warn(`Did not get confirmation Selendroid deleteSession worked; ` +90                  `Error was: ${err}`);91    }92  }93}...

1import { JWProxy } from 'appium-base-driver';2import log from './logger';3import { SubProcess } from 'teen_process';4import { fs, logger, process } from 'appium-support';5import path from 'path';6const DEFAULT_A4A_HOST = '127.0.0.1';7const DEFAULT_A4A_PORT = 4622;8const REQ_A4A_APP_PATH = '/Applications/AppiumForAwtk.app';9const A4A_APP_BUNDLE_ID = 'com.appium.AppiumForAwtk';10const a4aLog = logger.getLogger('Appium4Awtk');11class AppiumForAwtk {12  constructor (opts = {}) {13    this.proxyHost = opts.a4aHost;14    this.proxyPort = opts.a4aPort;15    this.a4aAppPath = opts.a4aAppPath;16    this.killAllA4AAppBeforeStart = opts.killAllA4AAppBeforeStart || true;17    this.proc = null;18    this.jwproxy = new JWProxy({server: this.proxyHost, port: this.proxyPort});19  }20  async start () {21    console.log('start')22  }23  sessionId () {24    if (this.state !== AppiumForAwtk.STATE_ONLINE) {25      return null;26    }27    return this.jwproxy.sessionId;28  }29  async waitForOnline () { // eslint-disable-line require-await30    // TODO: Actually check via HTTP31    return true;32  }33  async getStatus () {34    return await this.sendCommand('/status', 'GET');35  }36  async startSession (caps) {37    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);38    await this.sendCommand('/session', 'POST', {desiredCapabilities: caps});39  }40  async stop () {41    try {42      if (this.proc) {43        await this.proc.stop();44      }45    } catch (e) {46      log.error(e);47    }48  }49  async sendCommand (url, method, body) {50    let res;51    // need to cover over A4A's bad handling of responses, which sometimes52    // don't have 'value' properties53    try {54      res = await this.jwproxy.command(url, method, body);55    } catch (e) {56      if (e.message.indexOf('Did not get a valid response object') === -1 ||57          e.message.indexOf('value') !== -1) {58        throw e;59      }60    }61    return res;62  }63  async proxyReq (req, res) {64    return await this.jwproxy.proxyReqRes(req, res);65  }66  async killAll () {67    const processName = 'AppiumForAwtk';68    // js hint cannot handle backticks, even escaped, within template literals69    log.info(`Killing any old AppiumForAwtk`);70    await process.killProcess(processName);71    log.info('Successfully cleaned up old Appium4Awtk servers');72  }73  async deleteSession () {74    log.debug('Deleting AppiumForAwtk server session');75    // rely on jwproxy's intelligence to know what we're talking about and76    // delete the current session77    try {78      await this.sendCommand('/', 'DELETE');79    } catch (err) {80      log.warn(`Did not get confirmation AppiumForAwtk deleteSession worked; ` +81        `Error was: ${err}`);82    }83  }84}85export { AppiumForAwtk, DEFAULT_A4A_HOST, DEFAULT_A4A_PORT,86  A4A_APP_BUNDLE_ID, REQ_A4A_APP_PATH };...

1// transpile:main2// BaseDriver exports3import * as driver from './lib/basedriver/driver';4import * as image from './lib/basedriver/image-element';5import * as deviceSettings from './lib/basedriver/device-settings';6const { BaseDriver } = driver;7const { ImageElement } = image;8const { DeviceSettings, BASEDRIVER_HANDLED_SETTINGS } = deviceSettings;9export { BaseDriver, DeviceSettings, ImageElement, BASEDRIVER_HANDLED_SETTINGS };10export default BaseDriver;11// MJSONWP exports12import * as protocol from './lib/protocol';13import {14  DEFAULT_BASE_PATH, PROTOCOLS15} from './lib/constants';16const {17  Protocol, routeConfiguringFunction, errors, isErrorType,18  errorFromMJSONWPStatusCode, errorFromW3CJsonCode, ALL_COMMANDS, METHOD_MAP,19  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,20  normalizeBasePath, determineProtocol21} = protocol;22export {23  Protocol, routeConfiguringFunction, errors, isErrorType, PROTOCOLS,24  errorFromMJSONWPStatusCode, errorFromW3CJsonCode, determineProtocol,25  errorFromMJSONWPStatusCode as errorFromCode, ALL_COMMANDS, METHOD_MAP,26  routeToCommandName, NO_SESSION_ID_COMMANDS, isSessionCommand,27  DEFAULT_BASE_PATH, normalizeBasePath28};29// Express exports30import * as staticIndex from './lib/express/static';31const { STATIC_DIR } = staticIndex;32export { STATIC_DIR };33import * as serverIndex from './lib/express/server';34const { server } = serverIndex;35export { server };36// jsonwp-proxy exports37import * as proxyIndex from './lib/jsonwp-proxy/proxy';38const { JWProxy } = proxyIndex;39export { JWProxy };40// jsonwp-status exports41import * as statusIndex from './lib/jsonwp-status/status';42const { codes: statusCodes, getSummaryByCode } = statusIndex;43export { statusCodes, getSummaryByCode };44// W3C capabilities parser45import * as caps from './lib/basedriver/capabilities';46const { processCapabilities, isStandardCap, validateCaps } = caps;47export { processCapabilities, isStandardCap, validateCaps };48// Web socket helpers49import * as ws from './lib/express/websocket';50const { DEFAULT_WS_PATHNAME_PREFIX } = ws;...

...16  after(async function () {17    await baseServer.close();18  });19  it('should proxy status straight', async function () {20    let [res, resBody] = await jwproxy.proxy('/status', 'GET');21    res.statusCode.should.equal(200);22    resBody.status.should.equal(0);23    resBody.value.should.equal(`I'm fine`);24  });25  it('should proxy status as command', async function () {26    const res = await jwproxy.command('/status', 'GET');27    res.should.eql(`I'm fine`);28  });29  describe('new session', function () {30    afterEach(async function () {31      await jwproxy.command('', 'DELETE');32    });33    it('should start a new session', async function () {34      const caps = {browserName: 'fake'};...