Handle inferring electron-prebuilt-compile versions better (#932)

Only apply the `electron-prebuilt-compile` workaround when Electron < 1.6.5

Author: malept

infer.js

@@ -6,6 +6,7 @@ const parseAuthor = require('parse-author')
 const path = require('path')
 const pify = require('pify')
 const resolve = require('resolve')
+const semver = require('semver')
 
 function isMissingRequiredProperty (props) {
   return props.some(prop => prop === 'productName' || prop === 'dependencies.electron')
@@ -39,21 +40,24 @@ function getVersion (opts, electronProp) {
     // electron-prebuilt-compile cannot be resolved because `main` does not point
     // to a valid JS file.
     const electronVersion = electronProp.pkg[depType][packageName]
-    if (!/^\d+\.\d+\.\d+/.test(electronVersion)) {
-      throw new Error('Using electron-prebuilt-compile with Electron Packager requires specifying an exact Electron version')
-    }
+    const versionRange = new semver.Range(electronVersion)
+    if (versionRange.intersects(new semver.Range('< 1.6.5'))) {
+      if (!/^\d+\.\d+\.\d+/.test(electronVersion)) {
+        throw new Error('Using electron-prebuilt-compile with Electron Packager requires specifying an exact Electron version')
+      }
 
-    opts.electronVersion = electronVersion
-    return Promise.resolve()
-  } else {
-    return pify(resolve, { multiArgs: true })(packageName, { basedir: path.dirname(src) })
-      .then(res => {
-        debug(`Inferring target Electron version from ${packageName} in ${src}`)
-        const pkg = res[1]
-        opts.electronVersion = pkg.version
-        return null
-      })
+      opts.electronVersion = electronVersion
+      return Promise.resolve()
+    }
   }
+
+  return pify(resolve, { multiArgs: true })(packageName, { basedir: path.dirname(src) })
+    .then(res => {
+      debug(`Inferring target Electron version from ${packageName} in ${src}`)
+      const pkg = res[1]
+      opts.electronVersion = pkg.version
+      return null
+    })
 }
 
 function handleMetadata (opts, result) {

test/fixtures/infer-invalid-non-specific-electron-prebuilt-compile/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "main.js",
+  "productName": "MainJS",
+  "devDependencies": {
+    "electron-prebuilt-compile": "^1.4.15"
+  }
+}

test/fixtures/infer-non-specific-electron-prebuilt-compile/node_modules/electron-prebuilt-compile/index.js

@@ -2,6 +2,6 @@
   "main": "main.js",
   "productName": "MainJS",
   "devDependencies": {
-    "electron-prebuilt-compile": "^1.4.15"
+    "electron-prebuilt-compile": "^2.0.0"
   }
 }

test/fixtures/infer-non-specific-electron-prebuilt-compile/node_modules/electron-prebuilt-compile/package.json

@@ -5,6 +5,7 @@ const getMetadataFromPackageJSON = require('../infer')
 const packager = require('..')
 const path = require('path')
 const pkgUp = require('pkg-up')
+const semver = require('semver')
 const util = require('./_util')
 
 function inferElectronVersionTest (t, opts, fixture, packageName) {
@@ -14,7 +15,7 @@ function inferElectronVersionTest (t, opts, fixture, packageName) {
   return getMetadataFromPackageJSON([], opts, opts.dir)
     .then(() => {
       const packageJSON = require(path.join(opts.dir, 'package.json'))
-      return t.is(opts.electronVersion, packageJSON.devDependencies[packageName], `The version should be inferred from installed ${packageName} version`)
+      return t.true(semver.satisfies(opts.electronVersion, packageJSON.devDependencies[packageName]), `The version should be inferred from installed ${packageName} version`)
     })
 }
 
@@ -86,6 +87,7 @@ function testInferWin32metadataAuthorObject (t, opts, author, expected, assertio
 util.testSinglePlatformParallel('infer using `electron-prebuilt` package', inferElectronVersionTest, 'basic', 'electron-prebuilt')
 util.testSinglePlatformParallel('infer using `electron-nightly` package', inferElectronVersionTest, 'infer-electron-nightly', 'electron-nightly')
 util.testSinglePlatformParallel('infer using `electron-prebuilt-compile` package', inferElectronVersionTest, 'infer-electron-prebuilt-compile', 'electron-prebuilt-compile')
+util.testSinglePlatformParallel('infer using non-exact `electron-prebuilt-compile` package', inferElectronVersionTest, 'infer-non-specific-electron-prebuilt-compile', 'electron-prebuilt-compile')
 util.testSinglePlatformParallel('infer using `electron` package only', inferMissingVersionTest)
 util.testSinglePlatformParallel('infer where `electron` version is preferred over `electron-prebuilt`', inferElectronVersionTest, 'basic-renamed-to-electron', 'electron')
 util.testSinglePlatformParallel('infer win32metadata', (t, opts) => {
@@ -119,4 +121,4 @@ util.testSinglePlatformParallel('do not infer win32metadata.CompanyName when aut
 util.testSinglePlatformParallel('infer missing fields test', inferFailureTest, 'infer-missing-fields')
 util.testSinglePlatformParallel('infer with bad fields test', inferFailureTest, 'infer-bad-fields')
 util.testSinglePlatformParallel('infer with malformed JSON test', inferFailureTest, 'infer-malformed-json')
-util.testSinglePlatformParallel('infer using a non-specific `electron-prebuilt-compile` package version', inferFailureTest, 'infer-non-specific-electron-prebuilt-compile')
+util.testSinglePlatformParallel('infer using a non-specific `electron-prebuilt-compile` package version when the package did not have a main file', inferFailureTest, 'infer-invalid-non-specific-electron-prebuilt-compile')