@apollo/client 4.1.0-alpha.8 → 4.1.0-rc.0

package/__cjs/cache/inmemory/policies.cjs

@@ -4,19 +4,21 @@ const {
 } = require("@apollo/client/utilities/environment");
 
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Policies = void 0;
+exports.Policies = exports.defaultStreamFieldMergeFn = void 0;
 exports.normalizeReadFieldOptions = normalizeReadFieldOptions;
+const equality_1 = require("@wry/equality");
 const masking_1 = require("@apollo/client/masking");
 const utilities_1 = require("@apollo/client/utilities");
 const environment_1 = require("@apollo/client/utilities/environment");
 const internal_1 = require("@apollo/client/utilities/internal");
+const internal_2 = require("@apollo/client/utilities/internal");
 const invariant_1 = require("@apollo/client/utilities/invariant");
 const helpers_js_1 = require("./helpers.cjs");
 const key_extractor_js_1 = require("./key-extractor.cjs");
 const reactiveVars_js_1 = require("./reactiveVars.cjs");
 function argsFromFieldSpecifier(spec) {
     return (spec.args !== void 0 ? spec.args
-        : spec.field ? (0, internal_1.argumentsObjectFromField)(spec.field, spec.variables)
+        : spec.field ? (0, internal_2.argumentsObjectFromField)(spec.field, spec.variables)
             : null);
 }
 const nullKeyFieldsFn = () => void 0;
@@ -25,6 +27,21 @@ const simpleKeyArgsFn = (_args, context) => context.fieldName;
 // merge:false in a field policy.
 const mergeTrueFn = (existing, incoming, { mergeObjects }) => mergeObjects(existing, incoming);
 const mergeFalseFn = (_, incoming) => incoming;
