Skip to content

docs(hang): the hang-04 changelog describes the catalog that ships - #9133

Merged
kixelated merged 2 commits into
mainfrom
quest/m2/hang04/README
Nov 19, 2026
Merged

kixelated merged 2 commits into
mainfrom
quest/m2/hang04/README

Conversation

@kixelated

@kixelated kixelated commented Nov 19, 2026 •

Copy link
Copy Markdown
Collaborator

Finishes quest/m2/hang04/README.md, the hang-04 epic's own work: the last read before the freeze. Every child had already merged, so this deletes the epic.

Summary

  • Changelog. Rewrote drafts/draft-lcurley-moq-hang.md's moq-hang-04 changelog so it describes the change from the published hang-03 (the datatracker's draft-lcurley-moq-hang-03, which matches cddededdfb). The baseline is not release: that branch also carries backports hang-03 never had. I diffed the 03 source against main section by section.
    • Dropped steps main took along the way: the viewer feedback latency removal (hang-03 never had stats), and "wall-clock flush lateness" in the jitter entry (a release-only state; hang-03 defined a flush delay with frame-duration examples).
    • Merged the three include entries into one, merged the data track bitrate/jitter and delay entries, and rewrote the sync entry to say what replaced what (root archive and clock, and the timeline track) without listing fields that hang-03 never had (replayEpoch).
    • Added what was missing: the Discovery section's removal, the HLS and DASH section, the TTML payload rules, CMAF runs packed back to back with data_offset counted from the moof, LOC's codec payload using the legacy framing, and interlaced as an identity field.
  • Draft text. The Version section's list of changes an older consumer can safely ignore now also names preference, instance, color, projection, stereo, interlaced, and audio layout, which is what the code already does (only track raises an entry to version 4). The data track bitrate now has a range (0 to 2^53 - 1), so the root rule's "out of range" has something to apply to.
  • Parity corpus. rs/hang/fixtures/catalog-parity.json, which both rs/hang and js/hang's catalog/parity.test.ts load, gains 52 cases. Before, stats and echo had only mis-shaped cases. Now there are cases for accepted stats and echo, echo and broadcast path spelling, include entries, the sync.clock timescale and wall bounds, every json and binary field and its range, unknown data track modes and text formats, text roles, and the remaining video and audio fields (stereo, stalled, color, VR180, interlaced, a lone display aspect, ambisonic, PCM, versions 3 and 4).
  • Bug the corpus found. Rust accepted a json or binary track bitrate above 2^53 - 1, which JS refuses. Rust now bounds it the way it bounds a video bitrate (crate::snapshot::Number).

Decisions

Choices made while the maintainer is away; each can be undone in review:

  • Changelog baseline is the published hang-03, not release. The README says hang-03 is what the datatracker and release carry, but release has backported fields (rendition delay, data track estimates) that the datatracker's 03 lacks. The changelog tells a reader of published 03 what changed, so it has to diff against what was published.
  • Root-escape cases stay out of the parity corpus. Parsing never sees the catalog's own path, so neither language can refuse ../../x at parse time; resolution checks it. The corpus only covers path spelling.
  • Unknown data track mode and text format are kept at parse. Both languages already keep them, the same way an unknown container kind is kept, and leave them for selection to skip. The corpus records that rather than changing either side.
  • Consumers' marker rules left alone. Media consumers rewrites the duration and discontinuity marker rules before the cut, so the container marker entries stay as they are for that PR to rewrite.

Validation

  • bun test src/catalog/parity.test.ts in js/hang: 422 pass. A first probe failed on the root-escape cases (dropped, see Decisions) and on the unknown mode and format cases (both languages keep those entries; the expectations were corrected).
  • cargo test -p hang --lib: 143 pass. Before the Rust fix, shared_parity_fixtures failed on json bitrate beyond 2^53: accepted. That run is the independent check: the same corpus run through both implementations.
  • Changelog audited two ways: the source diff from cddededdfb to main, and the rendered datatracker text of hang-03.
  • just drafts check, just check, and quest check --base origin/main pass.

Public API and wire

  • Public API: none changed. Rust's hang::catalog::JsonConfig/BinaryConfig now refuse a bitrate above 2^53 - 1, matching JS (a behavior change, not breaking).
  • Wire: the hang-04 catalog JSON is still unpublished. The data track bitrate gains a range, and the changelog and Version text are editorial.

Caused by

  • moq-dev/moq#4089 - added the data track bitrate bounded to 2^53 - 1 in JS but unbounded in Rust (found by check)

Follow-ups

None.

Models

Size: S
Implementer: Claude, claude-opus-5-5, high effort

(Written by Claude Opus 5.5 with high)

🤖 Generated with Claude Code

Review

Rewritten by quest review after each round.

  • Head: bcded05

  • Base: origin/main at 77dd8fe

  • Risk: medium, the base has no RISK.md to name what is always high or customer-facing, so every change is medium

  • Classified: medium by default

  • Reviewer: Codex, gpt-6.1-sol, medium effort

  • Session: 01a1f12e-82d4-70c2-ae55-632db2144546, round 1

  • Score: 9/10, The Rust bitrate bounds match the existing JavaScript schemas and draft, with shared boundary fixtures and no actionable defects found by source review, though builds and tests were not run as instructed.

  • Rounds: 1; first round 0; findings 0: fixed 0, refuted 0, open 0

  • Findings: none

