experimental-a2 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/actor.js +1 -1
  3. package/dist/ai-fx.d.ts.map +1 -1
  4. package/dist/ai-fx.js +34 -4
  5. package/dist/ai-fx.js.map +1 -1
  6. package/dist/ai-harness-CV6rXbB3.d.ts.map +1 -1
  7. package/dist/{ai-harness-BuuC-gJ3.js → ai-harness-Clbg5ei7.js} +11 -2
  8. package/dist/ai-harness-Clbg5ei7.js.map +1 -0
  9. package/dist/ai-pi.js +2 -2
  10. package/dist/ai-server.d.ts.map +1 -1
  11. package/dist/ai-server.js +6 -4
  12. package/dist/ai-server.js.map +1 -1
  13. package/dist/internal-CscSY7K_.js.map +1 -1
  14. package/dist/scheduler-qstash.d.ts.map +1 -1
  15. package/dist/scheduler-qstash.js +5 -5
  16. package/dist/scheduler-qstash.js.map +1 -1
  17. package/dist/scheduler-vercel.d.ts.map +1 -1
  18. package/dist/scheduler-vercel.js +4 -3
  19. package/dist/scheduler-vercel.js.map +1 -1
  20. package/dist/server-DYAATFuT.d.ts.map +1 -1
  21. package/dist/{server-D-Y4pqwu.js → server-qyb5aJJG.js} +39 -25
  22. package/dist/server-qyb5aJJG.js.map +1 -0
  23. package/dist/server.js +1 -1
  24. package/dist/session-clear-DGI4jTQ5.js.map +1 -1
  25. package/dist/store-postgres.d.ts.map +1 -1
  26. package/dist/store-postgres.js +38 -136
  27. package/dist/store-postgres.js.map +1 -1
  28. package/docs/01-quickstart.mdx +7 -4
  29. package/docs/actors/01-introduction.mdx +1 -1
  30. package/docs/actors/meta.ts +1 -1
  31. package/docs/agents/02-tools.mdx +1 -1
  32. package/docs/agents/03-conversations.mdx +1 -1
  33. package/docs/agents/meta.ts +1 -1
  34. package/docs/client/meta.ts +1 -1
  35. package/docs/contract/03-sessions.mdx +1 -1
  36. package/docs/index.mdx +2 -2
  37. package/docs/reference/01-core.mdx +8 -8
  38. package/docs/reference/02-server.mdx +3 -3
  39. package/docs/reference/04-ai.mdx +9 -1
  40. package/docs/reference/05-telemetry.mdx +132 -0
  41. package/docs/reference/06-errors.mdx +1 -1
  42. package/docs/reference/meta.ts +1 -1
  43. package/docs/schedulers/01-overview.mdx +112 -0
  44. package/docs/schedulers/02-vercel-queues.mdx +87 -0
  45. package/docs/schedulers/03-qstash.mdx +123 -0
  46. package/docs/schedulers/meta.ts +1 -0
  47. package/docs/server/01-handlers.mdx +29 -2
  48. package/docs/server/02-timers.mdx +2 -2
  49. package/docs/server/06-guarantees.mdx +6 -3
  50. package/docs/stores/01-overview.mdx +37 -0
  51. package/docs/stores/02-redis.mdx +49 -0
  52. package/docs/stores/03-redis-http.mdx +56 -0
  53. package/docs/stores/04-postgres.mdx +121 -0
  54. package/docs/stores/05-sqlite.mdx +34 -0
  55. package/docs/stores/06-memory.mdx +22 -0
  56. package/docs/stores/meta.ts +1 -0
  57. package/examples/playground/DEPLOY.md +12 -7
  58. package/examples/playground/app/a0/apps/[appId]/route.ts +6 -10
  59. package/examples/playground/app/a0/chat.test.tsx +421 -330
  60. package/examples/playground/app/a0/shell.tsx +1 -1
  61. package/examples/playground/app/a0/uploads/route.test.ts +59 -0
  62. package/examples/playground/app/agent/[agentId]/agent-queue.test.tsx +116 -90
  63. package/examples/playground/app/agent/[agentId]/compaction-panel.test.tsx +107 -76
  64. package/examples/playground/app/agent/ingress.test.ts +41 -17
  65. package/examples/playground/app/agent/model-input.test.tsx +92 -43
  66. package/examples/playground/app/chat/[chatId]/agent-stream-drawer.test.tsx +2 -2
  67. package/examples/playground/app/chat/server.test.ts +38 -65
  68. package/examples/playground/app/components/activity-history.test.tsx +60 -18
  69. package/examples/playground/app/components/fast-link.test.tsx +3 -5
  70. package/examples/playground/app/initial-state.test.tsx +86 -45
  71. package/examples/playground/package.json +2 -1
  72. package/examples/playground/test/agent.ts +35 -0
  73. package/examples/playground/test/model.ts +149 -0
  74. package/examples/playground/test/serve.ts +184 -0
  75. package/examples/playground/test/server-only.ts +1 -0
  76. package/examples/playground/vitest.config.ts +27 -0
  77. package/package.json +3 -1
  78. package/sql/postgres/notifications.sql +24 -0
  79. package/sql/postgres/schema.sql +137 -0
  80. package/src/ai-agent.ts +5 -4
  81. package/src/ai-fx.ts +37 -3
  82. package/src/ai-harness.ts +18 -0
  83. package/src/errors.ts +1 -1
  84. package/src/internal.ts +2 -1
  85. package/src/postgres-notifications.ts +0 -22
  86. package/src/postgres-resources.ts +6 -9
  87. package/src/postgres-schema.ts +80 -0
  88. package/src/scheduler-qstash.ts +12 -5
  89. package/src/scheduler-vercel.ts +10 -4
  90. package/src/server.ts +66 -32
  91. package/src/store-postgres.ts +5 -123
  92. package/dist/ai-harness-BuuC-gJ3.js.map +0 -1
  93. package/dist/server-D-Y4pqwu.js.map +0 -1
  94. package/docs/reference/05-adapters.mdx +0 -351
  95. package/docs/server/05-production.mdx +0 -323
