Fix issue with data leaking inside partial @defer or @stream boundaries during intermediate results

.api-reports/api-report-cache.api.md

@@ -9,6 +9,7 @@ import type { AsStoreObject } from '@apollo/client/utilities';
 import { canonicalStringify } from '@apollo/client/utilities';
 import type { DataValue } from '@apollo/client';
 import type { DeepPartial } from '@apollo/client/utilities';
+import type { DeferInfoTrie } from '@apollo/client/utilities/internal';
 import type { DocumentNode } from 'graphql';
 import type { DocumentNode as DocumentNode_2 } from '@apollo/client';
 import type { ExtensionsWithStreamInfo } from '@apollo/client/utilities/internal';
@@ -21,6 +22,7 @@ import { getApolloCacheMemoryInternals } from '@apollo/client/utilities/internal
 import type { GetDataState } from '@apollo/client';
 import { getInMemoryCacheMemoryInternals } from '@apollo/client/utilities/internal';
 import type { GraphQLScalarType } from 'graphql';
+import { handleIncrementalSymbol } from '@apollo/client/utilities/internal';
 import type { Incremental } from '@apollo/client/incremental';
 import type { InlineFragmentNode } from 'graphql';
 import type { IsAny } from '@apollo/client/utilities/internal';
@@ -35,6 +37,7 @@ import type { RemoveIndexSignature } from '@apollo/client/utilities/internal';
 import type { SelectionSetNode } from 'graphql';
 import type { StoreObject } from '@apollo/client/utilities';
 import type { StoreValue } from '@apollo/client/utilities';
+import type { StreamInfoTrie } from '@apollo/client/utilities/internal';
 import { Trie } from '@wry/trie';
 import type { TypedDocumentNode } from '@apollo/client';
 import type { TypeOverrides } from '@apollo/client';
@@ -226,6 +229,32 @@ namespace Cache_2 {
         cache: infer TCache;
     } ? TCache extends ApolloCache ? TCache : "The cache type declared in TypeOverrides does not extend `ApolloCache` and cannot be used with Apollo Client. See https://www.apollographql.com/docs/react/data/typescript#declaring-the-cache-type." : ApolloCache;
     // (undocumented)
+    type InternalDiffResultWithDataState<TData> = {
+        result: DataValue.Complete<TData>;
+        complete: true;
+        missing?: never;
+        dataState: "complete";
+        fromOptimisticTransaction?: boolean;
+    } | {
+        result: DataValue.Streaming<TData>;
+        complete: false;
+        missing?: never;
+        dataState: "streaming";
+        fromOptimisticTransaction?: boolean;
+    } | {
+        result: DataValue.Partial<TData>;
+        complete: false;
+        missing?: MissingFieldError;
+        dataState: "partial";
+        fromOptimisticTransaction?: boolean;
+    } | {
+        result: null;
+        complete: false;
+        missing?: MissingFieldError;
+        dataState: "empty";
+        fromOptimisticTransaction?: boolean;
+    };
+    // (undocumented)
     interface ModifyOptions<Entity extends Record<string, any> = Record<string, any>> {
         // (undocumented)
         broadcast?: boolean;
@@ -370,9 +399,18 @@ interface DeleteModifier {
 // @public (undocumented)
 const _deleteModifier: unique symbol;
 
+// @internal @deprecated (undocumented)
+export interface DiffIncrementalInfo {
+    // (undocumented)
+    deferInfo?: DeferInfoTrie;
+    // (undocumented)
+    streamInfo?: StreamInfoTrie;
+}
+
 // @public (undocumented)
 export type DiffQueryAgainstStoreOptions = ReadQueryOptions & {
     returnPartialData?: boolean;
+    [handleIncrementalSymbol]?: true | DiffIncrementalInfo;
 };
 
 // @public (undocumented)
@@ -592,6 +630,8 @@ export namespace InMemoryCache {
 
 // @public (undocumented)
 export class InMemoryCache extends ApolloCache {
+    // (undocumented)
+    readonly [handleIncrementalSymbol] = true;
     constructor(...args: {} extends InMemoryCache.ScalarsOption ? [
     config?: InMemoryCacheConfig
     ] : [config: InMemoryCacheConfig]);
@@ -605,7 +645,11 @@ export class InMemoryCache extends ApolloCache {
     // (undocumented)
     protected config: InMemoryCacheConfig;
     // (undocumented)
-    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.DiffOptions<TData, TVariables>): Cache_2.DiffResult<TData>;
+    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache_2.DiffOptions<TData, TVariables> & {
+        [handleIncrementalSymbol]: true | DiffIncrementalInfo;
+    }): Cache_2.InternalDiffResultWithDataState<TData>;
+    // (undocumented)
+    diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache_2.DiffOptions<TData, TVariables>): Cache_2.DiffResult<TData>;
     // (undocumented)
     evict(options: Cache_2.EvictOptions): boolean;
     // (undocumented)
@@ -1109,9 +1153,11 @@ interface WriteContext extends ReadMergeModifyContext {
 
 // Warnings were encountered during analysis:
 //
+// src/cache/inmemory/inMemoryCache.ts:461:7 - (ae-incompatible-release-tags) The symbol "[handleIncrementalSymbol]" is marked as @public, but its signature references "DiffIncrementalInfo" which is marked as @internal
 // src/cache/inmemory/policies.ts:176:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:179:3 - (ae-forgotten-export) The symbol "ScalarNames" needs to be exported by the entry point index.d.ts
-// src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
+// src/cache/inmemory/types.ts:145:3 - (ae-incompatible-release-tags) The symbol "[handleIncrementalSymbol]" is marked as @public, but its signature references "DiffIncrementalInfo" which is marked as @internal
+// src/cache/inmemory/types.ts:149:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

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

@@ -74,9 +74,7 @@ class Defer20220824Handler implements Incremental.Handler<Defer20220824Handler.C
     // Warning: (ae-forgotten-export) The symbol "DeferRequest" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    startRequest<TData extends Record<string, unknown>>(_: {
-        query: DocumentNode;
-    }): DeferRequest<TData>;
+    startRequest<TData extends Record<string, unknown>>(_: Incremental.StartRequestOptions): DeferRequest<TData>;
 }
 export { Defer20220824Handler }
 export { Defer20220824Handler as GraphQL17Alpha2Handler }