kixelated and others added 2 commits November 18, 2026 16:04
Quest-Claim: 4ace436e3bb1d1d6
Rewrite the draft's moq-hang-04 changelog as the change from the
published hang-03, dropping steps main took on the way and adding the
Discovery, TTML, CMAF run, and LOC framing changes it missed. Complete
the list of catalog changes an older consumer can ignore, and give the
data track bitrate its range.

The shared parity corpus now covers stats, echo, path spelling, includes,
the sync clock, every data track field, text, and the remaining video and
audio fields. It found Rust accepting a data track bitrate above 2^53 - 1
that JS refuses; Rust now refuses it too.

Finishes the hang04 epic.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kixelated kixelated changed the title hang-04 freezes a catalog worth keeping docs(hang): the hang-04 changelog describes the catalog that ships Nov 19, 2026
@kixelated
kixelated marked this pull request as ready for review November 19, 2026 00:22

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Approach: sound. Diffing the changelog against the published datatracker hang-03, not release, is the right baseline for a reader of the published draft. The one code change brings Rust's data track bitrate into line with JS and with Rust's own media bitrate.

Reviewed changes

I reviewed all 7 files. I checked the changelog against the published hang-03 table of contents and checked the Rust bound against the existing bitrate fields and the JS schemas.

  • Changelog baseline: I checked the rewritten entries against the published draft-lcurley-moq-hang-03. It had Discovery, a root Clock, Timeline (holding archive), Recording, and MPEG-TS Service Information. It had no stats, echo, include, HLS section, Version section, data track estimates, or audio warmup. So the new "Removed the Discovery section", "Replaced the root archive and clock sections… Removed the Timeline section", and the dropped viewer feedback latency entry all match what was published.
  • Version section: The longer safe-to-ignore list matches the rule in the paragraph before it: only a track other than the ID raises an entry to 4.
  • Data track bitrate range: The draft now gives 0 to 2^53 - 1. Rust's JsonConfig/BinaryConfig use NotNull<crate::snapshot::Number>, the same as audio/mod.rs and video/mod.rs, and this matches u53Schema in js/hang/src/catalog/{json,binary}.ts.
  • Parity corpus: Each new range field gets a boundary pair (2^53 - 1 accepted, 2^53 refused). Rust and JS both keep an unknown mode or format and leave it for selection to skip, and the corpus records that.
  • Quest bookkeeping: The epic README is deleted, and the links to it in quest/m2/README.md and quest/m3/ffi-catalog-skipped.md are removed.

Pullfrog  | View workflow run | Using claude-opus-5-5 | 𝕏

@coderabbitai

coderabbitai Bot commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The draft adds catalog field details and reorganizes the hang-04 changelog. The quest documentation marks hang-04 as done, removes its planning document, and removes a related link. JSON and binary bitrate serialization now uses a bounded numeric type. New parity fixtures cover catalog validation and bitrate, jitter, and delay boundaries.

Merge Risk: Minimal · up to bcded

This change updates the hang-04 draft documentation and aligns the Rust bitrate bound with the JavaScript implementation. It adds parity test cases for the boundaries. No actionable merge-blocking risk is identified.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: the hang-04 changelog in the draft is rewritten to describe the catalog that ships. It is specific and matches the changelog rewrite, which is the core of the PR. The …
Description check Passed The description is detailed and directly related to the changeset. It covers the changelog rewrite, the draft Version section and bitrate range, the 52 parity fixture cases, the Rust bitrate bound fix…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the main change: the hang-04 changelog in the draft is rewritten to describe the catalog that ships. It is specific and matches the changelog rewrite, which is the core of the PR. The PR also touches fixtures and a Rust bitrate bound, but the title does not need to cover every detail.

Full details: Description check

Explanation

The description is detailed and directly related to the changeset. It covers the changelog rewrite, the draft Version section and bitrate range, the 52 parity fixture cases, the Rust bitrate bound fix, the deletion of the hang-04 epic README, and validation steps. It is on-topic and specific.

Finishing Touches

Simplify code

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a1527629-f9b9-4615-8d56-f0e50103b126
Commits

Reviewing files that changed from the base of the PR and between 77dd8fe and bcded05.

Files selected for processing: 7

  • drafts/draft-lcurley-moq-hang.md
  • quest/m2/README.md
  • quest/m2/hang04/README.md
  • quest/m3/ffi-catalog-skipped.md
  • rs/hang/fixtures/catalog-parity.json
  • rs/hang/src/catalog/binary.rs
  • rs/hang/src/catalog/json.rs
Files with no reviewable changes: 2

  • quest/m2/hang04/README.md
  • quest/m3/ffi-catalog-skipped.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

@kixelated

Copy link
Copy Markdown
Collaborator Author

Merge pick (maintainer away, granted the coordinator merges it confidently recommends): ✅ /quest-merge, accepting the decisions listed in the PR body.

(Written by Claude Opus 5.5 with high)

@kixelated
kixelated added this pull request to the merge queue Nov 19, 2026
Merged via the queue into main with commit 36666ad Nov 19, 2026
10 checks passed
@kixelated
kixelated deleted the quest/m2/hang04/README branch November 19, 2026 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant