Set up CI with Azure Pipelines

.gitignore

@@ -1,5 +1,4 @@
 node_modules
-package-lock.json
 
 dist
 release

.npmrc

@@ -1 +1 @@
-package-lock=false
+package-lock=true

.travis.yml

@@ -5,27 +5,29 @@ os:
 - linux
 - osx
 node_js:
-- '7'
+- '9'
 before_install:
+- nvm install 9
+- npm install -g [email protected]
 - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install --no-install-recommends
   -y icnsutils graphicsmagick xz-utils; fi
 addons:
   apt:
     packages:
     - xvfb
 before_script:
+- greenkeeper-lockfile-update
 - node --version
-- npm install
-- npm install -g electron
-- node --version
+- npm --version
 - travis_wait 30 npm run package-ci # This command takes a long time, so increased the time limit to 30 minutes (default is 10 minutes)
+- greenkeeper-lockfile-upload
 cache:
   directories:
   - node_modules
   - "$HOME/.electron"
   - "$HOME/.cache"
 install:
-- nvm install 7
+- npm ci
 - export DISPLAY=':99.0'
 - Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
 dist: trusty

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "dev",
+        "type": "node",
+        "request": "launch",
+        "cwd": "${workspaceRoot}",
+        "runtimeExecutable": "npm",
+        "env": {
+          "NODE_ENV": "development"
+        },
+        "runtimeArgs": [
+            "run-script", "dev"
+        ],
+        "port": 5858
+      }
+    ]
+  }

CHANGELOG.md

