upgrade to graphql v17 including support for new incremental delivery format

.changeset/wild-frogs-invite.md

@@ -0,0 +1,6 @@
+---
+'@graphiql/react': minor
+'graphiql': minor
+---
+
+support next iteration of incremental delivery format

.github/workflows/pr-graphql-compat-check.yml

@@ -23,7 +23,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        release: ['15.5.3', '^15.8.0', '16.1.0', '16.2.0', '16.3.0']
+        release:
+          ['15.5.3', '^15.8.0', '16.1.0', '16.2.0', '16.3.0', '17.0.0-alpha.5']
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4

package.json

@@ -143,6 +143,7 @@
   "resolutions": {
     "@babel/traverse": "^7.23.2",
     "vscode-languageserver-types": "3.17.3",
-    "markdown-it": "14.1.0"
+    "markdown-it": "14.1.0",
+    "graphql": "17.0.0-alpha.5"
   }
 }

packages/cm6-graphql/package.json

@@ -30,7 +30,7 @@
     "@lezer/highlight": "^1.0.0",
     "@lezer/lr": "^1.1.0",
     "esbuild": "0.18.10",
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "rollup": "^2.60.2",
     "rollup-plugin-dts": "^4.0.1",
     "rollup-plugin-esbuild": "^4.9.1",
@@ -44,7 +44,7 @@
     "@codemirror/state": "6.2.0",
     "@codemirror/view": "6.2.1",
     "@lezer/highlight": "^1.0.0",
-    "graphql": "^16.5.0"
+    "graphql": "^16.5.0 || ^17.0.0-alpha.2"
   },
   "license": "MIT"
 }

packages/codemirror-graphql/package.json

@@ -40,7 +40,7 @@
   "peerDependencies": {
     "@codemirror/language": "6.0.0",
     "codemirror": "^5.65.3",
-    "graphql": "^15.5.0 || ^16.0.0"
+    "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2"
   },
   "// TEMPORARILY PINNED until we fix graphql 15 support": "",
   "dependencies": {
@@ -51,7 +51,7 @@
     "@codemirror/language": "^6.0.0",
     "codemirror": "^5.65.3",
     "cross-env": "^7.0.2",
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "rimraf": "^3.0.2",
     "sane": "2.0.0"
   }

packages/codemirror-graphql/src/__tests__/lint-test.ts

@@ -11,7 +11,7 @@ import CodeMirror from 'codemirror';
 import 'codemirror/addon/lint/lint';
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
-import { GraphQLError, OperationDefinitionNode } from 'graphql';
+import { GraphQLError, OperationDefinitionNode, version } from 'graphql';
 import '../lint';
 import '../mode';
 import { TestSchema } from './testSchema';
