diff --git a/quest/m1/README.md b/quest/m1/README.md index 861569b35dc..e763d7cf0f4 100644 --- a/quest/m1/README.md +++ b/quest/m1/README.md @@ -40,7 +40,6 @@ does not require it. - [JS names](/quest/m1/api-js-net-names.md) - @moq/net and @moq/pattern mirror Rust: `consume`, typed durations, one `readFrame()`, `InvalidPattern` - [FFI units](/quest/m1/api-ffi-units-verbs.md) - every moq-ffi duration is microseconds and `publish()` / `consume()` pair with their setters - [Deprecated sweep](/quest/m1/deprecated-sweep.md) - uncalled deprecated items, warn-then-ignore flags, and silent aliases are removed or become refusals before the release -- [External API proof](/quest/m1/api-release-proof.md) - packaged callers exercise real moq.pro use cases and record each audit finding's disposition - [Monotonic timeline](/quest/m1/monotonic-timeline.md) - a marker group of one empty frame declares a break and moves the live edge; producers refuse a rewind; consumers jump the playhead on an unproven hole and drop rewind detection - [Joining FETCH](/quest/m1/joining-fetch.md) - moq-net: every subscribe to a draft-14 to draft-19 relay joins at a group boundary, with contiguous history for an explicit start, via Largest Object plus a joining FETCH - [Anonymous rank](/quest/m1/anonymous-route-rank.md) - moq-net: a route through an anonymous hop ranks below every identified route at any cost, and hop 0 travels the chain to say so diff --git a/quest/m1/api-finish-borrow.md b/quest/m1/api-finish-borrow.md index 60d87c4bd36..73657a4ffb7 100644 --- a/quest/m1/api-finish-borrow.md +++ b/quest/m1/api-finish-borrow.md @@ -59,7 +59,3 @@ Public API: breaking for callers who bind a non-`mut` producer and call Wire: none. Run the affected Rust and `moq-ffi` check/test recipes, including `finish_closes_producer` and the Python local tests that encode take-on-finish, then `just test smoke-full` because `moq-ffi` behavior changes. - -## Related - -- [External API proof](/quest/m1/api-release-proof.md) - records this disposition diff --git a/quest/m1/api-release-proof.md b/quest/m1/api-release-proof.md deleted file mode 100644 index 32dfede5845..00000000000 --- a/quest/m1/api-release-proof.md +++ /dev/null @@ -1,78 +0,0 @@ -# [L] Prove the dev API through packaged external consumers - -## Goal - -Before publishing the dev API, representative external browser and native -callers build and exercise the intended contracts, and every finding in the -2026-09-12 audit has an explicit fix or deferral decision. - -## Plan - -The audit inspected dev `e2350b39a6ce9bd0734841fc4b4ce399ee195562`, fetched -from origin on 2026-09-12, against main and the actual consumer at -`/home/kixelated/work/moq.pro`. Consumer code was read without modification; -it targets an older API. Compile migrations alone are not upstream defects. - -Coverage included Rust origin/announce, sessions, track subscription/control, -group/frame ownership, timestamp invariants, bandwidth handles, JSON/binary -publishers, mux/hang boundaries, browser net/signals and JSON/binary wrappers, -watch/publish integration, shared FFI with C and native language wrappers, -and relay embedding. This is a source/API audit, not an exhaustive behavioral -proof of every exported symbol, platform backend, codec, or protocol version. - -New findings and recommendations, ordered by consequence: - -| Finding | Evidence status | Quest | -|---|---|---| -| FFI pending reads serialize independent datagram/group lanes | Reproduced; fixed: independent group and datagram lanes | completed | -| Shared/private connections disagree on credential-refresh recovery and terminal state | Reproduced; fixed: one URL-recovery contract, `closed` is handle disposal | completed | -| Relay embedding can discard newly added socket owners without a compile error | Fixed: `Relay` owns listeners and workers; embedders clone handles and mount routes | completed | -| FFI first-frame convenience treats empty groups as EOF and loses an acquired group on cancellation | Fixed: the pending group lives on the ordered cursor; empty groups are skipped and a cancelled read keeps its group | completed | -| JSON/binary readers hide the subscription cleanup handle | Abandoned: finish must be `&mut` so abort can follow | deferred | -| Typed Getter input can be rejected solely for lacking an internal brand | Fixed: getter() reuses any conforming Getter | Fixed | -| JSON edit guard logs failed implicit publication | Fixed: `modify` refuses a closed track, a failed drop aborts it | completed | -| Terminal publisher methods inconsistently retain the caller's handle | Signature comparison; finish must borrow so abort can follow | [Finish borrows](/quest/m1/api-finish-borrow.md) | - -Recommend resolving behavioral failures and published contract choices before -merge. Cosmetic consistency can be deferred explicitly if the maintainer -accepts the later breaking change. The table is a disposition checklist, not -an automatic declaration that every proposed quest must be implemented first. -Record each disposition and its fixing revision in the merge proof. - -Build a small public fixture against packaged exports, outside workspace -hoisting and path aliases, modelling: - -- Connection, announcements, credential refresh, and publication replacement. - moq.pro `app/src/lib/live.svelte.ts:75,113` is the reference use case. -- Stats snapshots versus retained rollup groups; choose the intended mode - instead of mechanically replacing a removed read helper. -- Catalog-only reading with full snapshots followed by deltas. The old - consumer `app/src/lib/broadcastCatalog.svelte.ts:46` assumes every frame is - a full catalog. Use Json.Snapshot.Consumer and the catalog schema as the - upstream watch path does (`js/watch/src/broadcast.ts:304`); generic JSON - reads plus schema validation do not reconstruct merge patches. -- Embedded relay with custom routes and application workers, based on - moq.pro `rs/edge/src/main.rs:88,317`, through the settled owning API. - -Do not copy the private application into the public repo. Include dependency -deduplication in packaged validation: moq.pro already tests physical package -identity (`app/test/deps.test.ts`); the module-local Connection pool and private -net hooks deserve a real two-copy test. Duplicate-copy failure remains an -unverified hypothesis until reproduced, not an established audit defect. - -Update migration docs beside the affected APIs, including Connection exports, -broadcast.track(...).subscribe(...), Ordered readers, JSON modes, and the -moq_native to moq_tokio transition. Do not reintroduce obsolete wrappers to -avoid migration. Run the fixture in CI, record package versions and exact -revisions, and let moq.pro's separately owned pin/release process adopt the -proved surface. This quest does not bump packages or deploy the consumer. - -Public API: no additional API change beyond the fixing quests; fixture and -documentation prove the chosen surface. Wire: no new format. Use existing -browser/native integration recipes and cross-language smoke as appropriate. - -## Related - -- [Merge dev](/quest/m1/merge-dev.md) - records the final release and interop proof -- [C ABI parity](/quest/m2/2152-libmoq-c-abi-catch-up-with-the-moq-ffi-surface.md) - already owns C request/server omissions -- [C fetch](https://github.com/moq-dev/moq/blob/e2350b39a6ce9bd0734841fc4b4ce399ee195562/quest/m2/libmoq-fetch.md) - already owns the missing C fetch entry point diff --git a/quest/m1/merge-dev.md b/quest/m1/merge-dev.md index 23f7e8cad3f..76b7d657d4b 100644 --- a/quest/m1/merge-dev.md +++ b/quest/m1/merge-dev.md @@ -62,7 +62,6 @@ additive quest that builds on dev-only code start on main afterwards from - [Cluster peer API](/quest/m1/api-cluster-peer-config.md) - typed peer configuration supports current symmetric policy - [Broadcast clock](/quest/m1/broadcast-clock.md) - the root clock replaces the published archive wall field on dev before release - [m0](/quest/m0/README.md) - every release blocker lands or is punted before the merge -- [External API proof](/quest/m1/api-release-proof.md) - the packaged consumer fixture and explicit fix/deferral decisions must be recorded before merge - [Monotonic timeline](/quest/m1/monotonic-timeline.md) - so a shed marker still jumps the playhead on a timestamp hole (#3291) ## Closes