LSP Rewrite Step 2: refactor for @graphql-tools

.changeset/rotten-seahorses-fry.md

@@ -0,0 +1,35 @@
+---
+'graphql-language-service-server': minor
+'vscode-graphql': minor
+'graphql-language-service-server-cli': minor
+---
+
+Fix many schema and fragment lifecycle issues, for all contexts except for schema updates for url schemas.
+Note: this makes `cacheSchemaForLookup` enabled by default again for schema first contexts.
+
+this fixes multiple cacheing bugs, on writing some in-depth integration coverage for the LSP server.
+it also solves several bugs regarding loading config types, and properly restarts the server when there are config changes
+
+### Bugfix Summary
+
+- jump to definition in embedded files offset bug
+- cache invalidation for fragments
+- schema cache invalidation for schema files
+- schema definition lookups & autocomplete crossing into the wrong workspace
+
+### Known Bugs Fixed
+
+- #3318
+- #2357
+- #3469
+- #2422
+- #2820
+- many others to add here...
+
+### Test Improvements
+
+- new, high level integration spec suite for the LSP with a matching test utility
+- more unit test coverage
+- **total increased test coverage of about 25% in the LSP server codebase.**
+- many "happy paths" covered for both schema and code first contexts
+- many bugs revealed (and their source)

.changeset/silly-yaks-bathe.md

@@ -0,0 +1,11 @@
+---
+'graphiql': patch
+'graphql-language-service': patch
+'graphql-language-service-server': patch
+'graphql-language-service-server-cli': patch
+'codemirror-graphql': patch
+'@graphiql/react': patch
+'monaco-graphql': patch
+---
+
+bugfix to completion for SDL type fields

.github/workflows/pr.yml

@@ -87,7 +87,7 @@ jobs:
       - run: yarn pretty-check
 
   jest:
-    name: Jest Unit Tests
+    name: Jest Unit & Integration Tests
     runs-on: ubuntu-latest
     needs: [install]
     steps:

custom-words.txt

@@ -65,6 +65,7 @@ yoshiakis
 
 // packages and tools
 argparse
+arrayish
 astro
 astrojs
 changesets

packages/graphiql/test/afterDevServer.js

@@ -10,4 +10,5 @@ module.exports = function afterDevServer(_app, _server, _compiler) {
   });
   // eslint-disable-next-line react-hooks/rules-of-hooks
   useServer({ schema }, wsServer);
+  return wsServer;
 };

packages/graphiql/test/e2e-server.js

