fix: prevent AudioContext and MediaStream memory leaks in Sampler widget#4950
Merged
walterbender merged 1 commit intosugarlabs:masterfrom Jan 3, 2026
Conversation
Contributor
|
✅ All Jest tests passed! This PR is ready to merge. |
vyagh
added a commit
to vyagh/musicblocks
that referenced
this pull request
Jan 9, 2026
Replace addEventListener with onclick assignment for stop button handler to prevent duplicate event listeners from accumulating each time the play button is clicked. The previous implementation added a new click listener to the stop button every time the play button was clicked, causing: - Memory leak from accumulating listeners - Multiple handlers firing on single click - Performance degradation over time This fix follows the pattern used elsewhere in toolbar.js (e.g., renderStopIcon) and matches recent memory leak fixes in widgets (sugarlabs#5030, sugarlabs#5029, sugarlabs#4950, sugarlabs#4913). Changed Files: - js/toolbar.js: Replace addEventListener with onclick - js/__tests__/toolbar.test.js: Update test to match new implementation
vyagh
added a commit
to vyagh/musicblocks
that referenced
this pull request
Jan 9, 2026
Replace addEventListener with onclick assignment for stop button handler to prevent duplicate event listeners from accumulating each time the play button is clicked. The previous implementation added a new click listener to the stop button every time the play button was clicked, causing: - Memory leak from accumulating listeners - Multiple handlers firing on single click - Performance degradation over time This fix follows the pattern used elsewhere in toolbar.js (e.g., renderStopIcon) and matches recent memory leak fixes in widgets (sugarlabs#5030, sugarlabs#5029, sugarlabs#4950, sugarlabs#4913). Changed Files: - js/toolbar.js: Replace addEventListener with onclick - js/__tests__/toolbar.test.js: Update test to match new implementation
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
This PR fixes a resource leak in the Sampler widget’s pitch detection feature.
When users start pitch detection and then close the widget, the microphone, AudioContext, and animation loop were not properly cleaned up.
Problem
The
startPitchDetectionfunction injs/widgets/sampler.jshad multiple resource-management issues:1. Microphone Never Stopped (Privacy Concern)
Calling
navigator.mediaDevices.getUserMedia({ audio: true })activates the microphone, but the associated MediaStream tracks were never stopped when the widget closed. This resulted in:2. AudioContext Never Closed
Each pitch detection session created a new
AudioContextthat was never closed. This caused:3. Animation Loop Ran Indefinitely
The
requestAnimationFrame(updatePitch)loop had no exit condition:Solution
This PR adds explicit lifecycle management for pitch detection by tracking and cleaning up all related resources.
Added Resource Tracking