migrate over the wire tests to use local schema instance

Author: acao

.vscode/settings.json

@@ -4,7 +4,7 @@
   "files.insertFinalNewline": true,
   "editor.trimAutoWhitespace": false,
   "coverage-gutters.showLineCoverage": true,
-  "coverage-gutters.coverageBaseDir": "coverage/jest",
+  "coverage-gutters.coverageBaseDir": "coverage",
   "coverage-gutters.coverageFileNames": [
     "lcov.info",
     "cov.xml",

package.json

@@ -49,6 +49,7 @@
     "cypress-open": "yarn workspace graphiql cypress-open",
     "dev-graphiql": "yarn workspace graphiql dev",
     "e2e": "yarn run e2e:build && yarn workspace graphiql e2e",
+    "e2e:server": "yarn workspace graphiql e2e-server",
     "e2e:build": "WEBPACK_SERVE=1 yarn workspace graphiql build-bundles",
     "eslint": "NODE_OPTIONS=--max-old-space-size=4096 eslint --max-warnings=0 --ignore-path .gitignore --cache .",
     "format": "yarn eslint --fix && yarn pretty",
@@ -70,7 +71,7 @@
     "repo:fix": "manypkg fix",
     "repo:resolve": "node scripts/set-resolution.js",
     "t": "yarn test",
-    "test": "yarn jest",
+    "test": "yarn e2e:server yarn jest",
     "test:ci": "yarn build && jest --coverage && yarn vitest",
     "test:coverage": "yarn jest --coverage",
     "test:watch": "yarn jest --watch",

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/src/MessageProcessor.ts

@@ -1013,17 +1013,12 @@ export class MessageProcessor {
       ...DEFAULT_SUPPORTED_EXTENSIONS,
       ...DEFAULT_SUPPORTED_GRAPHQL_EXTENSIONS,
     ];
-    // only local schema lookups if all of the schema entries are local files that we can resolve
+    // only local schema lookups if all of the schema entries are local files
     const sdlOnly = unwrappedSchema.every(schemaEntry =>
       allExtensions.some(
-        // local schema file URIs for lookup don't start with http, and end with an extension that is not json but may
-        // be graphql, gql, ts, js, javascript, or even vue, svelte, etc.
-        // would be awesome to use tree sitter to expand our parser to other languages, and then we could support SDL literal
-        // definitions in other languages!
-        ext =>
-          !schemaEntry.startsWith('http') &&
-          schemaEntry.endsWith(ext) &&
-          ext !== 'json',
+        // local schema file URIs for lookup don't start with http, and end with an extension.
+        // though it isn't often used, technically schema config could include a remote .graphql file
+        ext => !schemaEntry.startsWith('http') && schemaEntry.endsWith(ext),
       ),
     );
     // if we are caching the config schema, and it isn't a .graphql file, cache it

packages/graphql-language-service-server/src/__tests__/MessageProcessor.spec.ts

@@ -78,9 +78,17 @@ describe('MessageProcessor with no config', () => {
 });
 
 describe('project with simple config and graphql files', () => {
+  let app;
   afterEach(() => {
     mockfs.restore();
   });
+  beforeAll(async () => {
+    app = await import('../../../graphiql/test/e2e-server');
+  });
+  afterAll(() => {
+    app.server.close();
+    app.wsServer.close();
+  });
   it('caches files and schema with .graphql file config, and the schema updates with watched file changes', async () => {
     const project = new MockProject({
       files: [
@@ -94,7 +102,6 @@ describe('project with simple config and graphql files', () => {
     });
     await project.init('query.graphql');
     expect(project.lsp._logger.error).not.toHaveBeenCalled();
-    // console.log(project.lsp._graphQLCache.getSchema('schema.graphql'));
     expect(await project.lsp._graphQLCache.getSchema()).toBeDefined();
     // TODO: for some reason the cache result formats the graphql query??
     const docCache = project.lsp._textDocumentCache;
@@ -208,46 +215,48 @@ describe('project with simple config and graphql files', () => {
   it('caches files and schema with a URL config', async () => {
     const project = new MockProject({
       files: [
-        ['query.graphql', 'query { bar  }'],
-        ['fragments.graphql', 'fragment Ep on Episode {\n created \n}'],
+        ['query.graphql', 'query { test { isTest, ...T } }'],
+        ['fragments.graphql', 'fragment T on Test {\n isTest \n}'],
         [
           'graphql.config.json',
-          '{ "schema": "https://rickandmortyapi.com/graphql", "documents": "./**.graphql" }',
+          '{ "schema": "http://localhost:3100/graphql", "documents": "./**.graphql" }',
         ],
       ],
     });
 
-    await project.init('query.graphql');
+    const initParams = await project.init('query.graphql');
+    expect(initParams.diagnostics).toEqual([]);
+
+    expect(project.lsp._logger.error).not.toHaveBeenCalled();
 
     const changeParams = await project.lsp.handleDidChangeNotification({
       textDocument: { uri: project.uri('query.graphql'), version: 1 },
-      contentChanges: [
-        { text: 'query { episodes { results { ...Ep, nop } }  }' },
-      ],
+      contentChanges: [{ text: 'query { test { isTest, ...T or }  }' }],
     });
     expect(changeParams?.diagnostics[0].message).toEqual(
-      'Cannot query field "nop" on type "Episode".',
+      'Cannot query field "or" on type "Test".',
     );
-    expect(project.lsp._logger.error).not.toHaveBeenCalled();
-    // console.log(project.lsp._graphQLCache.getSchema('schema.graphql'));
     expect(await project.lsp._graphQLCache.getSchema()).toBeDefined();
+
+    // schema file is present and contains schema
     const file = await readFile(join(genSchemaPath), { encoding: 'utf-8' });
     expect(file.split('\n').length).toBeGreaterThan(10);
+
+    // hover works
     const hover = await project.lsp.handleHoverRequest({
       position: {
         character: 10,
         line: 0,
       },
       textDocument: { uri: project.uri('query.graphql') },
     });
-    expect(project.lsp._textDocumentCache.size).toEqual(3);
+    expect(hover.contents).toContain('`test` field from `Test` type.');
 
-    expect(hover.contents).toContain('Get the list of all episodes');
+    // ensure that fragment definitions work
     const definitions = await project.lsp.handleDefinitionRequest({
       textDocument: { uri: project.uri('query.graphql') },
-      position: { character: 33, line: 0 },
+      position: { character: 26, line: 0 },
     });
-    // ensure that fragment definitions work
     expect(definitions[0].uri).toEqual(project.uri('fragments.graphql'));
     expect(serializeRange(definitions[0].range)).toEqual({
       start: {

packages/graphql-language-service-server/src/__tests__/__utils__/runServer.js

@@ -0,0 +1 @@
+exports.default = require('../../../../graphiql/test/e2e-server.js');