@@ -1,3 +1,45 @@
+## [1.7.0](https://github.com/appium/appium-desktop/compare/v1.7.0...v1.6.3) (2018-08-30)
+
+### Changes
+* Feature: Upgrade to Appium 1.9.0
+* Feature: Add relaxed security flag (#607)
+* Feature: Add Bitbar to cloud providers (#603)
+* Feature: Add React Native testID to strategy mappings (#614)
+* Fix: Remove unneeded ipc binding (#612)
+
+
+## [1.6.3](https://github.com/appium/appium-desktop/compare/v1.6.3...v1.6.2) (2018-08-02)
+
+### Changes
+* Feature: Make ANDROID_HOME and JAVA_HOME settable from the UI
+* Feature: Add icon for copying source XML to clipboard
+* Fix: Close session window when main window is closed
+
+## [1.6.2](https://github.com/appium/appium-desktop/compare/v1.6.2...v1.6.1) (2018-06-08)
+
+### Changes
+* Feature: Upgrade to Appium 1.8.1
+* Fix: Use absolute coordinates for 'swipe'
+
+## [1.6.1](https://github.com/appium/appium-desktop/compare/v1.6.1...v1.5.0) (2018-05-08)
+
+### Changes
+* Feature: Upgrade to Appium 1.8.0
+* Feature: Upgrade Electron to 2.0.0
+* Feature: Add internal session keep-alive (#509)
+* Feature: Add BrowserStack as a cloud provider
+
+## [1.5.0](https://github.com/appium/appium-desktop/compare/v1.4.1...v1.5.0) (2018-04-02)
+
+### Changes
+* Feature: Allow unauthorized SSL and set custom proxy (#469)
+
+## [1.4.1](https://github.com/appium/appium-desktop/compare/v1.4.0...v1.4.1) (2018-03-06)
+
+### Changes
+* Fix: Replace electron-builder autoupdater with Zeit Hazel server plus native updater (#435)
+
+
 ## [1.4.0](https://github.com/appium/appium-desktop/compare/v1.3.2...v1.4.0) (2018-02-27)
 
 ### Changes

CONTRIBUTING.md

@@ -83,6 +83,29 @@ To run the e2e tests call
 npm run e2e
 ```
 
+### Debugging
+
+#### Renderer
+* The renderer uses Chromium and can be debugged using Chrome DevTools the same way a webpage is debugged
+* When you run dev (`npm run dev`) the Chrome DevTools window is opened on startup. 
+* To open it again, after it has been closed, right click on the window and select `Inspect Element` 
+
+#### Main
+* In Chrome Dev Tools
+  * Run dev (`npm run dev`). This sets an --inspect port at 5858
+  * Running in dev sets up an inspector port at 5858
+  * Open chrome://inspect in your chrome browser
+  * Click `Open dedicated DevTools for Node`
+  * Add a connection `localhost:5858`
+  * Start inspecting code under other tabs
+* In VSCode
+  * In the debug tab, run 'dev'
+  * Set breakpoints directly in VSCode
+* For reference on NodeJS debugging see:
+  * https://electronjs.org/docs/tutorial/debugging-main-process-vscode
+  * https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27
+
+
 ### Packaging and Releasing
 
 Appium Desktop uses [Electron Builder](https://github.com/electron-userland/electron-builder/) to build app. Read this document for instructions on how to set up your local environment so that you can build and package the app: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build

README.md

@@ -33,7 +33,7 @@ from the downloaded DMG file to your own file system (the best place is the
 not supported, and will not work.
 
 ## Known Issues
-* Auto updater is not working (https://github.com/appium/appium-desktop/issues/74)
+* Some Windows 10 Users experience a `PathTooLongException` when installing the EXE. The workaround for this is to update the setting on Windows to [enable long paths](https://superuser.com/questions/1119883/windows-10-enable-ntfs-long-paths-policy-option-missing)
 
 ## Usage Instructions
 
@@ -108,9 +108,15 @@ this case, attaching to the local server will be disabled.
 
 These are the options for launching a session against a non-local Appium server:
 
-* A custom host/port configuration: this is useful if you want to launch an Inspector session against an Appium server running on another machine in your network, for example.
-* Sauce Labs: if you don't have access to, say, iOS simulators on your machine, you can leverage your [Sauce Labs](https://saucelabs.com) account to start an Appium session in the cloud.
-* TestObject: you can also utilize [TestObject](https://testobject.com)'s cloud of real devices for a real device-based Inspector session.
+|     Endpoint     |                                                        Description                                                         |
+| ---------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| Automatic server | Automatically utilizes the currently-running Appium server                                                                 |
+| Custom Server    | Launch a session on an Appium server running on another machine over the network                                           |
+| Sauce Labs       | Launch a session on the [Sauce Labs](https://saucelabs.com) cloud. [Documentation](https://wiki.saucelabs.com/)            |
+| TestObject       | Launch a session on the [TestObject](https://testobject.com) cloud. [Documentation](https://wiki.saucelabs.com/)           |
+| Headspin         | Launch a session on the [Headspin](https://headspin.com) cloud. [Documentation](https://docs.headspin.io/)                 |
+| BrowserStack     | Launch a session on the [Browserstack](https://browserstack.com) cloud. [Documentation](https://www.browserstack.com/docs) |
+| Bitbar           | Launch a session on the [Bitbar](https://bitbar.com) cloud. [Documentation](http://docs.bitbar.com/)                       |
 
 It should be straightforward to get set up with any of these options. Simply
 enter your details in the input fields provided.
@@ -121,7 +127,9 @@ Desired capabilities are how you configure your Appium session. They tell the
 Appium server what kind of platform and app you want to automate. If you are
 unfamiliar with the concept of desired capabilities, or which desired
 capabilities are required to launch Appium sessions of various types, you
-should consult the Appium documentation.
+should consult the Appium documentation. Additionally, if you're using one of
+the cloud providers, consult their documentation for possible vendor-specific
+details.
 
 Appium Desktop does not restrict your creation of desired capabilities in any
 way, nor will it validate them for you. It simply provides a nice UI for

app/env.js

@@ -0,0 +1,10 @@
+let env = {};
+
+// DefinePlugin doesn't work in dev so if _ENV_ is undefined, assume it's a development environment
+if (typeof(_ENV_) === "undefined") {
+  env = require('../env/.env-dev');
+} else {
+  env = _ENV_; // eslint-disable-line no-undef
+}
+
+export default env;

app/main/appium-method-handler.js

@@ -1,13 +1,61 @@
 import Bluebird from 'bluebird';
-import _ from 'lodash';
 import wd from 'wd';
 
+const isDevelopment = process.env.NODE_ENV === 'development';
+
+const KEEP_ALIVE_PING_INTERVAL = 5 * 1000;
+const NO_NEW_COMMAND_LIMIT = isDevelopment ?  30 * 1000 :  5 * 60 * 1000;
+const WAIT_FOR_USER_KEEP_ALIVE = 30 * 1000;
+
 export default class AppiumMethodHandler {
-  constructor (driver) {
+  constructor (driver, sender) {
     this.driver = driver;
+    this.sender = sender;
     this.elementCache = {};
     this.elVariableCounter = 1;
     this.elArrayVariableCounter = 1;
+    this._lastActiveMoment = +(new Date());
+  }
+
+  /**
+   * Ping server every 30 seconds to prevent `newCommandTimeout` from killing session
+   */
+  runKeepAliveLoop () {
+    this.keepAlive = setInterval(() => {
+      this.driver.sessionCapabilities(); // Pings the Appium server to keep it alive
+      const now = +(new Date());
+
+      // If the new command limit has been surpassed, prompt user if they want to keep session going
+      // Give them 30 seconds to respond
+      if (now - this._lastActiveMoment > NO_NEW_COMMAND_LIMIT) {
+        this.sender.send('appium-prompt-keep-alive');
+
+        // After the time limit kill the session (this timeout will be killed if they keep it alive)
+        this.waitForUserTimeout = setTimeout(() => {
+          this.close('Session closed due to inactivity');
+        }, WAIT_FOR_USER_KEEP_ALIVE);
+      }
+    }, KEEP_ALIVE_PING_INTERVAL);
+  }
+
+  /**
+   * Get rid of the intervals to keep the session alive
+   */
+  killKeepAliveLoop () {
+    clearInterval(this.keepAlive);
+    if (this.waitForUserTimeout) {
+      clearTimeout(this.waitForUserTimeout);
+    }
+  }
+
+  /**
+   * Reset the new command clock and kill the wait for user timeout
+   */
+  keepSessionAlive () {
+    this._lastActiveMoment = +(new Date());
+    if (this.waitForUserTimeout) {
+      clearTimeout(this.waitForUserTimeout);
+    }
   }
 
   async fetchElement (strategy, selector) {
@@ -59,6 +107,7 @@ export default class AppiumMethodHandler {
   }
 
   async _execute ({elementId, methodName, args, skipScreenshotAndSource}) {
+    this._lastActiveMoment = +(new Date());
     let cachedEl;
     let res = {};
 
@@ -76,7 +125,7 @@ export default class AppiumMethodHandler {
           .tap({x: args[0], y: args[1]})
           .perform();
       } else if (methodName === 'swipe') {
-        const [startX, startY, endX, endY]  = args;
+        const [startX, startY, endX, endY] = args;
         res = await (new wd.TouchAction(this.driver))
           .press({x: startX, y: startY})
           .moveTo({x: endX, y: endY})
@@ -111,7 +160,7 @@ export default class AppiumMethodHandler {
   }
 
   async _getSourceAndScreenshot () {
-    let source, sourceError, screenshot, screenshotError;
+    let source, sourceError, screenshot, screenshotError, windowSize, windowSizeError;
     try {
       source = await this.driver.source();
     } catch (e) {
@@ -129,13 +178,23 @@ export default class AppiumMethodHandler {
       }
       screenshotError = e;
     }
+
+    try {
+      windowSize = await this.driver.getWindowSize();
+
+    } catch (e) {
+      if (e.status === 6) {
+        throw e;
+      }
+      windowSizeError = e;
+    }
 
-    return {source, sourceError, screenshot, screenshotError};
+    return {source, sourceError, screenshot, screenshotError, windowSize, windowSizeError};
   }
 
   restart () {
     // Clear the variable names and start over (el1, el2, els1, els2, etc...)
-    for (let elCache of _.toPairs(this.elementCache)) {
+    for (const elCache of Object.values(this.elementCache)) {
       delete elCache.variableName;
     }
 
@@ -144,4 +203,14 @@ export default class AppiumMethodHandler {
     this.elArrayVariableCounter = 1;   
   }
 
-}
+  async close (reason, killedByUser=false) {
+    this.killKeepAliveLoop();
+    this.sender.send('appium-session-done', {reason, killedByUser});
+    if (!this.driver._isAttachedSession) {
+      try {
+        await this.driver.quit();
+      } catch (ign) { }
+    }
+  }
+
+}