docs(agent): call agent step an extension point

This commit is contained in:
_Kerman
2026-07-27 17:24:20 +08:00
parent e3a7836e4b
commit 7d5cc498d3
5 changed files with 15 additions and 15 deletions

View File

@@ -304,14 +304,14 @@ Source: [`packages/core/agent/src/types.ts:254`](../../packages/core/agent/src/t
### `agent/step` — serial ### `agent/step` — serial
Awaited serial checkpoint before EVERY request of a turn is built (the first as well as each post-tools continuation). The single "between steps" seam: inject context, steer, or edit the session log here — the request's history derives from the log right after this settles. Awaited serial checkpoint before EVERY request of a turn is built (the first as well as each post-tools continuation). The single "between steps" extension point: inject context, steer, or edit the session log here — the request's history derives from the log right after this settles.
```ts cordis-catalog ```ts cordis-catalog
/** /**
* Awaited serial checkpoint before EVERY request of a turn is built (the * Awaited serial checkpoint before EVERY request of a turn is built (the
* first as well as each post-tools continuation). The single "between * first as well as each post-tools continuation). The single "between
* steps" seam: inject context, steer, or edit the session log here — the * steps" extension point: inject context, steer, or edit the session log
* request's history derives from the log right after this settles. * here — the request's history derives from the log right after this settles.
* @param agent - the agent about to send a request. * @param agent - the agent about to send a request.
* @param turn - the open turn number. * @param turn - the open turn number.
* @param step - the step number about to open. * @param step - the step number about to open.

View File

@@ -1066,7 +1066,7 @@ export const EVENT_API: readonly EventApiEntry[] = [
name: 'agent/step', name: 'agent/step',
mode: 'serial', mode: 'serial',
signature: '\'agent/step\'(this: Scoped<Agent>, agent: Agent, turn: number, step: number, signal: AbortSignal): Promise<void> | void', signature: '\'agent/step\'(this: Scoped<Agent>, agent: Agent, turn: number, step: number, signal: AbortSignal): Promise<void> | void',
jsDoc: '/**\n * Awaited serial checkpoint before EVERY request of a turn is built (the\n * first as well as each post-tools continuation). The single "between\n * steps" seam: inject context, steer, or edit the session log here — the\n * request\'s history derives from the log right after this settles.\n * @param agent - the agent about to send a request.\n * @param turn - the open turn number.\n * @param step - the step number about to open.\n * @param signal - the turn abort signal.\n * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent.\n * @mode serial\n */', jsDoc: '/**\n * Awaited serial checkpoint before EVERY request of a turn is built (the\n * first as well as each post-tools continuation). The single "between\n * steps" extension point: inject context, steer, or edit the session log\n * here — the request\'s history derives from the log right after this settles.\n * @param agent - the agent about to send a request.\n * @param turn - the open turn number.\n * @param step - the step number about to open.\n * @param signal - the turn abort signal.\n * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only that agent.\n * @mode serial\n */',
summary: 'Awaited serial checkpoint before EVERY request of a turn is built (the first as well as each post-tools continuation).', summary: 'Awaited serial checkpoint before EVERY request of a turn is built (the first as well as each post-tools continuation).',
}, },
{ {

View File

@@ -415,8 +415,8 @@ export class ReactLoopAgent implements Agent {
} }
/** /**
* Run the `agent/step` seam, commit pending input, derive one request, and * Run the `agent/step` extension point, commit pending input, derive one
* execute its tool calls inside one durable step boundary. * request, and execute its tool calls inside one durable step boundary.
*/ */
private async step( private async step(
turn: number, turn: number,
@@ -425,8 +425,8 @@ export class ReactLoopAgent implements Agent {
): Promise<StepOutcome> { ): Promise<StepOutcome> {
const { session } = this const { session } = this
// The single between-steps seam: listeners inject, steer, or edit the log // The single between-steps extension point: listeners inject, steer, or
// here; the request derives from the log after this settles. // edit the log here; the request derives from the log after this settles.
await this.loopCtx.serial(agentCarrier(this), 'agent/step', this, turn, step, signal) await this.loopCtx.serial(agentCarrier(this), 'agent/step', this, turn, step, signal)
signal.throwIfAborted() signal.throwIfAborted()

View File

@@ -1221,7 +1221,7 @@ describe('disposal and cancellation during pre-step assembly', () => {
expect(reasons).toEqual([{ kind: 'aborted' }]) expect(reasons).toEqual([{ kind: 'aborted' }])
}) })
it('disposal during agent/step seam ends the turn disposed', { timeout: 15000 }, async () => { it('disposal during agent/step listeners ends the turn disposed', { timeout: 15000 }, async () => {
// Start disposal, then release pre-step; awaiting disposal first would // Start disposal, then release pre-step; awaiting disposal first would
// deadlock on the blocked driver. // deadlock on the blocked driver.
const adapter = new MockAdapter(['hang']) const adapter = new MockAdapter(['hang'])
@@ -1258,13 +1258,13 @@ describe('disposal and cancellation during pre-step assembly', () => {
await disposalDone await disposalDone
await driverDone(agent) await driverDone(agent)
// After the pre-step seam finishes, the post-seam cancel/dispose check // After the agent/step listeners finish, the post-listener cancel/dispose check
// catches disposal. The step was never opened, no LLM call was made. // catches disposal. The step was never opened, no LLM call was made.
const e = [...agent.session.events] const e = [...agent.session.events]
expect(e.filter(x => x.type === 'turn/start')).toHaveLength(1) expect(e.filter(x => x.type === 'turn/start')).toHaveLength(1)
expect(e.filter(x => x.type === 'turn/end')).toHaveLength(1) expect(e.filter(x => x.type === 'turn/end')).toHaveLength(1)
const turnEnd = e.findLast(x => x.type === 'turn/end') const turnEnd = e.findLast(x => x.type === 'turn/end')
// Disposal wins the post-seam check — reason is `disposed`. // Disposal wins the post-listener check — reason is `disposed`.
expect(turnEnd?.type === 'turn/end' && turnEnd.data.reason).toEqual({ kind: 'disposed' }) expect(turnEnd?.type === 'turn/end' && turnEnd.data.reason).toEqual({ kind: 'disposed' })
expect(e.some(x => x.type === 'step/start')).toBe(false) expect(e.some(x => x.type === 'step/start')).toBe(false)
expect(e.some(x => x.type === 'assistant/chunk')).toBe(false) expect(e.some(x => x.type === 'assistant/chunk')).toBe(false)
@@ -1272,8 +1272,8 @@ describe('disposal and cancellation during pre-step assembly', () => {
// (turn boundaries have no agent/* mirror). // (turn boundaries have no agent/* mirror).
}) })
it('cancel during agent/step seam ends the turn aborted', { timeout: 15000 }, async () => { it('cancel during agent/step listeners ends the turn aborted', { timeout: 15000 }, async () => {
// Release pre-step after cancellation to exercise the post-seam check. // Release agent/step after cancellation to exercise the post-listener check.
const adapter = new MockAdapter(['hang']) const adapter = new MockAdapter(['hang'])
let releasePreStep!: () => void let releasePreStep!: () => void
const blocker = new Promise<void>(r => void (releasePreStep = r)) const blocker = new Promise<void>(r => void (releasePreStep = r))

View File

@@ -323,8 +323,8 @@ declare module 'cordis' {
/** /**
* Awaited serial checkpoint before EVERY request of a turn is built (the * Awaited serial checkpoint before EVERY request of a turn is built (the
* first as well as each post-tools continuation). The single "between * first as well as each post-tools continuation). The single "between
* steps" seam: inject context, steer, or edit the session log here — the * steps" extension point: inject context, steer, or edit the session log
* request's history derives from the log right after this settles. * here — the request's history derives from the log right after this settles.
* @param agent - the agent about to send a request. * @param agent - the agent about to send a request.
* @param turn - the open turn number. * @param turn - the open turn number.
* @param step - the step number about to open. * @param step - the step number about to open.