@@ -1,351 +0,0 @@
1
- ---
2
- title: Adapters
3
- description: "Stores, schedulers, and OpenTelemetry."
4
- ---
5
-
6
- ## `experimental-a2/otel`
7
-
8
- ```ts
9
- otel(options?: { tracer?: Tracer; tracerName?: string }): A2Telemetry
10
- ```
11
-
12
- OpenTelemetry instrumentation for a server (`@opentelemetry/api` is a peer
13
- dependency). Pass it as `telemetry`. Spans nest through the active context, so
14
- the happy path lands in one trace: request → append → drain → each handler →
15
- the events those handlers append. `A2Telemetry` is a one-method interface:
16
- anything with `span(name, attributes, fn)` works, and `otel()` is the adapter
17
- A2 ships. See [Watch it in traces](/server/production#watch-it-in-traces).
18
-
19
- ### The span catalogue
20
-
21
- This catalogue is a contract: renames and additions are breaking for
22
- dashboards and are called out in the package's `CHANGELOG.md`. All spans carry
23
- `a2.contract` and `a2.session_id`. Core spans describe the durable runtime;
24
- `a2.ai.*` spans describe the built-in AI handlers.
25
-
26
- | Layer | Span | Wraps |
27
- | ----- | ---- | ----- |
28
- | Core | `a2.append` | validation + the store write (one batch) |
29
- | Core | `a2.drain` | one drain pass, including concurrent handlers |
30
- | Core | `a2.event` | one claimed dispatch, including its handler and completion |
31
- | Core | `a2.claim` | one `claimAvailable` store operation |
32
- | Core | `a2.commit` | one `completeAttempt` or `failAttempt` store operation |
33
- | Core | `a2.state` | one `state()` read: snapshot-plus-tail load + reducer fold |
34
- | Core | `a2.snapshot` | one background batch of checkpoint writes |
35
- | Core | `a2.redrive` | one `session.redrive()`: the store operation and starting the session's wakeup |
36
- | AI | `a2.ai.control` | applying an input/work report/session-close decision and preparing its returned events |
37
- | AI | `a2.ai.generate` | one generation handler, including Core calls and model/SDK work |
38
- | AI | `a2.ai.context` | constructing model messages, including tool prompt reconstruction when uncached |
39
- | AI | `a2.ai.compaction` | automatic summarization or the custom compaction callback |
40
- | AI | `a2.ai.tool` | one durable tool handler, including application execution |
41
- | AI | `a2.ai.ack` | waiting for a persisted work report's canonical events and control receipt |
42
-
43
- Durations include nested work: `a2.event` contains its AI handler and later
44
- commit, AI handlers call Core, and `a2.state` includes reducer code.
45
- Acknowledgements overlap control processing, claims can cover several events,
46
- and snapshots run in the background, so summing spans, or subtracting summed
47
- children, does not yield exclusive Core or AI overhead. Model and application
48
- I/O is included; its child spans have the detail.
49
-
50
- Attributes arrive in two waves: **at start** (passed to `span()`) and
51
- **mid-span** (via `handle.setAttribute`, for outcomes and counts known only
52
- after the work ran). A recorder must merge both; the ones you alert on are all
53
- mid-span.
54
-
55
- | Attribute | Span | When | Values |
56
- | --------------------- | ----------- | ----- | ----------------------------------------------------- |
57
- | `a2.append.source` | `a2.append` | start | `external` \| `handler` |
58
- | `a2.append.mode` | `a2.append` | start | `inline` \| `dispatch` |
59
- | `a2.append.types` | `a2.append` | start | comma-joined event types |
60
- | `a2.append.count` | `a2.append` | start | batch size |
61
- | `a2.append.armed` | `a2.append` | mid | `false` when the scheduler arm failed and this append degraded to append-driven healing |
62
- | `a2.drain.outcome` | `a2.drain` | mid | `settled` \| `busy` \| `stalled` |
63
- | `a2.drain.processed` | `a2.drain` | mid | events processed this pass |
64
- | `a2.claim.outcome` | `a2.claim` | mid | `claimed` \| `busy` \| `settled` |
65
- | `a2.claim.count` | `a2.claim` | mid | number of claimed events, or zero |
66
- | `a2.commit.operation` | `a2.commit` | start | `complete` \| `fail` |
67
- | `a2.commit.index` | `a2.commit` | start | event log position |
68
- | `a2.commit.attempt` | `a2.commit` | start | durable 1-based attempt ordinal |
69
- | `a2.commit.outcome` | `a2.commit` | mid | `completed` \| `failed` \| `dead_lettered` \| `superseded` |
70
- | `a2.event.type` | `a2.event` | start | the event's type |
71
- | `a2.event.index` | `a2.event` | start | log position |
72
- | `a2.event.id` | `a2.event` | start | event id |
73
- | `a2.event.attempt` | `a2.event` | start | same durable 1-based ordinal as `ctx.attempt` |
74
- | `a2.event.lane` | `a2.event` | start | stored lane value; absent for concurrent unlaned work |
75
- | `a2.event.handled` | `a2.event` | start | normally `true`; `false` when a custom-adapter row has no handler |
76
- | `a2.event.outcome` | `a2.event` | mid | `processed` \| `failed` \| `dead_lettered` \| `superseded` \| `surrendered` |
77
- | `a2.event.aborted` | `a2.event` | mid | `true` when `abortOn` fired during the run |
78
- | `a2.state.reducer` | `a2.state` | start | the reducer's name |
79
- | `a2.state.snapshot` | `a2.state` | mid | `hit` \| `miss` \| `rejected` (schema guard discarded it) \| `memory` (served from the server's in-memory state) |
80
- | `a2.state.folded` | `a2.state` | mid | events folded past the snapshot |
81
- | `a2.state.index` | `a2.state` | mid | the frontier the returned state reflects |
82
- | `a2.snapshot.reducer` | `a2.snapshot` | start | the reducer's name |
83
- | `a2.snapshot.index` | `a2.snapshot` | start | greatest checkpoint index in the write batch |
84
- | `a2.snapshot.count` | `a2.snapshot` | start | number of checkpoints in the write batch |
85
- | `a2.redrive.index` | `a2.redrive` | start | log position of the event being redriven |
86
- | `a2.redrive.action` | `a2.redrive` | start | `retry` \| `skip` |
87
- | `a2.redrive.redriven` | `a2.redrive` | mid | `true` when the event was dead-lettered and is now resolved |
88
- | `a2.redrive.armed` | `a2.redrive` | mid | `false` when the scheduler arm failed and the wakeup degraded to append-driven healing |
89
- | `a2.ai.control.type` | `a2.ai.control` | start | `ai.control.requested` \| `ai.work.reported` \| `ai.session.closed` |
90
- | `a2.ai.control.id` | `a2.ai.control` | start | triggering event id |
91
- | `a2.ai.control.attempt` | `a2.ai.control` | start | durable 1-based attempt ordinal |
92
- | `a2.ai.generate.request_id` | `a2.ai.generate` | start | generation request event id |
93
- | `a2.ai.generate.attempt` | `a2.ai.generate` | start | durable 1-based attempt ordinal |
94
- | `a2.ai.context.request_id` | `a2.ai.context` | start | generation request event id |
95
- | `a2.ai.context.phase` | `a2.ai.context` | start | `generation` \| `refresh` \| `tool` |
96
- | `a2.ai.compaction.request_id` | `a2.ai.compaction` | start | generation request event id |
97
- | `a2.ai.compaction.generation_id` | `a2.ai.compaction` | start | generation attempt id |
98
- | `a2.ai.compaction.policy` | `a2.ai.compaction` | start | `automatic` \| `custom` |
99
- | `a2.ai.tool.request_id` | `a2.ai.tool` | start | originating generation request event id |
100
- | `a2.ai.tool.call_id` | `a2.ai.tool` | start | tool call id |
101
- | `a2.ai.tool.name` | `a2.ai.tool` | start | tool name |
102
- | `a2.ai.tool.attempt` | `a2.ai.tool` | start | durable 1-based attempt ordinal |
103
- | `a2.ai.ack.request_id` | `a2.ai.ack` | start | reporting worker event id |
104
- | `a2.ai.ack.report_id` | `a2.ai.ack` | start | work report event id, matching the control span's id |
105
-
106
- - Drain outcomes: `settled` means nothing actionable is left; `busy` means live
107
- per-event claims or a failed event's retry hold remain; `stalled` means a
108
- caught failure in this drain needs a later retry.
109
- - A failing handler marks its `a2.event` span with the exception and error
110
- status. Alert on `a2.event.outcome = dead_lettered`. A dead-lettered event
111
- blocks only later events in its lane, until `session.redrive()` resolves it;
112
- other lanes stay eligible.
113
- - `superseded` means a stale completion or failure did not change the log.
114
-
115
- ## `experimental-a2/store-postgres`
116
-
117
- `postgres({ connectionString })` returns an `A2Store` on Postgres; pass
118
- `client` to inject your own pool. See [Postgres](/server/production#postgres)
119
- for setup.
120
-
121
- - Without `listenConnectionString`, a live stream polls with an adaptive
122
- cadence: every 25ms while the session is producing events, backing off to
123
- two seconds when it goes quiet. After a quiet period, an update from another
124
- client can take up to the idle interval plus query latency to arrive.
125
- - A client's own `push()` refreshes its idle stream immediately from the
126
- current cursor, even when the write and stream routes run in different
127
- invocations. A WebSocket push wakes the attached stream without reopening
128
- the socket.
129
- - With `listenConnectionString`, notifications arrive after commit, and a
130
- reconnect catches up from the cursor. Native event and presence
131
- subscriptions also reconcile every ten seconds.
132
-
133
- ## `experimental-a2/store-redis`
134
-
135
- `redis({ url })` returns an `A2Store` that keeps each session as a Redis
136
- Stream; pass `client` to inject your own. See
137
- [Redis](/server/production#redis-recommended) for setup and per-command costs.
138
-
139
- - Every write publishes a wake-up, so live streams are push-driven, not
140
- polled.
141
- - A wake-up is disposable: a safety re-read recovers a lost one within ten
142
- seconds.
143
-
144
- ## `experimental-a2/store-redis-http`
145
-
146
- `redisHttp({ url, token })` returns the same Redis store over `fetch`, for
147
- providers that expose only a REST API, such as Upstash. See
148
- [Redis](/server/production#redis-recommended) for setup and the trust warning.
149
-
150
- - Live events and presence use Upstash's HTTP `SUBSCRIBE` endpoint (SSE), with
151
- the same URL and token. Each active channel holds one outbound HTTP
152
- subscription per store instance, shared by its local viewers and closed when
153
- the last viewer leaves.
154
- - Writes publish their wake-ups in the same Redis script as the append. A
155
- rejected notification does not fail the applied write.
156
- - Idle event streams re-read every ten seconds to recover missed
157
- notifications. Subscriptions reconnect on their own and catch up from the
158
- event cursor.
159
- - After a reconnect, A2 re-reads the current presence fields and clears fields
160
- deleted during the gap, so presence may repeat its latest values. Updates
161
- received during that read take precedence.
162
- - If the subscribe endpoint answers 404, 405, or 501, events and presence use
163
- adaptive polling instead, from 25ms to two seconds while idle.
164
-
165
- ## `experimental-a2/scheduler-vercel`
166
-
167
- `vercelQueues(options?)` returns an `A2Scheduler` backed by Vercel Queues.
168
-
169
- ```ts server/scheduler-vercel.ts
170
- import { vercelQueues } from 'experimental-a2/scheduler-vercel'
171
-
172
- export const scheduler = vercelQueues()
173
- ```
174
-
175
- | Option | Type | Default |
176
- | --- | --- | --- |
177
- | `topic` | `string` matching `[A-Za-z0-9_-]+` | `'a2'` |
178
- | `deploymentId` | `string \| null` | `VERCEL_DEPLOYMENT_ID` |
179
- | `transport` | `QueueTransport` | lazy `@vercel/queue` client |
180
- | `clock` | `{ now(): Date }` | system clock |
181
-
182
- - `deploymentId` passes to the Queue SDK unchanged and applies to every task,
183
- recovery watchdogs included. Omit it for `VERCEL_DEPLOYMENT_ID`, pass an ID
184
- to target that deployment, or pass `null` for deploymentless delivery.
185
- Publishing and consuming clients must use the same deployment scope.
186
- - One configured client handles sends, payload fetches, acknowledgements, and
187
- visibility changes; callback contents never choose the client.
188
- - Pinned tasks stay with their target deployment after another is promoted.
189
- Deploymentless delivery lets Vercel choose an eligible consumer, not the
190
- latest production deployment; every eligible consumer must use
191
- `deploymentId: null` and stay compatible with pending tasks and session work.
192
- - Tasks are retained for seven days, Vercel Queues' maximum. A delay goes out
193
- as asked; Vercel Queues refuses one longer than the retention.
194
- - `transport` and `clock` are advanced injection seams for tests and custom
195
- delivery. An injected transport receives the topic, an exact
196
- `SchedulerTask`, and send options, and owns its provider configuration;
197
- `deploymentId` configures only the built-in client.
198
-
199
- See [Vercel Queues](/server/production#vercel-queues-recommended).
200
-
201
- ## `experimental-a2/scheduler-qstash`
202
-
203
- `qstash(options?)` returns an `A2Scheduler` backed by QStash HTTP delivery.
204
- Vercel Queues remains the recommended default on Vercel; use QStash for a
205
- scheduler that calls a stable public endpoint.
206
-
207
- ```ts server/scheduler-qstash.ts
208
- import { qstash } from 'experimental-a2/scheduler-qstash'
209
-
210
- export const scheduler = qstash()
211
- ```
212
-
213
- | Option | Type | Default |
214
- | --- | --- | --- |
215
- | `url` | `string` | conventional local or Vercel callback; required for process-less runtimes, other production, and custom routes |
216
- | `token` | `string` | `QSTASH_TOKEN` |
217
- | `currentSigningKey` | `string` | `QSTASH_CURRENT_SIGNING_KEY` |
218
- | `nextSigningKey` | `string` | `QSTASH_NEXT_SIGNING_KEY` |
219
- | `headers` | `Readonly<Record<string, string>>` | no additional callback headers |
220
- | `client` | `QStashPublishingClient` | lazy `@upstash/qstash` client |
221
- | `retries` | non-negative integer | the QStash provider default |
222
- | `maxBodyBytes` | positive integer | `1_048_576` (1 MiB) for callbacks and reserved outbound bodies |
223
- | `transport` | `QStashTransport` | lazy `@upstash/qstash` client and receiver |
224
- | `clock` | `{ now(): Date }` | system clock |
225
-
226
- Mount the application handler once and pass every server that shares the
227
- scheduler:
228
-
229
- ```ts app/api/a2/scheduler/route.ts
230
- import { billingServer, ordersServer, scheduler } from '@/server'
231
-
232
- export const POST = scheduler.handler(ordersServer, billingServer)
233
- ```
234
-
235
- **Callback URL.** An explicit `url` always wins. Otherwise:
236
-
237
- - Vercel production: `https://${VERCEL_PROJECT_PRODUCTION_URL}/api/a2/scheduler`.
238
- Preview: `https://${VERCEL_BRANCH_URL}/api/a2/scheduler`. Both are moving
239
- aliases, so pending tasks can reach later deployments on the same URL.
240
- - A runtime that exposes `process.env`, outside `NODE_ENV=production`:
241
- `http://localhost:${PORT ?? 3000}/api/a2/scheduler`, with `devMode: true` on
242
- the SDK client and receiver. `QSTASH_DEV` is not required, and
243
- `QSTASH_DEV=false` does not disable it. `PORT` must be an integer from 1
244
- through 65535; `QSTASH_DEV_PORT` configures the local QStash server, not the
245
- callback.
246
- - Automatic local startup needs `@upstash/qstash` 2.11.0 or newer in Node.js;
247
- the lazy transport starts it on the first publish or verification. An Edge
248
- runtime that exposes `process.env` infers the local URL but must start the
249
- development server separately.
250
- - Non-Vercel production, process-less runtimes, custom hosts or paths, ports
251
- not available through `PORT`, and Docker networking need an explicit
252
- absolute URL.
253
- - Outside production, an explicit URL leaves SDK development mode to
254
- `QSTASH_DEV` or a manual `QSTASH_URL` plus credentials. In production, A2
255
- passes `devMode: false`.
256
-
257
- **Options.**
258
-
259
- - `headers`: static headers on every callback delivery, recovery successors
260
- included. Validated and snapshotted when `qstash()` runs; A2 asks QStash to
261
- redact every value from its dashboard and API, but QStash still receives,
262
- stores, and delivers them. Names are case-insensitive. Reserved:
263
- provider-owned `Upstash-*`, `Content-Type*`, HTTP framing headers, and A2's
264
- managed Vercel identity headers.
265
- - `client`: the structural `publishJSON(...)` part of a configured
266
- `@upstash/qstash` `Client`, for its API endpoint, publish-request retry
267
- policy, or telemetry. Not combinable with `token` or `transport`; A2 still
268
- creates the `Receiver` lazily from the signing keys. Put callback credentials
269
- in `headers`, since client-global callback headers and redaction are outside
270
- A2's merge contract. The client receives raw callback credentials, including
271
- an automatic preview identity, and must honor per-publish redaction.
272
- - `transport`, `clock`: advanced injection seams for tests and custom delivery.
273
- A `QStashTransport` implements `publish(request)` and `verify(request)`.
274
- Publish requests carry the callback `url`, a complete `SchedulerTask` body
275
- (plus provider-private generation metadata for store-outage successors),
276
- optional `headers` and `redact.header` names, an optional Unix-seconds
277
- `notBefore`, and a deterministic `deduplicationId`; preserve the body,
278
- deliver every header, and apply every redaction. Verify requests carry the
279
- signature, raw body, exact callback URL, and optional Upstash region.
280
- - `retries`: omitted, QStash uses its provider default; an explicit value is
281
- forwarded. Every delivery attempt is billable.
282
- - `maxBodyBytes`: the adapter reserves room for a task's largest possible
283
- store-outage lineage before its initial publish, so an accepted task never
284
- exceeds the limit later. Raise it for a larger paid-plan payload limit. Keep
285
- one value across every deployment that receives this URL: a lower value can
286
- return a non-retryable 489 for a task an older value accepted.
287
-
288
- **The route.**
289
-
290
- - Must be reachable by the selected QStash server after any platform edge
291
- authentication; the development server calls localhost directly.
292
- - Reads the raw body once and verifies `Upstash-Signature`, the exact URL, and
293
- `Upstash-Region` before parsing or touching a server. Missing or invalid
294
- signatures return 401.
295
- - A signed malformed envelope, or a declared or streamed body over
296
- `maxBodyBytes`, returns 489 with `Upstash-NonRetryable-Error: true`.
297
- - Returns 200 when settled; when busy or stalled, after a durable successor
298
- watchdog exists, so each caught failure gets a fresh message and a fresh
299
- per-message retry budget. Append tasks return 200 after their fixed-id append
300
- succeeds and any recovery watchdog for pending handler work is durable; clear
301
- tasks after their conditional clear and its deletion finish.
302
- - A retryable store outage hands drain, append, and clear tasks to a fresh
303
- successor before acknowledging: 30 seconds, times four per signed
304
- generation, capped at one day. The generation keeps increasing past the cap,
305
- so each handoff gets a new deduplication id, and duplicate deliveries of one
306
- generation publish the same successor.
307
- - Unknown contracts, missing scheduler configuration, schema failures, and
308
- successor publish failures keep the delivery retryable.
309
-
310
- **Delivery.**
311
-
312
- - At least once, so handler side effects need idempotency keys. QStash's
313
- documented 10-minute deduplication window can reduce duplicate watchdogs but
314
- is not part of A2's correctness model; stable scheduled-event ids keep timer
315
- redelivery safe after it.
316
- - During a prolonged outage where QStash cannot reach the callback, nothing
317
- publishes a successor: monitor the DLQ and redrive.
318
- - One-shot delays are capped at 7 days on free plans and 1 year on usage-based
319
- plans, with no fixed maximum on fixed plans. Leave one second of margin at a
320
- plan maximum: `notBefore` uses whole Unix seconds.
321
- - Carries both recovery watchdogs and `session.schedule` tasks.
322
-
323
- **Protected previews.** For an inferred preview callback, each publish
324
- forwards the invocation's `x-vercel-oidc-token` as
325
- `x-vercel-trusted-oidc-idp-token`, with redaction requested, when it is a
326
- parseable JWT that expires at least 60 seconds after the task's first due time,
327
- so a matching Vercel Trusted Sources rule can admit the first delivery. QStash
328
- still receives it. This is opportunistic: missing, malformed, and near-expiry
329
- tokens fall back to an ordinary publish; an explicit `url` opts out; inferred
330
- production and local callbacks never forward it; and QStash reuses the stored
331
- header on retries, so delayed tasks and retries can outlive it. When every
332
- protected delivery must stay authorized, use an explicit automation bypass
333
- through `headers` (pending messages keep the captured value after rotation) or
334
- public ingress. Signature verification still applies after the edge-access
335
- check.
336
-
337
- See [QStash](/server/production#qstash).
338
-
339
- ## Scheduler send errors
340
-
341
- Both built-in adapters preserve the original provider error from a rejected
342
- send.
343
-
344
- - Terminal: a recognized definite 4xx status or error, except 408, 409, 425,
345
- and 429. The Vercel adapter also treats the SDK's name-only
346
- `BadRequestError`, `UnauthorizedError`, and `ForbiddenError` as terminal.
347
- - Retryable: 408, 409, 425, 429, 5xx responses, network failures, and errors
348
- with no recognized status.
349
- - The Vercel adapter's native duplicate-message error is success.
350
- - A2's durable AI tool execution uses this private classification. Direct
351
- `session.schedule()` calls still reject with the original error object.
@@ -1,323 +0,0 @@
1
- ---
2
- title: Production
3
- description: Choose a durable store, add a scheduler for recovery and timers, and know what to do when an event dead-letters.
4
- ---
5
-
6
- ## 1. Choose a store
7
-
8
- ```ts server/orders.ts
9
- import { createServer } from 'experimental-a2/server'
10
- import { redis } from 'experimental-a2/store-redis'
11
- import { orders } from '@/contracts'
12
-
13
- export const ordersServer = createServer({
14
- contract: orders,
15
- store: redis({ url: process.env.REDIS_URL }),
16
- handlers: {
17
- /* ... */
18
- },
19
- })
20
- ```
21
-
22
- | Entry point | Backend | Use it for |
23
- | --- | --- | --- |
24
- | `experimental-a2/store-redis` | Redis | Production (recommended) |
25
- | `experimental-a2/store-redis-http` | Redis over a REST API | Production |
26
- | `experimental-a2/store-postgres` | Postgres | Production |
27
- | `experimental-a2/store-sqlite` | SQLite | Development: the default, at `.a2/dev.db` |
28
- | `experimental-a2/store-memory` | In-memory | Tests: the default when `NODE_ENV=test` |
29
-
30
- When you omit `store`, development gets SQLite (state survives `next dev`
31
- restarts) and tests get memory. Production has no default, on purpose: the
32
- server throws `STORE_NOT_CONFIGURED` at startup rather than write events to a
33
- filesystem that evaporates.
34
-
35
- The store holds A2's session histories. It does not connect A2 to your
36
- application tables; see [Sessions and your database](/contract/sessions#sessions-and-your-database).
37
-
38
- ### Redis (recommended)
39
-
40
- `redis({ url })` from `experimental-a2/store-redis` stores each session as a
41
- Redis Stream and streams push-natively, so connections scale with your
42
- processes, not your audience. `ioredis` is an optional peer dependency; pass
43
- `url` or inject a client. It works on single instances and non-cluster
44
- providers such as Upstash, where durability is on by default.
45
-
46
- On providers that bill per command, such as Upstash, appending an event with a
47
- handler and running it takes 24 commands, and an idle live stream takes 6 a
48
- minute. See
49
- [`experimental-a2/store-redis`](/reference/adapters#experimental-a2store-redis)
50
- for how live streams recover a lost wake-up.
51
-
52
- When only a REST API is available, `redisHttp({ url, token })` from
53
- `experimental-a2/store-redis-http` speaks the same storage over `fetch`, with
54
- no client dependency or extra setup. Live events and presence use Upstash's
55
- HTTP `SUBSCRIBE` endpoint with the same URL and token. If that endpoint answers
56
- 404, 405, or 501, the store polls instead; other errors stay errors. See
57
- [`experimental-a2/store-redis-http`](/reference/adapters#experimental-a2store-redis-http)
58
- for its subscriptions, reconnects, and fallback.
59
-
60
- :::warning
61
- `redisHttp` live streams trust the messages on the store's `:notify`
62
- channels. Browsers never hold Redis credentials, so they can't reach those
63
- channels. The risk is a Redis credential that can publish but not write, such
64
- as a token another service uses: it could add or hide events in live views.
65
- Grant publish access only to credentials that can also write the store.
66
- :::
67
-
68
- ### Postgres
69
-
70
- Any Postgres works: Neon, Supabase, RDS, or your own box, including
71
- transaction-mode poolers. `pg` is an optional peer dependency. Pass
72
- `connectionString`, or inject your own pool as `client`; an injected pool's
73
- platform lifecycle is yours to manage.
74
-
75
- Live streams poll by default, backing off when a session goes quiet. For
76
- native notifications, also pass `listenConnectionString`: a direct connection
77
- to the same database. It installs notification triggers on A2's event and
78
- presence tables, which stay installed and also cover writes from instances
79
- without the option. Stores in one runtime share a listener, but every
80
- serverless instance opens its own direct connection, so leave connection
81
- headroom. See
82
- [`experimental-a2/store-postgres`](/reference/adapters#experimental-a2store-postgres)
83
- for live-stream latency and recovery.
84
-
85
- ## 2. Add a scheduler for handlers and timers
86
-
87
- The scheduler puts a clock on recovery and on [timers](/server/timers).
88
- Vercel Queues is the recommended default on Vercel. QStash delivers over HTTP
89
- from separate infrastructure. Either adapter carries recovery and
90
- `session.schedule` tasks through one route. Scheduled delays must fit the
91
- [provider's limit](/server/timers#provider-limits).
92
-
93
- ### Vercel Queues (recommended)
94
-
95
- ```ts
96
- // server/orders.ts, now with a scheduler:
97
- import { createServer } from 'experimental-a2/server'
98
- import { redis } from 'experimental-a2/store-redis'
99
- import { vercelQueues } from 'experimental-a2/scheduler-vercel'
100
- import { orders } from '@/contracts'
101
-
102
- export const scheduler = vercelQueues()
103
-
104
- export const ordersServer = createServer({
105
- contract: orders,
106
- store: redis({ url: process.env.REDIS_URL }),
107
- scheduler,
108
- handlers: {
109
- /* ... */
110
- },
111
- })
112
- ```
113
-
114
- `@vercel/queue` is a peer dependency. Share one scheduler instance across
115
- servers, and mount its handler once with every server it may deliver to:
116
-
117
- ```ts app/api/a2/scheduler/route.ts
118
- import { billingServer, ordersServer, scheduler } from '@/server'
119
-
120
- export const POST = scheduler.handler(ordersServer, billingServer)
121
- ```
122
-
123
- `scheduler.handler(...)` checks its servers when the module loads: at least
124
- one drainable server, with unique contract names. A bad route fails at
125
- startup, or in a build that evaluates route modules.
126
-
127
- ```json vercel.json
128
- {
129
- "functions": {
130
- "app/api/a2/scheduler/route.ts": {
131
- "experimentalTriggers": [
132
- {
133
- "type": "queue/v2beta",
134
- "topic": "a2"
135
- }
136
- ]
137
- }
138
- }
139
- }
140
- ```
141
-
142
- The trigger is required. It connects the route to Vercel Queues and makes the
143
- function private, so only queue infrastructure can invoke it. Don't expose the
144
- callback as a public route or wrap it in a second authentication scheme.
145
-
146
- The adapter keeps messages for 7 days (Vercel Queues' default is 24 hours), so
147
- scheduled appends and clears can be up to 7 days out.
148
-
149
- ### QStash
150
-
151
- ```ts
152
- // server/orders.ts, with QStash instead:
153
- import { createServer } from 'experimental-a2/server'
154
- import { qstash } from 'experimental-a2/scheduler-qstash'
155
- import { redis } from 'experimental-a2/store-redis'
156
- import { orders } from '@/contracts'
157
-
158
- export const scheduler = qstash()
159
-
160
- export const ordersServer = createServer({
161
- contract: orders,
162
- store: redis({ url: process.env.REDIS_URL }),
163
- scheduler,
164
- handlers: {
165
- /* ... */
166
- },
167
- })
168
- ```
169
-
170
- `@upstash/qstash` 2.11.0 or newer is a peer dependency. Mount
171
- `scheduler.handler(...)` in the same `app/api/a2/scheduler/route.ts`, and set
172
- `QSTASH_TOKEN`, `QSTASH_CURRENT_SIGNING_KEY`, and `QSTASH_NEXT_SIGNING_KEY`.
173
-
174
- - **Callback URL:** inferred from `PORT` locally, and from
175
- `VERCEL_PROJECT_PRODUCTION_URL` or `VERCEL_BRANCH_URL` on Vercel. Pass `url`
176
- anywhere else.
177
- - **Local development:** A2 starts QStash's development server on the first
178
- publish or verification, with no QStash variables needed.
179
- - **Security:** the route verifies `Upstash-Signature` before touching the
180
- store and answers unsigned traffic with 401. Behind Deployment Protection,
181
- pass an automation bypass as a callback header.
182
- - **Outages:** delivery is at least once and A2 keeps recovery going, but when
183
- QStash can't reach the route at all, redrive its DLQ.
184
-
185
- The [adapter reference](/reference/adapters#experimental-a2scheduler-qstash)
186
- covers the options, protected previews, Edge runtimes, and body limits.
187
-
188
- ### More than one scheduler
189
-
190
- Servers with different scheduler instances need separate routes, even from the
191
- same adapter. Each extra QStash instance passes its own `url`. Each Vercel
192
- Queues instance needs its own `topic` and a matching `experimentalTriggers`
193
- entry.
194
-
195
- ### Dispatch in a fresh invocation
196
-
197
- Ordinary `append` starts handlers inline and uses the scheduler as a watchdog.
198
- `append.dispatch` persists the input and hands the pending work straight to the
199
- queue instead:
200
-
201
- ```ts app/api/imports/route.ts
202
- import { ordersServer } from '@/server'
203
-
204
- export async function POST(request: Request) {
205
- const { orderId, shopId, items } = await request.json()
206
- await ordersServer.session(orderId).append.dispatch({
207
- id: `created:${orderId}`,
208
- type: 'created',
209
- payload: { shopId, items },
210
- })
211
- return Response.json({ accepted: true }, { status: 202 })
212
- }
213
- ```
214
-
215
- It requires a scheduler. The call awaits the queue send and starts no inline
216
- drain. If the send fails, the event may already be durable; its explicit id
217
- makes the retry idempotent. Dispatch controls the wakeup, not which worker
218
- claims the event.
219
-
220
- ### Running without a scheduler
221
-
222
- If no event type has a handler and nothing calls `session.schedule`, skip
223
- `scheduler`. Events settle in their append transaction, with no drains, claims,
224
- or queue messages. That's a complete production configuration: a durable event
225
- log for history, reducers, and live sync.
226
-
227
- With handlers, skipping it means the only wakeups are a top-level append or an
228
- explicit `server.drain()`. Reads never wake a session, so one nobody wakes
229
- stays stuck. That's fine for internal tools where "heals on the next write" is
230
- acceptable. For production, configure a scheduler.
231
-
232
- ## 3. When an event dead-letters
233
-
234
- A [dead-lettered](/server/guarantees#when-a-handler-keeps-failing) event waits
235
- for you. List a session's dead letters, then resolve each one:
236
-
237
- ```ts
238
- // anywhere on the server, behind your own operator checks:
239
- import { ordersServer } from '@/server'
240
-
241
- const order = ordersServer.session(orderId)
242
- const [dead] = await order.deadLetters()
243
- if (dead) {
244
- // dead.lastError says why (null if every attempt timed out or crashed);
245
- // deploy the handler fix first, then:
246
- await order.redrive(dead.index, { action: 'retry' })
247
- }
248
- ```
249
-
250
- - **Fix and retry.** `{ action: 'retry' }` runs the handler again with a fresh
251
- ten-failure budget. Once it completes, its lane continues.
252
- - **Skip.** `{ action: 'skip' }` marks the event processed without running it,
253
- accepting that its effects never happen. The next event in its lane runs.
254
-
255
- Each redrive is one atomic store operation, and it wakes the session the way an
256
- append does, so the lane resumes without another write. An event that isn't
257
- dead-lettered anymore is left alone: `redrive` reports `{ redriven: false }`.
258
-
259
- ## 4. Deploy safely
260
-
261
- The Vercel adapter's `deploymentId` applies to every task: recovery, scheduled
262
- appends, and scheduled clears. Omit it to use the publishing deployment, pass
263
- a deployment ID to target one, or pass `null` for deploymentless delivery.
264
- Publishing and consuming clients must use the same scope.
265
-
266
- - **Pinned tasks stay put.** Promoting a new deployment doesn't move them;
267
- older deployments keep receiving their own work until it is acknowledged or
268
- expires. Upgrading doesn't repair an older deployment's callback handler.
269
- - **Deploymentless doesn't mean latest.** Vercel picks an eligible consumer,
270
- not the latest production deployment. Every eligible consumer must use
271
- `deploymentId: null` and stay compatible with pending tasks and session work.
272
- - **Changing the setting doesn't move queued tasks.** Keep consumers for the
273
- original scope until those tasks finish.
274
-
275
- QStash's inferred production and branch URLs are moving aliases, so pending
276
- tasks can reach a later deployment. Keep task envelopes and event schemas
277
- compatible across deployments, and keep the same `maxBodyBytes` on every
278
- deployment that can receive the callback: lowering it mid-rollout can reject
279
- tasks the previous deployment accepted.
280
-
281
- :::warning
282
- Don't roll back to an A2 version without timer delivery while scheduled tasks
283
- are outstanding.
284
- An old route can acknowledge a new append task as a recovery message without
285
- writing its events. Rolling back past scheduled clears fails too: an old
286
- Vercel Queues route keeps failing a clear task until retention ends, and an
287
- old QStash route rejects it as non-retryable, moving it to QStash's
288
- dead-letter queue. Roll forward, or wait for those tasks to deliver or remove
289
- them through the provider first.
290
- :::
291
-
292
- ## Watch it in traces
293
-
294
- ```ts
295
- // server/orders.ts, with telemetry:
296
- import { createServer } from 'experimental-a2/server'
297
- import { otel } from 'experimental-a2/otel'
298
- import { orders } from '@/contracts'
299
-
300
- export const ordersServer = createServer({
301
- contract: orders,
302
- // ...store, scheduler, and handlers as above
303
- telemetry: otel(),
304
- })
305
- ```
306
-
307
- `telemetry` takes an instrumentation hook; `experimental-a2/otel` implements
308
- it over OpenTelemetry (`@opentelemetry/api` is a peer dependency). With any
309
- OTel setup registered (on Vercel, `@vercel/otel`), one trace shows the request,
310
- `a2.append`, the inline `a2.drain`, an `a2.event` span per handler, and the
311
- appends those handlers make. Failures mark their `a2.event` span,
312
- `a2.event.attempt` reports `ctx.attempt`, and `a2.event.outcome =
313
- dead_lettered` is the attribute to alert on. Agent servers add `a2.ai.*`
314
- spans. See the [span catalogue](/reference/adapters#the-span-catalogue).
315
-
316
- ## Checklist
317
-
318
- | Piece | Done when |
319
- | ------------------- | -------------------------------------------------------------------- |
320
- | Store | `store: redis(...)` (or `postgres(...)`) on every server |
321
- | Scheduler | for servers with handlers or timers: one shared adapter, route, and provider config |
322
- | Idempotent handlers | external side effects take `event.id` as an idempotency key |
323
- | Client split | contracts/reducers isomorphic; only `experimental-a2/server` touches backends |