Log message when overriding client's document selector #1602
Conversation
This file contains 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
dbaeumer
requested changes
Jan 28, 2025
client/src/common/features.ts
Outdated
| @@ -552,6 +552,11 @@ export abstract class TextDocumentLanguageFeature<PO, RO extends TextDocumentReg | |||
| if (!documentSelector || !capability) { | |||
| return undefined; | |||
| } | |||
|
|
|||
| if (documentSelector && capability) { | |||
There was a problem hiding this comment.
We should only log something if the document selectors are different. Specifying capabilities is fine since there are no client default once. In addition we should somehow log for which feature this is happening.
There was a problem hiding this comment.
Since both documentSelector and capability are objects, I ended up going with comparing their JSON stringified versions. I don't really like that approach, so let me know if you have a preferred way of comparing the selectors.
There are a few possible types for selectors. If you prefer, we can definitely add checks for each possible combination.
I also added the method name through this._registrationType.method.
vinistock
force-pushed
the
vs-add-trace-when-server-overrides-selector
branch
from
cc68315 to
3818da9
Compare
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.
Based on this discussion #1487 (comment)
This PR starts logging a message when the client's document selector gets overridden for a feature, in hopes to make this behaviour easier to trace when it occurs.
For the test, I redefined the
infomethod so that I could assert that the log is being invoked as expected. Let me know if that pattern is okay.