CLI: Added timeout for checkUpdate middleware (#335)

pantheon-systems · Feb 9, 2025 · 751b56c · 751b56c
1 parent cdcc1e4
commit 751b56c
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 41 deletions.
diff --git a/packages/cli/src/cli/commands/config.ts b/packages/cli/src/cli/commands/config.ts
@@ -1,3 +1,4 @@
+import { exit } from "process";
 import nunjucks from "nunjucks";
 import ora from "ora";
 import { getApiConfig } from "../../lib/apiConfig";
@@ -10,15 +11,24 @@ import { errorHandler } from "../exceptions";
 
 nunjucks.configure({ autoescape: true });
 
-export const setTargetEnvironment = errorHandler<"production" | "staging">(
-  async (target: "production" | "staging") => {
+export const setTargetEnvironment = errorHandler<string>(
+  async (target: string) => {
     return new Promise<void>(
       // eslint-disable-next-line no-async-promise-executor -- Handling promise rejection in the executor
       async (resolve, reject) => {
         const spinner = ora("Updating config file").start();
+
+        // Validate target value
+        if (!["production", "staging"].includes(target)) {
+          spinner.fail(
+            "The provided value should either be 'production' or `staging'",
+          );
+          exit(1);
+        }
+
         try {
           await persistConfigDetails({
-            targetEnvironment: target,
+            targetEnvironment: target as "production" | "staging",
           });
 
           spinner.succeed(`Successfully updated config file`);

diff --git a/packages/cli/src/cli/index.ts b/packages/cli/src/cli/index.ts
@@ -296,8 +296,9 @@ yargs(hideBin(process.argv))
           "Set the target environment.",
           (yargs) => {
             yargs.positional("<target>", {
-              describe: "Target environment: either 'production' or 'staging'.",
+              describe: "Target environment.",
               demandOption: true,
+              choices: ["production", "staging"],
               type: "string",
             });
           },

diff --git a/packages/cli/src/lib/checkUpdate.ts b/packages/cli/src/lib/checkUpdate.ts
@@ -17,44 +17,60 @@ export function getPackageDetails() {
   return { name, version };
 }
 
-const checkUpdate = async () => {
-  const { name, version } = getPackageDetails();
-  const { versions: allPublishedVersions } = await pkgJson(name, {
-    allVersions: true,
-  });
+// Max time limit for checkUpdate execution
+const CHECK_UPDATE_TIMEOUT_MS = 1000;
+
+const checkUpdate = async (): Promise<void> => {
+  return new Promise((resolve) => {
+    let isResolved = false;
+    const timer = setTimeout(() => {
+      isResolved = true;
+      resolve();
+    }, CHECK_UPDATE_TIMEOUT_MS);
+
+    (async () => {
+      const { name, version } = getPackageDetails();
+      const { versions: allPublishedVersions } = await pkgJson(name, {
+        allVersions: true,
+      });
+      if (isResolved) return;
+
+      const versionKeys = Object.keys(allPublishedVersions);
+      let latestVersion = versionKeys.pop();
 
-  const versionKeys = Object.keys(allPublishedVersions);
-  let latestVersion = versionKeys.pop();
-
-  while (latestVersion != null) {
-    if (
-      !semver.prerelease(latestVersion) &&
-      semver.gt(latestVersion, version)
-    ) {
-      break;
-    }
-
-    latestVersion = versionKeys.pop();
-  }
-
-  const updateAvailable =
-    latestVersion != null && semver.lt(version, latestVersion as string);
-  if (updateAvailable) {
-    const msg = {
-      updateAvailable: `Update available! ${chalk.dim(version)} → ${chalk.green(
-        latestVersion,
-      )}.`,
-      runUpdate: `Run ${chalk.cyan(`npm i -g ${name}`)} to update.`,
-    };
-
-    console.log(
-      boxen(`${msg.updateAvailable}\n${msg.runUpdate}`, {
-        margin: 1,
-        padding: 1,
-        align: "center",
-      }),
-    );
-  }
+      while (latestVersion != null) {
+        if (
+          !semver.prerelease(latestVersion) &&
+          semver.gt(latestVersion, version)
+        ) {
+          break;
+        }
+
+        latestVersion = versionKeys.pop();
+      }
+
+      const updateAvailable =
+        latestVersion != null && semver.lt(version, latestVersion as string);
+      if (updateAvailable) {
+        const msg = {
+          updateAvailable: `Update available! ${chalk.dim(version)} → ${chalk.green(
+            latestVersion,
+          )}.`,
+          runUpdate: `Run ${chalk.cyan(`npm i -g ${name}`)} to update.`,
+        };
+
+        console.log(
+          boxen(`${msg.updateAvailable}\n${msg.runUpdate}`, {
+            margin: 1,
+            padding: 1,
+            align: "center",
+          }),
+        );
+      }
+      clearTimeout(timer);
+      resolve();
+    })();
+  });
 };
 
 export default checkUpdate;