docs(contract): P4's violations and §6's backlog shipped — reconcile them - #548
Merged
Conversation
…them The doc advertised work that is done. P4 listed four live violations; all four landed, and §6's own "Shipped" record below the table already says so — the two halves of the same section contradicted each other. Verified against source, not against the record: - `ReconnectOptions.maxAttempts` → `attempts` (`maxAttempts` survives only as engine.ts's resolved reconnect policy) - `CacheOptions.maxEntries` → `entries` (cache.ts reads `config.entries`; `maxEntries` is a local) - `CircuitOptions.failureThreshold` → `failures` (resilience.ts reads `opts.failures`; `failureThreshold` is a local) - `paginate.max` → `pages`, on the extracted `PaginateOptions` That pattern is itself the rule's boundary, so P4 now states it: a `max*` spelling is fine on a RESOLVED internal, which names a computed value; P4 governs the authoring surface. §6's table had the same rot — seven of its eight rows shipped (the cross-package clashes are qualified per-framework/per-ecosystem, `stitchQueryOptions`, `OAuth2Options`/`CookieSessionOptions`, `PaginateOptions`, `streamStitchSse`, `StitchErrorOptions`, and `RedisDriver`'s async `close` — `quit` survives only on the upstream client duck-types, which P18 keeps at their upstream spelling). Only `bodyKind` (from-curl) is still live, so the table is down to that one row. Complements #528, which reconciles the other principles' violation lists but leaves P4 and §6's table untouched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…en entry #528 renamed §6 from "Migration backlog" to "Migration record", which broke both `(#6-migration-backlog)` links — the one this branch added under P4 and the one #528 left behind at P19. Both now point at the real heading. Also reconciles §6's intro with its new name (it still promised "proposed target spellings the sweep will apply" under a heading that says record), and states what the one surviving row actually is: `bodyKind` lives in `from-curl.ts`, imported by `cli.ts` alone, exported from no index and behind no subpath — so nothing on the published surface carries the name. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The contract advertises work that is already done. P4 lists four live violations — all four
shipped — and §6's own Shipped record, sitting a few lines below its backlog table, already
says so. The two halves of the same section contradict each other, which makes the rule read
as one nobody enforces.
Complements #528: that PR reconciles the violation lists on P3/P5/P7/P8/P9/P14/P16/P17/P20 and
leaves P4 and §6's table untouched. This is those two.
P4 — verified against source, not against the record
ReconnectOptions.maxAttempts→attemptsmaxAttemptssurvives only asengine.ts's resolved reconnect policyCacheConfig.maxEntries→entriescache.tsreadsconfig.entries,maxEntriesis a localCircuitOptions.failureThreshold→failuresCircuitOptionsoverhaul;resilience.tsreadsopts.failures,failureThresholdis a localpaginate.max→pagesPaginateOptionsThree of the four leave a
max*/*Thresholdname behind on a resolved internal, and thatpattern is the rule's own boundary — so P4 now states it rather than leaving the next reader to
grep and wonder: a
max*spelling names a computed value; P4 governs the authoring surface.§6 — seven of eight rows shipped
Only
bodyKind(from-curl) is still live (from-curl.ts:24), so the table is down to that row.The rest are recorded in §6's Shipped list below it; each verified in source:
StitchStore/StitchLike/RequestSeamclashes — qualified per-framework(
SolidStitchStore,SvelteStitchStore) and per-ecosystem (ExpressRequestSeam, …); theratchet's
UNIQUE_WATCHde-listedStitchLikewith a written rationalequeryOptions→stitchQueryOptionsacross all five framework bindingsOAuth2Opts/CookieSessionOpts→OAuth2Options/CookieSessionOptionspaginateshape → exportedPaginateOptionsstreamStitchSse(the old names appear in nosrc/)StitchErrorOptionsRedisDriverasyncclose—quitsurvives only on the upstream client duck-types, whichP18 keeps at their upstream
spelling, so the house contract is conformant
Deliberately not touched
The "New shorthand/toggle slots to add" line below the table (
.inspect()scalars,idempotencyboolean,throttlestring).throttle: stringlooks shipped —seam.tsfolds itvia
envelope(t, 'rate')— but the other two need the same per-item verification, and #528 isalready editing P12/P13/P20 territory. Left for a follow-up rather than guessed at here.
Verification
check-docs-linksgreen (110 routes)🤖 Generated with Claude Code