@flowscripter/dynamic-cli-framework 2.3.2 → 2.4.0

package/dist/src/command/VersionCommand.js

@@ -12,7 +12,7 @@ export default class VersionCommand {
         let line = context.cliConfig.version;
         if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
             const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID);
-            const result = await upgradeService.checkForUpgrade().catch(() => undefined);
+            const result = await upgradeService.getUpgradeCheckResult().catch(() => undefined);
             if (result?.updateAvailable) {
                 line += ` (${result.latestVersion} available, run '${context.cliConfig.name} upgrade')`;
             }

package/dist/src/service/banner/BannerServiceProvider.js

@@ -52,7 +52,7 @@ export default class BannerServiceProvider {
         }
         if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
             const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID);
-            const result = await upgradeService.checkForUpgrade().catch(() => undefined);
+            const result = await upgradeService.getUpgradeCheckResult().catch(() => undefined);
             if (result?.updateAvailable) {
                 await printerService.info(`  ${printerService.secondary(`(${result.latestVersion} available, run '${cliConfig.name} upgrade')`)}\n`);
             }

package/dist/src/service/plugin/SpawnInterfaceAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpawnInterfaceAdapter.d.ts","sourceRoot":"","sources":["../../../../src/service/plugin/SpawnInterfaceAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAE1F,MAAM,WAAW,4BAA4B;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;gBAOhE,YAAY,EAAE,YAAY,EAC1B,cAAc,EAAE,cAAc,EAC9B,OAAO,GAAE,4BAAiC;IAQ/B,KAAK,CAChB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GACvB,OAAO,CAAC,WAAW,CAAC;CA4BxB"}
+{"version":3,"file":"SpawnInterfaceAdapter.d.ts","sourceRoot":"","sources":["../../../../src/service/plugin/SpawnInterfaceAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAE1F,MAAM,WAAW,4BAA4B;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;gBAOhE,YAAY,EAAE,YAAY,EAC1B,cAAc,EAAE,cAAc,EAC9B,OAAO,GAAE,4BAAiC;IAQ/B,KAAK,CAChB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GACvB,OAAO,CAAC,WAAW,CAAC;CA+BxB"}

package/dist/src/service/plugin/SpawnInterfaceAdapter.js

@@ -33,8 +33,11 @@ export default class SpawnInterfaceAdapter {
         this.#printerService.endQuote();
         this.#printerService.endMark();
         await this.#printerService.clearMarked(this.#markMinimumDisplayTimeMs);
-        return result.ok
-            ? { ok: true, exitCode: result.exitCode }
+        if (result.ok) {
+            return { ok: true, exitCode: result.exitCode };
+        }
+        return "timedOut" in result
+            ? { ok: false, error: new Error("Command timed out") }
             : { ok: false, exitCode: result.exitCode, error: result.error };
     }
 }

