feat: add auto upgrade feature, liv-6434 (#22)

* feat: add upgrade CLI module

* fix: set upgrade frequency to once a day

* feat: add version checker from binary

* refactor: separate prompt check and upgrade to different methods

Author: ihors-livestorm

__tests__/cmds/envs/list.spec.ts

@@ -1,7 +1,7 @@
 import configStore from 'configstore'
 import envs from '../../../src/cmds/envs'
 
-jest.mock('configstore');
+jest.mock('configstore')
 
 const mockedConfigstore = jest.mocked(configStore, true)
 
@@ -17,4 +17,4 @@ describe('List command', () => {
         const [ key  ] = get.mock.calls[0]
         expect(key).toBe(`envs`)
     });
-})
+})

__tests__/cmds/envs/remove.spec.ts

@@ -1,7 +1,7 @@
 import configStore from 'configstore'
 import envs from '../../../src/cmds/envs'
 
-jest.mock('configstore');
+jest.mock('configstore')
 
 const mockedConfigstore = jest.mocked(configStore, true)
 
@@ -18,4 +18,4 @@ describe('Remove command', () => {
         const [ key ] = deleteFn.mock.calls[0]
         expect(key).toBe(`envs.${envName}`)
     });
-})
+})

index.js

@@ -1,13 +1,20 @@
 #!/usr/bin/env node
 const minimist = require('minimist')
 const availableCommands = require('./src/cmds')
+const { checkAndUpgradeCliVersion } = require('./src/cmds/upgrade')
 
-const command = process.argv[2]
+async function executeCommand() {
+  await checkAndUpgradeCliVersion()
 
-if (!command || !availableCommands[command]) {
-  console.log('Usage: livestorm <command>')
-  availableCommands.help()
-  process.exit(1)
+  const command = process.argv[2]
+
+  if (!command || !availableCommands[command]) {
+    console.log('Usage: livestorm <command>')
+    availableCommands.help()
+    process.exit(1)
+  }
+
+  availableCommands[command](minimist(process.argv.slice(3)))
 }
 
-availableCommands[command](minimist(process.argv.slice(3)))
+executeCommand()

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestorm/cli",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "CLI that allows you to build and deploy your Livestorm plugin",
   "main": "index.js",
   "bin": {
@@ -23,7 +23,8 @@
     "node-fetch": "^2.6.1",
     "node-watch": "^0.7.2",
     "prompts": "^2.4.0",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "semver": "^7.3.5"
   },
   "typings": "types/index.d.ts",
   "devDependencies": {

src/cmds/build.js

@@ -6,4 +6,4 @@ module.exports = () => {
   execSync('yarn build')
   console.log(`Bundling done`)
   return fs.readFileSync(`${process.cwd()}/build/bundle.js`)
-}
+}

src/cmds/create.js

@@ -82,4 +82,4 @@ module.exports = () => {
       console.log('Oops, an error happened. Please drop us an email with the error detail.')
     }
   })
-}
+}

src/cmds/help.js

@@ -23,6 +23,8 @@ _  /____/ /  __ |/ / _  /___  ____/ /_  /   / /_/ /_  _, _/_  /  / /
       ['asset   <file>', 'Upload files and use them in your plugins'],
       ['list [--environment|--api-token]', 'List the published plugins'],
       ['envs [add|remove|list] <environment> [--api-token|--endpoint]', 'Manage your environments'],
+      ['upgrade', 'Upgrade Livestorm Plugins CLI'],
+      ['version', 'Output the current version of the CLI'],
     ], ['blue', 'blue'])
   )
 

src/cmds/index.js

@@ -8,6 +8,8 @@ const asset = require('./asset')
 const help = require('./help')
 const list = require('./list')
 const envs = require('./envs')
+const { upgrade } = require('./upgrade')
+const version = require('./version').printModuleVersion
 
 module.exports = {
   publish,
@@ -20,4 +22,6 @@ module.exports = {
   help,
   list,
   envs,
-}
+  upgrade,
+  version
+}

