Fix/gif ordering: Fixing frame ordering issue for uploading costumes using GIFs. #1
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.
Resolves
Resolves scratchfoundation#5875
Before: Out of order GIFs after costume upload:
Screen.Recording.2024-12-08.at.4.18.34.PM.mov
After: In order GIF after costume upload:
Screen.Recording.2024-12-08.at.4.20.44.PM.mov
Proposed Changes
Modify the function
handleNewCostume
insrc/containers/costume-tab.jsx
to send costumes sequentially to the Scratch VM usingasync await
syntax to ensure a costume is received by the VM before moving onto the next.Reason for Changes
Large GIF frames were being added out of order when uploaded as costumes because they were being sent in parallel to the Scratch VM. Confirmed that the frames are in order when processed in
src/lib/gif-decoder.js
,src/lib/file-uploader.js
, ANDsrc/containers/costume-tab.jsx
, but were received out of order byscratch-vm/src/virtual-machine.js
in theaddCostume
function.Updated to modern
async await
syntax to handle Promises, which is the most up-to-date method of managing Promises in JS.Test Coverage
Before:
Unit tests:
Costume test:
After:
Unit Tests
Costume tests:
Browser Coverage
Check the OS/browser combinations tested (At least 2)
Mac
Windows
Chromebook
iPad
Android Tablet