docs(engine): ship the fast-capture-limitations.md every gate points at - #3880
Open
miga-heygen wants to merge 1 commit into
Open
docs(engine): ship the fast-capture-limitations.md every gate points at#3880miga-heygen wants to merge 1 commit into
miga-heygen wants to merge 1 commit into
Conversation
drawElementService.ts, frameCapture.ts, compileStage.ts, fallbackCaptureProfile.ts, validate-fast-video.ts, and the fast-video CI workflow all cite `docs/fast-capture-limitations.md` (several by specific `Lim N` number) as the reference for why a composition falls back to screenshot capture -- but the file never existed anywhere in the repo, so every one of those pointers was dangling and nothing was ever shipped in the published @hyperframes/engine package either. Add packages/engine/docs/fast-capture-limitations.md covering every fallback gate (SwiftShader, video capture, unsupported CSS effects, 3D contexts, supersampling, clip-cut boundaries, the at-risk-timeline predictor) plus the operational requirements and per-frame recoverable errors, and add "docs" to the package's `files` so it actually publishes. Add a regression test asserting the doc exists and still defines every limitation number cited by name elsewhere in the codebase. Co-Authored-By: Claude Sonnet 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.
Summary
PRINFRA-301 reported that
detectCssEffectRisk's drop-shadow fallback (correctly, still) routes to screenshot capture with no shippedfast-capture-limitations.mddoc. Investigation found the gap is broader than that one gate:drawElementService.ts,frameCapture.ts,compileStage.ts,fallbackCaptureProfile.ts,validate-fast-video.ts, and the fast-video CI workflow all citedocs/fast-capture-limitations.md— several by a specificLim Nnumber — but the file never existed anywhere in the repo, and even if it had,packages/engine'sfilesfield didn't ship adocs/directory in the published npm package.packages/engine/docs/fast-capture-limitations.md, covering every fallback gate currently in the engine (SwiftShader, video capture, unsupported CSS effects, 3D contexts, supersampling, clip-cut boundaries, the at-risk-timeline predictor) plus the operational requirements (Chrome build support, ffmpeg'spsnrfilter) and the per-frame recoverable-error fallback — cross-checked against the actual gate implementations, not just the doc pointers, so the limitation numbers match every existingLim Ncitation."docs"to@hyperframes/engine'spackage.jsonfilesarray so the doc actually publishes..github/workflows/fast-video-validation.ymlandvalidate-fast-video.ts's own comments ("fast capture cannot capture video on any platform yet") predate the Chrome-151 fix that removed the video-forces-screenshot gate, and haven't been re-validated since — likely stale, same flavor as the vault correction PRINFRA-301's repro already made for the drop-shadow-removed claim, but out of scope for this PR.Test plan
fastCaptureLimitationsDoc.test.ts) asserts the doc exists and still defines every limitation number cited by name elsewhere in the codebase — confirmed RED without the doc (isolated via taggedgit stash), GREEN with it.bunx vitest run packages/engine/src/services/fastCaptureLimitationsDoc.test.ts— 2/2 passed.bunx tsc --noEmit -p packages/engine— clean.bunx oxlint/bunx oxfmt --write— clean.bunx fallow audit --base origin/main --fail-on-issues— clean (0 issues in 3 changed files).🤖 Generated with Claude Code