src/cmds/list.js

@@ -1,10 +1,10 @@
 const { default: fetch } = require('node-fetch')
 const commandLineArgs = require('command-line-args')
+const cliff = require('cliff')
+
 const getLivestormConfig = require('../helpers/getLivestormConfig')
 const setLocalProxyIfNeeded = require('../helpers/setLocalProxyIfNeeded')
 const setLocalHostIfNeeded = require('../helpers/setLocalHostIfNeeded')
-const cliff = require('cliff')
-
 
 module.exports = async () => {
   const options = commandLineArgs([
@@ -59,4 +59,4 @@ function handleResponse(response) {
     ...response.plugins.map((plugin) => [plugin.id, plugin.name])
   ]
   console.log(cliff.stringifyRows(rows, ['blue', 'blue']))
-}
+}

src/cmds/remove.js

@@ -48,4 +48,4 @@ function handleNetworkError(err, json) {
   console.log(err)
   console.log(`Failed to remove plugin ${json.name} from ${json.endpoint}.`)
   console.log('Make sure your internet connection is working and check https://status.livestorm.co/')
-}
+}

src/cmds/upgrade.js

@@ -0,0 +1,65 @@
+const { execSync } = require('child_process')
+const { default: fetch } = require('node-fetch')
+const prompts = require('prompts')
+const semverGte = require('semver/functions/gte')
+ 
+const configStore = require('../helpers/configStore.js')
+const checkCurrentVersion = require('./version').getModuleVersion
+
+async function checkLatestVersion() {
+  const response = await fetch('https://registry.npmjs.org/@livestorm/cli')
+  const json = await response.json()
+  return json['dist-tags']['latest']
+}
+
+async function checkCandidateForUpgrade() {
+  try {
+    const currentDate = new Date().toISOString().split('T')[0]
+    const latestUpgradeDate = configStore.get('latestUpgradeDate')
+    if (currentDate === latestUpgradeDate) return false
+
+    configStore.set('latestUpgradeDate', currentDate)
+
+    const currentVersion = checkCurrentVersion()
+    const latestVersion = await checkLatestVersion()
+    if (semverGte(currentVersion, latestVersion)) return false
+
+    return true
+  }
+  catch (error) {
+    return false
+  }
+}
+
+async function promptUpgrade() {
+  const answer = await prompts({
+    type: 'text',
+    name: 'upgrade',
+    message: "We noticed your CLI isn't up to date, do you want to upgrade? (yes/no)",
+    validate: value => {
+      return (value !== 'no' || value !== 'yes')
+    }
+  })
+  if (answer.upgrade === 'yes') return true
+
+  return false
+}
+
+function upgrade() {
+  console.log('Upgrading @livestorm/cli to the latest version ...')
+  execSync('yarn global upgrade @livestorm/cli@latest')
+  console.log('All done 🙌')
+}
+
+async function checkAndUpgradeCliVersion() {
+  const isCandidateForUpgrade = await checkCandidateForUpgrade()
+  if (isCandidateForUpgrade) {
+    const yes = await promptUpgrade()
+    if (yes) upgrade()
+  }
+}
+
+module.exports = {
+  checkAndUpgradeCliVersion,
+  upgrade
+}

src/cmds/version.js

@@ -0,0 +1,15 @@
+const fs = require('fs')
+
+function getModuleVersion() {
+  const file = fs.readFileSync('package.json', 'utf8')
+  return JSON.parse(file).version
+}
+
+function printModuleVersion() {
+  console.log(getModuleVersion())
+}
+
+module.exports = {
+  getModuleVersion,
+  printModuleVersion
+}

yarn.lock

@@ -3221,7 +3221,7 @@ semver@^6.0.0, semver@^6.1.1, semver@^6.1.2, semver@^6.3.0:
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
   integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
 
-semver@^7.3.2:
+semver@^7.3.2, semver@^7.3.5:
   version "7.3.5"
   resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.5.tgz#0b621c879348d8998e4b0e4be94b3f12e6018ef7"
   integrity sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==