From 969055918fd318dce22acc7e8fa9264d34f1fb90 Mon Sep 17 00:00:00 2001 From: Dax Date: Wed, 2 Sep 2026 19:01:27 -0400 Subject: [PATCH] feat(cli): use endpoint-provided update packages (#46910) --- packages/cli/script/build.ts | 1 + packages/cli/script/publish.ts | 24 ++++++--- packages/cli/src/services/updater.ts | 59 +++++++++++++++-------- packages/cli/src/version.ts | 4 +- packages/cli/test/updater-install.test.ts | 33 +++++++++++-- packages/cli/vite.node.config.ts | 1 + 6 files changed, 89 insertions(+), 33 deletions(-) diff --git a/packages/cli/script/build.ts b/packages/cli/script/build.ts index 812839feb33..ffb4ff5e1e9 100755 --- a/packages/cli/script/build.ts +++ b/packages/cli/script/build.ts @@ -146,6 +146,7 @@ export default { path: file, version: ${JSON.stringify(opencodePty.version)}, sh OPENCODE_VERSION: `'${Script.version}'`, OPENCODE_CLI_NAME: `'${binary}'`, OPENCODE_CHANNEL: `'${Script.channel}'`, + OPENCODE_ARTIFACT: `'cli'`, OPENCODE_LIBC: item.os === "linux" ? `'${item.abi ?? "glibc"}'` : "undefined", // FFF_LIBC selects the fff native lib variant: "musl" or "gnu". FFF_LIBC: item.os === "linux" ? `'${item.abi ?? "gnu"}'` : "undefined", diff --git a/packages/cli/script/publish.ts b/packages/cli/script/publish.ts index df9dd390c34..01669503086 100755 --- a/packages/cli/script/publish.ts +++ b/packages/cli/script/publish.ts @@ -23,7 +23,13 @@ async function publish(dir: string, name: string, version: string) { } } -async function publishDistribution(input: { root: string; name: string; binary: string; packagePrefix: string }) { +async function publishDistribution(input: { + root: string + name: string + binary: string + packagePrefix: string + artifact: string +}) { const binaries: Record = {} for (const filepath of new Bun.Glob("*/package.json").scanSync({ cwd: input.root })) { const item = await Bun.file(`${input.root}/${filepath}`).json() @@ -72,6 +78,13 @@ async function publishDistribution(input: { root: string; name: string; binary: ), ) await publish(`${input.root}/${input.name}`, input.name, version) + await UpdateArtifact.publish({ + channel: Script.channel, + name: input.artifact, + distribution: "npm", + version, + metadata: { package: input.name }, + }) } await publishDistribution({ @@ -79,6 +92,7 @@ await publishDistribution({ name: pkg.name, binary: "opencode2", packagePrefix: "@opencode-ai/cli-", + artifact: "cli", }) if (existsSync("./dist/node")) { await publishDistribution({ @@ -86,12 +100,6 @@ if (existsSync("./dist/node")) { name: "opencode-node", binary: "opencode2-node", packagePrefix: "@opencode-ai/cli-node-", + artifact: "cli-node", }) } -await UpdateArtifact.publish({ - channel: Script.channel, - name: "cli", - distribution: "npm", - version: Script.version, - metadata: {}, -}) diff --git a/packages/cli/src/services/updater.ts b/packages/cli/src/services/updater.ts index 10263a9003e..2fb99f308c8 100644 --- a/packages/cli/src/services/updater.ts +++ b/packages/cli/src/services/updater.ts @@ -2,21 +2,16 @@ import { Global } from "@opencode-ai/util/global" import { AppProcess } from "@opencode-ai/util/process" import { OpenCode } from "@opencode-ai/client" import { PersistentPty } from "@opencode-ai/schema/persistent-pty" -import { OPENCODE_CHANNEL, OPENCODE_LOCAL, OPENCODE_VERSION } from "../version" +import { OPENCODE_ARTIFACT, OPENCODE_CHANNEL, OPENCODE_LOCAL, OPENCODE_VERSION } from "../version" import { Context, Duration, Effect, FileSystem, Layer, Ref, Schedule, Semaphore, Stream } from "effect" import { ChildProcess } from "effect/unstable/process" import { parse, type ParseError } from "jsonc-parser" import path from "node:path" import { action, parseReleaseVersion, type Action, type Policy } from "./updater-action" -declare const OPENCODE_CLI_NAME: string | undefined - export const methods = ["curl", "npm", "pnpm", "bun", "yarn"] as const export type Method = (typeof methods)[number] -const packageName = - typeof OPENCODE_CLI_NAME === "string" && OPENCODE_CLI_NAME === "opencode2-node" ? "opencode-node" : "@opencode-ai/cli" - export interface Interface { readonly check: () => Effect.Effect readonly monitor: (input: { @@ -180,6 +175,15 @@ const make = Effect.gen(function* () { const global = yield* Global.Service const appProcess = yield* AppProcess.Service const channel = OPENCODE_CHANNEL.replace(/[^a-zA-Z0-9._-]/g, "-") + const installedPackage = yield* Effect.gen(function* () { + const executable = yield* fs.realPath(process.execPath) + const directory = path.dirname(path.dirname(executable)) + const manifest: { name: string; bin?: Record } = yield* fs + .readFileString(path.join(directory, "package.json")) + .pipe(Effect.flatMap((text) => Effect.try(() => JSON.parse(text)))) + if (Object.values(manifest.bin ?? {}).some((bin) => path.resolve(directory, bin) === executable)) + return manifest.name + }).pipe(Effect.orElseSucceed(() => undefined)) const readPolicy = Effect.fnUntraced(function* () { const values = yield* Effect.forEach(["config.json", "opencode.json", "opencode.jsonc"], (name) => @@ -216,10 +220,11 @@ const make = Effect.gen(function* () { process.platform === "win32" ? "opencode2.exe" : "opencode2", ) if (path.resolve(process.execPath) === path.resolve(binary)) return "curl" + if (!installedPackage) return const checks: ReadonlyArray<{ method: Method; command: string[] }> = [ - { method: "npm", command: ["npm", "list", "-g", "--depth=0", packageName] }, - { method: "pnpm", command: ["pnpm", "list", "-g", "--depth=0", packageName] }, + { method: "npm", command: ["npm", "list", "-g", "--depth=0", installedPackage] }, + { method: "pnpm", command: ["pnpm", "list", "-g", "--depth=0", installedPackage] }, { method: "bun", command: ["bun", "pm", "ls", "-g"] }, { method: "yarn", command: ["yarn", "global", "list"] }, ] @@ -228,35 +233,49 @@ const make = Effect.gen(function* () { (check) => run(check.command).pipe(Effect.map((result) => ({ check, result }))), { concurrency: "unbounded" }, ) - return results.find((result) => result.result.stdout.includes(packageName))?.check.method + return results.find((result) => result.result.stdout.includes(installedPackage))?.check.method }) - const latest = Effect.fnUntraced(function* () { + const release = Effect.fnUntraced(function* () { const response = yield* Effect.tryPromise({ try: () => - fetch(`https://update.opencode.ai/api/${encodeURIComponent(channel)}/cli/npm`, { - headers: { "User-Agent": `opencode/${OPENCODE_VERSION}` }, - signal: AbortSignal.timeout(10_000), - }), + fetch( + `https://update.opencode.ai/api/${encodeURIComponent(channel)}/${encodeURIComponent(OPENCODE_ARTIFACT)}/npm`, + { + headers: { "User-Agent": `opencode/${OPENCODE_VERSION}` }, + signal: AbortSignal.timeout(10_000), + }, + ), catch: (cause) => new Error("Failed to check for updates", { cause }), }) if (!response.ok) return yield* Effect.fail(new Error(`Update check failed with status ${response.status}`)) - const data = yield* Effect.tryPromise({ + const data: { version: string; metadata?: { package?: string } } = yield* Effect.tryPromise({ try: () => response.json(), catch: (cause) => new Error("Failed to read update information", { cause }), }) - if (typeof data !== "object" || data === null || !("version" in data) || typeof data.version !== "string") { - return yield* Effect.fail(new Error("Update information did not include a version")) - } - return data.version + if (!data.metadata?.package) return yield* Effect.fail(new Error("Update information did not include a package")) + return { package: data.metadata.package, version: data.version } }) + const latest = () => release().pipe(Effect.map((data) => data.version)) + const upgrade = Effect.fnUntraced(function* (method: Method, input: string) { if (!parseReleaseVersion(input)) return yield* Effect.fail(new Error(`Invalid version: ${input}`)) const version = input.trim().replace(/^v/, "") + const packageName = (yield* release()).package const target = `${packageName}@${version}` + if (installedPackage && packageName !== installedPackage && (method === "pnpm" || method === "yarn")) { + return yield* Effect.fail(new Error(`Reinstall ${target} with ${method} to migrate from ${installedPackage}.`)) + } const commands: Record, string[]> = { - npm: ["npm", "install", "--global", target], + // Keep the old package: uninstalling it can unlink the replacement command. + npm: [ + "npm", + "install", + "--global", + ...(installedPackage && packageName !== installedPackage ? ["--force"] : []), + target, + ], pnpm: ["pnpm", "add", "--global", `--allow-build=${packageName}`, target], yarn: ["yarn", "global", "add", target], } diff --git a/packages/cli/src/version.ts b/packages/cli/src/version.ts index 04c3fb3f395..7124c72b518 100644 --- a/packages/cli/src/version.ts +++ b/packages/cli/src/version.ts @@ -1,8 +1,10 @@ declare const OPENCODE_VERSION: string declare const OPENCODE_CHANNEL: string +declare const OPENCODE_ARTIFACT: string const version = typeof OPENCODE_VERSION === "string" ? OPENCODE_VERSION : "local" const channel = typeof OPENCODE_CHANNEL === "string" ? OPENCODE_CHANNEL : "local" +const artifact = typeof OPENCODE_ARTIFACT === "string" ? OPENCODE_ARTIFACT : "cli" -export { version as OPENCODE_VERSION, channel as OPENCODE_CHANNEL } +export { version as OPENCODE_VERSION, channel as OPENCODE_CHANNEL, artifact as OPENCODE_ARTIFACT } export const OPENCODE_LOCAL = channel === "local" diff --git a/packages/cli/test/updater-install.test.ts b/packages/cli/test/updater-install.test.ts index 775b49af7ee..f452753afce 100644 --- a/packages/cli/test/updater-install.test.ts +++ b/packages/cli/test/updater-install.test.ts @@ -1,7 +1,7 @@ import { NodeServices } from "@effect/platform-node" import { Global } from "@opencode-ai/util/global" import { AppProcess } from "@opencode-ai/util/process" -import { expect, test } from "bun:test" +import { expect, spyOn, test } from "bun:test" import { Effect, FileSystem, Stream } from "effect" import { ChildProcess, ChildProcessSpawner } from "effect/unstable/process" import { existsSync } from "node:fs" @@ -17,11 +17,29 @@ function fixture( respond: (command: ChildProcess.StandardCommand) => Partial & { error?: AppProcess.AppProcessError } = () => ({}), + name = "@opencode-ai/cli", ) { return Effect.gen(function* () { const fs = yield* FileSystem.FileSystem const spawner = yield* ChildProcessSpawner.ChildProcessSpawner const root = yield* fs.makeTempDirectoryScoped({ prefix: "opencode-updater-" }) + const executable = path.join(root, "package", "bin", "opencode") + yield* fs.makeDirectory(path.dirname(executable), { recursive: true }) + yield* fs.writeFileString( + path.join(root, "package", "package.json"), + JSON.stringify({ name, bin: { opencode: "bin/opencode" } }), + ) + // The updater uses global fetch; scope this replacement to each install test. + yield* Effect.acquireRelease( + Effect.sync(() => + spyOn(globalThis, "fetch").mockImplementation( + Object.assign(async () => Response.json({ version: "2.3.4", metadata: { package: name } }), { + preconnect: fetch.preconnect, + }), + ), + ), + (request) => Effect.sync(() => request.mockRestore()), + ) const global = Global.make({ home: path.join(root, "home"), data: path.join(root, "data"), @@ -37,6 +55,10 @@ function fixture( const updater = yield* Updater.Service.pipe( Effect.provide(Updater.layer), Effect.provideService(Global.Service, global), + Effect.provideService(FileSystem.FileSystem, { + ...fs, + realPath: (input) => (input === process.execPath ? Effect.succeed(executable) : fs.realPath(input)), + }), Effect.provideService( AppProcess.Service, AppProcess.Service.of({ @@ -214,9 +236,12 @@ test("Node distribution honors the compile-time CLI name", async () => { if (typeof OPENCODE_CLI_NAME === "string" && OPENCODE_CLI_NAME === "opencode2-node") { it.live("Node distribution resolves the published npm package", () => Effect.gen(function* () { - const test = yield* fixture((command) => ({ - stdout: Buffer.from(command.command === "npm" ? "opencode-node@2.3.4" : ""), - })) + const test = yield* fixture( + (command) => ({ + stdout: Buffer.from(command.command === "npm" ? "opencode-node@2.3.4" : ""), + }), + "opencode-node", + ) expect(yield* test.updater.method()).toBe("npm") yield* test.updater.upgrade("npm", "v2.3.4") yield* test.updater.upgrade("pnpm", "v2.3.4") diff --git a/packages/cli/vite.node.config.ts b/packages/cli/vite.node.config.ts index 0ac32834271..92f7fef1e18 100644 --- a/packages/cli/vite.node.config.ts +++ b/packages/cli/vite.node.config.ts @@ -268,6 +268,7 @@ export function mainConfig(input: NodeBuildInput): UserConfig { OPENCODE_VERSION: JSON.stringify(input.version), OPENCODE_CLI_NAME: JSON.stringify("opencode2-node"), OPENCODE_CHANNEL: JSON.stringify(input.channel), + OPENCODE_ARTIFACT: JSON.stringify("cli-node"), OPENCODE_LIBC: input.target.platform === "linux" ? JSON.stringify("glibc") : "undefined", FFF_LIBC: input.target.platform === "linux" ? JSON.stringify("gnu") : "undefined", "process.env.WS_NO_BUFFER_UTIL": JSON.stringify("1"),