/** * Latest-version discovery + comparison for the dashboard "Update Available" banner. * * #4100: the banner is gated on `isNewer(latest, current)`. Previously `latest` came * ONLY from `npm info omniroute version --json` (the `npm` CLI binary). When that binary * is absent (Docker / desktop / locked-down installs) or the registry is unreachable, the * call returned null and the banner silently never rendered — even when an update existed. * * This module keeps the fast `npm` CLI path as the primary source but adds two * npm-binary-free HTTP fallbacks, reachable with plain `fetch`: * 1. the npm registry JSON API (`registry.npmjs.org`), then * 2. the GitHub releases API (`api.github.com/.../releases/latest`) — the source the * issue itself suggested, and the only one that still works on networks that reach * GitHub (the same host `getNews()` already pulls from) but block the npm registry. * It logs a warning instead of degrading silently when ALL sources fail. Version parsing * is also hardened so a `v`-prefix or pre-release suffix no longer collapses the * comparison to `false` via `NaN`. */ import { execFile } from "child_process"; import { promisify } from "util"; import { createLogger } from "@/shared/utils/logger"; const execFileAsync = promisify(execFile); const log = createLogger("system/versionCheck"); /** npm-binary-free latest-version source: the registry JSON API. */ const NPM_REGISTRY_LATEST_URL = "https://registry.npmjs.org/omniroute/latest"; /** * Second npm-binary-free source: the GitHub releases API. Works on networks that allow * GitHub (where `getNews()` already succeeds) but block the npm registry — the most likely * surviving cause of "#4100 still not fixed" after the registry fallback shipped in v3.8.28. */ const GITHUB_RELEASES_LATEST_URL = "https://api.github.com/repos/diegosouzapw/OmniRoute/releases/latest"; const LOOKUP_TIMEOUT_MS = 10_000; /** * Strip a leading `v`, drop pre-release/build metadata (`-`/`+` suffix), split on `.`, * and return a numeric tuple. Returns null when the string is empty or any segment is * non-numeric, so callers can fail safe instead of comparing `NaN`. */ export function normalizeVersion(v: string): number[] | null { if (typeof v !== "string") return null; const cleaned = v.trim().replace(/^v/i, "").split(/[-+]/)[0]; if (!cleaned) return null; const parts = cleaned.split(".").map((p) => Number(p)); if (parts.length === 0 || parts.some((n) => !Number.isFinite(n))) return null; return parts; } /** * True iff `latest` is a strictly higher semver than `current`. Safe on null/garbage * (returns false rather than throwing or yielding a `NaN`-driven false positive). */ export function isNewer(latest: string | null | undefined, current: string): boolean { if (!latest) return false; const a = normalizeVersion(latest); const b = normalizeVersion(current); if (!a || !b) return false; const len = Math.max(a.length, b.length); for (let i = 0; i < len; i++) { const av = a[i] ?? 0; const bv = b[i] ?? 0; if (av !== bv) return av > bv; } return false; } /** Latest published version via the `npm` CLI (fast when npm is on PATH, e.g. source installs). */ export async function getLatestVersionFromNpmCli(): Promise { try { const { stdout } = await execFileAsync("npm", ["info", "omniroute", "version", "--json"], { timeout: LOOKUP_TIMEOUT_MS, }); const parsed = JSON.parse(String(stdout).trim()); return typeof parsed === "string" && parsed ? parsed : null; } catch { return null; } } /** * Latest published version via the npm registry HTTP API. Needs only network access — no * `npm` binary — so it works in Docker / desktop / locked-down installs. */ export async function getLatestVersionFromRegistry( fetchImpl: typeof fetch = fetch ): Promise { try { const res = await fetchImpl(NPM_REGISTRY_LATEST_URL, { signal: AbortSignal.timeout(LOOKUP_TIMEOUT_MS), }); if (!res.ok) return null; const data = (await res.json()) as { version?: unknown }; return typeof data?.version === "string" && data.version ? data.version : null; } catch { return null; } } /** * Latest published version via the GitHub releases API. Needs only network access to * GitHub — no `npm` binary and no npm registry — so it covers installs that reach GitHub * (the same host `getNews()` pulls from) but cannot reach `registry.npmjs.org`. Reads the * `tag_name` of the latest release (e.g. `v3.8.39`); `normalizeVersion`/`isNewer` tolerate * the `v` prefix downstream. */ export async function getLatestVersionFromGitHub( fetchImpl: typeof fetch = fetch ): Promise { try { const res = await fetchImpl(GITHUB_RELEASES_LATEST_URL, { signal: AbortSignal.timeout(LOOKUP_TIMEOUT_MS), headers: { // GitHub's API rejects requests without a User-Agent. "User-Agent": "omniroute-version-check", Accept: "application/vnd.github+json", }, }); if (!res.ok) return null; const data = (await res.json()) as { tag_name?: unknown }; return typeof data?.tag_name === "string" && data.tag_name ? data.tag_name : null; } catch { return null; } } /** * Resolve the latest published version. Tries the `npm` CLI first (fast on source installs), * then the registry HTTP API, then the GitHub releases API — both npm-binary-free. Logs a * warning — instead of silently degrading to "no update available" — when ALL sources fail. * Thunks are injectable for tests. */ export async function resolveLatestVersion(opts?: { npmCli?: () => Promise; registry?: () => Promise; github?: () => Promise; }): Promise { const npmCli = opts?.npmCli ?? getLatestVersionFromNpmCli; const registry = opts?.registry ?? (() => getLatestVersionFromRegistry()); const github = opts?.github ?? (() => getLatestVersionFromGitHub()); const viaCli = await npmCli(); if (viaCli) return viaCli; const viaRegistry = await registry(); if (viaRegistry) return viaRegistry; const viaGitHub = await github(); if (viaGitHub) return viaGitHub; log.warn( "Latest-version lookup failed via npm CLI, registry HTTP, and GitHub releases — the update banner will not show even if a newer release exists" ); return null; }