@flowscripter/dynamic-cli-framework 2.3.1 → 2.3.3

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

@@ -1,10 +1,10 @@
-import type { CLIConfig, SpawnService, UpgradeCheckResult, UpgradeResult } from "@flowscripter/dynamic-cli-framework-api";
+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 default class DefaultUpgradeService implements UpgradeService {
     #private;
     constructor(config: UpgradeLocationsConfig, cliConfig: CLIConfig);
-    setDependencies(spawnService: SpawnService): void;
+    setDependencies(spawnService: SpawnService, shutdownService?: ShutdownService): void;
     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,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;AAW1E,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;gBAK/C,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,SAAS;IAKhE,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAIjD,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;CA6P1B"}
+{"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;AA0B1E,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;CAiR1B"}

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

@@ -6,6 +6,19 @@ import { InstallMethod, SupportedArch, SupportedOs, } from "@flowscripter/dynami
 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;
+// SpawnService has no built-in cancellation, so a stalled `brew`/`winget` invocation (e.g. winget's
+// first-ever run on a machine prompting to accept Microsoft Store terms) can otherwise hang
+// checkForUpgrade() indefinitely. Racing against this bounds how long we wait for a result; the
+// underlying process is not killed, but the CLI stops blocking on it.
+async function withSpawnTimeout(spawnPromise, fallback) {
+    return Promise.race([
+        spawnPromise,
+        new Promise((resolve) => setTimeout(() => resolve(fallback), VERSION_CHECK_TIMEOUT_MS)),
+    ]);
+}
 const OS_LABELS = {
     [SupportedOs.LINUX]: "Linux",
     [SupportedOs.MACOS]: "MacOS",
@@ -13,14 +26,16 @@ const OS_LABELS = {
 };
 export default class DefaultUpgradeService {
     #spawnService;
+    #shutdownService;
     #config;
     #cliConfig;
     constructor(config, cliConfig) {
         this.#config = config;
         this.#cliConfig = cliConfig;
     }
-    setDependencies(spawnService) {
+    setDependencies(spawnService, shutdownService) {
         this.#spawnService = spawnService;
+        this.#shutdownService = shutdownService;
     }
     detectOs() {
         switch (process.platform) {
@@ -130,14 +145,20 @@ 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 withSpawnTimeout(this.#spawnService.spawn(["brew", "list", "--versions", this.#config.homebrew.formula], {
+            stdio: "wrapped",
+            longRunning: false,
+        }), { ok: false });
         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 withSpawnTimeout(this.#spawnService.spawn(["winget", "list", "--id", this.#config.winget.packageId], {
+            stdio: "wrapped",
+            longRunning: false,
+        }), { ok: false });
         return result.ok;
     }
     #isLinuxScriptInstall() {
@@ -162,7 +183,7 @@ export default class DefaultUpgradeService {
         }
         const { owner, repo } = this.#config.githubRelease;
         try {
-            const response = await fetch(`https://api.github.com/repos/${owner}/${repo}/releases/latest`);
+            const response = await fetch(`https://api.github.com/repos/${owner}/${repo}/releases/latest`, { signal: AbortSignal.timeout(VERSION_CHECK_TIMEOUT_MS) });
             if (!response.ok) {
                 return undefined;
             }
@@ -184,7 +205,7 @@ export default class DefaultUpgradeService {
             return undefined;
         }
         try {
-            const response = await fetch(`https://raw.githubusercontent.com/${tapOwner}/homebrew-${tapName}/main/${formula}.rb`);
+            const response = await fetch(`https://raw.githubusercontent.com/${tapOwner}/homebrew-${tapName}/main/${formula}.rb`, { signal: AbortSignal.timeout(VERSION_CHECK_TIMEOUT_MS) });
             if (!response.ok) {
                 return undefined;
             }
@@ -201,11 +222,11 @@ export default class DefaultUpgradeService {
             return undefined;
         }
         const lines = [];
-        const result = await this.#spawnService.spawn(["winget", "show", "--id", this.#config.winget.packageId], {
+        const result = await withSpawnTimeout(this.#spawnService.spawn(["winget", "show", "--id", this.#config.winget.packageId], {
             stdio: "wrapped",
             longRunning: false,
             onOutput: (line) => lines.push(line),
-        });
+        }), { ok: false });
         if (!result.ok) {
             return undefined;
         }
