Add support for the new incremental format in GraphQL 17.0.0-alpha.9

.api-reports/api-report-incremental.api.md

@@ -80,6 +80,102 @@ class DeferRequest<TData extends Record<string, unknown>> implements Incremental
     hasNext: boolean;
 }
 
+// @public (undocumented)
+export namespace GraphQL17Alpha9Handler {
+    // (undocumented)
+    export type Chunk<TData> = InitialResult<TData> | SubsequentResult<TData>;
+    // (undocumented)
+    export interface CompletedResult {
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        id: string;
+    }
+    // (undocumented)
+    export interface GraphQL17Alpha9Result extends HKT {
+        // (undocumented)
+        arg1: unknown;
+        // (undocumented)
+        arg2: unknown;
+        // (undocumented)
+        return: GraphQL17Alpha9Handler.Chunk<Record<string, unknown>>;
+    }
+    // (undocumented)
+    export interface IncrementalDeferResult<TData = Record<string, unknown>> {
+        // (undocumented)
+        data: TData;
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        extensions?: Record<string, unknown>;
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        subPath?: Incremental.Path;
+    }
+    // (undocumented)
+    export type IncrementalResult<TData = unknown> = IncrementalDeferResult<TData> | IncrementalStreamResult<TData>;
+    // (undocumented)
+    export interface IncrementalStreamResult<TData = ReadonlyArray<unknown>> {
+        // (undocumented)
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        // (undocumented)
+        extensions?: Record<string, unknown>;
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        items: TData;
+        // (undocumented)
+        subPath?: Incremental.Path;
+    }
+    // (undocumented)
+    export type InitialResult<TData = Record<string, unknown>> = {
+        data: TData;
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        pending: ReadonlyArray<PendingResult>;
+        hasNext: boolean;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
+    export interface PendingResult {
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        label?: string;
+        // (undocumented)
+        path: Incremental.Path;
+    }
+    // (undocumented)
+    export type SubsequentResult<TData = unknown> = {
+        hasNext: boolean;
+        pending?: ReadonlyArray<PendingResult>;
+        incremental?: ReadonlyArray<IncrementalResult<TData>>;
+        completed?: ReadonlyArray<CompletedResult>;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
+    export interface TypeOverrides {
+        // (undocumented)
+        AdditionalApolloLinkResultTypes: GraphQL17Alpha9Result;
+    }
+}
+
+// @public
+export class GraphQL17Alpha9Handler implements Incremental.Handler<GraphQL17Alpha9Handler.Chunk<any>> {
+    // @internal @deprecated (undocumented)
+    extractErrors(result: ApolloLink.Result<any>): GraphQLFormattedError[] | undefined;
+    // @internal @deprecated (undocumented)
+    isIncrementalResult(result: ApolloLink.Result<any>): result is GraphQL17Alpha9Handler.InitialResult | GraphQL17Alpha9Handler.SubsequentResult;
+    // @internal @deprecated (undocumented)
+    prepareRequest(request: ApolloLink.Request): ApolloLink.Request;
+    // Warning: (ae-forgotten-export) The symbol "IncrementalRequest" needs to be exported by the entry point index.d.ts
+    //
+    // @internal @deprecated (undocumented)
+    startRequest<TData>(_: {
+        query: DocumentNode;
+    }): IncrementalRequest<TData>;
+}
+
 // @public (undocumented)
 export namespace Incremental {
     // @internal @deprecated (undocumented)
@@ -106,6 +202,14 @@ export namespace Incremental {
     export type Path = ReadonlyArray<string | number>;
 }
 
+// @public (undocumented)
+class IncrementalRequest<TData> implements Incremental.IncrementalRequest<GraphQL17Alpha9Handler.Chunk<TData>, TData> {
+    // (undocumented)
+    handle(cacheData: TData | DeepPartial<TData> | null | undefined, chunk: GraphQL17Alpha9Handler.Chunk<TData>): FormattedExecutionResult<TData>;
+    // (undocumented)
+    hasNext: boolean;
+}
+
 // @public (undocumented)
 export namespace NotImplementedHandler {
     // (undocumented)

.changeset/little-yaks-decide.md

@@ -0,0 +1,17 @@
+---
+"@apollo/client": minor
+---
+
+Support the newer incremental delivery format for the `@defer` directive implemented in `[email protected]`. Import the `GraphQL17Alpha9Handler` to use the newer incremental delivery format with `@defer`.
+
+```ts
+import { GraphQL17Alpha9Handler } from "@apollo/client/incremental";
+
+const client = new ApolloClient({
+  // ...
+  incrementalHandler: new GraphQL17Alpha9Handler(),
+});
+```
+
+> [!NOTE]
+> In order to use the `GraphQL17Alpha9Handler`, the GraphQL server MUST implement the newer incremental delivery format. You may see errors or unusual behavior if you use the wrong handler. If you are using Apollo Router, continue to use the `Defer20220824Handler` because Apollo Router does not yet support the newer incremental delivery format.

.prettierrc

@@ -17,6 +17,12 @@
         "parser": "typescript-with-jsdoc"
       }
     },
+    {
+      "files": ["**/__tests__/**/*.ts", "**/__tests__/**/*.tsx"],
+      "options": {
+        "parser": "typescript"
+      }
+    },
     {
       "files": ["*.mdx"],
       "options": {

.size-limits.json

@@ -1,6 +1,6 @@
 {
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 43857,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38699,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33415,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27498
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44206,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 39060,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33462,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27490
 }

config/jest.config.ts

@@ -49,8 +49,11 @@ const react17TestFileIgnoreList = [
   "src/testing/experimental/__tests__/createTestSchema.test.tsx",
   "src/react/hooks/__tests__/useSuspenseFragment.test.tsx",
   "src/react/hooks/__tests__/useSuspenseQuery.test.tsx",
+  "src/react/hooks/__tests__/useSuspenseQuery/*",
   "src/react/hooks/__tests__/useBackgroundQuery.test.tsx",
+  "src/react/hooks/__tests__/useBackgroundQuery/*",
   "src/react/hooks/__tests__/useLoadableQuery.test.tsx",
+  "src/react/hooks/__tests__/useLoadableQuery/*",
   "src/react/hooks/__tests__/useQueryRefHandlers.test.tsx",
   "src/react/query-preloader/__tests__/createQueryPreloader.test.tsx",
   "src/react/ssr/__tests__/prerenderStatic.test.tsx",

package.json

@@ -214,6 +214,7 @@
     "globals": "15.14.0",
     "graphql": "16.9.0",
     "graphql-17-alpha2": "npm:[email protected]",
+    "graphql-17-alpha9": "npm:[email protected]",
     "graphql-ws": "6.0.3",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",

patches/graphql-17-alpha9+17.0.0-alpha.9.patch

@@ -0,0 +1,16 @@
+diff --git a/node_modules/graphql-17-alpha9/execution/types.d.ts b/node_modules/graphql-17-alpha9/execution/types.d.ts
+index 48ef2e9..6ef2ab3 100644
+--- a/node_modules/graphql-17-alpha9/execution/types.d.ts
++++ b/node_modules/graphql-17-alpha9/execution/types.d.ts
+@@ -95,9 +95,8 @@ export interface CompletedResult {
+     errors?: ReadonlyArray<GraphQLError>;
+ }
+ export interface FormattedCompletedResult {
+-    path: ReadonlyArray<string | number>;
+-    label?: string;
+-    errors?: ReadonlyArray<GraphQLError>;
++    id: string;
++    errors?: ReadonlyArray<GraphQLFormattedError>;
+ }
+ export declare function isPendingExecutionGroup(incrementalDataRecord: IncrementalDataRecord): incrementalDataRecord is PendingExecutionGroup;
+ export type CompletedExecutionGroup = SuccessfulExecutionGroup | FailedExecutionGroup;

src/__tests__/__snapshots__/exports.ts.snap

@@ -145,6 +145,7 @@ exports[`exports of public entry points @apollo/client/incremental 1`] = `
 Array [
   "Defer20220824Handler",
   "GraphQL17Alpha2Handler",
+  "GraphQL17Alpha9Handler",
   "NotImplementedHandler",
 ]
 `;
@@ -362,7 +363,8 @@ Array [
   "enableFakeTimers",
   "executeWithDefaultContext",
   "markAsStreaming",
-  "mockDeferStream",
+  "mockDefer20220824",
+  "mockDeferStreamGraphQL17Alpha9",
   "mockMultipartSubscriptionStream",
   "renderAsync",
   "renderHookAsync",

src/__tests__/fetchMore.ts

@@ -19,7 +19,7 @@ import { Defer20220824Handler } from "@apollo/client/incremental";
 import { MockLink, MockSubscriptionLink } from "@apollo/client/testing";
 import {
   markAsStreaming,
-  mockDeferStream,
+  mockDefer20220824,
   ObservableStream,
   setupPaginatedCase,
 } from "@apollo/client/testing/internal";
@@ -2478,7 +2478,7 @@ test("uses updateQuery to update the result of the query with no-cache queries",
 });
 
 test("calling `fetchMore` on an ObservableQuery that hasn't finished deferring yet will not put it into completed state", async () => {
-  const defer = mockDeferStream();
+  const defer = mockDefer20220824();
   const baseLink = new MockSubscriptionLink();
 
   const client = new ApolloClient({