Skip to content

Commit f88c036

Browse files
fix(client): replace a registration that no longer describes a live service
A registration can outlive the process it names: after a reboot its PID can belong to an unrelated process, and its URL can answer as a different one. The previous commit held back any live owner, so such a registration was never replaced and ensure() waited until promiseTimeout. Recruitment now depends on what the poll learned. Only an owner that did not answer, either by timing out or across a suspend, holds its port for the recovery window. A dead or refusing owner gets one spawn delay and then a replacement, as before. Measure the unresponsive window on the monotonic clock, so a wall-clock jump on resume cannot close it with a single timed-out probe. - service-contender: ownerState(info, probe, alive), shouldRecruit(OwnerState) - both clients: pass performance.now() to the recovery policy - tests: owner classification, the contender gate per state, and a registration whose PID belongs to another process (times out without this change)
1 parent 5c28849 commit f88c036

8 files changed

Lines changed: 137 additions & 19 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Effect, FileSystem, Option, Schedule, Schema } from "effect"
22
import type { DiscoverOptions, EnsureOptions, StopOptions } from "../service.js"
3-
import { contenderPool, spawnServiceContender } from "../service-contender.js"
3+
import { contenderPool, ownerState, spawnServiceContender } from "../service-contender.js"
44
import { defaultEnsureTiming, ensureTiming, type EnsureTiming } from "../service-timing.js"
55
import { matchesVersion } from "../service-version.js"
66
import { PtyHandoff } from "../pty-handoff.js"
@@ -75,7 +75,7 @@ export const ensure = Effect.fn("service.ensure")(function* (options: EnsureOpti
7575
const service = registration.service
7676
const ownerAlive = yield* alive(info?.pid)
7777
const unresponsive = recovery.observe({
78-
now: Date.now(),
78+
now: performance.now(),
7979
info,
8080
timedOut: registration.timedOut,
8181
stalled: registration.stalled,
@@ -112,7 +112,7 @@ export const ensure = Effect.fn("service.ensure")(function* (options: EnsureOpti
112112

113113
const failed = pool.reap()
114114
if (failed !== undefined) return yield* Effect.fail(failed)
115-
if (pool.shouldRecruit(info === undefined ? "absent" : ownerAlive ? "alive" : "dead")) {
115+
if (pool.shouldRecruit(ownerState(info, registration, ownerAlive))) {
116116
yield* announce("missing")
117117
pool.add(yield* spawnContender)
118118
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { readFile, rm } from "node:fs/promises"
22
import type { DiscoverOptions, Endpoint, Info, EnsureOptions, StopOptions } from "../service.js"
3-
import { contenderPool, spawnServiceContender } from "../service-contender.js"
3+
import { contenderPool, ownerState, spawnServiceContender } from "../service-contender.js"
44
import { defaultEnsureTiming, ensureTiming, type EnsureTiming } from "../service-timing.js"
55
import { matchesVersion } from "../service-version.js"
66
import { PtyHandoff } from "../pty-handoff.js"
@@ -56,7 +56,7 @@ export async function ensure(options: EnsureOptions = {}): Promise<Endpoint> {
5656
const info = registration.info
5757
const ownerAlive = info === undefined ? false : !stopped(info.pid)
5858
const unresponsive = recovery.observe({
59-
now: Date.now(),
59+
now: performance.now(),
6060
info,
6161
timedOut: registration.timedOut,
6262
stalled: registration.stalled,
@@ -93,7 +93,7 @@ export async function ensure(options: EnsureOptions = {}): Promise<Endpoint> {
9393
} else {
9494
const failed = pool.reap()
9595
if (failed !== undefined) throw failed
96-
if (pool.shouldRecruit(info === undefined ? "absent" : ownerAlive ? "alive" : "dead")) {
96+
if (pool.shouldRecruit(ownerState(info, registration, ownerAlive))) {
9797
announce("missing")
9898
pool.add(await spawnContender())
9999
}

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

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { spawn, type ChildProcess } from "node:child_process"
2+
import type { Info } from "./service.js"
23
import type { EnsureTiming } from "./service-timing.js"
34

45
export type ServiceContender = {
@@ -54,6 +55,28 @@ export function spawnServiceContender(
5455
}
5556
}
5657

58+
/**
59+
* How a registered owner appears to one `ensure()` poll, which decides whether another attempt
60+
* may compete with it.
61+
*/
62+
export type OwnerState = "absent" | "unanswered" | "gone" | "refusing"
63+
64+
/**
65+
* Classify the registered owner. Only an owner that did not answer may be silently recovering: a
66+
* probe that timed out, or one that spanned a suspend, says nothing about whether the process still
67+
* holds its port. A dead PID leaves the port free, and a registration pointing at a process that
68+
* refuses the connection (or answers as another PID) no longer describes a service at all.
69+
*/
70+
export function ownerState(
71+
info: Info | undefined,
72+
probe: { readonly timedOut: boolean; readonly stalled: boolean },
73+
alive: boolean,
74+
): OwnerState {
75+
if (info === undefined) return "absent"
76+
if (!alive) return "gone"
77+
return probe.timedOut || probe.stalled ? "unanswered" : "refusing"
78+
}
79+
5780
/**
5881
* The startup attempts of one `ensure()` call. It keeps at most two attempts alive, remembers
5982
* the first startup failure, and backs off when attempts exit cleanly because another one won.
@@ -101,14 +124,15 @@ export function contenderPool(timing: EnsureTiming) {
101124
return contenders.size === 0 ? failure : undefined
102125
},
103126
/**
104-
* Whether to start another attempt now. A live owner holds its port, so a contender could only
105-
* fail to bind it and report that failure for the whole `ensure()`. An owner that is gone leaves
106-
* the port free and waits one spawn delay before an attempt competes with its exit.
127+
* Whether to start another attempt now. An unanswered owner holds its port and may still be
128+
* recovering (from a suspend, for example), so only the recovery window may replace it. A gone
129+
* owner leaves the port free, and a refusing one is no longer the service the registration
130+
* describes; both wait one spawn delay before an attempt competes.
107131
*/
108-
shouldRecruit(owner: "absent" | "alive" | "dead") {
132+
shouldRecruit(owner: OwnerState) {
109133
if (owner === "absent") return due()
110134
if (lastSpawn === 0) lastSpawn = Date.now()
111-
if (owner === "alive") return false
135+
if (owner === "unanswered") return false
112136
return due()
113137
},
114138
add(contender: ServiceContender) {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import type { EnsureTiming } from "./service-timing.js"
77
* process check; this module only decides when that evidence justifies replacing the service.
88
*/
99
export type Sample = {
10+
/** Monotonic timestamp (`performance.now()`): a wall-clock jump on resume must not close the window. */
1011
readonly now: number
1112
readonly info: Info | undefined
1213
readonly timedOut: boolean

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ export type EnsureTiming = {
33
readonly requestTimeout: number
44
// How long a live but silent service stays registered before the client replaces it. A resume from sleep
55
// can leave probes unanswered while the process is healthy, so this window must outlast that recovery.
6+
// The policy measures it on the monotonic clock, so a wall-clock jump cannot close it early.
67
readonly unresponsiveAfter: number
78
readonly spawnDelay: number
89
readonly maxSpawnDelay: number

‎packages/client/test/promise-service.test.ts‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,41 @@ test("replaces a registered service whose process is gone without waiting for th
270270
expect(endpoint.url).toBe(replacement.url)
271271
})
272272

273+
test("replaces a registration whose PID belongs to another process", async () => {
274+
await using fixture = await serviceFixture()
275+
const registration = fixture.registration
276+
// What a registration looks like after a reboot: its URL answers as a different process, and the
277+
// recorded PID was handed to something unrelated, so nothing in it describes a reachable service.
278+
const unrelated = Bun.spawn([process.execPath, "-e", "setTimeout(() => {}, 30_000)"], {
279+
stdout: "ignore",
280+
stderr: "ignore",
281+
})
282+
const stranger = Bun.serve({ port: 0, fetch: () => Response.json({ version: "test", pid: process.pid }) })
283+
try {
284+
await writeFile(
285+
registration,
286+
JSON.stringify({
287+
id: crypto.randomUUID(),
288+
version: "test",
289+
url: stranger.url.toString(),
290+
pid: unrelated.pid,
291+
password: "private",
292+
}),
293+
)
294+
295+
const endpoint = await ensure({ file: registration, version: "test", command: fixture.command("delayed", "10") })
296+
const replacement = await Bun.file(registration).json()
297+
fixture.track(replacement.pid)
298+
299+
expect(replacement.pid).not.toBe(unrelated.pid)
300+
expect(endpoint.url).toBe(replacement.url)
301+
} finally {
302+
stranger.stop(true)
303+
unrelated.kill("SIGKILL")
304+
await unrelated.exited
305+
}
306+
})
307+
273308
test("recovers when the starting service it waits for is stopped", async () => {
274309
await using fixture = await serviceFixture()
275310
const registration = fixture.registration

‎packages/client/test/service-contender-pool.test.ts‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { afterEach, expect, test } from "bun:test"
22
import {
33
contenderFinished,
44
contenderPool,
5+
ownerState,
56
type ServiceContender,
67
spawnServiceContender,
78
} from "../src/service-contender"
@@ -50,21 +51,40 @@ test("evicting a replaced owner forgets its failure and restarts the spawn clock
5051
expect(owner.child.exitCode).toBeNull()
5152
})
5253

53-
test("a gone owner gets one spawn delay, and a live owner is never contested", () => {
54+
test("a live owner that stops answering is never contested, and other owners get one spawn delay", () => {
5455
const timing = { ...defaultEnsureTiming, spawnDelay: 60_000 }
5556
expect(contenderPool(timing).shouldRecruit("absent")).toBe(true)
5657

5758
const dead = contenderPool(timing)
58-
expect(dead.shouldRecruit("dead")).toBe(false)
59+
expect(dead.shouldRecruit("gone")).toBe(false)
5960
dead.recruitNow()
60-
expect(dead.shouldRecruit("dead")).toBe(true)
61+
expect(dead.shouldRecruit("gone")).toBe(true)
6162

6263
// A live owner holds its port, so an attempt could only fail to bind and report that as the
63-
// startup failure of the whole ensure().
64-
const live = contenderPool(timing)
65-
expect(live.shouldRecruit("alive")).toBe(false)
66-
live.recruitNow()
67-
expect(live.shouldRecruit("alive")).toBe(false)
64+
// startup failure of the whole ensure(). Only the recovery window may replace it.
65+
const unanswered = contenderPool(timing)
66+
expect(unanswered.shouldRecruit("unanswered")).toBe(false)
67+
unanswered.recruitNow()
68+
expect(unanswered.shouldRecruit("unanswered")).toBe(false)
69+
70+
// A registration whose PID belongs to another process is no owner at all: it gets one spawn
71+
// delay and then a replacement, as before.
72+
const refusing = contenderPool(timing)
73+
expect(refusing.shouldRecruit("refusing")).toBe(false)
74+
refusing.recruitNow()
75+
expect(refusing.shouldRecruit("refusing")).toBe(true)
76+
})
77+
78+
test("classifies a registered owner by what the probe learned", () => {
79+
const owner = { id: "owner", url: "http://127.0.0.1:4096", pid: 4242 }
80+
const answered = { timedOut: false, stalled: false }
81+
82+
expect(ownerState(undefined, answered, false)).toBe("absent")
83+
expect(ownerState(owner, answered, false)).toBe("gone")
84+
expect(ownerState(owner, { timedOut: true, stalled: false }, true)).toBe("unanswered")
85+
// A probe that spanned a suspend says nothing about the owner, so it must not be contested.
86+
expect(ownerState(owner, { timedOut: false, stalled: true }, true)).toBe("unanswered")
87+
expect(ownerState(owner, answered, true)).toBe("refusing")
6888
})
6989

7090
test("keeps at most two attempts alive", async () => {

‎packages/client/test/service.test.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,43 @@ test("replaces a registered service whose process is gone without waiting for th
243243
expect(endpoint.url).toBe(replacement.url)
244244
})
245245

246+
test("replaces a registration whose PID belongs to another process", async () => {
247+
await using fixture = await serviceFixture()
248+
const registration = fixture.registration
249+
// What a registration looks like after a reboot: its URL answers as a different process, and the
250+
// recorded PID was handed to something unrelated, so nothing in it describes a reachable service.
251+
const unrelated = Bun.spawn([process.execPath, "-e", "setTimeout(() => {}, 30_000)"], {
252+
stdout: "ignore",
253+
stderr: "ignore",
254+
})
255+
const stranger = Bun.serve({ port: 0, fetch: () => Response.json({ version: "test", pid: process.pid }) })
256+
try {
257+
await writeFile(
258+
registration,
259+
JSON.stringify({
260+
id: crypto.randomUUID(),
261+
version: "test",
262+
url: stranger.url.toString(),
263+
pid: unrelated.pid,
264+
password: "private",
265+
}),
266+
)
267+
268+
const endpoint = await run(
269+
ensure({ file: registration, version: "test", command: fixture.command("delayed", "10") }),
270+
)
271+
const replacement = await Bun.file(registration).json()
272+
fixture.track(replacement.pid)
273+
274+
expect(replacement.pid).not.toBe(unrelated.pid)
275+
expect(endpoint.url).toBe(replacement.url)
276+
} finally {
277+
stranger.stop(true)
278+
unrelated.kill("SIGKILL")
279+
await unrelated.exited
280+
}
281+
})
282+
246283
test("signals an unresponsive registered service process", async () => {
247284
await using fixture = await serviceFixture()
248285
const registration = fixture.registration

0 commit comments

Comments
 (0)