fix(cli): set timeout for latest version check and avoid failing the CLI (#1559)

Author: ymc9

packages/schema/package.json

@@ -98,7 +98,6 @@
         "colors": "1.4.0",
         "commander": "^8.3.0",
         "deepmerge": "^4.3.1",
-        "get-latest-version": "^5.0.1",
         "langium": "1.3.1",
         "lower-case-first": "^2.0.2",
         "mixpanel": "^0.17.0",

packages/schema/src/cli/actions/generate.ts

@@ -43,13 +43,13 @@ export async function generate(projectPath: string, options: Options) {
         }
     }
 
-    const tasks = [runPlugins(options)];
+    await runPlugins(options);
 
     if (options.versionCheck) {
-        tasks.push(checkNewVersion());
+        // note that we can't run plugins and do version check concurrently because
+        // plugins are CPU-bound and can cause version check to false timeout
+        await checkNewVersion();
     }
-
-    await Promise.all(tasks);
 }
 
 async function runPlugins(options: Options) {

packages/schema/src/cli/actions/info.ts

@@ -1,8 +1,7 @@
 import colors from 'colors';
-import getLatestVersion from 'get-latest-version';
 import ora from 'ora';
 import semver from 'semver';
-import { getZenStackPackages } from '../cli-util';
+import { getLatestVersion, getZenStackPackages } from '../cli-util';
 
 /**
  * CLI action for getting information about installed ZenStack packages
@@ -25,20 +24,25 @@ export async function info(projectPath: string) {
         console.warn(colors.yellow('WARNING: Multiple versions of Zenstack packages detected. This may cause issues.'));
     } else if (versions.size > 0) {
         const spinner = ora('Checking npm registry').start();
-        const latest = await getLatestVersion('zenstack');
 
-        if (!latest) {
-            spinner.fail('unable to check for latest version');
+        let latest: string;
+
+        try {
+            latest = await getLatestVersion();
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        } catch (err: any) {
+            spinner.fail(`Failed to get latest version: ${err.message}`);
+            return;
+        }
+
+        spinner.succeed();
+        const version = [...versions][0];
+        if (semver.gt(latest, version)) {
+            console.log(`A newer version of Zenstack is available: ${latest}.`);
+        } else if (semver.gt(version, latest)) {
+            console.log('You are using a pre-release version of Zenstack.');
         } else {
-            spinner.succeed();
-            const version = [...versions][0];
-            if (semver.gt(latest, version)) {
-                console.log(`A newer version of Zenstack is available: ${latest}.`);
-            } else if (semver.gt(version, latest)) {
-                console.log('You are using a pre-release version of Zenstack.');
-            } else {
-                console.log('You are using the latest version of Zenstack.');
-            }
+            console.log('You are using the latest version of Zenstack.');
         }
     }
 }

packages/schema/src/cli/cli-util.ts

@@ -2,7 +2,6 @@ import { isDataSource, isPlugin, Model } from '@zenstackhq/language/ast';
 import { getDataModels, getLiteral, hasAttribute } from '@zenstackhq/sdk';
 import colors from 'colors';
 import fs from 'fs';
-import getLatestVersion from 'get-latest-version';
 import { getDocument, LangiumDocument, LangiumDocuments, linkContentToContainer } from 'langium';
 import { NodeFileSystem } from 'langium/node';
 import path from 'path';
@@ -20,6 +19,8 @@ import { CliError } from './cli-error';
 // required minimal version of Prisma
 export const requiredPrismaVersion = '4.8.0';
 
+const CHECK_VERSION_TIMEOUT = 1000;
+
 /**
  * Loads a zmodel document from a file.
  * @param fileName File name
@@ -267,12 +268,37 @@ export function checkRequiredPackage(packageName: string, minVersion?: string) {
 
 export async function checkNewVersion() {
     const currVersion = getVersion();
-    const latestVersion = await getLatestVersion('zenstack');
+    let latestVersion: string;
+    try {
+        latestVersion = await getLatestVersion();
+    } catch {
+        // noop
+        return;
+    }
+
     if (latestVersion && semver.gt(latestVersion, currVersion)) {
         console.log(`A newer version ${colors.cyan(latestVersion)} is available.`);
     }
 }
 
+export async function getLatestVersion() {
+    const fetchResult = await fetch('https://registry.npmjs.org/zenstack', {
+        headers: { accept: 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*' },
+        signal: AbortSignal.timeout(CHECK_VERSION_TIMEOUT),
+    });
+
+    if (fetchResult.ok) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const data: any = await fetchResult.json();
+        const latestVersion = data?.['dist-tags']?.latest;
+        if (typeof latestVersion === 'string' && semver.valid(latestVersion)) {
+            return latestVersion;
+        }
+    }
+
+    throw new Error('invalid npm registry response');
+}
+
 export async function formatDocument(fileName: string, isPrismaStyle = true) {
     const services = createZModelServices(NodeFileSystem).ZModel;
     const extensions = services.LanguageMetaData.fileExtensions;