Inlay hints should be requested on all open files (similarly to diagnostics)

[DanielRosenwasser]

Issue Type: Bug

Today, VS Code seems to request inlay hints for the most-recently edited (or currently focused?) file; however, inlay hints can be affected by edits in other files. That means you can end up in situations where 2 files can be edited side-by-side where one ends up with stale inlay hints.

VS Code version: Code - Insiders 1.60.0-insider (49af1cb, 2021-08-06T06:41:50.275Z)
OS version: Windows_NT x64 10.0.19043
Restricted Mode: No

[mjbvz]

@jrieken To support this on the TypeScript side, I believe we either need:

• Make VS Code call provideInlayHints for all visible files when one file changes

• Have onDidChangeInlayHints take a uri so that TypeScript can fire this event for all visible files

[DanielRosenwasser]

I should mention that semantic diagnostics probably has the same issue.

[jrieken]

Have onDidChangeInlayHints take a uri so that TypeScript can fire this event for all visible files

Yeah, I believe that's the most reasonable thing to do. Unsure about requesting inlay hint for all files tho

[jrieken]

There already is InlayHintsProvider#onDidChangeInlayHints. No plans to refresh all editors when the any model changes

[mjbvz]

@jrieken Can this event take an optional resource uri? Otherwise I have to add extra code to avoid calculating the hints twice

If I have file A and file B open for example:

1. File A changes -> hints requested by VS Code
2. TS extension fires onDidChangeInlayHints because multiple files are visible
3. VS Code requests hints for all visible files
4. But we only really want to compute the hints from file B here since we already handled file A in step 1

[mjbvz]

Reopening to track fix for JS/TS specifically

[jrieken]

Yeah, adding an optional uri event type should be easy.

[jrieken]

Re-opening this because for semantic tokens we have discusses second thought on allowing extensions to tell out one or more uris. Allowing to send uris add extra burden to extensions and/or language servers with little win. The implementation in the typescript extension is almost the same as sending the global event, except for omitting the current file. For that we have come up with the following ideas:

• Inlay hints (also code lens, semantic token etc) will ignore events for models for which a request is pending. Instead, providers must always respond with the most up-to-date data.
• With that there is no more need for spelling out uris. In fact we avoid the invitation for computational complexity, e.g to truly know what inlay hints depend on what changes is too expensive to pay off, esp if we are going to ignore the event anyways.
• (optionally) we can consider to expose EmitterOption#onFirstListener. That would allow extensions to optimize this further by use letting them know if there is any listener or not

[jrieken]

fixed with 5dcc080

[jrieken]

Verify that there is the option for InlayHintsProvider#onDidChangeInlayHints

[rchiodo]

/verified