ADR 0002 Amendment 1 declared `hints.maxConcurrent` declarative-only at
v0.1 — type-validated at startup but with no runtime enforcement.
D38 wires the runtime enforcement via a per-provider in-flight spawn
counter with immediate-advancement on saturation.
Design choice: **immediate-advancement via fallback engine** (queue +
timeout DEFERRED). When a provider is at its maxConcurrent limit, the
spawn call synchronously fails with a new `CONCURRENCY_LIMIT` error
code; the fallback engine treats this as a hard trigger and advances
to the next chain hop. If the entire chain is saturated, the user
sees a chain-exhausted error (existing path).
Rationale for immediate-advancement over queue+timeout:
1. The fallback chain exists precisely for this kind of overflow —
adding a queue layer would duplicate the advancement semantics.
2. Queue + timeout adds new config surface (timeout duration, queue
depth bounds, queue eviction policy) that isn't needed at the
personal/family scale OLP serves.
3. Head-of-line blocking risk: a long-running spawn would stall
queued requests behind it even though other providers in the chain
could serve them immediately.
4. Fail-fast latency aligns with the multi-provider proxy philosophy
("spread risk across providers, not within a provider").
Queue + timeout is deferred to a v1.x design ADR if real usage shows
demand. ADR 0002 Amendment 6 and ADR 0004 Amendment 4 capture the
decision explicitly.
Changes (8 files, +<delta>):
**Code**
1. **lib/providers/base.mjs** — add `CONCURRENCY_LIMIT` to
`PROVIDER_ERROR_CODES`. JSDoc clarifies the code is synthesised by
the orchestration layer, not thrown by provider plugins themselves.
2. **lib/providers/index.mjs** — new semaphore primitives:
- `tryAcquireSpawn(providerName, maxConcurrent)` — atomic
check-then-increment. Returns `true` on success, `false` if at
limit. Atomicity rests on the JS single-threaded invariant
(read + write synchronous, NO `await` between them); module-level
comment block warns future maintainers against breaking this.
- `releaseSpawn(providerName)` — decrement; throws on
under-decrement (defensive bug guard for missing acquire / double
release). Map.delete at zero for clean memory footprint.
- `getActiveSpawnCount(providerName)` — returns current count
(0 for unseen providers). For diagnostics + tests.
- `DEFAULT_MAX_CONCURRENT_SPAWNS = 4` — defense-in-depth fallback
matching the v0.1 plugin defaults (anthropic/codex/mistral all
declare hints.maxConcurrent: 4). Also coerces non-integer / NaN
/ negative inputs to the default.
- `__resetSpawnCounters()` — internal test seam.
3. **lib/fallback/engine.mjs** — `CONCURRENCY_LIMIT: true` added to
`HARD_TRIGGER_CODES`. `classifyTrigger` and `evaluateHardTriggers`
both pick it up via the same lookup. v0.1 live hard-trigger codes
are now 5 (was 4 post-D34): SPAWN_FAILED, CLI_NOT_FOUND,
AUTH_MISSING:false, SPAWN_TIMEOUT, CONCURRENCY_LIMIT.
4. **server.mjs** — gate the spawn call in handleChatCompletions at
BOTH spawn call sites:
- **Buffered path** (executeHopFn → collectAllChunks): acquire
before provider.spawn; on failure synthesise
`ProviderError(CONCURRENCY_LIMIT)` with providerName /
maxConcurrent / activeSpawns diagnostic fields and throw —
fallback engine catches and advances. On success, outer try/
finally wraps the inner D16 truncation-salvage try/catch so
releaseSpawn fires on EVERY exit path (return, D16 salvage
return, re-throw).
- **Streaming path** (single-hop real-SSE branch): acquire BEFORE
the streaming branch entry. If acquire fails, branch is skipped
and request falls through to buffered path (whose own gate
surfaces chain-exhausted for single-hop chains). If acquire
succeeds, existing streaming try/catch gains
`finally { releaseSpawn(streamProvider) }` — slot releases on
stop-chunk completion, generator exhaustion, abort, or any
exception path. `releaseSpawn` fires at END of stream
consumption, not when spawn() returns.
**Tests** (test-features.mjs): 431 → 447 (+16):
Suite 18 — D38 — maxConcurrent runtime enforcement:
- 18a: PROVIDER_ERROR_CODES.CONCURRENCY_LIMIT exists
- 18b: evaluateHardTriggers true for CONCURRENCY_LIMIT
- 18c: AUTH_MISSING regression guard (D38 did NOT flip it to hard)
- 18d.1-18d.4: semaphore unit (increment / saturate-no-increment /
release / map-delete-at-zero)
- 18e: tryAcquireSpawn returns false without side-effect when at limit
- 18f: releaseSpawn throws on under-decrement
- 18g.1-18g.2: DEFAULT_MAX_CONCURRENT_SPAWNS applied for invalid
inputs (undefined / NaN / negative / non-integer)
- 18h: __resetSpawnCounters clears state
- 18i: HTTP integration — 5 concurrent requests to single-hop
chain w/ maxConcurrent=2 → peak in-flight exactly 2, 2 succeed,
3 fail
- 18j: counter releases after buffered request (sequential test)
- 18k: 2-hop chain — saturated primary advances to fallback
- 18l: streaming counter releases at END of stream (not at spawn)
**ADR amendments**
5. **docs/adr/0002-plugin-architecture.md** — Amendment 6 added.
Removes "Declarative hint only at v0.1" caveat from the
`maxConcurrent` description in the Provider contract section.
Adds implementation reference + design-choice rationale (4 points).
Lists all exported symbols.
6. **docs/adr/0004-fallback-engine.md** — Amendment 4 added.
CONCURRENCY_LIMIT added to v0.1 hard-trigger taxonomy. Documents
synthesis-vs-plugin-thrown distinction. Documents first-chunk
safety (acquire before any res.write). v1.x re-evaluation triggers
named.
**CHANGELOG**
7. **CHANGELOG.md** — Unreleased sentinel replaced with proper D38
entry. Per CLAUDE.md release_kit phase_rolling_mode, this lands
under Unreleased; promotion to ## v0.1.1 happens at the v0.1.1
release. The D37 phase_rolling_mode gate now correctly fires if
anyone tags v0.1.x with this content present without promotion —
intentional.
Pre-commit fold-ins (per evidence-first checkpoint #4):
- **Reviewer Suggestion #1 (test 18c name mismatch)**: 18c is named
"classifyTrigger returns hard for CONCURRENCY_LIMIT" but body tests
AUTH_MISSING regression. Renamed header comment to
"AUTH_MISSING regression guard" and clarified that
CONCURRENCY_LIMIT classification is covered by 18b.
- **Reviewer Suggestion #3 (activeSpawns diagnostic field)**: server
.mjs:532 set `concurrencyErr.activeSpawns = maxConcurrent` (the
limit). Technically correct (since acquire just failed, live
count == limit) but confuses future readers. Changed to query
`getActiveSpawnCount(hopProvider)` directly. Added import of the
new symbol to the lib/providers/index.mjs import block.
- **Reviewer Suggestion #5 (ADR overstatement)**: ADR 0002 Amendment 6
said getActiveSpawnCount is "exported for /health, diagnostics,
and tests" but /health integration is not wired at D38. Reworded to
"exported for diagnostics and tests" + "/health integration
deferred — when surfaced there will land at providers.status.<name>
.activeSpawns; not wired at D38." Avoids overstating current state.
Two reviewer suggestions not folded:
- Suggestion #2 (streaming test 18l comment about branch entry
conditions) — low priority; the test passes and the branch is
taken (verified by reviewer). Future polish if confusion arises.
- Suggestion #4 (additional test for streaming-saturation → chain-
exhausted) — code path is straightforward and intentional; 18i
covers the buffered-path version directly. Defer.
Authority:
- ADR 0002 Amendment 1 (declarative-only caveat) — superseded by
Amendment 6
- ADR 0002 Amendment 6 (this commit) — runtime enforcement landed
- ADR 0004 Amendment 4 (this commit) — CONCURRENCY_LIMIT added to
v0.1 hard-trigger taxonomy
- GitHub issue #1 — closed by this commit
- CC 开发铁律 v1.6 § 10.x — independent fresh-context reviewer
- CLAUDE.md release_kit_overlay phase_rolling_mode — no version
bump; Unreleased entry written
Reviewer (Iron Rule v1.6 § 10.x Mode A, fresh-context opus,
independent of drafter): APPROVE. Critical depth checks:
- Atomicity in tryAcquireSpawn (lines 285-290 read+set with no
intervening await) — confirmed; module-level invariant comment
warns future maintainers
- Release on every exit path: buffered (outer finally wraps inner
try/catch covering D16 salvage return + normal return + re-throw);
streaming (try/finally covers stop-chunk return + loop exhaustion +
catch paths). No double-release path identified.
- Streaming release timing: fires in finally after res.end() at all
exit paths, never before stream consumption completes
- Counter leak: every code path traced — no orphan acquire identified
- 447/447 tests pass in reviewer's independent npm test run
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
28 KiB
ADR 0004 — Fallback Engine Semantics and Safety
- Date: 2026-05-23
- Status: Accepted (bootstrap)
- Authors: project maintainer (with AI drafting assistance)
- Related: OLP v0.1 spec §4.3; ADR 0001 (project founding — fallback is OLP's core value proposition); ADR 0002 (plugin architecture); ADR 0003 (IR — fallback replays IR across chain hops)
Amendments
Amendment 4 — 2026-05-24: Add CONCURRENCY_LIMIT to v0.1 hard-trigger code taxonomy (D38, issue #1)
- Finding: ADR 0002 Amendment 1 (2026-05-23) ratified
hints.maxConcurrentinto the Provider contract as declarative-only at v0.1 — no runtime enforcement. GitHub issue #1 tracked the gap. D38 lands runtime enforcement (see ADR 0002 Amendment 6 for the implementation details and design rationale). Once a saturation event occurs, the orchestration layer must communicate "this hop is at capacity — advance the chain" to the fallback engine using a code that fits the existing hard-trigger taxonomy inevaluateHardTriggers. - Change (D38): Add
CONCURRENCY_LIMITto both:PROVIDER_ERROR_CODESinlib/providers/base.mjs(closed enum used byProviderError).HARD_TRIGGER_CODESinlib/fallback/engine.mjs— valuetruesoevaluateHardTriggers(ProviderError CONCURRENCY_LIMIT)returnstrueandclassifyTriggerreturns'hard'. The chain advances to the next hop. The synthesised error carries diagnostic fields (providerName,maxConcurrent,activeSpawns) which surface in the existingfallback_hard_triggerlog event via theerror.messagefield.
- v0.1 live hard-trigger codes after this amendment (5 codes):
SPAWN_FAILED,CLI_NOT_FOUND,SPAWN_TIMEOUT,CONCURRENCY_LIMIT, plus the explicit non-triggerAUTH_MISSING:false. Pre-D38 list (per Amendment 3) was 4 codes (SPAWN_FAILED,CLI_NOT_FOUND,SPAWN_TIMEOUTas triggers +AUTH_MISSING:false). - Synthesis vs. plugin-thrown: Unlike the other live hard-trigger codes,
CONCURRENCY_LIMITis NOT thrown by provider plugins themselves. It is synthesised byserver.mjs handleChatCompletionswhentryAcquireSpawn(provider, hints.maxConcurrent)returns false. The code lives inPROVIDER_ERROR_CODESfor type consistency with the closed enum thatHARD_TRIGGER_CODESkeys on; the orchestration layer is the only callsite that throws it. A future provider plugin that gains its own internal concurrency limit (e.g., a CLI that returns a specific exit code on rate-limit) could thrown this code too; the enum is forward-compatible. - Design choice — immediate-advancement vs. queue+timeout: Re-stating from ADR 0002 Amendment 6 because this ADR governs the trigger taxonomy that surfaces the decision to the user: saturation is treated as a hard trigger (chain advances immediately) rather than as a soft trigger (would gate before spawn but would not advance after spawn attempt) or as a queueable condition (would block + timeout). The hard-trigger framing matches "the primary hop refused to serve this request; advance" semantics. Queue+timeout would require a NEW trigger category outside the existing taxonomy (hard / soft / deterministic-deferred / cost-aware-deferred) and is deferred per ADR 0002 Amendment 6 rationale.
- First-chunk safety:
tryAcquireSpawnruns beforeprovider.spawn(...)and before any bytes are written to the response. ACONCURRENCY_LIMITrejection therefore satisfies the first-chunk rule trivially — zero bytes have been emitted to the client. Fallback is safe. - Authority: ADR 0002 Amendment 6 (runtime enforcement implementation); GitHub issue #1 (tracking).
- Tests: Suite 18 in
test-features.mjs— see ADR 0002 Amendment 6 § Tests for the full list. Specifically for this ADR: tests 18a (PROVIDER_ERROR_CODES membership), 18b (evaluateHardTriggers(CONCURRENCY_LIMIT) === true), 18c (AUTH_MISSING regression guard — D38 did not flip it), 18k (chain advances to fallback hop on saturated primary). - v1.x re-evaluation triggers:
- If a future plugin gains a CLI-level concurrency response that should NOT be a hard trigger (e.g., "soft limit hit, retry after backoff") — file a follow-up to add a new code (e.g.,
CONCURRENCY_BACKOFF) rather than reclassifyingCONCURRENCY_LIMIT. - If queue+timeout becomes desirable (real usage shows fail-fast advancement is too aggressive for certain workloads), file an amendment to this ADR adding queue semantics as a NEW trigger category — do not reclassify CONCURRENCY_LIMIT into the existing taxonomy.
- If a future plugin gains a CLI-level concurrency response that should NOT be a hard trigger (e.g., "soft limit hit, retry after backoff") — file a follow-up to add a new code (e.g.,
- Procedural mechanism: CC 开发铁律 v1.6 § 10.x (D38 issue #1 implementation; fresh-context opus reviewer to follow per Iron Rule 10).
Amendment 3 — 2026-05-24: Narrow v0.1 hard-trigger code taxonomy (D34 F7)
- Finding: Round-6 cold-audit F7 (P2) —
PROVIDER_ERROR_CODESinlib/providers/base.mjsandHARD_TRIGGER_CODESinlib/fallback/engine.mjsboth listedQUOTA_EXHAUSTEDandRATE_LIMITEDas live hard-trigger codes. No v0.1 plugin emits either code. The Anthropic, Codex, and Mistral plugins all useclaude -p,codex exec --json, andvibe --promptrespectively — none parse the underlying-API HTTP response status code or surface a structured quota/rate error; they only throwSPAWN_FAILED,SPAWN_TIMEOUT,CLI_NOT_FOUND, orAUTH_MISSING. The twoHard triggersbullets in § Trigger taxonomy ("HTTP 5xx from provider's underlying API" and "HTTP 4xx quota exhaustion") are therefore unreachable through theProviderErrorcode path at v0.1. - Also found:
evaluateHardTriggersinengine.mjshas HTTPstatusCodebranches (>= 500and>= 400) that are also unreachable at v0.1 — plugins never attachstatusCodeto thrown errors. These branches are left in place as forward-compatible intent-signal code (option (b) per D34 discussion), with a prominent comment. Removing them would require corresponding ADR revision; keeping them preserves the design intent for when a future plugin gains HTTP-status parsing. - Change (D34 F7):
QUOTA_EXHAUSTEDandRATE_LIMITEDremoved fromPROVIDER_ERROR_CODES(base.mjs) andHARD_TRIGGER_CODES(engine.mjs). Dead code removal.- A comment block added in
evaluateHardTriggerslabeling the HTTP-status branches as "forward-compat reserved — v0.1 plugins never attach statusCode." - Test coverage: the two unit tests for
evaluateHardTriggers: ProviderError QUOTA_EXHAUSTED/RATE_LIMITED → firesare removed (tombstoned with a removal comment). All other hard-trigger tests that used these codes as convenient test vectors are rewritten to useSPAWN_FAILED/SPAWN_TIMEOUT.
- v0.1 live hard-trigger codes after this amendment:
SPAWN_FAILED,CLI_NOT_FOUND,SPAWN_TIMEOUT.AUTH_MISSINGremains in the table as an explicitfalseentry (deliberate non-trigger per ADR 0004 § "No fallback for client-side errors" analogue). Subsequently extended by Amendment 4 (D38) —CONCURRENCY_LIMITadded as a 4th true entry; the v0.1 live-codes list as of D38 isSPAWN_FAILED,CLI_NOT_FOUND,SPAWN_TIMEOUT,CONCURRENCY_LIMITplus the explicitAUTH_MISSING:falsenon-trigger entry. - v1.x re-activation path: When a plugin gains HTTP-status parsing (e.g., an Anthropic plugin variant that makes direct Messages API calls rather than spawning
claude -p), add the plugin-layer HTTP parsing, re-addQUOTA_EXHAUSTEDandRATE_LIMITEDto both tables, and amend this entry. TheevaluateHardTriggersHTTP-status branches will then activate naturally with no further engine changes. - Procedural mechanism: CC 开发铁律 v1.6 § 10.x (Round-6 Cold Audit).
Amendment 1 — 2026-05-24: Buffered-path SPAWN_FAILED with usable chunks must NOT trigger fallback (D16)
-
Finding: Cold-audit Finding 17 (P2 fallback correctness) — Hard triggers bullet 3 in the Decision section below reads: "Provider CLI exit code ≠ 0 with no usable response chunks streamed." The qualifier "with no usable response chunks streamed" is load-bearing. Pre-D16 code in
server.mjscollectAllChunkshad no catch block: if the provider generator threwProviderError(SPAWN_FAILED)after yielding N>0 IR delta/stop chunks, the throw propagated out of thefor awaitloop, discarding the accumulated chunks. The fallback engine then treated SPAWN_FAILED as a hard trigger unconditionally, advanced the chain, and served the next provider's response. The original provider's actual partial output — content the user had already paid for — was silently dropped. -
Clarification — "usable response chunks streamed": A chunks array has usable chunks if
chunks.length > 0where the counted chunks are IR delta or stop chunks (i.e.,type === 'delta'ortype === 'stop'). Chunks oftype === 'error'are excluded from this count — they are failure signals, not usable content. In the buffered path (collectAllChunksinserver.mjs),type === 'error'chunks cause an immediate throw before being pushed to the array (see existing code), so in practicechunks.length > 0after the loop implies the array contains only delta/stop chunks and the count correctly reflects usable content. The N=1 boundary is intentional: even a single non-empty delta chunk represents content the provider has committed and the user has paid for in quota; dropping it to serve an alternate provider's response is strict waste and potentially misleading (the second provider may produce different content for the same prompt). -
Behavior change (D16): In the buffered path (
collectAllChunksinserver.mjs), when the provider generator throwsProviderErrorwithcode === 'SPAWN_FAILED'after yielding one or more chunks:- If
chunks.length > 0: synthesize a final stop chunk{ type: 'stop', finish_reason: 'length' }, push it to the chunks array, log awarneventspawn_failed_after_usable_chunks, and return the chunks (do not re-throw). The fallback engine sees a successful return value and does not advance the chain. The client receives the partial response withfinish_reason: 'length'.X-OLP-Fallback-Hops: 0is emitted. - If
chunks.length === 0: the SPAWN_FAILED error propagates as before. The fallback engine fires the hard trigger and advances the chain (Case A — correct behavior unchanged). - Any other error code (not SPAWN_FAILED): always re-thrown, behavior unchanged.
- Cache behavior: truncated responses (those produced by the SPAWN_FAILED salvage path) are NOT persistently cached. ADR 0005 § "Cache write conditions" item 1 requires "response completed successfully (no truncation, no error mid-stream)"; a salvaged partial response does not meet this condition. In
executeHopFn, the salvaged result is written throughcacheStore.getOrComputenormally so that concurrent inflight callers (D4 singleflight) share the spawn and all receive the partial response — then the entry is immediately evicted viacacheStore.set(keyId, hopCacheKey, result, ttlMs=0), which causes_isAliveto treat the entry as expired on the next read. The write-then-evict pattern preserves D4 singleflight during the truncation event (the right behavior — concurrent callers should share the partial spawn rather than each triggering their own) while ensuring future fresh callers re-spawn the provider rather than serving cached truncated content. The salvage path uses a non-enumerable__truncatedmarker on the returned chunks array to signal the eviction; the marker does not appear inJSON.stringifyor in any client-visible surface.
- If
-
finish_reason choice: The synthesized stop chunk uses
finish_reason: 'length'because: (a) it is in the OpenAI spec enum (stop | length | tool_calls | content_filter | function_call | null); (b) it semantically maps to "output was truncated due to resource constraints," which is the closest available enum value to "truncated because the provider process exited non-zero during cleanup after streaming output"; (c)nullis inferior — some clients retry onnullfinish_reason expecting additional chunks, which would cause spurious re-requests; (d)stopwould be misleading — it implies the model naturally terminated at a sentence boundary, which is false. Usinglengthcorrectly signals to the client that the output was cut short and they may wish to re-request or continue. -
Streaming path note: The D10 real-streaming branch (single-hop,
server.mjslines 401–510) already handles the analogous case correctly via ADR 0004's first-chunk rule: oncefirstChunkEmitted === true, any subsequent error truncates the response withres.end()(no re-throw, no fallback). This amendment applies specifically to the buffered path (collectAllChunks+ multi-hop fallback chains). The streaming path is not changed by D16. -
Procedural mechanism: CC 开发铁律 v1.6 § 10.x (Cold Audit). Diff-review reviewers on earlier passes focused on the first-chunk rule for the real-streaming path; the buffered path has its own truncation-vs-fallback decision point, which the cold-audit pass on 2026-05-23 identified as Finding 17.
Amendment 2 — 2026-05-24: Soft triggers deferred to v1.x (D22)
-
Finding: Cold-audit round-2 Finding 2 (P2 — feature surface implemented but data ingestion not wired). The § Trigger taxonomy in the Decision section below lists soft triggers as a live, configurable feature category. However,
evaluateSoftTriggersinlib/fallback/engine.mjsis inert at v0.1 because: (a)buildDefaultChainhardcodesquotaSnapshot: nullon every hop; (b) no call site forprovider.quotaStatus()exists in production code paths (server.mjsorlib/fallback/engine.mjs); (c)evaluateSoftTriggerscorrectly short-circuits tofalsewhenquotaSnapshot == null. A user populatingrouting.soft_triggersin~/.olp/config.jsongets zero runtime effect at v0.1. -
Decision: Defer soft triggers to v1.x — re-classify them alongside Deterministic-deferred and Cost-aware-deferred in the trigger taxonomy. The evaluation code (
evaluateSoftTriggersinlib/fallback/engine.mjs) stays in place: it is small, well-tested via unit tests that inject quota snapshots directly, and architecturally correct. v1.x reactivation requires only wiring the data ingestion path, not rewriting the evaluation logic. Configuredrouting.soft_triggersthresholds in~/.olp/config.jsonhave no runtime effect at v0.1 and are silently ignored. -
Rationale: At v0.1, wiring
quotaStatus()polling requires: per-hop async I/O before each spawn decision, error handling for providers that do not implement the optionalquotaStatus()method, a caching layer to avoid re-polling on every request, and a latency budget for a pre-spawn network call. No current provider has a reliable quota endpoint (claude -pdoes not expose quota;codex exec --jsondoes not;vibe --promptdoes not). Implementation cost is high; value at v0.1 is zero. The inert-but-correct state is the conservative call. -
Effect on § Trigger taxonomy: The soft triggers entry in the table below is updated to mark soft triggers as deferred to v1.x, alongside Deterministic-deferred and Cost-aware-deferred. The architectural text describing the soft trigger design (the three threshold types) is retained — it remains the correct v1.x design — with an inline deferral note appended.
-
What v1.x reactivation looks like: A single ADR amendment + three code changes: (a) wire
await provider.quotaStatus(authContext)inbuildDefaultChainor per-hop inexecuteWithFallback, (b) populatechainHop.quotaSnapshotfrom the polling result, (c) add integration tests verifying the production path produces non-null snapshots that drive evaluation. TheevaluateSoftTriggersfunction inengine.mjsdoes not change. -
Procedural mechanism: CC 开发铁律 v1.6 § 10.x (Round-2 Cold Audit). Diff-review reviewers on D5/D9 focused on evaluation correctness; nobody traced the production data path end-to-end to verify
quotaSnapshotwas ever populated. Round-2 cold audit caught it.
Context
A multi-provider proxy is only valuable if it fails over gracefully. Per spec §1, OLP's core value proposition is "your IDEs and family clients keep working as long as any of your subscriptions has quota left." If Anthropic returns 529 (overloaded), or OpenAI returns 429 with insufficient_quota, or claude -p exits non-zero, the client should not see an error; the client should see the next provider in the chain transparently take over.
Naive fallback is dangerous. The most-natural-looking implementation — "any error, retry next provider" — is catastrophic for any request with side effects. Consider a /v1/chat/completions request whose first response chunk contained {"role": "assistant", "tool_calls": [{"name": "write_file", "arguments": "..."}]}, and the client's agent loop has already begun executing that tool call when the SSE stream breaks. If OLP retries against the next provider, the second provider's response may contain a different tool call — and now the client agent has executed two different write_file operations from what looks to them like one request. This is exactly the "duplicate write" failure mode that makes naive retry a foot-gun in any HTTP system with non-idempotent operations.
The structural answer is fallback only on idempotent failures: if the response has not started streaming back to the client, fallback is safe. If the response has started, the request is not retried — the client sees the truncation and decides what to do (an IDE agent loop typically has its own retry logic with awareness of partial state; OLP cannot reason about that).
The second axis of fallback design is trigger taxonomy. Not every provider response is a fallback signal. Anthropic 401 (auth failure) is a fallback signal only if it persistently fails — otherwise it's a configuration problem the user needs to fix, not a quota problem the proxy should hide. Anthropic 429 with no body might be a transient burst limit; OpenAI 429 with insufficient_quota is a hard out-of-credit signal. The fallback engine has to distinguish these.
The third axis is chain advancement. Spec §4.3 calls for one-provider-at-a-time advancement: if the chain is [anthropic, openai, mistral] and Anthropic fails, advance to OpenAI; if OpenAI also fails, advance to Mistral; if Mistral also fails, return the original error (not Mistral's, not the cascade) with X-OLP-Fallback-Exhausted listing tried providers. This preserves the client's ability to debug — the first failure is the load-bearing signal, not the last one.
The fourth axis is observability. Every fallback hop must be loggable and counted. X-OLP-Fallback-Hops: 0 on a successful primary serve; X-OLP-Fallback-Hops: 1 on first-fallback success; X-OLP-Provider-Used: openai so the client knows which subscription consumed the quota. These headers are user-facing instrumentation, not internal-debug; they are spec'd in §4.7.
Decision
Per spec §4.3, the OLP fallback engine implements the following:
Trigger taxonomy.
-
Hard triggers (mandatory, non-configurable).
- HTTP 5xx from provider's underlying API (after spawned CLI surfaces them)
- HTTP 4xx that semantically indicate quota exhaustion (Anthropic 529 overloaded, OpenAI 429 with
insufficient_quotabody, Anthropic post-2026-06-15 credit-pool-exhausted indicator if a body discriminator exists) - Provider CLI exit code ≠ 0 with no usable response chunks streamed
- Provider CLI spawn timeout (configurable per-provider via
hints.maxSpawnTimeMs)
-
Soft triggers (configurable per chain).
credit_pool_percent_threshold— fall back before hitting Anthropic's 100% Agent SDK Credit consumption, e.g., at 90% (per spec §4.3 example config)daily_request_count_threshold— fall back after N requests on the primary todayfive_hour_window_percent_threshold— fall back based on rolling 5h window quota usage- Soft triggers are evaluated before spawn. If a soft trigger fires for the primary, the proxy advances to the next chain entry without attempting the primary at all.
- 📋 Deferred to v1.x (Amendment 2) — evaluation surface is implemented in
lib/fallback/engine.mjs#evaluateSoftTriggersand unit-tested, but the production data ingestion path (quotaStatus()polling per hop) is deferred to v1.x. Configuredrouting.soft_triggersthresholds in~/.olp/config.jsonhave no runtime effect at v0.1.
-
Deterministic triggers (deferred to v1.x). Time-of-day routing, request-content routing ("code requests prefer Codex"). Out of scope for v0.1; tracked in spec §8 future work.
-
Cost-aware triggers (deferred to v1.x). Per spec §4.3 + §8, fully cost-aware automatic fallback is deferred until provider cost-reporting is reliably retrievable. v0.1 ships without this.
Fallback safety — first-chunk rule. A request is eligible for fallback only if no response chunk has been emitted to the client. Specifically:
if (responseChunksEmitted === 0 && triggerMatches(error)) {
advanceChainAndRetry();
} else {
surfaceErrorToClient(); // client sees truncation; client decides
}
This is non-negotiable for v1.0. Post-first-chunk truncations are surfaced to the client with the same error semantics OpenAI uses for streaming interruptions. Tool-using clients (agent loops) typically have their own handling for partial responses; OLP cannot second-guess that handling.
Chain advancement — one at a time. Given a chain [A, B, C]:
- Try A. If A succeeds, return; emit
X-OLP-Fallback-Hops: 0,X-OLP-Provider-Used: A. - If A's failure matches a hard or soft trigger AND no chunks emitted: try B. If B succeeds, return; emit
X-OLP-Fallback-Hops: 1,X-OLP-Provider-Used: B. - If B also fails: try C. Same logic.
- If all of A, B, C fail: return A's original error (not B's, not C's) with
X-OLP-Fallback-Exhausted: A,B,Clisting the chain order, and per-provider failure detail in a debug headerX-OLP-Fallback-Detail(JSON, owner-only — gated behind a config flag for non-owner keys).
Observability headers (per spec §4.7).
X-OLP-Provider-Used: <provider-name>X-OLP-Model-Used: <provider-native-model-id>X-OLP-Fallback-Hops: <integer ≥ 0>X-OLP-Cache: hit | miss | bypassX-OLP-Latency-Ms: <integer>
Each fallback hop emits a structured log event with: timestamp, chain id, hop index, failed provider, trigger type, IR request hash, downstream provider that was tried next.
No fallback for client-side errors. HTTP 400, 401 (auth misconfigured), 403, 404, 422 from a provider are not fallback triggers. They indicate the request itself is malformed or the user's auth is wrong, and silently masking that by trying the next provider would prevent the user from ever discovering the misconfiguration. These errors are surfaced to the client immediately with provider attribution.
Consequences
Positive
- The first-chunk rule eliminates the duplicate-side-effect failure mode at the architectural level. There is no configuration knob, no per-provider override, no "we'll try to be smart about it" — the rule is binary and the safety guarantee is binary.
- The trigger taxonomy is enumerated and bounded. A reviewer reading a PR that proposes a new trigger has a clean checkpoint: "is this hard, soft, deterministic, or cost-aware? cite the spec §4.3 category." Triggers outside the four categories require an ADR amendment.
- Chain advancement returning the original error (not the cascade) makes debugging tractable. The user sees what their primary provider said, not a confusing tail-end "Mistral failed" message that obscures the actual problem.
- Observability headers are surface-level. Clients (and the maintainer running
curl -i) can immediately see which provider served a request and whether fallback fired, without enabling debug logging.
Negative
- Some failures don't fall back. Post-first-chunk truncations surface to the client as truncations. This is the correct behavior, but it means OLP cannot achieve "literally never fails as long as one provider is alive" — clients still see truncations when a provider dies mid-response. This is a property of the safety guarantee, not a bug.
- The credit-pool-percent-threshold soft trigger requires per-provider quota retrievability. Per spec §4.2,
quotaStatusmay return null if a provider doesn't expose it. Soft triggers gracefully degrade (treat null as "don't fire") but the value proposition is weaker for providers without retrievable quota. - The trigger configuration is per-chain, not global. A user with three chains has three places to tune thresholds. The dashboard surface (spec §4.6) makes this navigable; raw
config.jsonediting is the source of truth.
Mitigations
- The first-chunk rule applies at the byte level (any data written to the response stream blocks fallback), not at the semantic level (where it would require parsing). Implementation is a single boolean flag tracking whether anything has been written; the rule is auditable in a few lines of code.
- Provider plugins that cannot retrieve quota (
quotaStatusreturns null) are documented in their plugin header and indocs/provider-caveats.md(📋 planned — not yet authored; until it exists, this information lives in the plugin header comment). Soft triggers configured against such providers issue a startup warning so the user knows the trigger will never fire. - The deferred trigger types (deterministic, cost-aware) are tracked in spec §8 with explicit Q-tags. Adding them later is an ADR amendment plus a contract addition to the trigger taxonomy, not a redesign.
Alternatives considered
(a) Full retry-on-any-error. Any non-2xx response triggers fallback. Rejected: this is the duplicate-side-effect foot-gun, and it also masks client-side errors (a malformed request would silently parade through every provider in the chain before being surfaced). The safety guarantee OLP is making would be impossible to make.
(b) No fallback at all — pure routing only. OLP picks one provider per request based on chain config but does not retry on failure. Rejected: this defeats the spec §1 value proposition. The whole reason for OLP's existence is "as long as any subscription has quota left, things work." No-fallback gives the user a manually-coordinated multi-provider setup, which they could have built with environment-variable swapping in their IDE.
(c) Semantic retry — try to detect when retry is safe. Inspect the in-flight request, the partial response, and the failure mode; if the partial response is reasoning-only (no tool calls emitted yet), retry; if tool calls have been emitted, do not retry. Rejected for v1.0 as too ambitious. Distinguishing "safe to retry" requires parsing the partial IR response, identifying side-effecting tool calls (which means OLP has to know which tools are side-effecting — it cannot), and reasoning about idempotency at the application layer. v1.0 ships with the conservative first-chunk rule; semantic retry is a candidate for a future ADR if real failure modes justify the complexity.
(d) Retry-after-N-seconds before fallback. When a provider transiently fails (e.g., Anthropic 529), wait N seconds and retry the same provider before advancing the chain. Rejected as a separate concern from this ADR. Per-provider retry-with-backoff before chain advancement is a useful refinement, but it's an enhancement to the "try A" step of chain advancement, not a change to the chain advancement rules. Tracked as future work; v1.0 has a single attempt per chain hop.
(e) Parallel fan-out — issue requests to all providers in the chain simultaneously, race them. Rejected: this consumes quota on all providers regardless of which one's response is used, which directly violates the spec §1 value proposition (minimize quota consumption). Quota is the constraint OLP exists to manage; spending it speculatively is the wrong shape.
Sources
- OLP v0.1 spec §4.3 (Fallback engine, including trigger types, fallback safety, example config)
- OLP v0.1 spec §4.7 (Observability — response headers)
- OLP v0.1 spec §8 Q-B, Q-E (Open questions about provider-specific quota and rate-limit-window awareness)
- OCP architecture context (
~/ocp/server.mjsdoes no fallback — it forwards to one Anthropic endpoint; the absence of fallback handling in OCP is informative about what greenfield design OLP needs)