Skip to content

fix(migrate)!: align guides with released APIs - #6443

Closed
kixelated wants to merge 2 commits into
mainfrom
quest/m1/api-audit/migrate
Closed

kixelated wants to merge 2 commits into
mainfrom
quest/m1/api-audit/migrate

Conversation

@kixelated

@kixelated kixelated commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

Problem

Migration guides mix released APIs with intermediate main-only shapes, omit real breaks, and give contradictory broadcast-finish advice. A reader upgrading from release cannot follow that history directly.

Approach

Compare checked-out main 3b6234c789 with release d603ab63b1, then describe the direct upgrade:

  • Correct broadcast finish, current async shutdown, untimed raw-track defaults, media naming targets, track-end positions, and transport-error classification in the core and wrapper guides.
  • Describe hang's released shared timeline becoming per-track timelines and frame positions, JS container read events, archive version 1 becoming version 3, and tagged HLS segment requests. Release already had Key::Groups; main removes it, so the guide documents removal rather than incorrectly claiming it was added.
  • Cover native video import names/fields, non-restartable CLI linger refusal, and opt-in Iroh. Drop main-only Writer, epoch, timebase, and JS cut-rate-limit migration stories.
  • Replace partial generated-binding histories and checksum-only notes with links to the complete core and wrapper guides.

Finish the settled short_side rename in the public transcode ladder and its actual catalog resolver consumer. Existing tests exercise ladder validation, portrait geometry, and software encoding. Remove the completed quest and references.

The publication instructions are reconciled by retaining MIGRATE in every affected package while giving never-published packages first-release/canonical guidance, without fictitious upgrade paths. C++ has no cpp-v* release tags; the released @moq/clock was a private example. No instruction rules change.

Impact

  • Breaking Rust API: moq_transcode::Rung.size is short_side; the scalar ladder error fields are short_side / below_short_side. The migration describes the published height directly becoming short_side. Constructor arity, validation, output geometry, and runtime cost are unchanged.
  • No new wire, recording-format, FFI, or binding API changes. Those changes already on main are documented accurately; package versions are unchanged.

Validation

  • Focused transcode tests with OpenH264: 65 passed.
  • Full nix develop --command just ci: passed. Rust 8,273 passed / 62 skipped; capture 513 passed / 13 skipped; CLI 223 passed / 1 skipped. JS, Python (104 tests), Kotlin, Go race, Dart, installed C++/doc consumers, OBS compilation, and selected lint/build checks passed.
  • Swift compilation was skipped because this Linux host has no Swift toolchain.
  • Final Markdown, quest check (607 documents), and git diff --check: passed.

Alternatives

Keeping each intermediate rename would preserve contradictory upgrade instructions. Deleting first-publication guides entirely would lose the package entry point and conflict with the per-package MIGRATE requirement.

Follow-ups

No new quests or open decisions. Coordinate overlapping paragraphs when combining with shutdown #6436, encoder config #6432, and resolution #6445: their owners retain direct released-to-final guidance. In particular, #6436 replaces this checked-out main's async shutdown advice with its final synchronous request/closed-wait shape. This audit does not advertise those unmerged APIs as present.

(Written by GPT-6)

kixelated and others added 2 commits October 22, 2026 19:06
Co-Authored-By: GPT-6 <codex@openai.com>
@kixelated kixelated changed the title MIGRATE matches release fix(migrate)!: align guides with released APIs Oct 23, 2026
@kixelated
kixelated marked this pull request as ready for review October 23, 2026 02:30
@coderabbitai

coderabbitai Bot commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 35 seconds.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ 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: 0786f0cb-688e-4226-8281-e8c188dcfc93
📥 Commits

Reviewing files that changed from the base of the PR and between 3b6234c and 570fb39.

📒 Files selected for processing: 27
  • cpp/moq/MIGRATE.md
  • dart/moq/MIGRATE.md
  • dart/moq_ffi/MIGRATE.md
  • go/ffi/MIGRATE.md
  • go/wrapper/MIGRATE.md
  • js/clock/MIGRATE.md
  • js/hang/MIGRATE.md
  • js/publish/MIGRATE.md
  • kt/moq-ffi/MIGRATE.md
  • kt/moq/MIGRATE.md
  • py/moq-ffi/MIGRATE.md
  • py/moq-rs/MIGRATE.md
  • quest/m1/api-audit/README.md
  • quest/m1/api-audit/migrate.md
  • quest/m1/ffi-shutdown-sync.md
  • rs/hang/MIGRATE.md
  • rs/moq-archive/MIGRATE.md
  • rs/moq-cli/MIGRATE.md
  • rs/moq-ffi/MIGRATE.md
  • rs/moq-hls/MIGRATE.md
  • rs/moq-net/MIGRATE.md
  • rs/moq-transcode/MIGRATE.md
  • rs/moq-transcode/src/catalog.rs
  • rs/moq-transcode/src/ladder.rs
  • rs/moq-video/MIGRATE.md
  • swift/MIGRATE.md
  • swift/ffi/MIGRATE.md
  • 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

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T02:35:15.576469Z 570fb39 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@kixelated
kixelated added this pull request to the merge queue Oct 23, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Oct 23, 2026
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