@@ -43,7 +43,9 @@ app.post('/graphql-error/graphql', (_req, res, next) => {
 app.use(express.static(path.resolve(__dirname, '../')));
 app.use('index.html', express.static(path.resolve(__dirname, '../dev.html')));
 
-app.listen(process.env.PORT || 0, function () {
+// messy but it allows close
+const server = require('node:http').createServer(app);
+server.listen(process.env.PORT || 3100, function () {
   const { port } = this.address();
 
   console.log(`Started on http://localhost:${port}/`);
@@ -56,5 +58,7 @@ app.listen(process.env.PORT || 0, function () {
     process.exit();
   });
 });
+const wsServer = WebSocketsServer();
 
-WebSocketsServer();
+module.exports.server = server;
+module.exports.wsServer = wsServer;

packages/graphql-language-service-server/README.md

@@ -157,7 +157,7 @@ module.exports = {
     // note that this file will be loaded by the vscode runtime, so the node version and other factors will come into play
     customValidationRules: require('./config/customValidationRules'),
     languageService: {
-      // should the language service read schema for definition lookups from a cached file based on graphql config output?
+      // this is enabled by default if non-local files are specified in the project `schema`
       // NOTE: this will disable all definition lookup for local SDL files
       cacheSchemaFileForLookup: true,
       // undefined by default which has the same effect as `true`, set to `false` if you are already using // `graphql-eslint` or some other tool for validating graphql in your IDE. Must be explicitly `false` to disable this feature, not just "falsy"
@@ -237,14 +237,14 @@ via `initializationOptions` in nvim.coc. The options are mostly designed to
 configure graphql-config's load parameters, the only thing we can't configure
 with graphql config. The final option can be set in `graphql-config` as well
 
-| Parameter                                 | Default                         | Description                                                                                                                                                       |
-| ----------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `graphql-config.load.baseDir`             | workspace root or process.cwd() | the path where graphql config looks for config files                                                                                                              |
-| `graphql-config.load.filePath`            | `null`                          | exact filepath of the config file.                                                                                                                                |
-| `graphql-config.load.configName`          | `graphql`                       | config name prefix instead of `graphql`                                                                                                                           |
-| `graphql-config.load.legacy`              | `true`                          | backwards compatibility with `graphql-config@2`                                                                                                                   |
-| `graphql-config.dotEnvPath`               | `null`                          | backwards compatibility with `graphql-config@2`                                                                                                                   |
-| `vscode-graphql.cacheSchemaFileForLookup` | `false`                         | generate an SDL file based on your graphql-config schema configuration for schema definition lookup and other features. useful when your `schema` config are urls |
+| Parameter                                 | Default                                           | Description                                                                                                                                                                                                                                             |
+| ----------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `graphql-config.load.baseDir`             | workspace root or process.cwd()                   | the path where graphql config looks for config files                                                                                                                                                                                                    |
+| `graphql-config.load.filePath`            | `null`                                            | exact filepath of the config file.                                                                                                                                                                                                                      |
+| `graphql-config.load.configName`          | `graphql`                                         | config name prefix instead of `graphql`                                                                                                                                                                                                                 |
+| `graphql-config.load.legacy`              | `true`                                            | backwards compatibility with `graphql-config@2`                                                                                                                                                                                                         |
+| `graphql-config.dotEnvPath`               | `null`                                            | backwards compatibility with `graphql-config@2`                                                                                                                                                                                                         |
+| `vscode-graphql.cacheSchemaFileForLookup` | `true` if `schema` contains non-sdl files or urls | generate an SDL file based on your graphql-config schema configuration for schema definition lookup and other features. enabled by default when your `schema` config are urls or introspection json, or if you have any non-local SDL files in `schema` |
 
 all the `graphql-config.load.*` configuration values come from static
 `loadConfig()` options in graphql config.

packages/graphql-language-service-server/package.json

@@ -42,6 +42,10 @@
     "@babel/parser": "^7.23.6",
     "@babel/types": "^7.23.5",
     "@graphql-tools/code-file-loader": "8.0.3",
+    "@graphql-tools/graphql-tag-pluck": "^8.3.0",
+    "@graphql-tools/graphql-file-loader": "^8.0.1",
+    "@graphql-tools/url-loader": "^8.0.2",
+    "@graphql-tools/utils": "^10.1.2",
     "@vue/compiler-sfc": "^3.4.5",
     "astrojs-compiler-sync": "^0.3.5",
     "cosmiconfig-toml-loader": "^1.0.0",
@@ -56,15 +60,16 @@
     "source-map-js": "1.0.2",
     "svelte": "^4.1.1",
     "svelte2tsx": "^0.7.0",
+    "typescript": "^5.3.3",
     "vscode-jsonrpc": "^8.0.1",
     "vscode-languageserver": "^8.0.1",
     "vscode-languageserver-types": "^3.17.2",
-    "vscode-uri": "^3.0.2",
-    "typescript": "^5.3.3"
+    "vscode-uri": "^3.0.2"
   },
   "devDependencies": {
     "@types/glob": "^8.1.0",
     "@types/mkdirp": "^1.0.1",
+    "@types/mock-fs": "^4.13.4",
     "cross-env": "^7.0.2",
     "graphql": "^16.8.1",
     "mock-fs": "^5.2.0"