Add full support for 'go to references'

[acao]

clone of #3250 with some desired changes and merging upstream

• add more tests
• add support for fragments
• add support for searching both the current document and the schema for references
  • add support for searching all files for references
  • refactor graphql cache to cache documents instead of MessageProcessor? (big undertaking!) OR just move this logic to MessageProcessor as with getDefinitions
• add tests for message processor

[changeset-bot]

🦋 Changeset detected

Latest commit: f7ccda0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages

Name	Type
graphql-language-service	Minor
graphql-language-service-server	Minor
graphql-language-service-cli	Minor
cm6-graphql	Patch
codemirror-graphql	Patch
@graphiql/react	Patch
graphiql	Patch
monaco-graphql	Patch
vscode-graphql	Patch
@graphiql/plugin-code-exporter	Patch
@graphiql/plugin-explorer	Patch
vscode-graphql-execution	Patch
vscode-graphql-syntax	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

The latest changes of this PR are available as canary in npm (based on the declared changesets):

[email protected]
[email protected]
[email protected]
@graphiql/[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

[codecov]

Codecov Report

Merging #3254 (f7ccda0) into main (5d06280) will decrease coverage by 0.08%.
The diff coverage is 50.90%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3254      +/-   ##
==========================================
- Coverage   56.39%   56.31%   -0.08%     
==========================================
  Files         109      109              
  Lines        5149     5190      +41     
  Branches     1405     1412       +7     
==========================================
+ Hits         2904     2923      +19     
- Misses       1822     1839      +17     
- Partials      423      428       +5     

Impacted Files	Coverage Δ
...ql-language-service-server/src/MessageProcessor.ts	45.33% <29.16%> (-0.90%)	⬇️
...guage-service-server/src/GraphQLLanguageService.ts	45.57% <67.74%> (+3.42%)	⬆️

[AaronMoat]

Running the debug build, I get this weird GraphQL request / fake file in the references list in vscode. Do you get the same?

[AaronMoat]

Suggested change

	Add basic support for 'go to references'
	Add support for 'go to references'

(given you'e expanded on it)

[acao]

@AaronMoat yes, it's the schema file. I will come back later this evening to iterate over the project documents like we do for symbols/definitions. Currently, the project file cache lives in MessageProcessor, but we can use graphqlProject.getDocuments() as long as the documents are valid, but then we are reading the files directly instead of using the cache that updates only when the watched files are changed.

What I'm hoping to refactor is moving the document cache from MessageProcessor to GraphQLCache, but this will require refactoring much of the codebase and 4 different language features and more than 50% of the tests, but it is badly needed! This is a design flaw I inherited about 6 years ago and have allowed to continue to haunt the codebase haha

[acao]

I'm putting together some diagrams and a writeup for this refactor to explain it better. Refactor is used broadly here, in the sense that the LSP outputs would be mostly the same, but the server needs a rewrite essentially. I may do this over the course of several PRs. I can use a branches from my fork if you'd like to contribute!

[AaronMoat]

I'd be happy to help if you're looking for some, though I'll need guidance, still getting up to speed in this codebase :)