fix: return defensive copies from public clip getters#137
Merged
Conversation
|
🎉 This PR is included in version 2.13.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
1 participant
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.
What changed
getClipById,getClip, andgetTrackreturned references to live internal state (the document clip and player clip configurations). A caller that mutated the returned object silently changed the running edit, and a caller that froze it — common with state libraries that auto-freeze, such as immer or Redux Toolkit — locked the edit's internal state in place, so the next resize or drag threwTypeError: Cannot add property width, object is not extensible.These getters now return copies, matching the library's existing convention of copying inputs at the document boundary. Mutating a returned clip no longer affects the edit — use
updateClip/updateClipByIdto make changes.How to verify
Regression tests in
tests/edit-clip-operations.test.ts("defensive copies from public getters"): freezing a clip returned bygetClipByIdmust not break in-place document updates, and objects returned bygetClip/getTrackare detached from player state. Full suite passes (1844 tests).