@@ -251,13 +272,24 @@ 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}`;
-        const response = await fetch(url);
-        if (!response.ok) {
-            throw new Error(`Failed to download release asset '${assetName}': HTTP ${response.status}`);
+        // 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
+        // Ctrl-C handling during what can be the slowest step of the upgrade.
+        this.#shutdownService?.enterLongRunningMode();
+        let archiveData;
+        try {
+            const response = await fetch(url);
+            if (!response.ok) {
+                throw new Error(`Failed to download release asset '${assetName}': HTTP ${response.status}`);
+            }
+            archiveData = await response.arrayBuffer();
+        }
+        finally {
+            this.#shutdownService?.leaveLongRunningMode();
         }
         const tmpDir = await mkdtemp(join(tmpdir(), "upgrade-"));
         const archivePath = join(tmpDir, assetName);
-        await Bun.write(archivePath, await response.arrayBuffer());
+        await Bun.write(archivePath, archiveData);
         const currentExecutable = process.execPath;
         if (os === SupportedOs.WINDOWS) {
             const extractResult = await this.#spawnService.spawn([

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;AAYzE,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;CA6G1D"}
+{"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"}

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

@@ -2,6 +2,7 @@ import { UPGRADE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PROMPTER_SERVICE_ID, PromptType } from "@flowscripter/dynamic-cli-framework-api";
 import { KEY_VALUE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { SPAWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import { SHUTDOWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultUpgradeService from "./DefaultUpgradeService.js";
 import { UpgradeSubCommand } from "./command/UpgradeSubCommand.js";
@@ -30,7 +31,10 @@ export default class UpgradeServiceProvider {
         const cliConfig = this.#cliConfig;
         if (context.doesServiceExist(SPAWN_SERVICE_ID)) {
             const spawnService = context.getServiceById(SPAWN_SERVICE_ID);
-            upgradeService.setDependencies(spawnService);
+            const shutdownService = context.doesServiceExist(SHUTDOWN_SERVICE_ID)
+                ? context.getServiceById(SHUTDOWN_SERVICE_ID)
+                : undefined;
+            upgradeService.setDependencies(spawnService, shutdownService);
         }
         else {
             logger.debug(() => "SpawnService not available, upgrade install methods will be unavailable");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",

package/src/service/upgrade/DefaultUpgradeService.ts

@@ -4,6 +4,7 @@ import { tmpdir } from "node:os";
 import { join } from "node:path";
 import type {
   CLIConfig,
+  ShutdownService,
   SpawnService,
   UpgradeCheckResult,
   UpgradeResult,
@@ -20,6 +21,21 @@ 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;
+
+// SpawnService has no built-in cancellation, so a stalled `brew`/`winget` invocation (e.g. winget's
+// first-ever run on a machine prompting to accept Microsoft Store terms) can otherwise hang
+// checkForUpgrade() indefinitely. Racing against this bounds how long we wait for a result; the
+// underlying process is not killed, but the CLI stops blocking on it.
+async function withSpawnTimeout<T>(spawnPromise: Promise<T>, fallback: T): Promise<T> {
+  return Promise.race([
+    spawnPromise,
+    new Promise<T>((resolve) => setTimeout(() => resolve(fallback), VERSION_CHECK_TIMEOUT_MS)),
+  ]);
+}
+
 const OS_LABELS: Record<SupportedOs, string> = {
   [SupportedOs.LINUX]: "Linux",
   [SupportedOs.MACOS]: "MacOS",
@@ -28,6 +44,7 @@ const OS_LABELS: Record<SupportedOs, string> = {
 
 export default class DefaultUpgradeService implements UpgradeService {
   #spawnService: SpawnService | undefined;
+  #shutdownService: ShutdownService | undefined;
   readonly #config: UpgradeLocationsConfig;
   readonly #cliConfig: CLIConfig;
 
@@ -36,8 +53,9 @@ export default class DefaultUpgradeService implements UpgradeService {
     this.#cliConfig = cliConfig;
   }
 
-  public setDependencies(spawnService: SpawnService): void {
+  public setDependencies(spawnService: SpawnService, shutdownService?: ShutdownService): void {
     this.#spawnService = spawnService;
+    this.#shutdownService = shutdownService;
   }
 
   public detectOs(): SupportedOs | undefined {
@@ -168,9 +186,12 @@ export default class DefaultUpgradeService implements UpgradeService {
     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 withSpawnTimeout(
+      this.#spawnService.spawn(["brew", "list", "--versions", this.#config.homebrew.formula], {
+        stdio: "wrapped",
+        longRunning: false,
+      }),
+      { ok: false } as const,
     );
     return result.ok;
   }
@@ -179,9 +200,12 @@ export default class DefaultUpgradeService implements UpgradeService {
     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 withSpawnTimeout(
+      this.#spawnService.spawn(["winget", "list", "--id", this.#config.winget.packageId], {
+        stdio: "wrapped",
+        longRunning: false,
+      }),
+      { ok: false } as const,
     );
     return result.ok;
   }
@@ -210,7 +234,10 @@ export default class DefaultUpgradeService implements UpgradeService {
     }
     const { owner, repo } = this.#config.githubRelease;
     try {
-      const response = await fetch(`https://api.github.com/repos/${owner}/${repo}/releases/latest`);
+      const response = await fetch(
+        `https://api.github.com/repos/${owner}/${repo}/releases/latest`,
+        { signal: AbortSignal.timeout(VERSION_CHECK_TIMEOUT_MS) },
+      );
       if (!response.ok) {
         return undefined;
       }