@@ -180,9 +178,7 @@ export class GraphQL17Alpha9Handler implements Incremental.Handler<GraphQL17Alph
     // 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>;
+    startRequest<TData>(_: Incremental.StartRequestOptions): IncrementalRequest<TData>;
 }
 
 // @public (undocumented)
@@ -196,19 +192,35 @@ export namespace Incremental {
         // (undocumented)
         prepareRequest: (request: ApolloLink.Request) => ApolloLink.Request;
         // (undocumented)
-        startRequest: <TData extends Record<string, unknown>>(request: {
-            query: DocumentNode;
-        }) => IncrementalRequest<Chunk, TData>;
+        startRequest: <TData extends Record<string, unknown>>(request: Incremental.StartRequestOptions) => IncrementalRequest<Chunk, TData>;
     }
     // (undocumented)
     export interface IncrementalRequest<Chunk extends Record<string, unknown>, TData> {
+        // (undocumented)
+        getPendingType?: (id: string) => "defer" | "stream";
         // (undocumented)
         handle: (cacheData: TData | DeepPartial<TData> | undefined | null, chunk: Chunk) => FormattedExecutionResult<TData>;
         // (undocumented)
         hasNext: boolean;
+        // (undocumented)
+        pending?: Array<Incremental.PendingResult>;
     }
     // (undocumented)
     export type Path = ReadonlyArray<string | number>;
