Improve Appium support in Nightwatch

lib/transport/factory.js

@@ -48,20 +48,20 @@ module.exports = class TransportFactory {
 
     let {browserName} = settings.desiredCapabilities;
 
-    // Better support for Appium, if the browserName has explicitly been set to null we can skip all further checks
-    if (settings.selenium && settings.selenium.use_appium && !browserName) {
+    // Better support for app-testing, if the browserName is not present we can skip all further checks
+    const usingAppium = TransportFactory.usingSeleniumServer(settings) && settings.selenium.use_appium;
+    const usingBrowserStack = TransportFactory.usingBrowserstack(settings);
+    if ((usingAppium || usingBrowserStack) && !browserName) {
       return browserName;
     }
 
     // for backward compatibility
     if (browserName === null) {
-      // TODO:
-      // Deprecation warning: Setting browserName to null for running Appium tests has
-      // now been deprecated and will be removed from future versions. Set `use_appium`
-      // property to true in `selenium` config to run Appium tests.
-      // 
-      // put a warning here that if trying to connect to an Appium server,
-      // just setting browserName=null will not work in the future.
+      // eslint-disable-next-line no-console
+      console.warn('DEPRECATED: Setting browserName=null for running Appium tests has been deprecated ' +
+        'and will not be supported in future versions. Set `use_appium` property in `selenium` config to true ' +
+        'in your Nightwatch configuration file to run Appium tests.');
+
       settings.selenium.use_appium = true;
 
       return browserName;

lib/transport/selenium-webdriver/appium.js

@@ -43,45 +43,41 @@ module.exports = class AppiumServer extends SeleniumServer {
   }
 
   createSessionOptions(argv) {
-    // TODO: Re-think the below temp solution
-    if (TransportFactory.usingBrowserstack(this.settings)) {
-      return super.createSessionOptions(argv);
-    }
-
-    const options = this.desiredCapabilities;
-
     // break 'appium:options' to individual configs
-    if (isObject(options['appium:options'])) {
-      const appiumOptions = options['appium:options'];
+    if (isObject(this.desiredCapabilities['appium:options'])) {
+      const appiumOptions = this.desiredCapabilities['appium:options'];
       for (let key of Object.keys(appiumOptions)) {
         const value = appiumOptions[key];
 
         if (!key.startsWith('appium:')) {
           key = `appium:${key}`;
         }
-        options[key] = value;
+        this.desiredCapabilities[key] = value;
       }
 
-      delete options['appium:options'];
+      delete this.desiredCapabilities['appium:options'];
     }
 
     // if `appium:chromedriverExecutable` is present and left blank,
     // assign the path of binary from `chromedriver` NPM package to it.
-    if (options['appium:chromedriverExecutable'] === '') {
+    if (this.desiredCapabilities['appium:chromedriverExecutable'] === '') {
       const chromedriver = this.seleniumCapabilities.getChromedriverPath();
       if (chromedriver) {
-        options['appium:chromedriverExecutable'] = chromedriver;
+        this.desiredCapabilities['appium:chromedriverExecutable'] = chromedriver;
       }
     }
 
-    return options;
+    return super.createSessionOptions(argv) || this.desiredCapabilities;
   }
 
   createDriver({options = this.desiredCapabilities} = {}) {
-    const httpClient = new http.HttpClient(this.getServerUrl());
+    // If creating a session with BrowserStack Automate, use Selenium's session builder.
+    if (TransportFactory.usingBrowserstack(this.settings) && this.productNamespace === 'automate') {
+      return super.createDriver({options});
+    }
 
-    const session = WebDriver.createSession(new Executor(httpClient), options);
+    const httpClient = new http.HttpClient(this.getServerUrl());
 
-    return session;
+    return WebDriver.createSession(new Executor(httpClient), options);
   }
 };

lib/transport/selenium-webdriver/browserstack.js

@@ -5,7 +5,7 @@ const defaultsDeep = require('lodash.defaultsdeep');
 
 class Browserstack extends BaseDriver {
   get ApiUrl() {
-    return `https://api.browserstack.com/${this.isMobile ? 'app-automate' : 'automate'}`;
+    return `https://api.browserstack.com/${this.productNamespace}`;
   }
 
   bStackOptions() {
@@ -31,7 +31,7 @@ class Browserstack extends BaseDriver {
   constructor(nightwatchInstance, browserName) {
     super(nightwatchInstance, browserName);
 
-    this.isMobile = this.api.isMobile();
+    this.productNamespace = browserName ? 'automate' : 'app-automate';
     this.useLocal = false;
 
     this.nightwatchInstance.on('nightwatch:session.create', (data) => {
@@ -146,7 +146,7 @@ class Browserstack extends BaseDriver {
       await this.sendReasonToBrowserstack(!!failures, reason);
       // eslint-disable-next-line no-console
       console.log('\n  ' + 'See more info, video, & screenshots on Browserstack:\n' +
-        '  ' + Logger.colors.light_cyan(`https://${this.isMobile ? 'app-automate' : 'automate'}.browserstack.com/builds/${this.buildId}/sessions/${this.sessionId}`));
+        '  ' + Logger.colors.light_cyan(`https://${this.productNamespace}.browserstack.com/builds/${this.buildId}/sessions/${this.sessionId}`));
 
       this.sessionId = null;