@apollo/client 4.3.3 → 4.3.4

package/cache/inmemory/types.d.ts

@@ -1,7 +1,8 @@
 import type { DocumentNode, FieldNode } from "graphql";
 import type { OperationVariables } from "@apollo/client";
+import type { Incremental } from "@apollo/client/incremental";
 import type { Reference, StoreObject, StoreValue } from "@apollo/client/utilities";
-import type { DeferInfoTrie, ExtensionsWithStreamInfo, RemoveIndexSignature, StreamInfoTrie } from "@apollo/client/utilities/internal";
+import type { ExtensionsWithStreamInfo, handleIncrementalSymbol, RemoveIndexSignature, StreamInfoTrie } from "@apollo/client/utilities/internal";
 import type { ApolloCache, Transaction } from "../core/cache.js";
 import type { AllFieldsModifier, CanReadFunction, Modifiers, ToReferenceFunction } from "../core/types/common.js";
 import type { FieldValueGetter } from "./entityStore.js";
@@ -86,7 +87,10 @@ export type ReadQueryOptions = {
 */
 export interface DiffIncrementalInfo {
     streamInfo?: StreamInfoTrie;
-    deferInfo?: DeferInfoTrie;
+    isDeferPending?: (path: Incremental.Path, label: string | undefined) => boolean;
+}
+export interface WithHandleIncremental {
+    [handleIncrementalSymbol]?: DiffIncrementalInfo | undefined;
 }
 export type DiffQueryAgainstStoreOptions = ReadQueryOptions & {
     returnPartialData?: boolean;
@@ -128,6 +132,7 @@ export interface ReadMergeModifyContext {
     variables?: OperationVariables;
     varString?: string;
     extensions?: ExtensionsWithStreamInfo;
+    isDeferPending?: (path: Incremental.Path, label: string | undefined) => boolean;
 }
 type ListOf<T extends string> = `[${T}]`;
 type NestedScalarName<T extends string> = T | ListOf<T> | ListOf<ListOf<T>> | ListOf<ListOf<ListOf<T>>> | ListOf<ListOf<ListOf<ListOf<T>>>>;

package/cache/inmemory/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/cache/inmemory/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FieldNode } from \"graphql\";\n\nimport type { OperationVariables } from \"@apollo/client\";\nimport type {\n  Reference,\n  StoreObject,\n  StoreValue,\n} from \"@apollo/client/utilities\";\nimport type {\n  DeferInfoTrie,\n  ExtensionsWithStreamInfo,\n  RemoveIndexSignature,\n  StreamInfoTrie,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { ApolloCache, Transaction } from \"../core/cache.js\";\nimport type {\n  AllFieldsModifier,\n  CanReadFunction,\n  Modifiers,\n  ToReferenceFunction,\n} from \"../core/types/common.js\";\n\nimport type { FieldValueGetter } from \"./entityStore.js\";\nimport type { FragmentRegistryAPI } from \"./fragmentRegistry.js\";\nimport type { InMemoryCache } from \"./inMemoryCache.js\";\nimport type {\n  FieldMergeFunction,\n  KeyFieldsFunction,\n  PossibleTypesMap,\n  StorageType,\n  TypePolicies,\n} from \"./policies.js\";\n\nexport type { Reference, StoreObject, StoreValue };\n\nexport interface IdGetterObj extends Object {\n  __typename?: string;\n  id?: string;\n  _id?: string;\n}\n\nexport declare type IdGetter = (value: IdGetterObj) => string | undefined;\n\n/**\n * This is an interface used to access, set and remove\n * StoreObjects from the cache\n */\nexport interface NormalizedCache {\n  has(dataId: string): boolean;\n  get(dataId: string, fieldName: string): StoreValue;\n\n  // The store.merge method allows either argument to be a string ID, but\n  // the other argument has to be a StoreObject. Either way, newer fields\n  // always take precedence over older fields.\n  merge(olderId: string, newerObject: StoreObject): void;\n  merge(olderObject: StoreObject, newerId: string): void;\n\n  modify<Entity extends Record<string, any>>(\n    dataId: string,\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>,\n    exact: boolean\n  ): boolean;\n  delete(dataId: string, fieldName?: string): boolean;\n  clear(): void;\n\n  // non-Map elements:\n  /**\n   * returns an Object with key-value pairs matching the contents of the store\n   */\n  toObject(): NormalizedCacheObject;\n  /**\n   * replace the state of the store\n   */\n  replace(newData: NormalizedCacheObject): void;\n\n  /**\n   * Retain (or release) a given root ID to protect (or expose) it and its\n   * transitive child entities from (or to) garbage collection. The current\n   * retainment count is returned by both methods. Note that releasing a root\n   * ID does not cause that entity to be garbage collected, but merely removes\n   * it from the set of root IDs that will be considered during the next\n   * mark-and-sweep collection.\n   */\n  retain(rootId: string): number;\n  release(rootId: string): number;\n\n  getFieldValue: FieldValueGetter;\n  toReference: ToReferenceFunction;\n  canRead: CanReadFunction;\n\n  getStorage(\n    idOrObj: string | StoreObject,\n    ...storeFieldNames: (string | number)[]\n  ): StorageType;\n}\n\n/**\n * This is a normalized representation of the Apollo query result cache. It consists of\n * a flattened representation of query result trees.\n */\nexport interface NormalizedCacheObject {\n  __META?: {\n    // Well-known singleton IDs like ROOT_QUERY and ROOT_MUTATION are\n    // always considered to be root IDs during cache.gc garbage\n    // collection, but other IDs can become roots if they are written\n    // directly with cache.writeFragment or retained explicitly with\n    // cache.retain. When such IDs exist, we include them in the __META\n    // section so that they can survive cache.{extract,restore}.\n    extraRootIds: string[];\n  };\n  [dataId: string]: StoreObject | undefined;\n}\n\nexport type OptimisticStoreItem = {\n  id: string;\n  data: NormalizedCacheObject;\n  transaction: Transaction;\n};\n\nexport type ReadQueryOptions = {\n  /**\n   * The Apollo Client store object.\n   */\n  store: NormalizedCache;\n  /**\n   * A parsed GraphQL query document.\n   */\n  query: DocumentNode;\n  variables?: Object;\n  previousResult?: any;\n  rootId?: string;\n  config?: ApolloReducerConfig;\n};\n\n/** @internal */\nexport interface DiffIncrementalInfo {\n  streamInfo?: StreamInfoTrie;\n  deferInfo?: DeferInfoTrie;\n}\n\nexport type DiffQueryAgainstStoreOptions = ReadQueryOptions & {\n  returnPartialData?: boolean;\n};\n\nexport type ApolloReducerConfig = {\n  dataIdFromObject?: KeyFieldsFunction;\n};\n\nexport interface InputObjectConfig {\n  fields: Record<string, string>;\n}\n\nexport interface InputObjectsOption {\n  [inputObjectName: string]: InputObjectConfig;\n}\n\nexport type InMemoryCacheConfig = ApolloReducerConfig & {\n  resultCaching?: boolean;\n  possibleTypes?: PossibleTypesMap;\n  typePolicies?: TypePolicies;\n  fragments?: FragmentRegistryAPI;\n  inputObjects?: InputObjectsOption;\n} & ({} extends InMemoryCache.ScalarsOption ?\n    InMemoryCache.ScalarsOption extends Record<string, never> ?\n      {\n        scalars?: Record<\n          string,\n          `Scalar types must be declared in ApolloCache.Scalars before usage. See https://www.apollographql.com/docs/react/data/typescript#declaring-scalar-types.`\n        >;\n      }\n    : { scalars?: InMemoryCache.ScalarsOption }\n  : { scalars: InMemoryCache.ScalarsOption });\n\nexport interface MergeInfo {\n  field: FieldNode;\n  typename: string | undefined;\n  merge: FieldMergeFunction;\n  path: Array<string | number>;\n}\n\nexport interface MergeTree {\n  info?: MergeInfo;\n  map: Map<string | number, MergeTree>;\n}\n\nexport interface ReadMergeModifyContext {\n  store: NormalizedCache;\n  variables?: OperationVariables;\n  // A JSON.stringify-serialized version of context.variables.\n  varString?: string;\n  extensions?: ExtensionsWithStreamInfo;\n}\n\ntype ListOf<T extends string> = `[${T}]`;\n\ntype NestedScalarName<T extends string> =\n  | T\n  | ListOf<T>\n  | ListOf<ListOf<T>>\n  | ListOf<ListOf<ListOf<T>>>\n  | ListOf<ListOf<ListOf<ListOf<T>>>>;\n\nexport type KnownScalars = RemoveIndexSignature<ApolloCache.Scalars>;\n\nexport type ScalarType =\n  | NestedScalarName<keyof KnownScalars & string>\n  | (string extends keyof ApolloCache.Scalars ? string & {} : never);\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/cache/inmemory/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FieldNode } from \"graphql\";\n\nimport type { OperationVariables } from \"@apollo/client\";\nimport type { Incremental } from \"@apollo/client/incremental\";\nimport type {\n  Reference,\n  StoreObject,\n  StoreValue,\n} from \"@apollo/client/utilities\";\nimport type {\n  ExtensionsWithStreamInfo,\n  handleIncrementalSymbol,\n  RemoveIndexSignature,\n  StreamInfoTrie,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { ApolloCache, Transaction } from \"../core/cache.js\";\nimport type {\n  AllFieldsModifier,\n  CanReadFunction,\n  Modifiers,\n  ToReferenceFunction,\n} from \"../core/types/common.js\";\n\nimport type { FieldValueGetter } from \"./entityStore.js\";\nimport type { FragmentRegistryAPI } from \"./fragmentRegistry.js\";\nimport type { InMemoryCache } from \"./inMemoryCache.js\";\nimport type {\n  FieldMergeFunction,\n  KeyFieldsFunction,\n  PossibleTypesMap,\n  StorageType,\n  TypePolicies,\n} from \"./policies.js\";\n\nexport type { Reference, StoreObject, StoreValue };\n\nexport interface IdGetterObj extends Object {\n  __typename?: string;\n  id?: string;\n  _id?: string;\n}\n\nexport declare type IdGetter = (value: IdGetterObj) => string | undefined;\n\n/**\n * This is an interface used to access, set and remove\n * StoreObjects from the cache\n */\nexport interface NormalizedCache {\n  has(dataId: string): boolean;\n  get(dataId: string, fieldName: string): StoreValue;\n\n  // The store.merge method allows either argument to be a string ID, but\n  // the other argument has to be a StoreObject. Either way, newer fields\n  // always take precedence over older fields.\n  merge(olderId: string, newerObject: StoreObject): void;\n  merge(olderObject: StoreObject, newerId: string): void;\n\n  modify<Entity extends Record<string, any>>(\n    dataId: string,\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>,\n    exact: boolean\n  ): boolean;\n  delete(dataId: string, fieldName?: string): boolean;\n  clear(): void;\n\n  // non-Map elements:\n  /**\n   * returns an Object with key-value pairs matching the contents of the store\n   */\n  toObject(): NormalizedCacheObject;\n  /**\n   * replace the state of the store\n   */\n  replace(newData: NormalizedCacheObject): void;\n\n  /**\n   * Retain (or release) a given root ID to protect (or expose) it and its\n   * transitive child entities from (or to) garbage collection. The current\n   * retainment count is returned by both methods. Note that releasing a root\n   * ID does not cause that entity to be garbage collected, but merely removes\n   * it from the set of root IDs that will be considered during the next\n   * mark-and-sweep collection.\n   */\n  retain(rootId: string): number;\n  release(rootId: string): number;\n\n  getFieldValue: FieldValueGetter;\n  toReference: ToReferenceFunction;\n  canRead: CanReadFunction;\n\n  getStorage(\n    idOrObj: string | StoreObject,\n    ...storeFieldNames: (string | number)[]\n  ): StorageType;\n}\n\n/**\n * This is a normalized representation of the Apollo query result cache. It consists of\n * a flattened representation of query result trees.\n */\nexport interface NormalizedCacheObject {\n  __META?: {\n    // Well-known singleton IDs like ROOT_QUERY and ROOT_MUTATION are\n    // always considered to be root IDs during cache.gc garbage\n    // collection, but other IDs can become roots if they are written\n    // directly with cache.writeFragment or retained explicitly with\n    // cache.retain. When such IDs exist, we include them in the __META\n    // section so that they can survive cache.{extract,restore}.\n    extraRootIds: string[];\n  };\n  [dataId: string]: StoreObject | undefined;\n}\n\nexport type OptimisticStoreItem = {\n  id: string;\n  data: NormalizedCacheObject;\n  transaction: Transaction;\n};\n\nexport type ReadQueryOptions = {\n  /**\n   * The Apollo Client store object.\n   */\n  store: NormalizedCache;\n  /**\n   * A parsed GraphQL query document.\n   */\n  query: DocumentNode;\n  variables?: Object;\n  previousResult?: any;\n  rootId?: string;\n  config?: ApolloReducerConfig;\n};\n\n/** @internal */\nexport interface DiffIncrementalInfo {\n  streamInfo?: StreamInfoTrie;\n  isDeferPending?: (\n    path: Incremental.Path,\n    label: string | undefined\n  ) => boolean;\n}\n\nexport interface WithHandleIncremental {\n  [handleIncrementalSymbol]?: DiffIncrementalInfo | undefined;\n}\n\nexport type DiffQueryAgainstStoreOptions = ReadQueryOptions & {\n  returnPartialData?: boolean;\n};\n\nexport type ApolloReducerConfig = {\n  dataIdFromObject?: KeyFieldsFunction;\n};\n\nexport interface InputObjectConfig {\n  fields: Record<string, string>;\n}\n\nexport interface InputObjectsOption {\n  [inputObjectName: string]: InputObjectConfig;\n}\n\nexport type InMemoryCacheConfig = ApolloReducerConfig & {\n  resultCaching?: boolean;\n  possibleTypes?: PossibleTypesMap;\n  typePolicies?: TypePolicies;\n  fragments?: FragmentRegistryAPI;\n  inputObjects?: InputObjectsOption;\n} & ({} extends InMemoryCache.ScalarsOption ?\n    InMemoryCache.ScalarsOption extends Record<string, never> ?\n      {\n        scalars?: Record<\n          string,\n          `Scalar types must be declared in ApolloCache.Scalars before usage. See https://www.apollographql.com/docs/react/data/typescript#declaring-scalar-types.`\n        >;\n      }\n    : { scalars?: InMemoryCache.ScalarsOption }\n  : { scalars: InMemoryCache.ScalarsOption });\n\nexport interface MergeInfo {\n  field: FieldNode;\n  typename: string | undefined;\n  merge: FieldMergeFunction;\n  path: Array<string | number>;\n}\n\nexport interface MergeTree {\n  info?: MergeInfo;\n  map: Map<string | number, MergeTree>;\n}\n\nexport interface ReadMergeModifyContext {\n  store: NormalizedCache;\n  variables?: OperationVariables;\n  // A JSON.stringify-serialized version of context.variables.\n  varString?: string;\n  extensions?: ExtensionsWithStreamInfo;\n  isDeferPending?: (\n    path: Incremental.Path,\n    label: string | undefined\n  ) => boolean;\n}\n\ntype ListOf<T extends string> = `[${T}]`;\n\ntype NestedScalarName<T extends string> =\n  | T\n  | ListOf<T>\n  | ListOf<ListOf<T>>\n  | ListOf<ListOf<ListOf<T>>>\n  | ListOf<ListOf<ListOf<ListOf<T>>>>;\n\nexport type KnownScalars = RemoveIndexSignature<ApolloCache.Scalars>;\n\nexport type ScalarType =\n  | NestedScalarName<keyof KnownScalars & string>\n  | (string extends keyof ApolloCache.Scalars ? string & {} : never);\n"]}