+const defaultStreamFieldMergeFn = (existing, incoming, { streamFieldInfo, existingData }) => {
+    if (!existing && !existingData) {
+        return incoming;
+    }
+    const results = [];
+    const previous = existing ?? existingData;
+    const length = streamFieldInfo?.isLastChunk ?
+        incoming.length
+        : Math.max(previous.length, incoming.length);
+    for (let i = 0; i < length; i++) {
+        results[i] = incoming[i] === undefined ? previous[i] : incoming[i];
+    }
+    return results;
+};
+exports.defaultStreamFieldMergeFn = defaultStreamFieldMergeFn;
 class Policies {
     config;
     typePolicies = {};
@@ -94,7 +111,7 @@ class Policies {
         masking_1.disableWarningsSlot.withValue(true, () => {
             while (keyFn) {
                 const specifierOrId = keyFn({ ...object, ...storeObject }, context);
-                if ((0, internal_1.isArray)(specifierOrId)) {
+                if ((0, internal_2.isArray)(specifierOrId)) {
                     keyFn = (0, key_extractor_js_1.keyFieldsFnFromSpecifier)(specifierOrId);
                 }
                 else {
@@ -159,7 +176,7 @@ class Policies {
             keyFields === false ? nullKeyFieldsFn
                 // Pass an array of strings to use those fields to compute a
                 // composite ID for objects of this typename.
-                : (0, internal_1.isArray)(keyFields) ? (0, key_extractor_js_1.keyFieldsFnFromSpecifier)(keyFields)
+                : (0, internal_2.isArray)(keyFields) ? (0, key_extractor_js_1.keyFieldsFnFromSpecifier)(keyFields)
                     // Pass a function to take full control over identification.
                     : typeof keyFields === "function" ? keyFields
                         // Leave existing.keyFn unchanged if above cases fail.
@@ -187,7 +204,7 @@ class Policies {
                         keyArgs === false ? simpleKeyArgsFn
                             // Pass an array of strings to use named arguments to
                             // compute a composite identity for the field.
-                            : (0, internal_1.isArray)(keyArgs) ? (0, key_extractor_js_1.keyArgsFnFromSpecifier)(keyArgs)
+                            : (0, internal_2.isArray)(keyArgs) ? (0, key_extractor_js_1.keyArgsFnFromSpecifier)(keyArgs)
                                 // Pass a function to take full control over field identity.
                                 : typeof keyArgs === "function" ? keyArgs
                                     // Leave existing.keyFn unchanged if above cases fail.
@@ -212,7 +229,7 @@ class Policies {
         const rootId = "ROOT_" + which.toUpperCase();
         const old = this.rootTypenamesById[rootId];
         if (typename !== old) {
-            (0, invariant_1.invariant)(!old || old === which, 102, which);
+            (0, invariant_1.invariant)(!old || old === which, 103, which);
             // First, delete any old __typename associated with this rootId from
             // rootIdsByTypename.
             if (old)
@@ -355,7 +372,7 @@ class Policies {
                 if (supertypeSet.has(supertype)) {
                     if (!typenameSupertypeSet.has(supertype)) {
                         if (checkingFuzzySubtypes) {
-                            __DEV__ && invariant_1.invariant.warn(103, typename, supertype);
+                            __DEV__ && invariant_1.invariant.warn(104, typename, supertype);
                         }
                         // Record positive results for faster future lookup.
                         // Unfortunately, we cannot safely cache negative results,
@@ -414,7 +431,7 @@ class Policies {
             const args = argsFromFieldSpecifier(fieldSpec);
             while (keyFn) {
                 const specifierOrString = keyFn(args, context);
-                if ((0, internal_1.isArray)(specifierOrString)) {
+                if ((0, internal_2.isArray)(specifierOrString)) {
                     keyFn = (0, key_extractor_js_1.keyArgsFnFromSpecifier)(specifierOrString);
                 }
                 else {
@@ -428,8 +445,8 @@ class Policies {
         if (storeFieldName === void 0) {
             storeFieldName =
                 fieldSpec.field ?
-                    (0, internal_1.storeKeyNameFromField)(fieldSpec.field, fieldSpec.variables)
-                    : (0, internal_1.getStoreKeyName)(fieldName, argsFromFieldSpecifier(fieldSpec));
+                    (0, internal_2.storeKeyNameFromField)(fieldSpec.field, fieldSpec.variables)
+                    : (0, internal_2.getStoreKeyName)(fieldName, argsFromFieldSpecifier(fieldSpec));
         }
         // Returning false from a keyArgs function is like configuring
         // keyArgs: false, but more dynamic.
@@ -484,7 +501,9 @@ class Policies {
         }
         return merge;
     }
-    runMergeFunction(existing, incoming, { field, typename, merge }, context, storage) {
+    runMergeFunction(existing, incoming, { field, typename, merge, path }, context, storage) {
+        // Preserve the value in case `context.overwrite` is set.
+        const existingData = existing;
         if (merge === mergeTrueFn) {
             // Instead of going to the trouble of creating a full
             // FieldFunctionOptions object and calling mergeTrueFn, we can
@@ -502,7 +521,18 @@ class Policies {
         if (context.overwrite) {
             existing = void 0;
         }
-        return merge(existing, incoming, makeFieldFunctionOptions(this, 
+        const streamInfo = context.extensions?.[internal_1.streamInfoSymbol]
+            ?.deref()
+            ?.peekArray(path);
+        if (streamInfo) {
+            const { current, previous } = streamInfo;
+            if (previous &&
+                (0, equality_1.equal)(previous.incoming, incoming) &&
+                (0, equality_1.equal)(previous.streamFieldInfo, current)) {
+                return previous.result;
+            }
+        }
+        const result = merge(existing, incoming, makeMergeFieldFunctionOptions(this, 
         // Unlike options.readField for read functions, we do not fall
         // back to the current object if no foreignObjOrRef is provided,
         // because it's not clear what the current object should be for
@@ -519,7 +549,16 @@ class Policies {
             fieldName: field.name.value,
             field,
             variables: context.variables,
-        }, context, storage || {}));
+            path,
+        }, context, storage || {}, existingData));
+        if (streamInfo) {
+            streamInfo.previous = {
+                incoming,
+                streamFieldInfo: streamInfo.current,
+                result,
+            };
+        }
+        return result;
     }
 }
 exports.Policies = Policies;
@@ -545,6 +584,26 @@ function makeFieldFunctionOptions(policies, objectOrReference, fieldSpec, contex
         mergeObjects: makeMergeObjectsFunction(context.store),
     };
 }
+function makeMergeFieldFunctionOptions(policies, objectOrReference, fieldSpec, context, storage, existingData) {
+    const options = {
+        ...makeFieldFunctionOptions(policies, objectOrReference, fieldSpec, context, storage),
+        extensions: context.extensions,
+        existingData,
+    };
+    const extensions = context.extensions;
+    if (extensions && internal_1.streamInfoSymbol in extensions) {
+        const { [internal_1.streamInfoSymbol]: streamInfo, ...otherExtensions } = extensions;
+        const streamFieldInfo = streamInfo?.deref()?.peekArray(fieldSpec.path);
+        if (streamFieldInfo) {
+            options.streamFieldInfo = streamFieldInfo.current;
+        }
+        // If the only key in `extensions` was the stream details key, we didn't
+        // receive any remote extensions, so we reset extensions back to undefined
+        options.extensions =
+            Object.keys(otherExtensions).length === 0 ? undefined : otherExtensions;
+    }
+    return options;
+}
 function normalizeReadFieldOptions(readFieldArgs, objectOrReference, variables) {
     const { 0: fieldNameOrOptions, 1: from, length: argc } = readFieldArgs;
     let options;
@@ -566,7 +625,7 @@ function normalizeReadFieldOptions(readFieldArgs, objectOrReference, variables)
         }
     }
     if (environment_1.__DEV__ && options.from === void 0) {
-        __DEV__ && invariant_1.invariant.warn(104, (0, internal_1.stringifyForDisplay)(Array.from(readFieldArgs)));
+        __DEV__ && invariant_1.invariant.warn(105, (0, internal_2.stringifyForDisplay)(Array.from(readFieldArgs)));
     }
     if (void 0 === options.variables) {
         options.variables = variables;
@@ -575,14 +634,14 @@ function normalizeReadFieldOptions(readFieldArgs, objectOrReference, variables)
 }
 function makeMergeObjectsFunction(store) {
     return function mergeObjects(existing, incoming) {
-        if ((0, internal_1.isArray)(existing) || (0, internal_1.isArray)(incoming)) {
-            throw (0, invariant_1.newInvariantError)(105);
+        if ((0, internal_2.isArray)(existing) || (0, internal_2.isArray)(incoming)) {
+            throw (0, invariant_1.newInvariantError)(106);
         }
         // These dynamic checks are necessary because the parameters of a
         // custom merge function can easily have the any type, so the type
         // system cannot always enforce the StoreObject | Reference parameter
         // types of options.mergeObjects.
-        if ((0, internal_1.isNonNullObject)(existing) && (0, internal_1.isNonNullObject)(incoming)) {
+        if ((0, internal_2.isNonNullObject)(existing) && (0, internal_2.isNonNullObject)(incoming)) {
             const eType = store.getFieldValue(existing, "__typename");
             const iType = store.getFieldValue(incoming, "__typename");
             const typesDiffer = eType && iType && eType !== iType;