+    // (undocumented)
+    export interface PendingResult {
+        // (undocumented)
+        id: string;
+        // (undocumented)
+        label?: string;
+        // (undocumented)
+        path: Incremental.Path;
+    }
+    // @internal @deprecated (undocumented)
+    export interface StartRequestOptions {
+        // (undocumented)
+        query: DocumentNode;
+    }
     // @internal @deprecated (undocumented)
     export interface StreamFieldInfo {
         // (undocumented)
@@ -220,10 +232,14 @@ export namespace Incremental {
 
 // @public (undocumented)
 class IncrementalRequest<TData> implements Incremental.IncrementalRequest<GraphQL17Alpha9Handler.Chunk<TData>, TData> {
+    // (undocumented)
+    getPendingType(id: string): "defer" | "stream";
     // (undocumented)
     handle(cacheData: TData | DeepPartial<TData> | null | undefined, chunk: GraphQL17Alpha9Handler.Chunk<TData>): FormattedExecutionResult<TData>;
     // (undocumented)
     hasNext: boolean;
+    // (undocumented)
+    get pending(): GraphQL17Alpha9Handler.PendingResult[];
 }
 
 // @public (undocumented)

.api-reports/api-report-utilities.api.md

@@ -40,11 +40,15 @@ export interface CacheSizes {
     "inMemoryCache.executeSelectionSet": number;
     "inMemoryCache.executeSubSelectedArray": number;
     "inMemoryCache.maybeBroadcastWatch": number;
+    "inMemoryCache.prunePartialBoundaries": number;
+    "inMemoryCache.prunePartialStreamArray": number;
     "PersistedQueryLink.persistedQueryHashes": number;
     "queryManager.getDocumentInfo": number;
     "removeTypenameFromVariables.getVariableDefinitions": number;
     canonicalStringify: number;
     checkDocument: number;
+    isDeferredFragment: number;
+    isStreamField: number;
     print: number;
 }
 

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

@@ -86,21 +86,6 @@ export type ClassicSignature = SignatureStyle extends "classic" ? unknown : neve
 // @internal @deprecated
 export function cloneDeep<T>(value: T): T;
 
-// @public (undocumented)
-interface CollectionContext {
-    // (undocumented)
-    exclude: SelectionNode;
-    // Warning: (ae-incompatible-release-tags) The symbol "fragmentMap" is marked as @public, but its signature references "FragmentMap" which is marked as @internal
-    //
-    // (undocumented)
-    fragmentMap: FragmentMap;
-}
-
-// Warning: (ae-forgotten-export) The symbol "CollectionContext" needs to be exported by the entry point index.d.ts
-//
-// @internal @deprecated
-export function collectSiblingFields(selectionSet: SelectionSetNode, context: CollectionContext, visitedFragments?: Map<string, FieldMap>): FieldMap;
-
 // @public
 export function combineLatestBatched<T>(observables: Array<Observable<T> & {
     dirty?: boolean;
@@ -182,6 +167,9 @@ type DeepOmitArray<T extends any[], K> = {
 // @public (undocumented)
 type DeepOmitPrimitive = Primitive | Function;
 
+// @internal @deprecated
+export type DeferInfoTrie = Trie<true>;
+
 // @public (undocumented)
 type Directives = {
     [directiveName: string]: {
@@ -237,11 +225,6 @@ export interface ExtensionsWithStreamInfo extends Record<string, unknown> {
     };
 }
 
-// @public (undocumented)
-export type FieldMap = {
-    [fieldName: string]: FieldMap | true;
-};
-
 // @public (undocumented)
 export function filterMap<T, R>(fn: (value: T, context: undefined) => R | undefined): OperatorFunction<T, R>;
 
@@ -288,6 +271,8 @@ export const getApolloClientMemoryInternals: (() => {
             executeSelectionSet: number | undefined;
             executeSubSelectedArray: number | undefined;
             maybeBroadcastWatch: number | undefined;
+            prunePartialBoundaries: number | undefined;
+            prunePartialStreamArray: number | undefined;
         } | undefined;
         fragmentRegistry?: {
             findFragmentSpreads: number | undefined;
@@ -335,6 +320,8 @@ export const getInMemoryCacheMemoryInternals: (() => {
         executeSelectionSet: number | undefined;
         executeSubSelectedArray: number | undefined;
         maybeBroadcastWatch: number | undefined;
+        prunePartialBoundaries: number | undefined;
+        prunePartialStreamArray: number | undefined;
     };
     fragmentRegistry: {
         findFragmentSpreads: number | undefined;
@@ -377,6 +364,9 @@ const globalCaches: {
 // @internal @deprecated (undocumented)
 export function graphQLResultHasError(result: FormattedExecutionResult<any>): boolean;
 
+// @internal @deprecated
+export const handleIncrementalSymbol: unique symbol;
+
 // @internal @deprecated (undocumented)
 export function hasDirectives(names: string[], root: ASTNode, all?: boolean): boolean;
 
@@ -389,8 +379,8 @@ export type IsAny<T> = 0 extends 1 & T ? true : false;
 // @internal @deprecated
 export const isArray: (a: any) => a is any[] | readonly any[];
 
-// @public (undocumented)
-export function isDeferredFragment(fragmentSelection: InlineFragmentNode | FragmentSpreadNode, variables: OperationVariables): boolean;
+// @internal @deprecated (undocumented)
+export const isDeferredFragment: (fragmentSelection: FragmentSpreadNode | InlineFragmentNode, variables: OperationVariables | undefined) => boolean;
 
 // @internal @deprecated (undocumented)
 export function isDocumentNode(value: unknown): value is DocumentNode;
@@ -414,6 +404,9 @@ export function isNonNullObject(obj: unknown): obj is Record<string | number, an
 // @internal @deprecated (undocumented)
 export function isPlainObject(obj: unknown): obj is Record<string | number, any>;
 
+// @internal @deprecated (undocumented)
+export const isStreamField: (field: FieldNode, variables: OperationVariables | undefined) => boolean;
+
 // @public (undocumented)
 export function isTypenameField(field: FieldNode): boolean;
 
@@ -425,6 +418,9 @@ export type LazyType<T> = T & {
 // @internal @deprecated (undocumented)
 export function makeReference(id: string): Reference;
 
+// @internal @deprecated (undocumented)
+export function makeStreamInfoTrie(): StreamInfoTrie;
+
 // @internal @deprecated
 export function makeUniqueId(prefix: string): string;
 
@@ -538,12 +534,25 @@ export function storeKeyNameFromField(field: FieldNode, variables?: Object): str
 // @public (undocumented)
 let storeKeyNameStringify: (value: any) => string;
 
+// @public (undocumented)
+export class StreamArrayState {
+    constructor(path: Incremental.Path);
+    // (undocumented)
+    depend(): void;
+    // (undocumented)
+    get streamPosition(): number;
+    set streamPosition(value: number);
+    // (undocumented)
+    truncate: boolean;
+}
+
 // @public
 export const streamInfoSymbol: unique symbol;
 
 // @internal @deprecated (undocumented)
 export type StreamInfoTrie = Trie<{
     current: Incremental.StreamFieldInfo;
+    state: StreamArrayState;
     previous?: {
         incoming: unknown;
         streamFieldInfo: Incremental.StreamFieldInfo;