Skip to content

Commit 7487028

Browse files
committed
fix(cli): resolve background service port collision on Windows
Default background service port on Windows to 0x40de (16606) for stable and 0x40df (16607) for local channel to avoid dynamic port exclusions from Hyper-V, WSL2, and Docker (49152-65535). Additionally, capture stdout and stderr from service contenders and immediately surface startup failures during service.ensure instead of timing out silently after discarded retries. Fixes anomalyco#41746
1 parent 00067d2 commit 7487028

5 files changed

Lines changed: 63 additions & 16 deletions

File tree

‎packages/cli/src/services/service-config.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,18 @@ export function filename(channel = OPENCODE_CHANNEL) {
3232
}
3333

3434
export function defaultPort(channel = OPENCODE_CHANNEL) {
35+
if (process.platform === "win32") {
36+
if (channel === "latest" || channel === "dev" || channel === "beta" || channel === "next") return 0x40de
37+
if (channel === "local") return 0x40df
38+
return 10_000 + (Number.parseInt(Hash.fast(channel).slice(0, 8), 16) % 35_000)
39+
}
3540
if (channel === "latest" || channel === "dev" || channel === "beta" || channel === "next") return 0xc0de
3641
if (channel === "local") return 0xc0df
3742
return 10_000 + (Number.parseInt(Hash.fast(channel).slice(0, 8), 16) % 50_000)
3843
}
3944

4045
export function legacyFilename(channel = OPENCODE_CHANNEL) {
41-
if (channel === "latest" || channel === "local") return
46+
if (channel === "latest" || channel === "local") return undefined
4247
return `service-${Hash.fast(channel)}.json`
4348
}
4449

‎packages/cli/test/service.test.ts‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ import { ServiceRegistration } from "../src/services/service-registration"
1212
import { isolatedEnv } from "./fixture/environment"
1313

1414
test("managed service ports are stable per installation channel", () => {
15-
expect(ServiceConfig.defaultPort("latest")).toBe(0xc0de)
16-
expect(ServiceConfig.defaultPort("dev")).toBe(0xc0de)
17-
expect(ServiceConfig.defaultPort("beta")).toBe(0xc0de)
18-
expect(ServiceConfig.defaultPort("next")).toBe(0xc0de)
19-
expect(ServiceConfig.defaultPort("local")).toBe(0xc0df)
15+
const expectedDefault = process.platform === "win32" ? 0x40de : 0xc0de
16+
const expectedLocal = process.platform === "win32" ? 0x40df : 0xc0df
17+
expect(ServiceConfig.defaultPort("latest")).toBe(expectedDefault)
18+
expect(ServiceConfig.defaultPort("dev")).toBe(expectedDefault)
19+
expect(ServiceConfig.defaultPort("beta")).toBe(expectedDefault)
20+
expect(ServiceConfig.defaultPort("next")).toBe(expectedDefault)
21+
expect(ServiceConfig.defaultPort("local")).toBe(expectedLocal)
2022
expect(ServiceConfig.defaultPort("preview-a")).toBe(ServiceConfig.defaultPort("preview-a"))
2123
expect(ServiceConfig.defaultPort("preview-a")).not.toBe(ServiceConfig.defaultPort("preview-b"))
2224
})
@@ -382,6 +384,33 @@ test("unrelated managed port occupancy reports an actionable conflict", async ()
382384
}
383385
}, 30_000)
384386

