Add support for @stream

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

@@ -25,27 +25,38 @@ namespace Defer20220824Handler {
         return: Defer20220824Handler.Chunk<Record<string, unknown>>;
     }
     // (undocumented)
-    type IncrementalDeferPayload<TData = Record<string, unknown>> = {
-        data?: TData | null | undefined;
+    type IncrementalDeferResult<TData = Record<string, unknown>> = {
+        data?: TData | null;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         path?: Incremental.Path;
         label?: string;
     };
     // (undocumented)
+    type IncrementalResult<TData = Record<string, unknown>> = IncrementalDeferResult<TData> | IncrementalStreamResult<TData>;
+    // (undocumented)
+    type IncrementalStreamResult<TData = Array<unknown>> = {
+        errors?: ReadonlyArray<GraphQLFormattedError>;
+        items?: TData;
+        path?: Incremental.Path;
+        label?: string;
+        extensions?: Record<string, unknown>;
+    };
+    // (undocumented)
     type InitialResult<TData = Record<string, unknown>> = {
         data?: TData | null | undefined;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         hasNext: boolean;
+        incremental?: ReadonlyArray<IncrementalResult<TData>>;
     };
     // (undocumented)
     type SubsequentResult<TData = Record<string, unknown>> = {
         data?: TData | null | undefined;
         errors?: ReadonlyArray<GraphQLFormattedError>;
         extensions?: Record<string, unknown>;
         hasNext: boolean;
-        incremental?: Array<IncrementalDeferPayload<TData>>;
+        incremental?: Array<IncrementalResult<TData>>;
     };
     // (undocumented)
     interface TypeOverrides {

.api-reports/api-report-utilities_internal.api.md

@@ -449,7 +449,7 @@ export type VariablesOption<TVariables extends OperationVariables> = {} extends
 
 // Warnings were encountered during analysis:
 //
-// src/utilities/internal/getStoreKeyName.ts:88:1 - (ae-forgotten-export) The symbol "storeKeyNameStringify" needs to be exported by the entry point index.d.ts
+// src/utilities/internal/getStoreKeyName.ts:89:1 - (ae-forgotten-export) The symbol "storeKeyNameStringify" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

.changeset/six-islands-drum.md

@@ -0,0 +1,8 @@
+---
+"@apollo/client": minor
+---
+
+Add support for the `@stream` directive on both the `Defer20220824Handler` and the `GraphQL17Alpha2Handler`.
+
+> [!NOTE]
+> The implementations of `@stream` differ in the delivery of incremental results between the different GraphQL spec versions. If you upgrading from the older format to the newer format, expect the timing of some incremental results to change.

.size-limits.json

@@ -1,6 +1,6 @@
 {
-  "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
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44194,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 39041,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33526,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27519
 }

src/__tests__/__snapshots__/exports.ts.snap

@@ -357,15 +357,21 @@ Array [
   "ObservableStream",
   "actAsync",
   "addDelayToMocks",
+  "asyncIterableSubject",
   "createClientWrapper",
   "createMockWrapper",
   "createOperationWithDefaultContext",
   "enableFakeTimers",
+  "executeSchemaGraphQL17Alpha2",
+  "executeSchemaGraphQL17Alpha9",
   "executeWithDefaultContext",
+  "friendListSchemaGraphQL17Alpha2",
+  "friendListSchemaGraphQL17Alpha9",
   "markAsStreaming",
   "mockDefer20220824",
   "mockDeferStreamGraphQL17Alpha9",
   "mockMultipartSubscriptionStream",
+  "promiseWithResolvers",
   "renderAsync",
   "renderHookAsync",
   "resetApolloContext",

src/cache/inmemory/__tests__/cache.ts

@@ -1042,6 +1042,49 @@ describe("Cache", () => {
         });
       }
     );
+
+    it("does not write @stream directive as part of the cache key", () => {
+      const cache = new InMemoryCache();
+
+      cache.writeQuery({
+        data: {
+          list: [{ __typename: "Item", id: "1", value: 1 }],
+        },
+        query: gql`
+          query {
+            list @stream(initialCount: 1) {
+              id
+              value
+            }
+          }
+        `,
+      });
+
+      expect(cache.extract()).toStrictEqualTyped({
+        ROOT_QUERY: {
+          __typename: "Query",
+          list: [{ __ref: "Item:1" }],
+        },
+        "Item:1": { __typename: "Item", id: "1", value: 1 },
+      });
+
+      // We should be able to read the list without the `@stream` directive and
+      // get back results
+      expect(
+        cache.readQuery({
+          query: gql`
+            query {
+              list {
+                id
+                value
+              }
+            }
+          `,
+        })
+      ).toStrictEqualTyped({
+        list: [{ __typename: "Item", id: "1", value: 1 }],
+      });
+    });
   });
 
   describe("writeFragment", () => {