microsoft / microsoft/TypeScript

TSServer responses requesting further files to be opened

Open
#45,315 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: LS: TSServer In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

Background

Back in https://github.com/microsoft/TypeScript/issues/37713, I suggested that TSServer could produce several look-up locations in go-to-definition in the absence of a full project; part of the concern was that in an environment where the TypeScript server is on the same machine as the file system, it's way cheaper to perform that operation. We never went that route, though @sheetalkamat did try to create miniature projects in partial semantic mode in https://github.com/microsoft/TypeScript/pull/39476, and backed that out in https://github.com/microsoft/TypeScript/pull/40026.

Since then, partial semantic mode has been generalized to work in web settings where neither the client nor the server have all the files available at once, but the client may be in a better position to see whether a given file exists. The most we do to leverage this is in @andrewbranch's pull request at https://github.com/microsoft/TypeScript/pull/42539 which tries to construct paths from relative imports, but doesn't really work if your import needs to resolve to a .ts/.tsx file.

Idea

Coming back to the idea in https://github.com/microsoft/TypeScript/issues/37713, we could produce a result that signals to the editor that TypeScript doesn't have enough files open to produce an answer - but if the editor opens some set of files on its behalf, then it might be able to.

In other words, some sort of response type for go-to-definition that has

  • A list of entities TypeScript would like to resolve, each containing
    • the specific file paths that TypeScript needs to try to resolve to load those paths

When this information is given to the editor, the editor can try to open the set of files and send fileOpen requests to TSServer with the appropriate file content. Once that's done, TypeScript can re-request go-to-definition to produce further results.

Beyond the file transfer, adding a single file to a small program is likely not to have considerable overhead for most users.

Risks/Drawbacks

  • If opening files actually means opening editor tabs. That might not be desirable, especially if these requests have a noticeable delay. If a user closes this tab (or the tab is "ambient" and navigating away ends up closing the tab), then a user might end up with a "thrashing" editor experience where TSServer keeps trying to reload content.
  • If a re-request results in another "open more files" response, then this can result in a cascading effect that might be very slow.

This mechanism

Related work

Relative References in Partial Mode

In https://github.com/microsoft/TypeScript/pull/39476, @sheetalkamat had partial semantic mode try to construct a program out of only relative references. This was backed out in https://github.com/microsoft/TypeScript/pull/40026.

unverified Go-to-Definition Results

In https://github.com/microsoft/TypeScript/pull/42539, @andrewbranch had go-to-definition jump to files that might not actually exist. Editors had the option of handling these requests and occasionally suggesting creating a file if they didn't exist.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the TSServer go-to-definition and fileOpen request flows, then read the related discussions in issues 37713 and 45315 and pull requests 39476, 40026, and 42539. Clarify the response shape, editor behavior, and safeguards against repeated file requests. Done requires an agreed protocol design and a scoped implementation plan, not just another proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.