@flowscripter/dynamic-cli-framework 7.0.7 → 7.0.8

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

@@ -14,6 +14,11 @@ export default class DefaultUpgradeService implements UpgradeService {
      * pick it up on a later invocation.
      */
     refreshUpgradeCheckCache(): Promise<UpgradeCheckResult>;
+    /**
+     * Return the result last persisted by {@link refreshUpgradeCheckCache}, without running a check.
+     * Returns `undefined` if nothing has been persisted yet or no KeyValueService is available.
+     */
+    getCachedUpgradeCheckResult(): 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":"AAKA,OAAO,KAAK,EACV,SAAS,EACT,OAAO,EAOP,kBAAkB,EAClB,aAAa,EAEd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEL,aAAa,EAIb,aAAa,EACb,WAAW,EACX,KAAK,cAAc,EACpB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAuC1E,eAAO,MAAM,uBAAuB,yBAAyB,CAAC;AAY9D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAI7E;AAQD,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;IAMlE,YAAmB,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,SAAS,EAGtE;IAEM,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAExC;IA4DM,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAe1D;IAED;;;;OAIG;IACU,wBAAwB,IAAI,OAAO,CAAC,kBAAkB,CAAC,CASnE;IAEM,QAAQ,IAAI,WAAW,GAAG,SAAS,CAWzC;IAEM,UAAU,IAAI,aAAa,GAAG,SAAS,CAS7C;IAEY,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAsCpF;IA2CY,eAAe,CAC1B,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,kBAAkB,CAAC,CAsC7B;IAEY,OAAO,CAClB,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,aAAa,CAAC,CAkDxB;CAwTF"}
+{"version":3,"file":"DefaultUpgradeService.d.ts","sourceRoot":"","sources":["../../../../src/service/upgrade/DefaultUpgradeService.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,SAAS,EACT,OAAO,EAOP,kBAAkB,EAClB,aAAa,EAEd,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEL,aAAa,EAIb,aAAa,EACb,WAAW,EACX,KAAK,cAAc,EACpB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAwC1E,eAAO,MAAM,uBAAuB,yBAAyB,CAAC;AAY9D,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAI7E;AAQD,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,cAAc;;IAMlE,YAAmB,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,SAAS,EAGtE;IAEM,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAExC;IA4DM,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAe1D;IAED;;;;OAIG;IACU,wBAAwB,IAAI,OAAO,CAAC,kBAAkB,CAAC,CASnE;IAED;;;OAGG;IACU,2BAA2B,IAAI,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAWlF;IAEM,QAAQ,IAAI,WAAW,GAAG,SAAS,CAWzC;IAEM,UAAU,IAAI,aAAa,GAAG,SAAS,CAS7C;IAEY,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAsCpF;IA2CY,eAAe,CAC1B,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,kBAAkB,CAAC,CAsC7B;IAEY,OAAO,CAClB,UAAU,CAAC,EAAE,WAAW,EACxB,YAAY,CAAC,EAAE,aAAa,EAC5B,qBAAqB,CAAC,EAAE,aAAa,GACpC,OAAO,CAAC,aAAa,CAAC,CAkDxB;CAwTF"}

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

@@ -23,9 +23,10 @@ const LATEST_VERSION_CACHE_KEY_PREFIX = "latest-version:";
 const CACHE_TTL_MILLIS = 24 * 60 * 60 * 1000;
 // KeyValueService key holding the last checkForUpgrade() result, refreshed opportunistically by
 // UpgradeServiceProvider's background StartupTask and by the `upgrade` command - shared by both so
-// there's one cache, not two. The banner task only ever reads this key (kv.has()/kv.get()) - it
-// never calls checkForUpgrade()/getUpgradeCheckResult() live, since checking live would stall
-// startup on the network/spawn calls checkForUpgrade() makes.
+// there's one cache, not two. The key lives in this service's own KeyValueService scope, so other
+// consumers (e.g. the banner task) read it via getCachedUpgradeCheckResult() rather than their own
+// scoped KeyValueService. The banner never calls checkForUpgrade()/getUpgradeCheckResult() live,
+// since checking live would stall startup on the network/spawn calls checkForUpgrade() makes.
 export const UPGRADE_CHECK_CACHE_KEY = "upgrade-check-result";
 function describeSpawnFailure(result) {
     return "timedOut" in result
@@ -133,6 +134,22 @@ export default class DefaultUpgradeService {
         }
         return result;
     }
+    /**
+     * Return the result last persisted by {@link refreshUpgradeCheckCache}, without running a check.
+     * Returns `undefined` if nothing has been persisted yet or no KeyValueService is available.
+     */
+    async getCachedUpgradeCheckResult() {
+        const keyValueService = this.#keyValueService;
+        if (!keyValueService) {
+            return undefined;
+        }
+        const has = await this.#safeKeyValueCall(() => keyValueService.has(UPGRADE_CHECK_CACHE_KEY));
+        if (!has) {
+            return undefined;
+        }
+        const cached = await this.#safeKeyValueCall(() => keyValueService.get(UPGRADE_CHECK_CACHE_KEY));
+        return cached;
+    }
     detectOs() {
         switch (process.platform) {
             case "linux":

package/dist/src/startup/banner/bannerStartupTask.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bannerStartupTask.d.ts","sourceRoot":"","sources":["../../../../src/startup/banner/bannerStartupTask.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIV,WAAW,EAEZ,MAAM,yCAAyC,CAAC;AAYjD,eAAO,MAAM,sBAAsB,4DAA4D,CAAC;AAEhG;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAC7C,QAAQ,EAAE,MAAM,EAChB,QAAQ,SAAa,GACpB,WAAW,CA2Db"}
+{"version":3,"file":"bannerStartupTask.d.ts","sourceRoot":"","sources":["../../../../src/startup/banner/bannerStartupTask.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAYpG,eAAO,MAAM,sBAAsB,4DAA4D,CAAC;AAEhG;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAC7C,QAAQ,EAAE,MAAM,EAChB,QAAQ,SAAa,GACpB,WAAW,CA+Db"}

package/dist/src/startup/banner/bannerStartupTask.js

@@ -1,5 +1,5 @@
-import { ASCII_BANNER_GENERATOR_SERVICE_ID, CONFIGURATION_SERVICE_ID, KEY_VALUE_SERVICE_ID, PRINTER_SERVICE_ID, } from "@flowscripter/dynamic-cli-framework-api";
-import { UPGRADE_CHECK_CACHE_KEY } from "../../service/upgrade/DefaultUpgradeService.js";
+import { ASCII_BANNER_GENERATOR_SERVICE_ID, CONFIGURATION_SERVICE_ID, PRINTER_SERVICE_ID, UPGRADE_SERVICE_ID, } from "@flowscripter/dynamic-cli-framework-api";
+import DefaultUpgradeService from "../../service/upgrade/DefaultUpgradeService.js";
 import NoBannerCommand, {} from "./command/NoBannerCommand.js";
 export const BANNER_STARTUP_TASK_ID = "@flowscripter/dynamic-cli-framework/banner-startup-task";
 /**
@@ -41,14 +41,18 @@ export default function createBannerStartupTask(priority, fontName = "standard")
                 let versionLine = "version: " + cliConfig.version;
                 // Cheap cache read only - never calls checkForUpgrade()/getUpgradeCheckResult() live,
                 // since that could stall startup on a network/spawn call. A first-ever run (no cached
-                // key yet) simply shows no upgrade-available suffix - that's expected, not a bug.
-                if (context.doesServiceExist(KEY_VALUE_SERVICE_ID)) {
-                    const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID);
-                    if (await keyValueService.has(UPGRADE_CHECK_CACHE_KEY)) {
-                        const result = (await keyValueService.get(UPGRADE_CHECK_CACHE_KEY));
-                        if (result.status === "checked" && result.updateAvailable) {
-                            versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
-                        }
+                // result yet) shows no upgrade-available suffix. The cached result is read through the
+                // upgrade service because it is stored in that service's own KeyValueService scope, and
+                // it is ignored if it was recorded by a different version (e.g. before an upgrade).
+                const upgradeService = context.doesServiceExist(UPGRADE_SERVICE_ID)
+                    ? context.getServiceById(UPGRADE_SERVICE_ID)
+                    : undefined;
+                if (upgradeService instanceof DefaultUpgradeService) {
+                    const result = await upgradeService.getCachedUpgradeCheckResult();
+                    if (result?.status === "checked" &&
+                        result.updateAvailable &&
+                        result.currentVersion === cliConfig.version) {
+                        versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
                     }
                 }
                 await printerService.info(`  ${printerService.secondary(versionLine)}\n`);

package/package.json

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

package/src/service/upgrade/DefaultUpgradeService.ts

@@ -63,9 +63,10 @@ interface CachedLatestVersion {
 
 // KeyValueService key holding the last checkForUpgrade() result, refreshed opportunistically by
 // UpgradeServiceProvider's background StartupTask and by the `upgrade` command - shared by both so
-// there's one cache, not two. The banner task only ever reads this key (kv.has()/kv.get()) - it
-// never calls checkForUpgrade()/getUpgradeCheckResult() live, since checking live would stall
-// startup on the network/spawn calls checkForUpgrade() makes.
+// there's one cache, not two. The key lives in this service's own KeyValueService scope, so other
+// consumers (e.g. the banner task) read it via getCachedUpgradeCheckResult() rather than their own
+// scoped KeyValueService. The banner never calls checkForUpgrade()/getUpgradeCheckResult() live,
+// since checking live would stall startup on the network/spawn calls checkForUpgrade() makes.
 export const UPGRADE_CHECK_CACHE_KEY = "upgrade-check-result";
 
 type VersionLookupResult =
@@ -196,6 +197,23 @@ export default class DefaultUpgradeService implements UpgradeService {
     return result;
   }
 
+  /**
+   * Return the result last persisted by {@link refreshUpgradeCheckCache}, without running a check.
+   * Returns `undefined` if nothing has been persisted yet or no KeyValueService is available.
+   */
+  public async getCachedUpgradeCheckResult(): Promise<UpgradeCheckResult | undefined> {
+    const keyValueService = this.#keyValueService;
+    if (!keyValueService) {
+      return undefined;
+    }
+    const has = await this.#safeKeyValueCall(() => keyValueService.has(UPGRADE_CHECK_CACHE_KEY));
+    if (!has) {
+      return undefined;
+    }
+    const cached = await this.#safeKeyValueCall(() => keyValueService.get(UPGRADE_CHECK_CACHE_KEY));
+    return cached as unknown as UpgradeCheckResult | undefined;
+  }
+
   public detectOs(): SupportedOs | undefined {
     switch (process.platform) {
       case "linux":

package/src/startup/banner/bannerStartupTask.ts

@@ -1,19 +1,13 @@
-import type {
-  Context,
-  KeyValueService,
-  PrinterService,
-  StartupTask,
-  UpgradeCheckResult,
-} from "@flowscripter/dynamic-cli-framework-api";
+import type { Context, PrinterService, StartupTask } from "@flowscripter/dynamic-cli-framework-api";
 import {
   ASCII_BANNER_GENERATOR_SERVICE_ID,
   CONFIGURATION_SERVICE_ID,
-  KEY_VALUE_SERVICE_ID,
   PRINTER_SERVICE_ID,
+  UPGRADE_SERVICE_ID,
 } from "@flowscripter/dynamic-cli-framework-api";
 import type { AsciiBannerGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
 import type { ConfigurationService } from "@flowscripter/dynamic-cli-framework-api";
-import { UPGRADE_CHECK_CACHE_KEY } from "../../service/upgrade/DefaultUpgradeService.ts";
+import DefaultUpgradeService from "../../service/upgrade/DefaultUpgradeService.ts";
 import NoBannerCommand, { type BannerState } from "./command/NoBannerCommand.ts";
 
 export const BANNER_STARTUP_TASK_ID = "@flowscripter/dynamic-cli-framework/banner-startup-task";
@@ -67,16 +61,20 @@ export default function createBannerStartupTask(
         let versionLine = "version: " + cliConfig.version;
         // Cheap cache read only - never calls checkForUpgrade()/getUpgradeCheckResult() live,
         // since that could stall startup on a network/spawn call. A first-ever run (no cached
-        // key yet) simply shows no upgrade-available suffix - that's expected, not a bug.
-        if (context.doesServiceExist(KEY_VALUE_SERVICE_ID)) {
-          const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
-          if (await keyValueService.has(UPGRADE_CHECK_CACHE_KEY)) {
-            const result = (await keyValueService.get(
-              UPGRADE_CHECK_CACHE_KEY,
-            )) as unknown as UpgradeCheckResult;
-            if (result.status === "checked" && result.updateAvailable) {
-              versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
-            }
+        // result yet) shows no upgrade-available suffix. The cached result is read through the
+        // upgrade service because it is stored in that service's own KeyValueService scope, and
+        // it is ignored if it was recorded by a different version (e.g. before an upgrade).
+        const upgradeService = context.doesServiceExist(UPGRADE_SERVICE_ID)
+          ? context.getServiceById(UPGRADE_SERVICE_ID)
+          : undefined;
+        if (upgradeService instanceof DefaultUpgradeService) {
+          const result = await upgradeService.getCachedUpgradeCheckResult();
+          if (
+            result?.status === "checked" &&
+            result.updateAvailable &&
+            result.currentVersion === cliConfig.version
+          ) {
+            versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
           }
         }
         await printerService.info(`  ${printerService.secondary(versionLine)}\n`);