@@ -234,6 +261,7 @@ export default class DefaultUpgradeService implements UpgradeService {
     try {
       const response = await fetch(
         `https://raw.githubusercontent.com/${tapOwner}/homebrew-${tapName}/main/${formula}.rb`,
+        { signal: AbortSignal.timeout(VERSION_CHECK_TIMEOUT_MS) },
       );
       if (!response.ok) {
         return undefined;
@@ -251,13 +279,13 @@ export default class DefaultUpgradeService implements UpgradeService {
       return undefined;
     }
     const lines: string[] = [];
-    const result = await this.#spawnService.spawn(
-      ["winget", "show", "--id", this.#config.winget.packageId],
-      {
+    const result = await withSpawnTimeout(
+      this.#spawnService.spawn(["winget", "show", "--id", this.#config.winget.packageId], {
         stdio: "wrapped",
         longRunning: false,
         onOutput: (line) => lines.push(line),
-      },
+      }),
+      { ok: false } as const,
     );
     if (!result.ok) {
       return undefined;
@@ -316,14 +344,24 @@ 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}`;
 
-    const response = await fetch(url);
-    if (!response.ok) {
-      throw new Error(`Failed to download release asset '${assetName}': HTTP ${response.status}`);
+    // 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
+    // Ctrl-C handling during what can be the slowest step of the upgrade.
+    this.#shutdownService?.enterLongRunningMode();
+    let archiveData: ArrayBuffer;
+    try {
+      const response = await fetch(url);
+      if (!response.ok) {
+        throw new Error(`Failed to download release asset '${assetName}': HTTP ${response.status}`);
+      }
+      archiveData = await response.arrayBuffer();
+    } finally {
+      this.#shutdownService?.leaveLongRunningMode();
     }
 
     const tmpDir = await mkdtemp(join(tmpdir(), "upgrade-"));
     const archivePath = join(tmpDir, assetName);
-    await Bun.write(archivePath, await response.arrayBuffer());
+    await Bun.write(archivePath, archiveData);
 
     const currentExecutable = process.execPath;
 

package/src/service/upgrade/UpgradeServiceProvider.ts

@@ -8,6 +8,8 @@ import { KEY_VALUE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import type { KeyValueService } from "@flowscripter/dynamic-cli-framework-api";
 import { SPAWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import type { SpawnService } from "@flowscripter/dynamic-cli-framework-api";
+import { SHUTDOWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import type { ShutdownService } from "@flowscripter/dynamic-cli-framework-api";
 import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultUpgradeService from "./DefaultUpgradeService.ts";
@@ -44,7 +46,10 @@ export default class UpgradeServiceProvider implements ServiceProvider {
 
     if (context.doesServiceExist(SPAWN_SERVICE_ID)) {
       const spawnService = context.getServiceById(SPAWN_SERVICE_ID) as SpawnService;
-      upgradeService.setDependencies(spawnService);
+      const shutdownService = context.doesServiceExist(SHUTDOWN_SERVICE_ID)
+        ? (context.getServiceById(SHUTDOWN_SERVICE_ID) as ShutdownService)
+        : undefined;
+      upgradeService.setDependencies(spawnService, shutdownService);
     } else {
       logger.debug(() => "SpawnService not available, upgrade install methods will be unavailable");
     }