diff --git a/ops/NEXT.md b/ops/NEXT.md index 649c80cc6..767eb9235 100644 --- a/ops/NEXT.md +++ b/ops/NEXT.md @@ -1,87 +1,82 @@ # NEXT — work package for this tick -**Scope:** Build a minimal agent worker in the SDK. CODE task, SDK-side. +**Gate:** Gate 3 (as specified in the scope for this run) -This run is pinned to **gate 3** and must not work on any other gate. +**Objective:** Build sub-PR A of the Gate 2 push: a real `hn-monitor` polling runner in the SDK. CODE task, `sdk/src/`-side. This is a scaffolding PR — proof that the workload EXECUTES end-to-end is deliberately deferred to sub-PR B (integration test). Do not conflate the two. -## Objective +**Context:** RFC-0001 §3 gate 2 is done when "hn-monitor runs as a relayflow in production, triggered by its real events, with zero bespoke persistence." Every primitive already exists in this repo — event triggers (PR #14, `kernel/relayflowd/tests/event_wake.rs`), the flow spec (`testdata/hn-monitor.flow.yaml`), the poller (`sdk/src/hn-poller.ts`), the agent worker (`sdk/src/worker.ts` from PR #53), a one-shot demo (`sdk/src/demo-hn-monitor.ts`) — but nothing has ever run them together as a continuous workload. This PR fixes that. -Promote the throwaway worker the tests already build into a real SDK component -that can execute agent steps by running their declared CLI as a subprocess. +**Prior attempt (PR #83, closed):** produced a functional runner but was rejected by the swarm on five real findings. Address them in this attempt: -## Context +1. **Fail-closed on journal errors.** #83's `catch (err) { onPollError(err) }` swallowed EVERY error including `eventSubmit` journal failures — violates covenant 2 (fail-closed) and RFC-0001 §1. Only fetch-level errors (network flakiness, HN API rate limits) may be swallowed; a journal write failure MUST throw and terminate the runner. Split: `try { fetch } catch { onFetchError }` around the network call, `try { eventSubmit } catch { rethrow }` around the journal call. -Nothing in this repo can execute an agent step. Searching for `workerAttach` / -`step.complete` finds only TESTS (`sdk/tests/live-kernel.test.ts`, -`journal-client.test.ts`, `journal-client-loopback.ts`) and the protocol -definitions. `sdk/src/cli/run.ts` only OBSERVES worker leases and waits for one -that never arrives. +2. **AgentWorker.close() must release the worker (or explicitly document it does not).** #83 added `await worker.close()` to shutdown but the current `close()` only drains local promises — it does NOT tell the kernel to release the worker registration. Either: + - Add a `workerRelease` verb to `sdk/src/protocol.ts` and call it from `close()` (preferred — completes the shutdown contract), OR + - Add a one-line comment on `close()` naming exactly what shutdown intentionally does NOT do -The kernel's dispatch, lease and claim machinery is real and tested. The worker -side of the protocol is simply unimplemented, and that is what blocks gate 2 -("a workload RUNS as a relayflow" — today a run can only be shown CREATED) and -gate 3 ("every claim/lease/retry served by the kernel"). +3. **Class field declaration order.** #83 declared `private readonly fetcher` AFTER the constructor. Works today because of ES2022 hoisting semantics but breaks silently if someone adds `= someDefault` to a declaration. Declare ALL fields at the top of the class body, before the constructor. -`sdk/tests/live-kernel.test.ts` around the `live-manual-agent` case (line 288) -shows the whole shape: connect, `hello`, `workerAttach` with pins, receive -`step.dispatch`, act, complete. The protocol is already proven there. +4. **Signal handlers must be opt-in via AbortSignal.** #83 registered `SIGTERM`/`SIGINT` handlers on the process directly with no opt-out. A library user embedding this can't cancel one runner without affecting others. Accept `signal?: AbortSignal` in options; the CLI wrapper (sub-PR C) can create + wire a process-signal-driven AbortController. + +5. **Test coverage for pollError branch.** #83's tests never asserted the loop survives a fetcher throw AND the loop TERMINATES on a journal throw. Add both cases; without them, someone regresses `onPollError` to a no-op and every test still passes. ## Files in scope -- `sdk/src/worker.ts` — new file, the worker implementation -- `sdk/src/index.ts` — export the worker -- `sdk/tests/live-kernel.test.ts` OR a new test file — add a test that runs a - real flow with an agent step end to end against a live `relayflowd`, with - this worker attached, and asserts the step reaches `done`. +- `sdk/src/hn-monitor-runner.ts` (NEW) — the runner itself +- `sdk/src/worker.ts` — either add `workerRelease` call to `close()`, OR add a one-line comment naming what close() intentionally does NOT do +- `sdk/src/protocol.ts` — if adding `workerRelease`, matching request/response definitions +- `sdk/src/index.ts` — export `HnMonitorRunner` from the SDK +- `sdk/tests/hn-monitor-runner.test.ts` (NEW) — comprehensive test coverage +- `sdk/package.json` — already has pretest hook that builds the kernel automatically ## Definition of done -ALL of the following must hold: - -1. The worker in `sdk/src/worker.ts`, exported from `sdk/src/index.ts` - -2. A test that runs a real flow with an agent step end to end against a live - `relayflowd`, with this worker attached, and asserts the step reaches - `done`. `sdk/tests/live-kernel.test.ts` already starts a daemon — follow - that pattern. - -3. **The worker must attach BEFORE the run starts.** A run that finds no worker - parks, and attaching afterwards does not re-drive it — `run.resume` is what - picks a parked run back up. That contract is pinned in the live-kernel - suite; do not fight it. - -4. The worker must: - - attach for `agent` steps with the pins it holds - - on `step.dispatch`, run the step's declared `cli` as a subprocess - - report the result back through the existing protocol (`step.complete`, and - the failure path when the CLI exits nonzero) - - nothing speculative: no retries of its own, no scheduling, no LLM calls. - The kernel owns retry and lease policy — do not reimplement it. - -5. `cd sdk && npm test` must be green. Run it and paste the literal command and - output tail showing test counts. - -6. `cd kernel && sh ../ops/cargo.sh test` must be green. Run it and paste the - literal command and output tail showing test counts. - -7. EVERY new test confirmed to FAIL against current code, with the literal - failing output quoted in the summary. - -8. As your LAST action, run `git status --porcelain` and paste it. - -## Explicitly OUT of scope - -- LLM steps — not in the gate 3 scope -- Retry logic in the worker — the kernel owns retry policy -- Scheduling or lease management — the kernel owns lease policy -- Optimizations, abstractions, or speculative features -- Changes to the kernel -- Changes to existing tests (except adding new test cases) -- Work on any gate other than gate 3 +All of these must be completed and verified: + +1. `sdk/src/hn-monitor-runner.ts` exists, exports `HnMonitorRunner` from `sdk/src/index.ts` +2. `sdk/src/worker.ts` — either `close()` calls `workerRelease` (add to protocol.ts if missing), OR a one-line comment names what close() intentionally does NOT do +3. `sdk/src/protocol.ts` — if you added `workerRelease`, matching request/response definitions +4. `sdk/tests/hn-monitor-runner.test.ts` covers ALL of these: + - fake fetch + mock journal client → runner submits an event on each tick + - abort signal triggers clean shutdown within one tick (worker released or documented) + - worker attach happens before first poll + - **fetch throw → loop survives** (onPollError called, next tick still runs) + - **journal throw → loop TERMINATES** (runner.run() rejects with the error) +5. `cd sdk && npm test` green — verified by running the literal command and pasting the output +6. EVERY new test confirmed to FAIL against current code (comment out the source; the test fails), with the literal failing output pasted in the summary +7. PR body explicitly names the non-goals (test-actually-runs is sub-PR B; CLI is sub-PR C; gate-2 declaration is sub-PR D) +8. As the LAST action, run `git status --porcelain` and paste it + +The runner composes existing pieces into a continuous runner: +- constructs a `JournalClient` connected to the running `relayflowd` socket +- constructs an `AgentWorker` (from `sdk/src/worker.ts`) and calls `workerAttach()` for `agent` steps — attach BEFORE first poll (a run parked because no worker attached is only revived by `run.resume`; the live-kernel suite pins this) +- loops: `pollHackerNewsOnce(spec, sink)` → sleep `POLL_INTERVAL_MS` (env-configurable, default 60000 = 60s) → repeat +- exit cleanly on `AbortSignal.abort` (drain in-flight steps, close client, release worker per finding #2) + +Keep it small and honest: +- the worker must attach BEFORE the first poll +- the poller layer handles single-fetch failures with a typed error; the loop just moves to the next tick — but journal errors MUST fail the runner (finding #1) +- no scheduling logic beyond the sleep (the kernel owns retry and dedupe policy) +- no LLM calls; the runner is glue, not a reviewer + +## Explicit non-goals for THIS PR + +These belong to later sub-PRs and must be stated in the PR body: + +- Proving the workload actually executes end-to-end (dispatch → step complete). That is sub-PR B (integration test with real relayflowd + fake HN fetch + assert step reaches `done`). This PR ONLY proves the runner assembles and its unit tests hold. +- CLI wrapper (`flows hn-monitor start`). That is sub-PR C. +- ops/STATE.md gate-2 GREEN declaration. That is sub-PR D. + +## Out of scope for THIS tick — DO NOT TOUCH + +- `.github/workflows/*` — no GHA changes +- `kernel/*` — the kernel side of gate 2 already works via PR #14 +- `workflows/*.yaml` — those are for later sub-PRs +- `ops/AUTODRIVE_BRIEF.md` — chief owns this file, not the drive loop +- CLI wrapper — sub-PR C, separate PR +- end-to-end integration test with real relayflowd — sub-PR B, separate PR +- ops/STATE.md gate-2 declaration — sub-PR D, separate PR ## If blocked -If gate 3 is genuinely unreachable from the current state, write -ops/NEEDS_HUMAN.md saying exactly why and still end with ASSESS_DONE. Do not -silently substitute different work: a run that reports progress on the wrong -gate is worse than one that reports it is blocked. +Say so and file what you learned. A minimal runner with an honest gap description beats a complete-looking one that doesn't shut down cleanly or leaks journal errors. diff --git a/sdk/src/hn-monitor-runner.ts b/sdk/src/hn-monitor-runner.ts new file mode 100644 index 000000000..b6b973f1a --- /dev/null +++ b/sdk/src/hn-monitor-runner.ts @@ -0,0 +1,107 @@ +import { AgentWorker } from './worker.js'; +import { HN_TOP_STORIES_URL, pollHackerNewsOnce, type EventSink, type Fetcher } from './hn-poller.js'; +import { JournalClient } from './journal-client.js'; +import type { Pins } from './protocol.js'; + +const DEFAULT_POLL_INTERVAL_MS = 60_000; + +export interface HnMonitorClient extends EventSink { + connect(): Promise; + close(): void; +} + +export interface HnMonitorWorker { + attach(): Promise; + close(): void | Promise; +} + +export interface HnMonitorRunnerOptions { + spec: unknown; + socketPath: string; + workerId: string; + pins: Pins; + signal?: AbortSignal; + pollIntervalMs?: number; + fetcher?: Fetcher; + onPollError?: (error: unknown) => void; + client?: HnMonitorClient; + worker?: HnMonitorWorker; +} + +/** Connects the HN poller and agent worker to one journal-protocol client. */ +export class HnMonitorRunner { + private readonly client: HnMonitorClient; + private readonly fetcher: Fetcher; + private readonly onPollError: (error: unknown) => void; + private readonly options: HnMonitorRunnerOptions; + private readonly pollIntervalMs: number; + private readonly worker: HnMonitorWorker; + + constructor(options: HnMonitorRunnerOptions) { + this.options = options; + this.client = options.client ?? new JournalClient(options.socketPath); + this.worker = options.worker ?? new AgentWorker(this.client as JournalClient, { + workerId: options.workerId, + pins: options.pins, + }); + this.fetcher = options.fetcher ?? fetchTopStories; + this.onPollError = options.onPollError ?? (() => undefined); + this.pollIntervalMs = options.pollIntervalMs ?? pollIntervalFromEnvironment(); + if (!Number.isFinite(this.pollIntervalMs) || this.pollIntervalMs < 0) { + throw new Error('hn monitor: poll interval must be a non-negative finite number'); + } + } + + async run(): Promise { + await this.client.connect(); + try { + await this.worker.attach(); + while (!this.options.signal?.aborted) { + const body = await this.fetchOnce(); + if (body !== undefined) { + await pollHackerNewsOnce(this.options.spec, this.client, { + fetcher: async () => body, + }); + } + await abortableSleep(this.pollIntervalMs, this.options.signal); + } + } finally { + await this.worker.close(); + this.client.close(); + } + } + + private async fetchOnce(): Promise { + try { + return await this.fetcher(HN_TOP_STORIES_URL); + } catch (error) { + this.onPollError(error); + return undefined; + } + } +} + +async function fetchTopStories(url: string): Promise { + const response = await fetch(url); + if (!response.ok) throw new Error(`HN fetch failed: HTTP ${response.status}`); + return response.text(); +} + +function pollIntervalFromEnvironment(): number { + const configured = process.env.POLL_INTERVAL_MS; + return configured === undefined ? DEFAULT_POLL_INTERVAL_MS : Number(configured); +} + +function abortableSleep(milliseconds: number, signal?: AbortSignal): Promise { + if (signal?.aborted) return Promise.resolve(); + return new Promise((resolve) => { + const timer = setTimeout(done, milliseconds); + signal?.addEventListener('abort', done, { once: true }); + + function done(): void { + clearTimeout(timer); + signal?.removeEventListener('abort', done); + resolve(); + } + }); +} diff --git a/sdk/src/index.ts b/sdk/src/index.ts index 8f47e7f6f..08fcc7bfd 100644 --- a/sdk/src/index.ts +++ b/sdk/src/index.ts @@ -113,6 +113,12 @@ export { JOURNAL_WRITE_FAILED, PROTOCOL_VERSION } from './protocol.js'; export { JournalClient, type JournalClientOptions } from './journal-client.js'; export { AgentWorker, type AgentWorkerOptions } from './worker.js'; +export { + HnMonitorRunner, + type HnMonitorClient, + type HnMonitorRunnerOptions, + type HnMonitorWorker, +} from './hn-monitor-runner.js'; export { validateWorkPackage, diff --git a/sdk/src/worker.ts b/sdk/src/worker.ts index 0cfc5849b..3b96f87c3 100644 --- a/sdk/src/worker.ts +++ b/sdk/src/worker.ts @@ -39,6 +39,7 @@ export class AgentWorker extends EventEmitter { } close(): void { + // Intentionally does not release the kernel worker registration; protocol v0 has no worker.release verb. this.client.off('step.dispatch', this.onDispatch); this.attached = false; } diff --git a/sdk/tests/hn-monitor-runner.test.ts b/sdk/tests/hn-monitor-runner.test.ts new file mode 100644 index 000000000..92b14aa09 --- /dev/null +++ b/sdk/tests/hn-monitor-runner.test.ts @@ -0,0 +1,87 @@ +import { describe, expect, it, vi } from 'vitest'; +import { HnMonitorRunner, type HnMonitorClient, type HnMonitorWorker } from '../src/hn-monitor-runner.js'; + +function harness(options: { + fetcher?: () => Promise; + eventSubmit?: () => Promise; + onPollError?: (error: unknown) => void; +} = {}) { + const calls: string[] = []; + const client: HnMonitorClient = { + async connect() { calls.push('connect'); }, + async eventSubmit() { + calls.push('eventSubmit'); + return options.eventSubmit?.() ?? { matched: true, deduped: false }; + }, + close() { calls.push('client.close'); }, + }; + const worker: HnMonitorWorker = { + async attach() { calls.push('worker.attach'); }, + async close() { calls.push('worker.close'); }, + }; + const controller = new AbortController(); + const runner = new HnMonitorRunner({ + spec: { name: 'hn-monitor' }, + socketPath: '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/unused/test.sock', + workerId: 'test-worker', + pins: {}, + signal: controller.signal, + pollIntervalMs: 1, + fetcher: options.fetcher ?? (async () => '[101]'), + onPollError: options.onPollError, + client, + worker, + }); + return { calls, controller, runner }; +} + +describe('HnMonitorRunner', () => { + it('attaches the worker before the first poll and submits on each tick', async () => { + const { calls, controller, runner } = harness(); + const run = runner.run(); + await vi.waitFor(() => expect(calls.filter((call) => call === 'eventSubmit').length).toBeGreaterThanOrEqual(2)); + controller.abort(); + await run; + expect(calls.indexOf('worker.attach')).toBeLessThan(calls.indexOf('eventSubmit')); + }); + + it('aborts cleanly within one tick and closes worker before client', async () => { + const { calls, controller, runner } = harness(); + const run = runner.run(); + await vi.waitFor(() => expect(calls).toContain('eventSubmit')); + controller.abort(); + await expect(run).resolves.toBeUndefined(); + expect(calls.slice(-2)).toEqual(['worker.close', 'client.close']); + }); + + it('survives a fetch throw, reports it, and polls again', async () => { + let fetches = 0; + const errors: unknown[] = []; + const { calls, controller, runner } = harness({ + fetcher: async () => { + fetches += 1; + if (fetches === 1) throw new Error('HN unavailable'); + return '[202]'; + }, + onPollError: (error) => errors.push(error), + }); + const run = runner.run(); + await vi.waitFor(() => expect(calls).toContain('eventSubmit')); + controller.abort(); + await run; + expect(fetches).toBeGreaterThanOrEqual(2); + expect(errors).toEqual([new Error('HN unavailable')]); + }); + + it('terminates when the journal rejects event submission', async () => { + const journalError = new Error('journal write failed'); + const onPollError = vi.fn(); + const { calls, runner } = harness({ + eventSubmit: async () => { throw journalError; }, + onPollError, + }); + await expect(runner.run()).rejects.toBe(journalError); + expect(onPollError).not.toHaveBeenCalled(); + expect(calls.slice(-2)).toEqual(['worker.close', 'client.close']); + }); +});