package/cache/inmemory/writeToStore.d.ts

@@ -2,9 +2,10 @@ import type { FieldNode, SelectionSetNode } from "graphql";
 import type { Cache, OperationVariables } from "@apollo/client";
 import type { Reference, StoreObject } from "@apollo/client/utilities";
 import type { FragmentMap, FragmentMapFunction } from "@apollo/client/utilities/internal";
+import { handleIncrementalSymbol } from "@apollo/client/utilities/internal";
 import type { InMemoryCache } from "./inMemoryCache.js";
 import type { StoreReader } from "./readFromStore.js";
-import type { InMemoryCacheConfig, MergeTree, NormalizedCache, ReadMergeModifyContext } from "./types.js";
+import type { DiffIncrementalInfo, InMemoryCacheConfig, MergeTree, NormalizedCache, ReadMergeModifyContext } from "./types.js";
 export interface WriteContext extends ReadMergeModifyContext {
     readonly written: {
         [dataId: string]: SelectionSetNode[];
@@ -28,7 +29,9 @@ export declare class StoreWriter {
     private reader?;
     private fragments?;
     constructor(cache: InMemoryCache, reader?: StoreReader | undefined, fragments?: InMemoryCacheConfig["fragments"]);
-    writeToStore<TData = unknown, TVariables extends OperationVariables = OperationVariables>(store: NormalizedCache, { query, result, dataId, variables, overwrite, extensions, }: Cache.WriteOptions<TData, TVariables>): Reference | undefined;
+    writeToStore<TData = unknown, TVariables extends OperationVariables = OperationVariables>(store: NormalizedCache, { query, result, dataId, variables, overwrite, extensions, [handleIncrementalSymbol]: incrementalInfo, }: Cache.WriteOptions<TData, TVariables> & {
+        [handleIncrementalSymbol]?: DiffIncrementalInfo;
+    }): Reference | undefined;
     private processSelectionSet;
     private processFieldValue;
     private flattenFields;

package/cache/inmemory/writeToStore.js

@@ -3,7 +3,7 @@ import { Trie } from "@wry/trie";
 import { Kind } from "graphql";
 import { addTypenameToDocument, canonicalStringify, isReference, } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { argumentsObjectFromField, cloneDeep, getDefaultValues, getFragmentFromSelection, getOperationDefinition, isArray, isField, isNonEmptyArray, isStreamField, makeReference, resultKeyNameFromField, shouldInclude, streamInfoSymbol, } from "@apollo/client/utilities/internal";
+import { argumentsObjectFromField, cloneDeep, getDefaultValues, getFragmentFromSelection, getOperationDefinition, handleIncrementalSymbol, isArray, isField, isNonEmptyArray, isStreamField, makeReference, resultKeyNameFromField, shouldInclude, streamInfoSymbol, } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
 import { extractFragmentContext, fieldNameFromStoreName, makeProcessedFieldsMerger, storeValueIsStoreObject, } from "./helpers.js";
 import { defaultStreamFieldMergeFn, normalizeReadFieldOptions, } from "./policies.js";
@@ -36,7 +36,7 @@ export class StoreWriter {
         this.reader = reader;
         this.fragments = fragments;
     }
-    writeToStore(store, { query, result, dataId, variables, overwrite, extensions, }) {
+    writeToStore(store, { query, result, dataId, variables, overwrite, extensions, [handleIncrementalSymbol]: incrementalInfo, }) {
         const operationDefinition = getOperationDefinition(query);
         const merger = makeProcessedFieldsMerger();
         variables = {
@@ -58,6 +58,7 @@ export class StoreWriter {
             deferred: false,
             flavors: new Map(),
             extensions,
+            isDeferPending: incrementalInfo?.isDeferPending,
         };
         const ref = this.processSelectionSet({
             result: result || {},
@@ -68,7 +69,7 @@ export class StoreWriter {
             path: [],
         });
         if (!isReference(ref)) {
-            throw newInvariantError(122, result);
+            throw newInvariantError(123, result);
         }
         // So far, the store has not been modified, so now it's time to process
         // context.incomingById and merge those incoming fields into context.store.
@@ -166,10 +167,10 @@ export class StoreWriter {
         // This WriteContext will be the default context value for fields returned
         // by the flattenFields method, but some fields may be assigned a modified
         // context, depending on the presence of @client and other directives.
-        context, typename).forEach((context, field) => {
+        context, currentPath, typename).forEach((context, field) => {
             const resultFieldKey = resultKeyNameFromField(field);
             const value = result[resultFieldKey];
-            const path = [...currentPath, field.name.value];
+            const path = [...currentPath, resultFieldKey];
             fieldNodeSet.add(field);
             if (value !== void 0) {
                 const storeFieldName = policies.getStoreFieldName({
@@ -180,10 +181,15 @@ export class StoreWriter {
                 });
                 const childTree = getChildMergeTree(mergeTree, storeFieldName);
                 let incomingValue = this.processFieldValue(value, field, 
-                // Reset context.clientOnly and context.deferred to their default
-                // values before processing nested selection sets.
+                // Reset context.clientOnly to its default value before processing
+                // nested selection sets, but inherit context.deferred: a resolved
+                // parent field must not erase the fact that an ancestor @defer
+                // boundary is still pending, or nested fields reached only through
+                // that ancestor will incorrectly be treated as complete and report
+                // spurious "Missing field" errors when their own boundary hasn't
+                // arrived yet.
                 field.selectionSet ?
-                    getContextFlavor(context, false, false)
+                    getContextFlavor(context, false, context.deferred)
                     : context, childTree, path);
                 // To determine if this field holds a child object with a merge function
                 // defined in its type policy (see PR #7070), we need to figure out the
@@ -230,7 +236,7 @@ export class StoreWriter {
                 // provide a default value, so its absence from the written data should
                 // not be cause for alarm.
                 !policies.getReadFunction(typename, field.name.value)) {
-                invariant.error(123, resultKeyNameFromField(field), result);
+                invariant.error(124, resultKeyNameFromField(field), result);
             }
         });
         // Identify the result object, even if dataId was already provided,
@@ -322,7 +328,7 @@ export class StoreWriter {
     }
     // Implements https://spec.graphql.org/draft/#sec-Field-Collection, but with
     // some additions for tracking @client and @defer directives.
-    flattenFields(selectionSet, result, context, typename = getTypenameFromResult(result, selectionSet, context.fragmentMap)) {
+    flattenFields(selectionSet, result, context, path, typename = getTypenameFromResult(result, selectionSet, context.fragmentMap)) {
         const fieldMap = new Map();
         const { policies } = this.cache;
         const limitingTrie = new Trie(false); // No need for WeakMap, since limitingTrie does not escape.
@@ -357,10 +363,19 @@ export class StoreWriter {
                             // @defer(if: false) does not make context.deferred false, but
                             // instead behaves as if there was no @defer directive.
                             if (!args || args.if !== false) {
-                                deferred = true;
+                                // If we know (via context.isDeferPending) that this specific
+                                // boundary has already been delivered, we don't need to mark
+                                // it deferred, which allows fields under it to be validated
+                                // normally instead of being silently exempted from the
+                                // "Missing field" check below. When we can't determine
+                                // whether the boundary is still pending (no callback, or the
+                                // handler can't identify individual boundaries),
+                                // conservatively assume it's still pending (`?? true`).
+                                // `||=` (rather than `=`) preserves `deferred` if it was
+                                // already true from an ancestor boundary.
+                                deferred ||=
+                                    context.isDeferPending?.(path, args?.label) ?? true;
                             }
-                            // TODO In the future, we may want to record args.label using
-                            // context.deferred, if a label is specified.
                         }
                     });
                 }
@@ -378,7 +393,7 @@ export class StoreWriter {
                 else {
                     const fragment = getFragmentFromSelection(selection, context.lookupFragment);
                     if (!fragment && selection.kind === Kind.FRAGMENT_SPREAD) {
-                        throw newInvariantError(124, selection.name.value);
+                        throw newInvariantError(125, selection.name.value);
                     }
                     if (fragment &&
                         policies.fragmentMatches(fragment, typename, result, context.variables)) {
@@ -550,7 +565,7 @@ function warnAboutDataLoss(existingRef, incomingObj, storeFieldName, store) {
             }
         });
     }
-    __DEV__ && invariant.warn(125, fieldName, parentType, childTypenames.length ?
+    __DEV__ && invariant.warn(126, fieldName, parentType, childTypenames.length ?
         "either ensure all objects of type " +
             childTypenames.join(" and ") +
             " have an ID or a custom merge function, or "