fix(chat): cache language selection to prevent listener leak in chat editing snapshots (#309905)#310721
Open
maruthang wants to merge 1 commit intomicrosoft:mainfrom
Open
Conversation
Contributor
📬 CODENOTIFYThe following users are being notified based on files changed in this PR: @jriekenMatched files:
|
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.
What
Prevents a listener leak triggered by
ChatEditingSession.getSnapshotModelduring long agent sessions.Why
getSnapshotModelpassed a freshILanguageSelection(fromLanguageService.createByFilepathOrFirstLine) intoIModelService.createModelfor every snapshot. Each resultingTextModelinternally subscribed (via the selection'sobservableFromEvent+Event.fromObservable) to the sharedLanguageService.onDidChange. In long-running agent sessions the 200-listener threshold was crossed, producing the[Unhandled Error] potential listener LEAK detectedtelemetry reported in #309905.How
Resolve the
languageIdeagerly and pass a static{ languageId, onDidChange: Event.None }selection intocreateModel— the language of a snapshot doesn't change, so there's nothing to subscribe to. This mirrors the pattern already used elsewhere in the codebase (chatTextEditContentPart,terminal.environmentChanges,aiCustomizationManagementEditor).Test plan
getSnapshotModel does not leak LanguageService.onDidChange listeners, #309905insrc/vs/workbench/contrib/chat/test/browser/chatEditing/chatEditingService.test.ts. The test spieslanguageService.onDidChange, creates 25 snapshot models, and asserts that new subscriptions are fewer than the number of snapshots (previously it was 1:1).npm run compile-check-ts-nativepasses cleanly for the changed files.Fixes #309905