@@ -61,7 +61,15 @@ describe('graphql-lint', () => {
     const noMutationOperationRule = (context: any) => ({
       OperationDefinition(node: OperationDefinitionNode) {
         if (node.operation === 'mutation') {
-          context.reportError(new GraphQLError('I like turtles.', node));
+          context.reportError(
+            new GraphQLError(
+              'I like turtles.',
+              // @ts-expect-error
+              version.startsWith('16') || version.startsWith('15')
+                ? node
+                : { nodes: node },
+            ),
+          );
         }
         return false;
       },

packages/graphiql-plugin-code-exporter/package.json

@@ -34,14 +34,14 @@
   },
   "peerDependencies": {
     "@graphiql/react": "^0.23.0",
-    "graphql": "^15.5.0 || ^16.0.0",
+    "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2",
     "react": "^16.8.0 || ^17 || ^18",
     "react-dom": "^16.8.0 || ^17 || ^18"
   },
   "devDependencies": {
     "@graphiql/react": "^0.23.0",
     "@vitejs/plugin-react": "^4.3.1",
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "postcss-nesting": "^10.1.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

packages/graphiql-plugin-explorer/package.json

@@ -33,14 +33,14 @@
   },
   "peerDependencies": {
     "@graphiql/react": "^0.23.0",
-    "graphql": "^15.5.0 || ^16.0.0",
+    "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2",
     "react": "^16.8.0 || ^17 || ^18",
     "react-dom": "^16.8.0 || ^17 || ^18"
   },
   "devDependencies": {
     "@graphiql/react": "^0.23.0",
     "@vitejs/plugin-react": "^4.3.1",
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "typescript": "^4.6.3",

packages/graphiql-react/package.json

@@ -43,7 +43,7 @@
     "build": "tsc --emitDeclarationOnly && vite build"
   },
   "peerDependencies": {
-    "graphql": "^15.5.0 || ^16.0.0",
+    "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2",
     "react": "^16.8.0 || ^17 || ^18",
     "react-dom": "^16.8.0 || ^17 || ^18"
   },
@@ -60,17 +60,19 @@
     "codemirror-graphql": "^2.0.13",
     "copy-to-clipboard": "^3.2.0",
     "framer-motion": "^6.5.1",
+    "get-value": "^3.0.1",
     "graphql-language-service": "^5.2.2",
     "markdown-it": "^14.1.0",
     "set-value": "^4.1.0"
   },
   "devDependencies": {
-    "@types/markdown-it": "^14.1.2",
     "@babel/helper-string-parser": "^7.19.4",
     "@testing-library/react": "14.0.0",
+    "@types/markdown-it": "^14.1.2",
+    "@types/get-value": "^3.0.5",
     "@types/set-value": "^4.0.1",
     "@vitejs/plugin-react": "^4.3.1",
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "postcss-nesting": "^10.1.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

packages/graphiql-react/src/execution.tsx

@@ -15,6 +15,7 @@ import {
 import { getFragmentDependenciesForAST } from 'graphql-language-service';
 import { ReactNode, useCallback, useMemo, useRef, useState } from 'react';
 import setValue from 'set-value';
+import getValue from 'get-value';
 
 import { useAutoCompleteLeafs, useEditorContext } from './editor';
 import { UseAutoCompleteLeafsArgs } from './editor/hooks';
@@ -343,31 +344,85 @@ type IncrementalResult = {
   incremental?: ReadonlyArray<IncrementalResult>;
   label?: string;
   items?: ReadonlyArray<Record<string, unknown>> | null;
+  pending?: ReadonlyArray<{ id: string; path: ReadonlyArray<string | number> }>;
+  completed?: ReadonlyArray<{
+    id: string;
+    errors?: ReadonlyArray<GraphQLError>;
+  }>;
+  id?: string;
+  subPath?: ReadonlyArray<string | number>;
 };
 
+const pathsMap = new WeakMap<
+  ExecutionResult,
+  Map<string, ReadonlyArray<string | number>>
+>();
+
 /**
  * @param executionResult The complete execution result object which will be
  * mutated by merging the contents of the incremental result.
  * @param incrementalResult The incremental result that will be merged into the
  * complete execution result.
  */
-function mergeIncrementalResult(
-  executionResult: ExecutionResult,
+export function mergeIncrementalResult(
+  executionResult: IncrementalResult,
   incrementalResult: IncrementalResult,
 ): void {
-  const path = ['data', ...(incrementalResult.path ?? [])];
-
-  if (incrementalResult.items) {
-    for (const item of incrementalResult.items) {
-      setValue(executionResult, path.join('.'), item);
-      // Increment the last path segment (the array index) to merge the next item at the next index
-      // eslint-disable-next-line unicorn/prefer-at -- cannot mutate the array using Array.at()
-      (path[path.length - 1] as number)++;
+  let path: ReadonlyArray<string | number> | undefined = [
+    'data',
+    ...(incrementalResult.path ?? []),
+  ];
+
+  for (const result of [executionResult, incrementalResult]) {
+    if (result.pending) {
+      let paths = pathsMap.get(executionResult);
+      if (paths === undefined) {
+        paths = new Map();
+        pathsMap.set(executionResult, paths);
+      }
+
+      for (const { id, path: pendingPath } of result.pending) {
+        paths.set(id, ['data', ...pendingPath]);
+      }
     }
   }
 
-  if (incrementalResult.data) {
-    setValue(executionResult, path.join('.'), incrementalResult.data, {
+  const { items } = incrementalResult;
+  if (items) {
+    const { id } = incrementalResult;
+    if (id) {
+      path = pathsMap.get(executionResult)?.get(id);
+      if (path === undefined) {
+        throw new Error('Invalid incremental delivery format.');
+      }
+
+      const list = getValue(executionResult, path.join('.'));
+      list.push(...items);
+    } else {
+      path = ['data', ...(incrementalResult.path ?? [])];
+      for (const item of items) {
+        setValue(executionResult, path.join('.'), item);
+        // Increment the last path segment (the array index) to merge the next item at the next index
+        // eslint-disable-next-line unicorn/prefer-at -- cannot mutate the array using Array.at()
+        (path[path.length - 1] as number)++;
+      }
+    }
+  }
+
+  const { data } = incrementalResult;
+  if (data) {
+    const { id } = incrementalResult;
+    if (id) {
+      path = pathsMap.get(executionResult)?.get(id);
+      if (path === undefined) {
+        throw new Error('Invalid incremental delivery format.');
+      }
+      const { subPath } = incrementalResult;
+      if (subPath !== undefined) {
+        path = [...path, ...subPath];
+      }
+    }
+    setValue(executionResult, path.join('.'), data, {
       merge: true,
     });
   }
@@ -390,4 +445,16 @@ function mergeIncrementalResult(
       mergeIncrementalResult(executionResult, incrementalSubResult);
     }
   }
+
+  if (incrementalResult.completed) {
+    // Remove tracking and add additional errors
+    for (const { id, errors } of incrementalResult.completed) {
+      pathsMap.get(executionResult)?.delete(id);
+
+      if (errors) {
+        executionResult.errors ||= [];
+        (executionResult.errors as GraphQLError[]).push(...errors);
+      }
+    }
+  }
 }

packages/graphiql-toolkit/package.json

@@ -24,13 +24,13 @@
     "meros": "^1.1.4"
   },
   "devDependencies": {
-    "graphql": "^16.8.1",
+    "graphql": "^17.0.0-alpha.5",
     "graphql-ws": "^5.5.5",
     "isomorphic-fetch": "^3.0.0",
     "subscriptions-transport-ws": "0.11.0"
   },
   "peerDependencies": {
-    "graphql": "^15.5.0 || ^16.0.0",
+    "graphql": "^15.5.0 || ^16.0.0 || ^17.0.0-alpha.2",
     "graphql-ws": ">= 4.5.0"
   },
   "peerDependenciesMeta": {

packages/graphiql/cypress/e2e/errors.cy.ts

@@ -1,8 +1,12 @@
-import { version } from 'graphql';
+import { GraphQLError, version } from 'graphql';
 
 describe('Errors', () => {
   it('Should show an error when the HTTP request fails', () => {
-    cy.visit('/?http-error=true');
+    cy.intercept('/graphql', {
+      statusCode: 502,
+      body: 'Bad Gateway',
+    });
+    cy.visit('/');
     cy.assertQueryResult({
       errors: [
         {
@@ -21,23 +25,27 @@ describe('Errors', () => {
   });
 
   it('Should show an error when introspection fails', () => {
+    cy.intercept('/graphql', {
+      body: { errors: [new GraphQLError('Something unexpected happened...')] },
+    });
     cy.visit('/?graphql-error=true');
     cy.assertQueryResult({
       errors: [{ message: 'Something unexpected happened...' }],
     });
   });
 
   it('Should show an error when the schema is invalid', () => {
-    cy.visit('/?bad=true');
+    cy.intercept('/graphql', { fixture: 'bad-schema.json' });
+    cy.visit('/');
     /**
      * We can't use `cy.assertQueryResult` here because the stack contains line
      * and column numbers of the `graphiql.min.js` bundle which are not stable.
      */
     cy.get('section.result-window').should(element => {
       expect(element.get(0).innerText).to.contain(
-        version.startsWith('16.')
-          ? 'Names must only contain [_a-zA-Z0-9] but \\"<img src=x onerror=alert(document.domain)>\\" does not.'
-          : 'Names must match /^[_a-zA-Z][_a-zA-Z0-9]*$/ but \\"<img src=x onerror=alert(document.domain)>\\" does not.',
+        version.startsWith('15')
+          ? 'Names must match /^[_a-zA-Z][_a-zA-Z0-9]*$/ but \\"<img src=x onerror=alert(document.domain)>\\" does not.'
+          : 'Names must only contain [_a-zA-Z0-9] but \\"<img src=x onerror=alert(document.domain)>\\" does not.',
       );
     });
   });

packages/graphiql/cypress/e2e/incremental-delivery.cy.ts

@@ -1,10 +1,9 @@
 import { version } from 'graphql';
 
-let describeOrSkip = describe.skip;
+let describeOrSkip: Mocha.SuiteFunction | Mocha.PendingSuiteFunction = describe;
 
-// TODO: disable when defer/stream is merged to graphql
-if (version.includes('stream')) {
-  describeOrSkip = describe;
+if (version.startsWith('15') || version.startsWith('16')) {
+  describeOrSkip = describe.skip;
 }
 
 describeOrSkip('IncrementalDelivery support via fetcher', () => {
@@ -52,7 +51,6 @@ describeOrSkip('IncrementalDelivery support via fetcher', () => {
           },
         ],
       },
-      hasNext: false,
     };
 
     it('Expects slower streams to resolve in several increments, and the payloads to patch properly', () => {
@@ -99,7 +97,6 @@ describeOrSkip('IncrementalDelivery support via fetcher', () => {
               'Oops, this took 1 seconds longer than I thought it would!',
           },
         },
-        hasNext: false,
       });
     });
 
@@ -164,7 +161,6 @@ describeOrSkip('IncrementalDelivery support via fetcher', () => {
             age: 1000,
           },
         },
-        hasNext: false,
       });
     });
   });

packages/graphiql/cypress/e2e/init.cy.ts

@@ -49,7 +49,8 @@ describe('GraphiQL On Initialization', () => {
     cy.assertQueryResult(mockSuccess);
   });
   it('Shows the expected error when the schema is invalid', () => {
-    cy.visit('/?bad=true');
+    cy.intercept('/graphql', { fixture: 'bad-schema.json' });
+    cy.visit('/');
     cy.get('section.result-window').should(element => {
       expect(element.get(0).innerText).to.contain('Names must');
     });