package/dist/src/service/spawn/DefaultSpawnService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultSpawnService.d.ts","sourceRoot":"","sources":["../../../../src/service/spawn/DefaultSpawnService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACZ,WAAW,EACX,YAAY,EACb,MAAM,yCAAyC,CAAC;AAOjD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,CAa3E;AAED,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,YAAY;;IAIvD,eAAe,CAAC,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI;IAkCjF,KAAK,CAChB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,WAAW,CAAC;CAiExB"}
+{"version":3,"file":"DefaultSpawnService.d.ts","sourceRoot":"","sources":["../../../../src/service/spawn/DefaultSpawnService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACZ,WAAW,EACX,YAAY,EACb,MAAM,yCAAyC,CAAC;AAOjD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,CAa3E;AAED,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,YAAY;;IAIvD,eAAe,CAAC,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI;IAkDjF,KAAK,CAChB,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,WAAW,CAAC;CA8ExB"}

package/dist/src/service/spawn/DefaultSpawnService.js

@@ -28,6 +28,18 @@ export default class DefaultSpawnService {
         this.#printerService = printerService;
         this.#shutdownService = shutdownService;
     }
+    async #terminate(proc, command) {
+        logger.debug(() => `Sending SIGTERM to spawned command '${command.join(" ")}'`);
+        proc.kill("SIGTERM");
+        const exitedInTime = await Promise.race([
+            proc.exited.then(() => true),
+            new Promise((resolve) => setTimeout(() => resolve(false), SHUTDOWN_GRACE_PERIOD_MS)),
+        ]);
+        if (!exitedInTime) {
+            logger.debug(() => `Sending SIGKILL to spawned command '${command.join(" ")}'`);
+            proc.kill("SIGKILL");
+        }
+    }
     async #pipeLines(stream, streamName, onOutput) {
         if (typeof stream !== "object" || stream === null) {
             return;
@@ -85,16 +97,7 @@ export default class DefaultSpawnService {
             if (settled) {
                 return;
             }
-            logger.debug(() => `Sending SIGTERM to spawned command '${command.join(" ")}'`);
-            proc.kill("SIGTERM");
-            await Promise.race([
-                proc.exited.then(() => { }),
-                new Promise((resolve) => setTimeout(resolve, SHUTDOWN_GRACE_PERIOD_MS)),
-            ]);
-            if (!settled) {
-                logger.debug(() => `Sending SIGKILL to spawned command '${command.join(" ")}'`);
-                proc.kill("SIGKILL");
-            }
+            await this.#terminate(proc, command);
         });
         if (stdio === "wrapped" && options.onOutput) {
             const onOutput = options.onOutput;
@@ -102,6 +105,25 @@ export default class DefaultSpawnService {
             void this.#pipeLines(proc.stderr, "stderr", onOutput);
         }
         try {
+            if (options.timeoutMs === undefined) {
+                const exitCode = await proc.exited;
+                settled = true;
+                return exitCode === 0 ? { ok: true, exitCode } : { ok: false, exitCode };
+            }
+            let timeoutHandle;
+            const timedOut = await Promise.race([
+                proc.exited.then(() => false),
+                new Promise((resolve) => {
+                    timeoutHandle = setTimeout(() => resolve(true), options.timeoutMs);
+                }),
+            ]);
+            clearTimeout(timeoutHandle);
+            if (timedOut) {
+                logger.debug(() => `Command '${command.join(" ")}' timed out after ${options.timeoutMs}ms`);
+                await this.#terminate(proc, command);
+                settled = true;
+                return { ok: false, timedOut: true };
+            }
             const exitCode = await proc.exited;
             settled = true;
             return exitCode === 0 ? { ok: true, exitCode } : { ok: false, exitCode };

package/dist/src/service/upgrade/DefaultUpgradeService.d.ts

@@ -1,10 +1,12 @@
 import type { CLIConfig, ShutdownService, SpawnService, UpgradeCheckResult, UpgradeResult } from "@flowscripter/dynamic-cli-framework-api";
 import { InstallMethod, SupportedArch, SupportedOs, type UpgradeService } from "@flowscripter/dynamic-cli-framework-api";
 import type { UpgradeLocationsConfig } from "./UpgradeLocationsConfig.ts";
+export declare const VERSION_CHECK_TIMEOUT_MS = 250;
 export default class DefaultUpgradeService implements UpgradeService {
     #private;
     constructor(config: UpgradeLocationsConfig, cliConfig: CLIConfig);
     setDependencies(spawnService: SpawnService, shutdownService?: ShutdownService): void;
+    getUpgradeCheckResult(waitForResult?: boolean): Promise<UpgradeCheckResult | undefined>;
     detectOs(): SupportedOs | undefined;
     detectArch(): SupportedArch | undefined;
     detectInstallMethod(os: SupportedOs): Promise<InstallMethod | undefined>;

package/dist/src/service/upgrade/DefaultUpgradeService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultUpgradeService.d.ts","sourceRoot":"","sources":["../../../../src/service/upgrade/DefaultUpgradeService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,KAAK,cAAc,EACpB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAe1E,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;gBAM/C,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,SAAS;IAKhE,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI;IAKpF,QAAQ,IAAI,WAAW,GAAG,SAAS;IAanC,UAAU,IAAI,aAAa,GAAG,SAAS;IAWjC,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAgBxE,eAAe,CAC1B,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAmC7B,OAAO,CAClB,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,aAAa,CAAC;CA2Q1B"}
+{"version":3,"file":"DefaultUpgradeService.d.ts","sourceRoot":"","sources":["../../../../src/service/upgrade/DefaultUpgradeService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EAEf,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,KAAK,cAAc,EACpB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAO1E,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAc5C,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;gBAO/C,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,SAAS;IAKhE,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI;IAKpF,qBAAqB,CAAC,aAAa,UAAQ,GAAG,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAerF,QAAQ,IAAI,WAAW,GAAG,SAAS;IAanC,UAAU,IAAI,aAAa,GAAG,SAAS;IAWjC,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAgBxE,eAAe,CAC1B,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAmC7B,OAAO,CAClB,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,aAAa,CAAC;CAyQ1B"}

package/dist/src/service/upgrade/DefaultUpgradeService.js

@@ -7,8 +7,13 @@ import semver from "semver";
 import getLogger from "../../util/logger.js";
 const logger = getLogger("DefaultUpgradeService");
 // checkForUpgrade() runs opportunistically on every CLI invocation (via BannerServiceProvider),
-// so its version-check network calls must never be allowed to stall CLI startup.
-const VERSION_CHECK_TIMEOUT_MS = 250;
+// so its version-check network/spawn calls must never be allowed to stall CLI startup.
+export const VERSION_CHECK_TIMEOUT_MS = 250;
+function describeSpawnFailure(result) {
+    return "timedOut" in result
+        ? "timed out"
+        : (result.error?.message ?? `exit code ${result.exitCode}`);
+}
 const OS_LABELS = {
     [SupportedOs.LINUX]: "Linux",
     [SupportedOs.MACOS]: "MacOS",
@@ -17,6 +22,7 @@ const OS_LABELS = {
 export default class DefaultUpgradeService {
     #spawnService;
     #shutdownService;
+    #upgradeCheckPromise;
     #config;
     #cliConfig;
     constructor(config, cliConfig) {
@@ -27,6 +33,18 @@ export default class DefaultUpgradeService {
         this.#spawnService = spawnService;
         this.#shutdownService = shutdownService;
     }
+    getUpgradeCheckResult(waitForResult = false) {
+        if (!this.#upgradeCheckPromise) {
+            this.#upgradeCheckPromise = this.checkForUpgrade();
+        }
+        if (waitForResult) {
+            return this.#upgradeCheckPromise;
+        }
+        return Promise.race([
+            this.#upgradeCheckPromise,
+            new Promise((resolve) => setTimeout(() => resolve(undefined), VERSION_CHECK_TIMEOUT_MS)),
+        ]);
+    }
     detectOs() {
         switch (process.platform) {
             case "linux":
@@ -96,7 +114,10 @@ export default class DefaultUpgradeService {
     }
     async upgrade(osOverride, archOverride, installMethodOverride) {
         const oldVersion = this.#cliConfig.version;
-        const checkResult = await this.checkForUpgrade(osOverride, archOverride, installMethodOverride);
+        const hasOverride = osOverride !== undefined || archOverride !== undefined || installMethodOverride !== undefined;
+        const checkResult = hasOverride
+            ? await this.checkForUpgrade(osOverride, archOverride, installMethodOverride)
+            : await this.getUpgradeCheckResult(true);
         if (!checkResult) {
             return {
                 ok: false,
@@ -135,14 +156,14 @@ export default class DefaultUpgradeService {
         if (!this.#spawnService || !this.#config.homebrew) {
             return false;
         }
-        const result = await this.#spawnService.spawn(["brew", "list", "--versions", this.#config.homebrew.formula], { stdio: "wrapped", longRunning: false });
+        const result = await this.#spawnService.spawn(["brew", "list", "--versions", this.#config.homebrew.formula], { stdio: "wrapped", longRunning: false, timeoutMs: VERSION_CHECK_TIMEOUT_MS });
         return result.ok;
     }
     async #isWingetInstalled() {
         if (!this.#spawnService || !this.#config.winget) {
             return false;
         }
-        const result = await this.#spawnService.spawn(["winget", "list", "--id", this.#config.winget.packageId], { stdio: "wrapped", longRunning: false });
+        const result = await this.#spawnService.spawn(["winget", "list", "--id", this.#config.winget.packageId], { stdio: "wrapped", longRunning: false, timeoutMs: VERSION_CHECK_TIMEOUT_MS });
         return result.ok;
     }
     #isLinuxScriptInstall() {
@@ -209,6 +230,7 @@ export default class DefaultUpgradeService {
         const result = await this.#spawnService.spawn(["winget", "show", "--id", this.#config.winget.packageId], {
             stdio: "wrapped",
             longRunning: false,
+            timeoutMs: VERSION_CHECK_TIMEOUT_MS,
             onOutput: (line) => lines.push(line),
         });
         if (!result.ok) {
@@ -226,14 +248,14 @@ export default class DefaultUpgradeService {
         const { scriptUrl } = this.#config.linuxScript;
         const result = await this.#spawnService.spawn(["sh", "-c", `curl -fsSL ${scriptUrl} | sh`]);
         if (!result.ok) {
-            throw new Error(`Install script failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`);
+            throw new Error(`Install script failed: ${describeSpawnFailure(result)}`);
         }
     }
     async #upgradeViaHomebrew() {
         const { tap, formula } = this.#config.homebrew;
         const result = await this.#spawnService.spawn(["brew", "upgrade", `${tap}/${formula}`]);
         if (!result.ok) {
-            throw new Error(`brew upgrade failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`);
+            throw new Error(`brew upgrade failed: ${describeSpawnFailure(result)}`);
         }
     }
     async #upgradeViaWinget() {
@@ -248,7 +270,7 @@ export default class DefaultUpgradeService {
             "--accept-source-agreements",
         ]);
         if (!result.ok) {
-            throw new Error(`winget upgrade failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`);
+            throw new Error(`winget upgrade failed: ${describeSpawnFailure(result)}`);
         }
     }
     async #upgradeViaGithubRelease(os, arch) {
@@ -256,8 +278,7 @@ export default class DefaultUpgradeService {
         const archLabel = os === SupportedOs.MACOS ? "aarch64" : arch === SupportedArch.X64 ? "x64" : "arm64";
         const assetName = assetPattern.replace("{os}", OS_LABELS[os]).replace("{arch}", archLabel);
         const url = `https://github.com/${owner}/${repo}/releases/latest/download/${assetName}`;
-        // Downloading the release asset happens outside SpawnService (which enters long-running mode
-        // for its own subprocesses by default), so bracket it here to get the same cooperative
+        // Downloading the release asset but enter long-running mode to get cooperative
         // Ctrl-C handling during what can be the slowest step of the upgrade.
         this.#shutdownService?.enterLongRunningMode();
         let archiveData;

package/dist/src/service/upgrade/UpgradeServiceProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UpgradeServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/upgrade/UpgradeServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAczE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAK1E,MAAM,CAAC,OAAO,OAAO,sBAAuB,YAAW,eAAe;;IACpE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAsB;IAChD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;gBAKd,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB;IAKnE,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASpD,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAgH1D"}
+{"version":3,"file":"UpgradeServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/upgrade/UpgradeServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAczE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAK1E,MAAM,CAAC,OAAO,OAAO,sBAAuB,YAAW,eAAe;;IACpE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAsB;IAChD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;gBAKd,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB;IAKnE,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IASpD,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAkH1D"}

package/dist/src/service/upgrade/UpgradeServiceProvider.js

@@ -39,6 +39,7 @@ export default class UpgradeServiceProvider {
         else {
             logger.debug(() => "SpawnService not available, upgrade install methods will be unavailable");
         }
+        void upgradeService.getUpgradeCheckResult();
         if (!context.doesServiceExist(PROMPTER_SERVICE_ID)) {
             logger.debug(() => "PrompterService not available, skipping auto-upgrade");
             return;
@@ -101,7 +102,7 @@ export default class UpgradeServiceProvider {
     }
     async #checkAndUpgrade(context, upgradeService, cliConfig) {
         try {
-            const checkResult = await upgradeService.checkForUpgrade();
+            const checkResult = await upgradeService.getUpgradeCheckResult();
             if (!checkResult?.updateAvailable) {
                 return;
             }

package/dist/src/service/upgrade/command/UpgradeSubCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UpgradeSubCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/upgrade/command/UpgradeSubCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAC;AASjD,OAAO,KAAK,qBAAqB,MAAM,6BAA6B,CAAC;AAErE,qBAAa,iBAAkB,YAAW,UAAU;;IAClD,QAAQ,CAAC,IAAI,aAAa;IAC1B,QAAQ,CAAC,WAAW,6CAA6C;IACjE,QAAQ,CAAC,mBAAmB,SAAS;IACrC,QAAQ,CAAC,WAAW,UAAM;IAE1B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAerC;gBAIiB,cAAc,EAAE,qBAAqB;IAI3C,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAsCtF"}
+{"version":3,"file":"UpgradeSubCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/upgrade/command/UpgradeSubCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,yCAAyC,CAAC;AASjD,OAAO,KAAK,qBAAqB,MAAM,6BAA6B,CAAC;AAErE,qBAAa,iBAAkB,YAAW,UAAU;;IAClD,QAAQ,CAAC,IAAI,aAAa;IAC1B,QAAQ,CAAC,WAAW,6CAA6C;IACjE,QAAQ,CAAC,mBAAmB,SAAS;IACrC,QAAQ,CAAC,WAAW,UAAM;IAE1B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAerC;gBAIiB,cAAc,EAAE,qBAAqB;IAI3C,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAyCtF"}

package/dist/src/service/upgrade/command/UpgradeSubCommand.js

@@ -31,7 +31,9 @@ export class UpgradeSubCommand {
         const os = argumentValues.os;
         const arch = undefined;
         const installMethod = argumentValues["install-method"];
-        const checkResult = await this.#upgradeService.checkForUpgrade(os, arch, installMethod);
+        const checkResult = os === undefined && installMethod === undefined
+            ? await this.#upgradeService.getUpgradeCheckResult(true)
+            : await this.#upgradeService.checkForUpgrade(os, arch, installMethod);
         if (!checkResult) {
             await printerService.error(`No upgrade location is configured for the detected or requested platform.\n`, Icon.FAILURE);
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",
@@ -48,7 +48,7 @@
     "build": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
-    "@flowscripter/dynamic-cli-framework-api": "^1.2.0",
+    "@flowscripter/dynamic-cli-framework-api": "^1.3.0",
     "@flowscripter/dynamic-plugin-framework": "1.11.1",
     "emphasize": "^7.0.0",
     "fastest-levenshtein": "^1.0.16",

package/src/command/VersionCommand.ts

@@ -19,7 +19,7 @@ export default class VersionCommand implements GlobalCommand {
     let line = context.cliConfig.version;
     if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
       const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID) as UpgradeService;
-      const result = await upgradeService.checkForUpgrade().catch(() => undefined);
+      const result = await upgradeService.getUpgradeCheckResult().catch(() => undefined);
       if (result?.updateAvailable) {
         line += ` (${result.latestVersion} available, run '${context.cliConfig.name} upgrade')`;
       }

package/src/service/banner/BannerServiceProvider.ts

@@ -72,7 +72,7 @@ export default class BannerServiceProvider implements ServiceProvider {
     }
     if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
       const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID) as UpgradeService;
-      const result = await upgradeService.checkForUpgrade().catch(() => undefined);
+      const result = await upgradeService.getUpgradeCheckResult().catch(() => undefined);
       if (result?.updateAvailable) {
         await printerService.info(
           `  ${printerService.secondary(

package/src/service/plugin/SpawnInterfaceAdapter.ts

@@ -55,8 +55,11 @@ export default class SpawnInterfaceAdapter implements SpawnInterface {
     this.#printerService.endMark();
     await this.#printerService.clearMarked(this.#markMinimumDisplayTimeMs);
 
-    return result.ok
-      ? { ok: true, exitCode: result.exitCode }
+    if (result.ok) {
+      return { ok: true, exitCode: result.exitCode };
+    }
+    return "timedOut" in result
+      ? { ok: false, error: new Error("Command timed out") }
       : { ok: false, exitCode: result.exitCode, error: result.error };
   }
 }

package/src/service/spawn/DefaultSpawnService.ts

@@ -41,6 +41,22 @@ export default class DefaultSpawnService implements SpawnService {
     this.#shutdownService = shutdownService;
   }
 
+  async #terminate(
+    proc: ReturnType<typeof Bun.spawn>,
+    command: ReadonlyArray<string>,
+  ): Promise<void> {
+    logger.debug(() => `Sending SIGTERM to spawned command '${command.join(" ")}'`);
+    proc.kill("SIGTERM");
+    const exitedInTime = await Promise.race([
+      proc.exited.then(() => true),
+      new Promise<boolean>((resolve) => setTimeout(() => resolve(false), SHUTDOWN_GRACE_PERIOD_MS)),
+    ]);
+    if (!exitedInTime) {
+      logger.debug(() => `Sending SIGKILL to spawned command '${command.join(" ")}'`);
+      proc.kill("SIGKILL");
+    }
+  }
+
   async #pipeLines(
     stream: ReadableStream<Uint8Array> | number | undefined,
     streamName: "stdout" | "stderr",
@@ -110,16 +126,7 @@ export default class DefaultSpawnService implements SpawnService {
       if (settled) {
         return;
       }
-      logger.debug(() => `Sending SIGTERM to spawned command '${command.join(" ")}'`);
-      proc.kill("SIGTERM");
-      await Promise.race([
-        proc.exited.then(() => {}),
-        new Promise<void>((resolve) => setTimeout(resolve, SHUTDOWN_GRACE_PERIOD_MS)),
-      ]);
-      if (!settled) {
-        logger.debug(() => `Sending SIGKILL to spawned command '${command.join(" ")}'`);
-        proc.kill("SIGKILL");
-      }
+      await this.#terminate(proc, command);
     });
 
     if (stdio === "wrapped" && options.onOutput) {
@@ -129,6 +136,28 @@ export default class DefaultSpawnService implements SpawnService {
     }
 
     try {
+      if (options.timeoutMs === undefined) {
+        const exitCode = await proc.exited;
+        settled = true;
+        return exitCode === 0 ? { ok: true, exitCode } : { ok: false, exitCode };
+      }
+
+      let timeoutHandle: ReturnType<typeof setTimeout>;
+      const timedOut = await Promise.race([
+        proc.exited.then(() => false),
+        new Promise<boolean>((resolve) => {
+          timeoutHandle = setTimeout(() => resolve(true), options.timeoutMs);
+        }),
+      ]);
+      clearTimeout(timeoutHandle!);
+
+      if (timedOut) {
+        logger.debug(() => `Command '${command.join(" ")}' timed out after ${options.timeoutMs}ms`);
+        await this.#terminate(proc, command);
+        settled = true;
+        return { ok: false, timedOut: true };
+      }
+
       const exitCode = await proc.exited;
       settled = true;
       return exitCode === 0 ? { ok: true, exitCode } : { ok: false, exitCode };

package/src/service/upgrade/DefaultUpgradeService.ts

@@ -5,6 +5,7 @@ import { join } from "node:path";
 import type {
   CLIConfig,
   ShutdownService,
+  SpawnResult,
   SpawnService,
   UpgradeCheckResult,
   UpgradeResult,
@@ -22,8 +23,14 @@ import getLogger from "../../util/logger.ts";
 const logger = getLogger("DefaultUpgradeService");
 
 // checkForUpgrade() runs opportunistically on every CLI invocation (via BannerServiceProvider),
-// so its version-check network calls must never be allowed to stall CLI startup.
-const VERSION_CHECK_TIMEOUT_MS = 250;
+// so its version-check network/spawn calls must never be allowed to stall CLI startup.
+export const VERSION_CHECK_TIMEOUT_MS = 250;
+
+function describeSpawnFailure(result: Extract<SpawnResult, { ok: false }>): string {
+  return "timedOut" in result
+    ? "timed out"
+    : (result.error?.message ?? `exit code ${result.exitCode}`);
+}
 
 const OS_LABELS: Record<SupportedOs, string> = {
   [SupportedOs.LINUX]: "Linux",
@@ -34,6 +41,7 @@ const OS_LABELS: Record<SupportedOs, string> = {
 export default class DefaultUpgradeService implements UpgradeService {
   #spawnService: SpawnService | undefined;
   #shutdownService: ShutdownService | undefined;
+  #upgradeCheckPromise: Promise<UpgradeCheckResult | undefined> | undefined;
   readonly #config: UpgradeLocationsConfig;
   readonly #cliConfig: CLIConfig;
 
@@ -47,6 +55,21 @@ export default class DefaultUpgradeService implements UpgradeService {
     this.#shutdownService = shutdownService;
   }
 
+  public getUpgradeCheckResult(waitForResult = false): Promise<UpgradeCheckResult | undefined> {
+    if (!this.#upgradeCheckPromise) {
+      this.#upgradeCheckPromise = this.checkForUpgrade();
+    }
+    if (waitForResult) {
+      return this.#upgradeCheckPromise;
+    }
+    return Promise.race([
+      this.#upgradeCheckPromise,
+      new Promise<undefined>((resolve) =>
+        setTimeout(() => resolve(undefined), VERSION_CHECK_TIMEOUT_MS),
+      ),
+    ]);
+  }
+
   public detectOs(): SupportedOs | undefined {
     switch (process.platform) {
       case "linux":
@@ -132,7 +155,11 @@ export default class DefaultUpgradeService implements UpgradeService {
     installMethodOverride?: InstallMethod,
   ): Promise<UpgradeResult> {
     const oldVersion = this.#cliConfig.version;
-    const checkResult = await this.checkForUpgrade(osOverride, archOverride, installMethodOverride);
+    const hasOverride =
+      osOverride !== undefined || archOverride !== undefined || installMethodOverride !== undefined;
+    const checkResult = hasOverride
+      ? await this.checkForUpgrade(osOverride, archOverride, installMethodOverride)
+      : await this.getUpgradeCheckResult(true);
     if (!checkResult) {
       return {
         ok: false,
@@ -177,7 +204,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     }
     const result = await this.#spawnService.spawn(
       ["brew", "list", "--versions", this.#config.homebrew.formula],
-      { stdio: "wrapped", longRunning: false },
+      { stdio: "wrapped", longRunning: false, timeoutMs: VERSION_CHECK_TIMEOUT_MS },
     );
     return result.ok;
   }
@@ -188,7 +215,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     }
     const result = await this.#spawnService.spawn(
       ["winget", "list", "--id", this.#config.winget.packageId],
-      { stdio: "wrapped", longRunning: false },
+      { stdio: "wrapped", longRunning: false, timeoutMs: VERSION_CHECK_TIMEOUT_MS },
     );
     return result.ok;
   }
@@ -267,6 +294,7 @@ export default class DefaultUpgradeService implements UpgradeService {
       {
         stdio: "wrapped",
         longRunning: false,
+        timeoutMs: VERSION_CHECK_TIMEOUT_MS,
         onOutput: (line) => lines.push(line),
       },
     );
@@ -286,9 +314,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     const { scriptUrl } = this.#config.linuxScript!;
     const result = await this.#spawnService!.spawn(["sh", "-c", `curl -fsSL ${scriptUrl} | sh`]);
     if (!result.ok) {
-      throw new Error(
-        `Install script failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`,
-      );
+      throw new Error(`Install script failed: ${describeSpawnFailure(result)}`);
     }
   }
 
@@ -296,9 +322,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     const { tap, formula } = this.#config.homebrew!;
     const result = await this.#spawnService!.spawn(["brew", "upgrade", `${tap}/${formula}`]);
     if (!result.ok) {
-      throw new Error(
-        `brew upgrade failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`,
-      );
+      throw new Error(`brew upgrade failed: ${describeSpawnFailure(result)}`);
     }
   }
 
@@ -314,9 +338,7 @@ export default class DefaultUpgradeService implements UpgradeService {
       "--accept-source-agreements",
     ]);
     if (!result.ok) {
-      throw new Error(
-        `winget upgrade failed: ${result.error?.message ?? `exit code ${result.exitCode}`}`,
-      );
+      throw new Error(`winget upgrade failed: ${describeSpawnFailure(result)}`);
     }
   }
 
@@ -327,8 +349,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     const assetName = assetPattern.replace("{os}", OS_LABELS[os]).replace("{arch}", archLabel);
     const url = `https://github.com/${owner}/${repo}/releases/latest/download/${assetName}`;
 
-    // Downloading the release asset happens outside SpawnService (which enters long-running mode
-    // for its own subprocesses by default), so bracket it here to get the same cooperative
+    // Downloading the release asset but enter long-running mode to get cooperative
     // Ctrl-C handling during what can be the slowest step of the upgrade.
     this.#shutdownService?.enterLongRunningMode();
     let archiveData: ArrayBuffer;

package/src/service/upgrade/UpgradeServiceProvider.ts

@@ -54,6 +54,8 @@ export default class UpgradeServiceProvider implements ServiceProvider {
       logger.debug(() => "SpawnService not available, upgrade install methods will be unavailable");
     }
 
+    void upgradeService.getUpgradeCheckResult();
+
     if (!context.doesServiceExist(PROMPTER_SERVICE_ID)) {
       logger.debug(() => "PrompterService not available, skipping auto-upgrade");
       return;
@@ -128,7 +130,7 @@ export default class UpgradeServiceProvider implements ServiceProvider {
     cliConfig: CLIConfig,
   ): Promise<void> {
     try {
-      const checkResult = await upgradeService.checkForUpgrade();
+      const checkResult = await upgradeService.getUpgradeCheckResult();
       if (!checkResult?.updateAvailable) {
         return;
       }

package/src/service/upgrade/command/UpgradeSubCommand.ts

@@ -52,7 +52,10 @@ export class UpgradeSubCommand implements SubCommand {
     const arch = undefined as SupportedArch | undefined;
     const installMethod = argumentValues["install-method"] as InstallMethod | undefined;
 
-    const checkResult = await this.#upgradeService.checkForUpgrade(os, arch, installMethod);
+    const checkResult =
+      os === undefined && installMethod === undefined
+        ? await this.#upgradeService.getUpgradeCheckResult(true)
+        : await this.#upgradeService.checkForUpgrade(os, arch, installMethod);
     if (!checkResult) {
       await printerService.error(
         `No upgrade location is configured for the detected or requested platform.\n`,