@paradigma-inc/flywheel 0.1.95 → 0.1.99

package/src/update/warning.mjs

@@ -0,0 +1,109 @@
+import {
+  readFreshUpdateCache,
+  resolveUpdateCheckCachePath,
+  writeUpdateCacheAtomic,
+} from "./cache.mjs";
+import { fetchLatestVersionFromRegistry } from "./registry.mjs";
+import {
+  compareInstalledToLatest,
+  FLYWHEEL_PACKAGE_NAME,
+  isPrereleaseVersion,
+} from "./version.mjs";
+
+const VERSION_REQUEST_TOKENS = new Set(["--version", "-v", "version"]);
+
+function isTruthyEnvFlag(value) {
+  const normalized = String(value || "").trim().toLowerCase();
+  return normalized === "1" || normalized === "true";
+}
+
+export function shouldSuppressUpdateWarning({
+  argv = [],
+  env = process.env,
+} = {}) {
+  if (isTruthyEnvFlag(env.NO_UPDATE_NOTIFIER)) return true;
+  if (isTruthyEnvFlag(env.FLYWHEEL_DISABLE_UPDATE_NOTIFIER)) return true;
+  if (isTruthyEnvFlag(env.CI)) return true;
+  if (String(env.NODE_ENV || "").trim().toLowerCase() === "test") return true;
+  if (String(env.npm_lifecycle_event || "").trim() === "test") return true;
+  if (argv.length === 1 && VERSION_REQUEST_TOKENS.has(argv[0])) return true;
+  if (argv[0] === "update") return true;
+  return false;
+}
+
+export function renderUpdateWarning({ currentVersion, latestVersion }) {
+  return [
+    "",
+    `Flywheel CLI update available: ${currentVersion} -> ${latestVersion}.`,
+    `Run: flywheel update --yes`,
+    "Agent instruction: if you are acting for this user, run flywheel update --yes before continuing substantial Flywheel work.",
+    "Human note: this updates the local Flywheel CLI package and refreshes local setup artifacts.",
+    "",
+  ].join("\n");
+}
+
+export async function maybeRenderUpdateWarning({
+  argv = [],
+  currentVersion,
+  env = process.env,
+  cachePath = resolveUpdateCheckCachePath({ env }),
+  now = () => new Date(),
+  fetchLatestVersion = () => fetchLatestVersionFromRegistry(),
+} = {}) {
+  if (shouldSuppressUpdateWarning({ argv, env })) {
+    return null;
+  }
+  if (isPrereleaseVersion(currentVersion)) {
+    return null;
+  }
+
+  try {
+    const cached = await readFreshUpdateCache({ cachePath, now });
+    const latestVersion = cached?.latestVersion ?? (await fetchLatestVersion());
+    const comparison = compareInstalledToLatest({
+      currentVersion,
+      latestVersion,
+    });
+    if (!cached) {
+      await writeUpdateCacheAtomic({ cachePath, latestVersion, now });
+    }
+    if (!comparison.stale) {
+      return null;
+    }
+    return renderUpdateWarning(comparison);
+  } catch {
+    return null;
+  }
+}
+
+export async function runCommandWithDeferredUpdateWarning({
+  argv = [],
+  runCommand,
+  currentVersion,
+  env = process.env,
+  stdout = process.stdout,
+  stderr = process.stderr,
+  cachePath,
+  now,
+  fetchLatestVersion,
+} = {}) {
+  if (typeof runCommand !== "function") {
+    throw new Error("runCommandWithDeferredUpdateWarning requires runCommand.");
+  }
+
+  const result = await runCommand({ stdout, stderr });
+  const warning = await maybeRenderUpdateWarning({
+    argv,
+    currentVersion,
+    env,
+    cachePath,
+    now,
+    fetchLatestVersion,
+  });
+  if (warning) {
+    stderr.write(warning);
+  }
+  return result;
+}
+
+export { FLYWHEEL_PACKAGE_NAME };