fix(docs): Clear timeout in 3D Fish example#2311
Merged
Conversation
iwoplaza
requested review from
aleksanderkatan,
cieplypolar,
Copilot and
reczkok
|
pkg.pr.new packages benchmark commit |
📊 Bundle Size Comparison
👀 Notable resultsStatic test results:No major changes. Dynamic test results:No major changes. 📋 All resultsClick to reveal the results table (344 entries).
If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu. |
There was a problem hiding this comment.
Pull request overview
Updates the TypeGPU docs “3D Fish” rendering example to avoid applying delayed preset updates after the example has been cleaned up/unmounted.
Changes:
- Introduces a
disposedflag for lifecycle tracking. - Guards the delayed preset-reset timeout callback to no-op after cleanup.
- Marks the example as disposed during
onCleanup().
Comments suppressed due to low confidence (1)
apps/typegpu-docs/src/examples/rendering/3d-fish/index.ts:86
enqueuePresetChanges()schedules a timeout but doesn't keep the timer id, soonCleanup()cannot actually clear it. Thedisposedguard avoids writes after cleanup, but the pending timer still fires and can also stack ifenqueuePresetChanges()is called repeatedly within 300ms (potentially resettingspeedMultiplierearly). Store thesetTimeoutreturn value, clear any previous pending timeout before scheduling a new one, and clear it inonCleanup()to match the PR intent and avoid lingering callbacks.
window.setTimeout(() => {
if (disposed) return;
fishBehaviorBuffer.write(presets.default);
spinnerBackground.style.display = 'none';
speedMultiplier = 1;
}, 300);
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
reczkok
approved these changes
Mar 25, 2026
Contributor
|
When can this dispose matter? Is it when the fish haven't finished loading yet? |
Collaborator
Author
@aleksanderkatan Yes, it's when somebody would change a preset (or open up the example), then leave before it finished loading. |
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.
No description provided.