feat: show warning when new swarm-cli version is available

.github/workflows/tests-rc.yaml

@@ -58,11 +58,11 @@ jobs:
 
       - name: Deposit to chequebook
         run: |
-          swarm-cli cheque deposit 100000000000000000
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:11633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:21633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:31633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:41633
+          swarm-cli cheque deposit 10
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:11633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:21633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:31633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:41633
 
       - name: Print swarm-cli status
         continue-on-error: true

.github/workflows/tests.yaml

@@ -42,11 +42,11 @@ jobs:
 
       - name: Deposit to chequebook
         run: |
-          swarm-cli cheque deposit 100000000000000000
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:11633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:21633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:31633
-          swarm-cli cheque deposit 100000000000000000 --bee-api-url http://localhost:41633
+          swarm-cli cheque deposit 10
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:11633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:21633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:31633
+          swarm-cli cheque deposit 10 --bee-api-url http://localhost:41633
 
       - name: Print swarm-cli status
         continue-on-error: true

jest.config.ts

@@ -17,6 +17,8 @@ export default async (): Promise<Config.InitialOptions> => {
    */
   const console = new CommandLog(VerbosityLevel.Normal)
 
+  process.env.SKIP_VERSION_CHECK = 'true'
+
   if (!process.env.SKIP_WORKER) {
     process.env.WORKER_PSS_ADDRESS = (await getPssAddress('http://localhost:11633')).toCompressedHex()
   }

src/command/root-command/index.ts

@@ -6,6 +6,7 @@ import { parseHeaders } from '../../utils'
 import { ConfigOption } from '../../utils/types/config-option'
 import { CONFIG_OPTIONS, CommandConfig } from './command-config'
 import { CommandLog, VerbosityLevel } from './command-log'
+import { checkForUpdates } from '../../service/version_checker'
 
 export class RootCommand {
   @ExternalOption('bee-api-url')
@@ -57,6 +58,10 @@ export class RootCommand {
     this.commandConfig = new CommandConfig(this.appName, this.console, this.configFile, this.configFolder)
     this.sourcemap = Utils.getSourcemap()
 
+    if (!this.quiet) {
+      checkForUpdates()
+    }
+
     CONFIG_OPTIONS.forEach((option: ConfigOption) => {
       this.maybeSetFromConfig(option)
     })

src/service/version_checker.ts

@@ -0,0 +1,27 @@
+import PackageJson from '../../package.json'
+import { CommandLog, VerbosityLevel } from '../command/root-command/command-log'
+import { warningText } from '../utils/text'
+import fetch from 'node-fetch'
+
+const LATEST_RELEASE_URL = 'https://api.github.com/repos/ethersphere/swarm-cli/releases/latest'
+
+export async function checkForUpdates() {
+  if (process.env.SKIP_VERSION_CHECK === 'true') {
+    return
+  }
+
+  const console = new CommandLog(VerbosityLevel.Normal)
+  await fetch(LATEST_RELEASE_URL)
+    .then(res => res.json())
+    .then((data: { tag_name: string }) => {
+      const latestVersion = data.tag_name.replace(/^v/, '')
+
+      if (latestVersion !== PackageJson.version) {
+        console.log(
+          warningText(
+            `A new version of swarm-cli is available: ${latestVersion}. You are using version ${PackageJson.version}. Please update to the latest version.`,
+          ),
+        )
+      }
+    })
+}

test/command/version-warning.spec.ts

@@ -0,0 +1,20 @@
+import fetch, { Response } from 'node-fetch'
+import PackageJson from '../../package.json'
+import { describeCommand, invokeTestCli } from '../utility'
+
+jest.mock('node-fetch')
+const mockedFetch = fetch as jest.MockedFunction<typeof fetch>
+
+describeCommand('Test Outdated Version Warning', ({ consoleMessages }) => {
+  it('should print warning when version is outdated', async () => {
+    process.env.SKIP_VERSION_CHECK = 'false'
+    mockedFetch.mockResolvedValue({
+      json: () => Promise.resolve({ tag_name: 'v999.0.0' }),
+    } as unknown as Response)
+    await invokeTestCli(['status'])
+    expect(consoleMessages[2]).toContain(
+      `A new version of swarm-cli is available: 999.0.0. You are using version ${PackageJson.version}. Please update to the latest version.`,
+    )
+    process.env.SKIP_VERSION_CHECK = 'true'
+  })
+})

test/coverage/coverage-summary.json

@@ -1,4 +1,4 @@
-{"total": {"lines":{"total":2863,"covered":2186,"skipped":0,"pct":76.35},"statements":{"total":2884,"covered":2200,"skipped":0,"pct":76.28},"functions":{"total":343,"covered":271,"skipped":0,"pct":79},"branches":{"total":621,"covered":353,"skipped":0,"pct":56.84},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{"total": {"lines":{"total":2880,"covered":2203,"skipped":0,"pct":76.49},"statements":{"total":2901,"covered":2217,"skipped":0,"pct":76.42},"functions":{"total":346,"covered":274,"skipped":0,"pct":79.19},"branches":{"total":624,"covered":356,"skipped":0,"pct":57.05},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/application.ts": {"lines":{"total":2,"covered":0,"skipped":0,"pct":0},"functions":{"total":0,"covered":0,"skipped":0,"pct":100},"statements":{"total":2,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/config.ts": {"lines":{"total":33,"covered":32,"skipped":0,"pct":96.96},"functions":{"total":1,"covered":0,"skipped":0,"pct":0},"statements":{"total":33,"covered":32,"skipped":0,"pct":96.96},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/curl.ts": {"lines":{"total":24,"covered":24,"skipped":0,"pct":100},"functions":{"total":7,"covered":7,"skipped":0,"pct":100},"statements":{"total":25,"covered":25,"skipped":0,"pct":100},"branches":{"total":13,"covered":12,"skipped":0,"pct":92.3}}
@@ -65,7 +65,7 @@
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/pss/subscribe.ts": {"lines":{"total":18,"covered":8,"skipped":0,"pct":44.44},"functions":{"total":5,"covered":1,"skipped":0,"pct":20},"statements":{"total":18,"covered":8,"skipped":0,"pct":44.44},"branches":{"total":4,"covered":0,"skipped":0,"pct":0}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/root-command/command-config.ts": {"lines":{"total":39,"covered":33,"skipped":0,"pct":84.61},"functions":{"total":8,"covered":8,"skipped":0,"pct":100},"statements":{"total":42,"covered":35,"skipped":0,"pct":83.33},"branches":{"total":11,"covered":6,"skipped":0,"pct":54.54}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/root-command/command-log.ts": {"lines":{"total":78,"covered":60,"skipped":0,"pct":76.92},"functions":{"total":9,"covered":6,"skipped":0,"pct":66.66},"statements":{"total":78,"covered":60,"skipped":0,"pct":76.92},"branches":{"total":11,"covered":7,"skipped":0,"pct":63.63}}
-,"/home/runner/work/swarm-cli/swarm-cli/src/command/root-command/index.ts": {"lines":{"total":44,"covered":40,"skipped":0,"pct":90.9},"functions":{"total":4,"covered":4,"skipped":0,"pct":100},"statements":{"total":44,"covered":40,"skipped":0,"pct":90.9},"branches":{"total":9,"covered":5,"skipped":0,"pct":55.55}}
+,"/home/runner/work/swarm-cli/swarm-cli/src/command/root-command/index.ts": {"lines":{"total":47,"covered":43,"skipped":0,"pct":91.48},"functions":{"total":4,"covered":4,"skipped":0,"pct":100},"statements":{"total":47,"covered":43,"skipped":0,"pct":91.48},"branches":{"total":10,"covered":6,"skipped":0,"pct":60}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/root-command/printer.ts": {"lines":{"total":9,"covered":9,"skipped":0,"pct":100},"functions":{"total":6,"covered":6,"skipped":0,"pct":100},"statements":{"total":9,"covered":9,"skipped":0,"pct":100},"branches":{"total":1,"covered":1,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/stake/deposit.ts": {"lines":{"total":40,"covered":31,"skipped":0,"pct":77.5},"functions":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":40,"covered":31,"skipped":0,"pct":77.5},"branches":{"total":17,"covered":11,"skipped":0,"pct":64.7}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/stake/index.ts": {"lines":{"total":8,"covered":8,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"statements":{"total":8,"covered":8,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
@@ -92,6 +92,7 @@
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/wallet/status.ts": {"lines":{"total":11,"covered":11,"skipped":0,"pct":100},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":11,"covered":11,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/wallet/withdraw-bzz.ts": {"lines":{"total":21,"covered":19,"skipped":0,"pct":90.47},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":21,"covered":19,"skipped":0,"pct":90.47},"branches":{"total":6,"covered":3,"skipped":0,"pct":50}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/command/wallet/withdraw-dai.ts": {"lines":{"total":21,"covered":19,"skipped":0,"pct":90.47},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":21,"covered":19,"skipped":0,"pct":90.47},"branches":{"total":6,"covered":3,"skipped":0,"pct":50}}
+,"/home/runner/work/swarm-cli/swarm-cli/src/service/version_checker.ts": {"lines":{"total":14,"covered":14,"skipped":0,"pct":100},"functions":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":14,"covered":14,"skipped":0,"pct":100},"branches":{"total":2,"covered":2,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/service/history/index.ts": {"lines":{"total":21,"covered":19,"skipped":0,"pct":90.47},"functions":{"total":5,"covered":5,"skipped":0,"pct":100},"statements":{"total":22,"covered":20,"skipped":0,"pct":90.9},"branches":{"total":1,"covered":1,"skipped":0,"pct":100}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/service/identity/index.ts": {"lines":{"total":36,"covered":32,"skipped":0,"pct":88.88},"functions":{"total":7,"covered":7,"skipped":0,"pct":100},"statements":{"total":36,"covered":32,"skipped":0,"pct":88.88},"branches":{"total":9,"covered":6,"skipped":0,"pct":66.66}}
 ,"/home/runner/work/swarm-cli/swarm-cli/src/service/identity/types/identity.ts": {"lines":{"total":4,"covered":4,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"statements":{"total":4,"covered":4,"skipped":0,"pct":100},"branches":{"total":2,"covered":2,"skipped":0,"pct":100}}