fix: clear parent change listener before disposeContext in ScopedContextKeyService#307593
Merged
Yoyokrazy merged 2 commits intomicrosoft:mainfrom Apr 22, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a potential listener leak in the platform ContextKeyService by ensuring ScopedContextKeyService stops forwarding parent context-change events before tearing down its scoped context.
Changes:
- Clear the scoped service’s parent
onDidChangeContextlistener at the start ofScopedContextKeyService.dispose(). - Dispose the scoped context (
disposeContext) only after detaching from parent events, preventing late event forwarding during teardown.
Show a summary per file
| File | Description |
|---|---|
| src/vs/platform/contextkey/browser/contextKeyService.ts | Adjusts ScopedContextKeyService.dispose() ordering to detach parent listener before disposing scoped context, addressing listener leak warnings. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
Comment on lines
515
to
517
| this._parent.disposeContext(this._myContextId); | ||
| this._domNode.removeAttribute(KEYBINDING_CONTEXT_ATTR); | ||
| super.dispose(); |
There was a problem hiding this comment.
This disposal-order fix would be safer with a regression test. There are existing unit tests for ContextKeyService, but none appear to cover that a disposed scoped service stops forwarding parent onDidChangeContext events (and doesn’t contribute to listener leak warnings). Consider adding a test that creates many scoped services, disposes them, then mutates the parent context and asserts no child change events fire / no listeners remain attached.
Suggested change
| this._parent.disposeContext(this._myContextId); | |
| this._domNode.removeAttribute(KEYBINDING_CONTEXT_ATTR); | |
| super.dispose(); | |
| try { | |
| this._parent.disposeContext(this._myContextId); | |
| this._domNode.removeAttribute(KEYBINDING_CONTEXT_ATTR); | |
| } finally { | |
| super.dispose(); | |
| } |
bryanchen-d
approved these changes
Apr 16, 2026
Yoyokrazy
approved these changes
Apr 16, 2026
rzhao271
approved these changes
Apr 17, 2026
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.
Fixes #307067
Summary
ScopedContextKeyService.dispose()now callsthis._parentChangeListener.clear()beforethis._parent.disposeContext(this._myContextId)dispose()andsuper.dispose()being called, contributing to the listener leakTest plan