feat: print bundled Node and Electron versions in cypress version (#…

…9183)

circle.yml

@@ -8,7 +8,7 @@ macBuildFilters: &macBuildFilters
     branches:
       only:
         - develop
-        - remove-old-binary-file
+        - include-electron-node-version
 
 defaults: &defaults
   parallelism: 1
@@ -308,6 +308,10 @@ commands:
           working_directory: /tmp/<<parameters.repo>>
           # force installing the freshly built binary
           command: CYPRESS_INSTALL_BINARY=~/cypress/cypress.zip npm i ~/cypress/cypress.tgz
+      - run:
+          name: Print Cypress version
+          working_directory: /tmp/<<parameters.repo>>
+          command: npx cypress version
       - run:
           name: Types check 🧩 (maybe)
           working_directory: /tmp/<<parameters.repo>>
@@ -1286,6 +1290,10 @@ jobs:
           working_directory: test-binary
           # force installing the freshly built binary
           command: CYPRESS_INSTALL_BINARY=/root/cypress/cypress.zip npm i /root/cypress/cypress.tgz
+      - run:
+          name: Cypress version
+          working_directory: test-binary
+          command: $(yarn bin)/cypress version
       - run:
           name: Verify Cypress binary
           working_directory: test-binary

cli/NPM_README.md

@@ -12,7 +12,7 @@ After installing you'll be able to:
 
 ## Install
 
-Requires Node version >= 4.0.0
+Requires Node version >= 10.0.0
 
 ```sh
 npm install --save-dev cypress

cli/__snapshots__/cli_spec.js

@@ -359,26 +359,43 @@ exports['cli CYPRESS_INTERNAL_ENV catches environment "foo" 1'] = `
 exports['cli version and binary version 1'] = `
 Cypress package version: 1.2.3
 Cypress binary version: X.Y.Z
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['cli version and binary version 2'] = `
 Cypress package version: 1.2.3
 Cypress binary version: X.Y.Z