387+
test("service ensure surfaces managed port conflict in error", async () => {
388+
const root = await fs.mkdtemp(path.join(os.tmpdir(), "opencode-service-ensure-conflict-"))
389+
const listener = Bun.serve({ hostname: "127.0.0.1", port: 0, fetch: () => new Response("unrelated") })
390+
const port = listener.port
391+
const registration = path.join(root, "state", "opencode", "service-local.json")
392+
await fs.mkdir(path.join(root, "config", "opencode"), { recursive: true })
393+
await fs.writeFile(path.join(root, "config", "opencode", "service-local.json"), JSON.stringify({ port }))
394+
const env = serviceEnv(root)
395+
try {
396+
const error = await Effect.runPromise(
397+
Service.ensure({
398+
file: registration,
399+
env,
400+
command: [process.execPath, path.join(import.meta.dir, "../src/index.ts"), "serve", "--service"],
401+
}).pipe(
402+
Effect.flip,
403+
Effect.provide(NodeFileSystem.layer),
404+
),
405+
)
406+
expect(error.message).toContain(`Managed service port ${port} on 127.0.0.1 is already in use by another process`)
407+
expect(error.message).toContain("opencode service set port <port>")
408+
} finally {
409+
listener.stop(true)
410+
await fs.rm(root, { recursive: true, force: true })
411+
}
412+
}, 30_000)
413+
385414
test("unresponsive managed port occupancy reports a bounded conflict", async () => {
386415
const root = await fs.mkdtemp(path.join(os.tmpdir(), "opencode-service-unresponsive-conflict-"))
387416
const recognizing = Promise.withResolvers<void>()

‎packages/client/src/effect/service.ts‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export const ensure = Effect.fn("service.ensure")(function* (options: EnsureOpti
5454
const timing = ensureTiming(options)
5555
const contenders = new Set<ServiceContender>()
5656
let timeouts: { readonly info: Info; readonly count: number } | undefined
57+
let lastFailure: Error | undefined
5758
let announced = false
5859
let lastSpawn = 0
5960
let spawnDelay = timing.spawnDelay
@@ -115,13 +116,14 @@ export const ensure = Effect.fn("service.ensure")(function* (options: EnsureOpti
115116

116117
const finished = [...contenders].filter(contenderFinished)
117118
const failure = finished.map(contenderFailure).find((error): error is Error => error !== undefined)
119+
if (failure !== undefined) lastFailure = failure
118120
if (finished.some((item) => item.child.exitCode === 0)) {
119121
spawnDelay = Math.min(spawnDelay * 2, timing.maxSpawnDelay)
120122
}
121123
finished.forEach((item) => contenders.delete(item))
122-
if (failure !== undefined && contenders.size === 0) return yield* Effect.fail(failure)
124+
if (lastFailure !== undefined && contenders.size === 0) return yield* Effect.fail(lastFailure)
123125
// Keep one candidate plus one lock probe so a pre-lock stall cannot block recovery.
124-
if (contenders.size < 2 && Date.now() - lastSpawn >= spawnDelay) {
126+
if (lastFailure === undefined && contenders.size < 2 && Date.now() - lastSpawn >= spawnDelay) {
125127
yield* announce("missing")
126128
contenders.add(yield* spawnContender)
127129
lastSpawn = Date.now()
@@ -134,8 +136,10 @@ export const ensure = Effect.fn("service.ensure")(function* (options: EnsureOpti
134136
}),
135137
Effect.ensuring(Effect.sync(() => contenders.forEach((contender) => contender.release()))),
136138
)
137-
if (Option.isNone(found))
139+
if (Option.isNone(found)) {
140+
if (lastFailure !== undefined) return yield* Effect.fail(lastFailure)
138141
return yield* Effect.fail(new Error("Timed out waiting for the background service to start"))
142+
}
139143
return found.value.endpoint
140144
})
141145

‎packages/client/src/promise/service.ts‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ export async function ensure(options: EnsureOptions = {}): Promise<Endpoint> {
3535
const deadline = Date.now() + timing.promiseTimeout
3636
const contenders = new Set<ServiceContender>()
3737
let timeouts: { readonly info: Info; readonly count: number } | undefined
38+
let lastFailure: Error | undefined
3839
let announced = false
3940
let lastSpawn = 0
4041
let spawnDelay = timing.spawnDelay
@@ -56,7 +57,10 @@ export async function ensure(options: EnsureOptions = {}): Promise<Endpoint> {
5657

5758
try {
5859
while (true) {
59-
if (Date.now() >= deadline) throw new Error("Timed out waiting for the background service to start")
60+
if (Date.now() >= deadline) {
61+
if (lastFailure !== undefined) throw lastFailure
62+
throw new Error("Timed out waiting for the background service to start")
63+
}
6064
const registration = await registered(options.file, true, timing.requestTimeout)
6165
if (registration.timedOut && registration.info !== undefined) {
6266
timeouts = {
@@ -96,13 +100,14 @@ export async function ensure(options: EnsureOptions = {}): Promise<Endpoint> {
96100
if (lastSpawn === 0 && registration.info !== undefined) lastSpawn = Date.now()
97101
const finished = [...contenders].filter(contenderFinished)
98102
const failure = finished.map(contenderFailure).find((error) => error !== undefined)
103+
if (failure !== undefined) lastFailure = failure
99104
if (finished.some((item) => item.child.exitCode === 0)) {
100105
spawnDelay = Math.min(spawnDelay * 2, timing.maxSpawnDelay)
101106
}
102107
finished.forEach((item) => contenders.delete(item))
103-
if (failure !== undefined && contenders.size === 0) throw failure
108+
if (lastFailure !== undefined && contenders.size === 0) throw lastFailure
104109
// Keep one candidate plus one lock probe so a pre-lock stall cannot block recovery.
105-
if (contenders.size < 2 && Date.now() - lastSpawn >= spawnDelay) {
110+
if (lastFailure === undefined && contenders.size < 2 && Date.now() - lastSpawn >= spawnDelay) {
106111
announce("missing")
107112
contenders.add(await spawnContender())
108113
lastSpawn = Date.now()

‎packages/client/src/service-contender.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,22 @@ export function spawnServiceContender(
1717
): ServiceContender {
1818
const child = spawn(command, args, {
1919
detached: true,
20-
stdio: ["ignore", "ignore", "pipe"],
20+
stdio: ["ignore", "pipe", "pipe"],
2121
env: { ...process.env, ...env },
2222
})
2323
let error: Error | undefined
2424
let closed = false
2525
let stderr = Buffer.alloc(0)
26-
const onStderr = (chunk: Buffer) => {
26+
const onData = (chunk: Buffer) => {
2727
const tail = chunk.subarray(-stderrLimit)
2828
stderr =
2929
tail.length === stderrLimit
3030
? Buffer.from(tail)
3131
: Buffer.concat([stderr.subarray(-(stderrLimit - tail.length)), tail])
3232
}
33-
child.stderr?.on("data", onStderr)
33+
child.stdout?.on("data", onData)
34+
child.stderr?.on("data", onData)
35+
if (child.stdout !== null && "unref" in child.stdout && typeof child.stdout.unref === "function") child.stdout.unref()
3436
if (child.stderr !== null && "unref" in child.stderr && typeof child.stderr.unref === "function") child.stderr.unref()
3537
child.once("error", (cause) => {
3638
error = new Error("Failed to start server", { cause })
@@ -45,7 +47,9 @@ export function spawnServiceContender(
4547
closed: () => closed,
4648
stderr: () => stderr.toString("utf8").trim(),
4749
release: () => {
48-
child.stderr?.off("data", onStderr)
50+
child.stdout?.off("data", onData)
51+
child.stdout?.resume()
52+
child.stderr?.off("data", onData)
4953
child.stderr?.resume()
5054
stderr = Buffer.alloc(0)
5155
},

0 commit comments

Comments
 (0)