@boyingliu01/xp-gate 0.12.2 → 0.12.4

package/plugins/opencode/__tests__/xp-gate-update.test.ts

@@ -1,518 +0,0 @@
-/**
- * XP-Gate auto-update tests
- *
- * Tests for:
- * - semverLt: version comparison
- * - checkXpGateUpdate: xp-gate npm registry check + cache + auto-upgrade
- * - chat.message integration
- * - Legacy checkPluginUpdate modified to detect BOTH packages
- */
-
-import { describe, it, before, after } from "node:test"
-import assert from "node:assert/strict"
-import { randomUUID } from "node:crypto"
-import { mkdirSync, writeFileSync, readFileSync, existsSync, rmSync } from "node:fs"
-import { join } from "node:path"
-import { tmpdir, homedir } from "node:os"
-import { execSync, spawn } from "node:child_process"
-
-// ── Pure function: semverLt ──
-
-function semverLt(a: string, b: string): boolean {
-  const pa = a.replace(/^v/, "").split(".").map(Number)
-  const pb = b.replace(/^v/, "").split(".").map(Number)
-  for (let i = 0; i < Math.max(pa.length, pb.length); i++) {
-    const na = pa[i] ?? 0
-    const nb = pb[i] ?? 0
-    if (na !== nb) return na < nb
-  }
-  return false
-}
-
-// ── XP-GATE specific: these are the new functions we need to implement ──
-
-const xpGateCacheFile = () => join(homedir(), ".xp-gate", "xp-gate-version-check.json")
-const XP_GATE_NPM_PKG = "@boyingliu01/xp-gate"
-const XP_GATE_REGISTRY_URL = `https://registry.npmjs.org/-/package/${encodeURIComponent(XP_GATE_NPM_PKG)}/dist-tags`
-const CACHE_TTL_MS = 86_400_000 // 24h
-
-type XpGateCache = {
-  ts: number
-  localVersion: string
-  remoteVersion: string
-  status?: "current" | "upgraded"
-}
-
-/**
- * Read version from installed xp-gate npm package.
- * Returns null if not installed.
- */
-/**
- * Get local xp-gate version. Can be overridden in tests via getLocalVersionOverride.
- */
-let getLocalVersionOverride: (() => string | null) | null = null
-
-function getLocalXpGateVersion(): string | null {
-  if (getLocalVersionOverride) return getLocalVersionOverride()
-  try {
-    const pkgPath = join(
-      execSync("npm root -g", { encoding: "utf8" }).trim(),
-      XP_GATE_NPM_PKG,
-      "package.json"
-    )
-    const pkg = JSON.parse(readFileSync(pkgPath, "utf8"))
-    return pkg.version || null
-  } catch {
-    return null
-  }
-}
-
-/**
- * Read cache file, returns null if absent / stale.
- */
-function readXpGateCache(): XpGateCache | null {
-  try {
-    if (!existsSync(xpGateCacheFile())) return null
-    const raw = readFileSync(xpGateCacheFile(), "utf8")
-    const data: XpGateCache = JSON.parse(raw)
-    if (Date.now() - data.ts < CACHE_TTL_MS && data.remoteVersion) {
-      return data
-    }
-    return null // stale
-  } catch {
-    return null
-  }
-}
-
-/**
- * Write cache file.
- */
-function writeXpGateCache(data: XpGateCache): void {
-  try {
-    mkdirSync(join(homedir(), ".xp-gate"), { recursive: true })
-    const tmp = xpGateCacheFile() + ".tmp." + process.pid
-    writeFileSync(tmp, JSON.stringify(data), "utf8")
-    try { rmSync(xpGateCacheFile()) } catch {}
-    const orig = readFileSync(tmp, "utf8")
-    writeFileSync(xpGateCacheFile(), orig, "utf8")
-    rmSync(tmp)
-  } catch {
-    // silent
-  }
-}
-
-/**
- * Fetch latest version from npm registry. Returns null on failure.
- */
-async function fetchNpmLatestVersion(url: string, timeoutMs = 5000): Promise<string | null> {
-  const controller = new AbortController()
-  const timer = setTimeout(() => controller.abort(), timeoutMs)
-  try {
-    const response = await fetch(url, { signal: controller.signal })
-    if (!response.ok) return null
-    const data: Record<string, unknown> = await response.json()
-    const latest = data.latest
-    return typeof latest === "string" ? latest : null
-  } catch {
-    return null
-  } finally {
-    clearTimeout(timer)
-  }
-}
-
-type UpgradeResult = {
-  action: "noop" | "upgraded" | "error"
-  localVersion: string | null
-  remoteVersion: string | null
-  error?: string
-}
-
-/**
- * Check xp-gate version and auto-upgrade if outdated.
- *
- * - Respects daily cache
- * - Fires npm install -g in background
- * - Returns result for user notification
- */
-async function checkXpGateUpdate(): Promise<UpgradeResult> {
-  // 1. Check cache — must validate localVersion still matches
-  const cached = readXpGateCache()
-  const localVersion = getLocalXpGateVersion()
-
-  if (cached && cached.status === "current" && cached.localVersion && localVersion && cached.localVersion === localVersion) {
-    return { action: "noop", localVersion, remoteVersion: cached.remoteVersion }
-  }
-
-  // 2. No valid cache or local changed — check remote
-  if (!localVersion) {
-    return { action: "noop", localVersion: null, remoteVersion: null }
-  }
-
-  // 3. Fetch remote
-  const remoteVersion = await fetchNpmLatestVersion(XP_GATE_REGISTRY_URL)
-  if (!remoteVersion) {
-    return { action: "noop", localVersion, remoteVersion: null }
-  }
-
-  // 4. Compare
-  if (!semverLt(localVersion, remoteVersion)) {
-    writeXpGateCache({ ts: Date.now(), localVersion, remoteVersion, status: "current" })
-    return { action: "noop", localVersion, remoteVersion }
-  }
-
-  // 5. Outdated — auto upgrade (awaited spawn)
-  writeXpGateCache({ ts: Date.now(), localVersion, remoteVersion })
-  try {
-    const exitCode = await new Promise<number | null>((resolve, reject) => {
-      const child = spawn("npm", ["install", "-g", `${XP_GATE_NPM_PKG}@${remoteVersion}`], {
-        stdio: "pipe",
-        timeout: 120_000,
-      })
-      child.on("close", (code) => resolve(code))
-      child.on("error", (err) => reject(err))
-    })
-    if (exitCode === 0) {
-      writeXpGateCache({ ts: Date.now(), localVersion: remoteVersion, remoteVersion, status: "current" })
-      return { action: "upgraded", localVersion, remoteVersion }
-    }
-    return { action: "error", localVersion, remoteVersion, error: `npm install exited with code ${exitCode}` }
-  } catch (err) {
-    const msg = err instanceof Error ? err.message : String(err)
-    return { action: "error", localVersion, remoteVersion, error: msg }
-  }
-}
-
-/**
- * Read xp-gate config.json for opt-out settings.
- * Returns null if config doesn't exist or is malformed.
- */
-function readXpGateConfig(): { autoUpgrade?: boolean } | null {
-  const cfgPath = join(homedir(), ".xp-gate", "config.json")
-  try {
-    if (!existsSync(cfgPath)) return null
-    const raw = readFileSync(cfgPath, "utf8")
-    return JSON.parse(raw)
-  } catch {
-    return null
-  }
-}
-
-// ── Tests ──
-
-void describe("semverLt", () => {
-  void it("returns true when local < remote", () => {
-    assert.equal(semverLt("0.9.1", "0.9.2"), true)
-  })
-
-  void it("returns false when local > remote", () => {
-    assert.equal(semverLt("0.9.3", "0.9.2"), false)
-  })
-
-  void it("returns false when versions equal", () => {
-    assert.equal(semverLt("0.9.2", "0.9.2"), false)
-  })
-
-  void it("handles 'v' prefix", () => {
-    assert.equal(semverLt("v0.9.1", "v0.9.2"), true)
-  })
-
-  void it("handles mixed prefix", () => {
-    assert.equal(semverLt("v0.9.1", "0.9.2"), true)
-  })
-
-  void it("handles different segment counts", () => {
-    assert.equal(semverLt("0.9", "0.9.2"), true)
-  })
-
-  void it("handles major version bumps", () => {
-    assert.equal(semverLt("0.9.2", "1.0.0"), true)
-  })
-
-  void it("returns false for identical versions with v prefix", () => {
-    assert.equal(semverLt("v1.0.0", "1.0.0"), false)
-  })
-})
-
-void describe("checkXpGateUpdate — cache & upgrade", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-test-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("returns noop when no xp-gate installed locally", async () => {
-    // Test isolation limitation: npm root -g returns the REAL global prefix
-    // regardless of HOME, so if xp-gate IS installed globally, this test
-    // will detect it and try to upgrade. This is acceptable — the key
-    // behavior is that it doesn't crash.
-    const result = await checkXpGateUpdate()
-    assert.ok(["noop", "upgraded", "error"].includes(result.action))
-  })
-
-  void it("returns noop when cache says current AND local version matches", async () => {
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now(),
-      localVersion: "0.9.2",
-      remoteVersion: "0.9.2",
-      status: "current",
-    }))
-
-    // Override local version to match cache so "current" check passes
-    getLocalVersionOverride = () => "0.9.2"
-
-    const result = await checkXpGateUpdate()
-    getLocalVersionOverride = null
-
-    // If cache matches local, action should be "noop" (cache hit).
-    // However, fetchNpmLatestVersion is a real network call that cannot
-    // be mocked here — if npm registry returns a different version,
-    // the cache-localVersion match still prevents re-check.
-    assert.equal(result.action, "noop")
-    assert.equal(result.localVersion, "0.9.2")
-  })
-
-  void it("ignores cache when local version changed (manual upgrade detected)", async () => {
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now(),
-      localVersion: "0.9.1",  // old cached version
-      remoteVersion: "0.9.1",
-      status: "current",
-    }))
-
-    // Simulate user manually upgraded npm package to 0.10.8
-    getLocalVersionOverride = () => "0.10.8"
-
-    const result = await checkXpGateUpdate()
-    getLocalVersionOverride = null
-
-    // Cache must be ignored because cached localVersion (0.9.1) ≠ actual (0.10.8)
-    // Falls through to network check. We got past the cache shortcut — that's the pass condition.
-    assert.ok(["noop", "upgraded", "error"].includes(result.action))
-  })
-
-  void it("handles cache expiry correctly", async () => {
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now() - 86_400_000 - 3600_000, // 25h old
-      localVersion: "0.9.1",
-      remoteVersion: "0.9.2",
-    }))
-
-    const result = await checkXpGateUpdate()
-    // Stale cache should be ignored — should check npm registry
-    // If network check fails, returns noop with localVersion if found
-    assert.equal(result.action, "noop")
-  })
-})
-
-
-// ── UPG-002: spawn-based upgrade tests ──
-
-void describe("checkXpGateUpdate — spawn (UPG-002)", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-spawn-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("returns upgraded with spawn-based npm install", async () => {
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now() - 86_400_000 - 3600_000, // stale
-      localVersion: "0.9.1",
-      remoteVersion: "0.9.2",
-    }))
-
-    const result = await checkXpGateUpdate()
-    assert.ok(["noop", "upgraded", "error"].includes(result.action))
-  })
-})
-
-// ── UPG-003: readXpGateConfig isolated tests ──
-
-void describe("readXpGateConfig", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-cfg-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("returns null when no config.json exists", () => {
-    assert.equal(readXpGateConfig(), null)
-  })
-
-  void it("returns parsed config when config.json exists with autoUpgrade false", () => {
-    const cfgPath = join(fakeHome, ".xp-gate", "config.json")
-    writeFileSync(cfgPath, JSON.stringify({ autoUpgrade: false }))
-    const cfg = readXpGateConfig()
-    assert.notEqual(cfg, null)
-    assert.equal(cfg!.autoUpgrade, false)
-  })
-
-  void it("returns parsed config when config.json exists with autoUpgrade true", () => {
-    const cfgPath = join(fakeHome, ".xp-gate", "config.json")
-    writeFileSync(cfgPath, JSON.stringify({ autoUpgrade: true }))
-    const cfg = readXpGateConfig()
-    assert.notEqual(cfg, null)
-    assert.equal(cfg!.autoUpgrade, true)
-  })
-
-  void it("returns null when config.json is malformed", () => {
-    const cfgPath = join(fakeHome, ".xp-gate", "config.json")
-    writeFileSync(cfgPath, "not-json")
-    assert.equal(readXpGateConfig(), null)
-  })
-})
-
-// ── UPG-003: opt-out config integration tests ──
-
-void describe("checkXpGateUpdate — opt-out config integration (UPG-003)", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-cfg-int-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("handles config.json with autoUpgrade false (no crash, graceful noop)", async () => {
-    const cfgPath = join(fakeHome, ".xp-gate", "config.json")
-    writeFileSync(cfgPath, JSON.stringify({ autoUpgrade: false }))
-
-    const result = await checkXpGateUpdate()
-    // Should not crash — returns noop because local install not found in fake home
-    assert.ok(["noop", "upgraded", "error"].includes(result.action))
-  })
-})
-
-// ── UPG-004: Fire-and-forget spawn → cache write test ──
-
-void describe("checkXpGateUpdate — spawn completes and writes cache (UPG-004)", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-spawn-cache-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("should write cache with status:current after spawn-based upgrade completes", async () => {
-    // WARNING: This test ACTUALLY spawns npm install -g.
-    // It's skipped in CI environments.
-    if (process.env.CI) {
-      console.log("SKIP: UPG-004 spawn test disabled in CI")
-      return
-    }
-
-    // Simulate: local is old, remote is newer → should trigger spawn
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now() - 86_400_000 - 3600_000, // stale cache
-      localVersion: "0.9.0",
-      remoteVersion: "0.9.1",
-    }))
-
-    // Override local version to force upgrade path
-    getLocalVersionOverride = () => "0.9.0"
-
-    const result = await checkXpGateUpdate()
-    getLocalVersionOverride = null
-
-    // After fix: spawn is awaited, so cache is already written when function returns
-    assert.equal(result.action, "upgraded")
-
-    // Cache should have status:current immediately (no delay needed)
-    const finalCache = readXpGateCache()
-    if (finalCache) {
-      assert.equal(finalCache.status, "current",
-        "UPG-004 FAIL: spawn did not write status:current. The upgrade promise " +
-        "must be awaited so the cache reflects the completed install.")
-    }
-  })
-})
-
-// ── UPG-005: runBackgroundUpdates awaits checkXpGateUpdate ──
-
-/**
- * Simulates runBackgroundUpdates to verify it properly awaits the upgrade.
- * This test validates that the chat.message hook doesn't lose the upgrade.
- */
-void describe("runBackgroundUpdates — await verification (UPG-005)", () => {
-  const fakeHome = join(tmpdir(), "xp-gate-upd-await-" + randomUUID())
-  const origHome = process.env.HOME
-
-  before(() => {
-    process.env.HOME = fakeHome
-    mkdirSync(join(fakeHome, ".xp-gate"), { recursive: true })
-  })
-
-  after(() => {
-    process.env.HOME = origHome
-    rmSync(fakeHome, { recursive: true, force: true })
-  })
-
-  void it("checkXpGateUpdate resolves its promise BEFORE returning result", async () => {
-    // If spawn is fire-and-forget, the function returns before spawn completes.
-    // This test measures: does the returned promise resolve before or after spawn?
-    if (process.env.CI) {
-      console.log("SKIP: UPG-005 spawn timing test disabled in CI")
-      return
-    }
-
-    const cachePath = join(fakeHome, ".xp-gate", "xp-gate-version-check.json")
-    writeFileSync(cachePath, JSON.stringify({
-      ts: Date.now() - 86_400_000 - 3600_000,
-      localVersion: "0.9.0",
-      remoteVersion: "0.9.1",
-    }))
-
-    getLocalVersionOverride = () => "0.9.0"
-
-    const startTime = Date.now()
-    const result = await checkXpGateUpdate()
-    const elapsed = Date.now() - startTime
-    getLocalVersionOverride = null
-
-    assert.equal(result.action, "upgraded")
-
-    // After fix: spawn is properly awaited, so elapsed >= 1000ms
-    console.log(`UPG-005: checkXpGateUpdate() returned in ${elapsed}ms`)
-    assert.ok(elapsed > 1000,
-      `UPG-005 FAIL: resolve took only ${elapsed}ms — spawn is NOT awaited. ` +
-      "The chat.message hook must await the upgrade promise so " +
-      "npm install completes and cache gets status:current.")
-  })
-})