Upgrade to support electron 4 (2) (electron-userland#361)

Alexandre Lacheze · codebytere · commit a64c8095eb4b · 2019-06-20T10:20:58.000-07:00
* chore: bump package version * chore: bump associated Electron version * chore: upgrade to electron-chromedriver 4.0.0 * chore: add new version to matrix * chore: update chai and chai-as-promised * Use random port Implement workaround found https://bitbucket.org/chromiumembedded/cef/issues/2476/cef-webdriver-instructions-will-need-to * Minor fixes of tests * Lock * 👕 * Make multi-window tests independant of the order of windowhandles() * Update to latest electron version * Do not set random if it was already set by user * Make comment clearer * Make comment more accurate
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ For given versions of Electron you must depend on a very specific version range
 | `~1.8.0` | `~3.8.0` |
 | `^2.0.0` | `^4.0.0` |
 | `^3.0.0` | `^5.0.0` |
+| `^4.0.0` | `^6.0.0` |
 
 Learn more from [this presentation](https://speakerdeck.com/kevinsawicki/testing-your-electron-apps-with-chromedriver).
 
diff --git a/lib/application.js b/lib/application.js
@@ -153,6 +153,20 @@ Application.prototype.createClient = function () {
       args.push(arg)
     })
 
+    // Since ChromeDriver v2.41, ChromeDriver will only connect
+    // if, either we precise a port for remote debugging, either
+    // the embedder (ie electron) made sure to pass `USER_DATA_DIR`
+    // to the remote debugging server.
+    // https://bitbucket.org/chromiumembedded/cef/issues/2476/cef-webdriver-instructions-will-need-to
+    // `USER_DATA_DIR` is properly passed to the remote debugging server
+    // since electron 5 (see electron/electron#17800)
+    // So, for now, we'll just use a random port if not already set.
+    // todo(electron-5): remove me
+    if (!args.some(arg => arg.startsWith('remote-debugging-port'))) {
+      const randomPort = Math.floor(Math.random() * (9999 - 9000) + 9000)
+      args.push(`remote-debugging-port=${randomPort}`)
+    }
+
     var isWin = process.platform === 'win32'
     var launcherPath = path.join(__dirname, isWin ? 'launcher.bat' : 'launcher.js')
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "spectron",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "description": "Easily test your Electron apps using ChromeDriver and WebdriverIO.",
   "main": "index.js",
   "types": "./lib/spectron.d.ts",
@@ -9,7 +9,6 @@
     "prepack": "check-for-leaks",
     "prepush": "check-for-leaks",
     "pretest": "tslint lib/spectron.d.ts && tsc lib/spectron.d.ts",
-    "lint": "standard",
     "test": "mocha && standard"
   },
   "engines": {
@@ -26,18 +25,18 @@
   "license": "MIT",
   "dependencies": {
     "dev-null": "^0.1.1",
-    "electron-chromedriver": "~3.0.0",
+    "electron-chromedriver": "~4.0.0",
     "request": "^2.87.0",
     "split": "^1.0.0",
     "webdriverio": "^4.13.0"
   },
   "devDependencies": {
     "@types/webdriverio": "^4.8.0",
-    "chai": "^3.5.0",
-    "chai-as-promised": "^6.0.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "chai-roughly": "^1.0.0",
     "check-for-leaks": "^1.0.2",
-    "electron": "~3.0.0",
+    "electron": "^4.2.2",
     "husky": "^0.14.3",
     "mocha": "^5.2.0",
     "standard": "^12.0.1",
diff --git a/test/application-test.js b/test/application-test.js
@@ -137,7 +137,7 @@ describe('application loading', function () {
     it('gets the render process console logs and clears them', function () {
       return app.client.waitUntilWindowLoaded()
         .getRenderProcessLogs().then(function (logs) {
-          expect(logs.length).to.equal(3)
+          expect(logs.length).to.equal(4)
 
           expect(logs[0].message).to.contain('6:14 "render log"')
           expect(logs[0].source).to.equal('console-api')
diff --git a/test/multi-window-test.js b/test/multi-window-test.js