+Electron version: not found
+Bundled Node version: not found
+`
+
+exports['cli version with electron and node 1'] = `
+Cypress package version: 1.2.3
+Cypress binary version: X.Y.Z
+Electron version: 10.10.88
+Bundled Node version: 11.10.3
 `
 
 exports['cli version no binary version 1'] = `
 Cypress package version: 1.2.3
 Cypress binary version: not installed
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['cli --version no binary version 1'] = `
 Cypress package version: 1.2.3
 Cypress binary version: not installed
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['cli -v no binary version 1'] = `
 Cypress package version: 1.2.3
 Cypress binary version: not installed
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['cli cypress run warns with space-separated --spec 1'] = `
@@ -445,11 +462,15 @@ exports['cli CYPRESS_INTERNAL_ENV allows and warns when staging environment 1']
 exports['cli version and binary version with npm log silent'] = `
 Cypress package version: 1.2.3
 Cypress binary version: X.Y.Z
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['cli version and binary version with npm log warn'] = `
 Cypress package version: 1.2.3
 Cypress binary version: X.Y.Z
+Electron version: not found
+Bundled Node version: not found
 `
 
 exports['prints explanation when no cache'] = `

cli/lib/cli.js

@@ -168,6 +168,8 @@ function showVersions () {
   .then((versions = {}) => {
     logger.always('Cypress package version:', versions.package)
     logger.always('Cypress binary version:', versions.binary)
+    logger.always('Electron version:', versions.electronVersion)
+    logger.always('Bundled Node version:', versions.electronNodeVersion)
     process.exit(0)
   })
   .catch(util.logErrorExit1)

cli/lib/exec/versions.js

@@ -28,12 +28,29 @@ const getVersions = () => {
 
     return state.getBinaryDir()
   })
-  .then(state.getBinaryPkgVersionAsync)
-  .then((binaryVersion) => {
-    return {
+  .then(state.getBinaryPkgAsync)
+  .then((pkg) => {
+    const versions = {
+      binary: state.getBinaryPkgVersion(pkg),
+      electronVersion: state.getBinaryElectronVersion(pkg),
+      electronNodeVersion: state.getBinaryElectronNodeVersion(pkg),
+    }
+
+    debug('binary versions %o', versions)
+
+    return versions
+  })
+  .then((binaryVersions) => {
+    const versions = {
       package: util.pkgVersion(),
-      binary: binaryVersion || 'not installed',
+      binary: binaryVersions.binary || 'not installed',
+      electronVersion: binaryVersions.electronVersion || 'not found',
+      electronNodeVersion: binaryVersions.electronNodeVersion || 'not found',
     }
+
+    debug('combined versions %o', versions)
+
+    return versions
   })
 }
 

cli/lib/tasks/install.js

@@ -290,7 +290,7 @@ const start = (options = {}) => {
   })
   .then(() => {
     return Promise.all([
-      state.getBinaryPkgVersionAsync(binaryDir),
+      state.getBinaryPkgAsync(binaryDir).then(state.getBinaryPkgVersion),
       getVersionSpecifier(),
     ])
   })

cli/lib/tasks/state.js

@@ -2,6 +2,7 @@ const _ = require('lodash')
 const os = require('os')
 const path = require('path')
 const untildify = require('untildify')
+const R = require('ramda')
 const debug = require('debug')('cypress:cli')
 
 const fs = require('../fs')
@@ -159,7 +160,11 @@ const getPathToExecutable = (binaryDir) => {
   return path.join(binaryDir, getPlatformExecutable())
 }
 
-const getBinaryPkgVersionAsync = (binaryDir) => {
+/**
+ * Resolves with an object read from the binary app package.json file.
+ * If the file does not exist resolves with null
+ */
+const getBinaryPkgAsync = (binaryDir) => {
   const pathToPackageJson = getBinaryPkgPath(binaryDir)
 
   debug('Reading binary package.json from:', pathToPackageJson)
@@ -171,15 +176,22 @@ const getBinaryPkgVersionAsync = (binaryDir) => {
     }
 
     return fs.readJsonAsync(pathToPackageJson)
-    .get('version')
   })
 }
 
+const getBinaryPkgVersion = R.propOr(null, 'version')
+const getBinaryElectronVersion = R.propOr(null, 'electronVersion')
+const getBinaryElectronNodeVersion = R.propOr(null, 'electronNodeVersion')
+
 module.exports = {
   getPathToExecutable,
   getPlatformExecutable,
-  getBinaryPkgVersionAsync,
+  // those names start to sound like Java
+  getBinaryElectronNodeVersion,
+  getBinaryElectronVersion,
+  getBinaryPkgVersion,
   getBinaryVerifiedAsync,
+  getBinaryPkgAsync,
   getBinaryPkgPath,
   getBinaryDir,
   getCacheDir,

cli/lib/tasks/verify.js

@@ -318,7 +318,10 @@ const start = (options = {}) => {
     return debug('binaryDir is ', binaryDir)
   })
   .then(() => {
-    return state.getBinaryPkgVersionAsync(binaryDir)
+    return state.getBinaryPkgAsync(binaryDir)
+  })
+  .then((pkg) => {
+    return state.getBinaryPkgVersion(pkg)
   })
   .then((binaryVersion) => {
     if (!binaryVersion) {

cli/test/lib/cli_spec.js

@@ -151,9 +151,11 @@ describe('cli', () => {
     it('reports package version', (done) => {
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
       sinon
-      .stub(state, 'getBinaryPkgVersionAsync')
+      .stub(state, 'getBinaryPkgAsync')
       .withArgs(binaryDir)
-      .resolves('X.Y.Z')
+      .resolves({
+        version: 'X.Y.Z',
+      })
 
       this.exec('version')
       process.exit.callsFake(() => {
@@ -164,7 +166,7 @@ describe('cli', () => {
 
     it('reports package and binary message', (done) => {
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves('X.Y.Z')
+      sinon.stub(state, 'getBinaryPkgAsync').resolves({ version: 'X.Y.Z' })
 
       this.exec('version')
       process.exit.callsFake(() => {
@@ -173,13 +175,28 @@ describe('cli', () => {
       })
     })
 
+    it('reports electron and node message', (done) => {
+      sinon.stub(util, 'pkgVersion').returns('1.2.3')
+      sinon.stub(state, 'getBinaryPkgAsync').resolves({
+        version: 'X.Y.Z',
+        electronVersion: '10.10.88',
+        electronNodeVersion: '11.10.3',
+      })
+
+      this.exec('version')
+      process.exit.callsFake(() => {
+        snapshot('cli version with electron and node 1', logger.print())
+        done()
+      })
+    })
+
     it('reports package and binary message with npm log silent', (done) => {
       restoreEnv = mockedEnv({
         npm_config_loglevel: 'silent',
       })
 
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves('X.Y.Z')
+      sinon.stub(state, 'getBinaryPkgAsync').resolves({ version: 'X.Y.Z' })
 
       this.exec('version')
       process.exit.callsFake(() => {
@@ -195,7 +212,9 @@ describe('cli', () => {
       })
 
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves('X.Y.Z')
+      sinon.stub(state, 'getBinaryPkgAsync').resolves({
+        version: 'X.Y.Z',
+      })
 
       this.exec('version')
       process.exit.callsFake(() => {
@@ -207,7 +226,7 @@ describe('cli', () => {
 
     it('handles non-existent binary version', (done) => {
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves(null)
+      sinon.stub(state, 'getBinaryPkgAsync').resolves(null)
 
       this.exec('version')
       process.exit.callsFake(() => {
@@ -218,7 +237,7 @@ describe('cli', () => {
 
     it('handles non-existent binary --version', (done) => {
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves(null)
+      sinon.stub(state, 'getBinaryPkgAsync').resolves(null)
 
       this.exec('--version')
       process.exit.callsFake(() => {
@@ -229,7 +248,7 @@ describe('cli', () => {
 
     it('handles non-existent binary -v', (done) => {
       sinon.stub(util, 'pkgVersion').returns('1.2.3')
-      sinon.stub(state, 'getBinaryPkgVersionAsync').resolves(null)
+      sinon.stub(state, 'getBinaryPkgAsync').resolves(null)
 
       this.exec('-v')
       process.exit.callsFake(() => {

cli/test/lib/exec/versions_spec.js

@@ -1,35 +1,69 @@
+const { expect } = require('chai')
+
 require('../../spec_helper')
 
 const util = require(`${lib}/util`)
 const state = require(`${lib}/tasks/state`)
 const versions = require(`${lib}/exec/versions`)
 
 describe('lib/exec/versions', function () {
+  const binaryDir = '/cache/1.2.3/Cypress.app'
+
   beforeEach(function () {
-    sinon.stub(state, 'getBinaryDir').returns('/cache/1.2.3/Cypress.app')
-    sinon.stub(state, 'getBinaryPkgVersionAsync').withArgs('/cache/1.2.3/Cypress.app').resolves('1.2.3')
+    sinon.stub(state, 'getBinaryDir').returns(binaryDir)
+    sinon.stub(state, 'getBinaryPkgAsync').withArgs(binaryDir).resolves({
+      version: '1.2.3',
+      electronVersion: '10.1.2',
+      electronNodeVersion: '12.16.3',
+    })
+
     sinon.stub(util, 'pkgVersion').returns('4.5.6')
   })
 
   describe('.getVersions', function () {
     it('gets the correct binary and package version', function () {
       return versions.getVersions().then(({ package, binary }) => {
-        expect(package).to.eql('4.5.6')
-        expect(binary).to.eql('1.2.3')
+        expect(package, 'package version').to.eql('4.5.6')
+        expect(binary, 'binary version').to.eql('1.2.3')
+      })
+    })
+
+    it('gets the correct Electron and bundled Node version', function () {
+      return versions.getVersions().then(({ electronVersion, electronNodeVersion }) => {
+        expect(electronVersion, 'electron version').to.eql('10.1.2')
+        expect(electronNodeVersion, 'node version').to.eql('12.16.3')
       })
     })
 
     it('gets correct binary version if CYPRESS_RUN_BINARY', function () {
       sinon.stub(state, 'parseRealPlatformBinaryFolderAsync').resolves('/my/cypress/path')
       process.env.CYPRESS_RUN_BINARY = '/my/cypress/path'
-      state.getBinaryPkgVersionAsync
+      state.getBinaryPkgAsync
       .withArgs('/my/cypress/path')
-      .resolves('7.8.9')
+      .resolves({
+        version: '7.8.9',
+      })
 
       return versions.getVersions().then(({ package, binary }) => {
         expect(package).to.eql('4.5.6')
         expect(binary).to.eql('7.8.9')
       })
     })
+
+    it('reports default versions if not found', function () {
+      // imagine package.json only has version there
+      state.getBinaryPkgAsync.withArgs(binaryDir).resolves({
+        version: '90.9.9',
+      })
+
+      return versions.getVersions().then((versions) => {
+        expect(versions).to.deep.equal({
+          'package': '4.5.6',
+          'binary': '90.9.9',
+          'electronVersion': 'not found',
+          'electronNodeVersion': 'not found',
+        })
+      })
+    })
   })
 })