Merge pull request #472 from apollographql/main

GulajavaMinistudio · web-flow · commit b446daf6e5d0 · 2026-01-14T14:31:22.000+07:00
Create a new pull request by comparing changes across two branches
diff --git a/.api-reports/api-report-utilities_internal.api.md b/.api-reports/api-report-utilities_internal.api.md
@@ -60,6 +60,9 @@ export const AutoCleanedWeakCache: typeof WeakCache;
 // @internal @deprecated (undocumented)
 export type AutoCleanedWeakCache<K extends object, V> = WeakCache<K, V>;
 
+// @public
+export function bindCacheKey(...prebound: object[]): (...args: any) => object;
+
 // @public
 export const canonicalStringify: ((value: any) => string) & {
     reset(): void;
diff --git a/.api-reports/api-report.api.md b/.api-reports/api-report.api.md
@@ -2704,7 +2704,7 @@ interface WriteContext extends ReadMergeModifyContext {
 
 // Warnings were encountered during analysis:
 //
-// src/cache/core/cache.ts:94:9 - (ae-forgotten-export) The symbol "MissingTree" needs to be exported by the entry point index.d.ts
+// src/cache/core/cache.ts:95:9 - (ae-forgotten-export) The symbol "MissingTree" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:98:3 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
diff --git a/.size-limits.json b/.size-limits.json
@@ -1,6 +1,6 @@
 {
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44088,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38925,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33546,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27621
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44208,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 39079,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33629,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27641
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # @apollo/client
 
+## 4.0.13
+
+### Patch Changes
+
+- [#13094](https://github.com/apollographql/apollo-client/pull/13094) [`9cbe2c2`](https://github.com/apollographql/apollo-client/commit/9cbe2c2dd2282ac861327d3c394578db7706df05) Thanks [@phryneas](https://github.com/phryneas)! - Ensure that `compact` and `mergeOptions` preserve symbol keys.
+
+  This fixes an issue where the change introduced in 4.0.11 via #13049 would not
+  be applied if `defaultOptions` for `watchQuery` were declared.
+
+  Please note that `compact` and `mergeOptions` are considered internal utilities
+  and they might have similar behavior changes in future releases.
+  Do not use them in your application code - a change like this is not considered
+  breaking and will not be announced as such.
+
+## 4.0.12
+
+### Patch Changes
+
+- [#13077](https://github.com/apollographql/apollo-client/pull/13077) [`f322460`](https://github.com/apollographql/apollo-client/commit/f322460fe9baae82c0980dd082c1b6b4956a4951) Thanks [@phryneas](https://github.com/phryneas)! - Fix a potential memory leak where Trie nodes would remain in memory too long.
+
 ## 4.0.11
 
 ### Patch Changes
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "description": "A fully-featured caching GraphQL client.",
   "private": true,
   "keywords": [
diff --git a/patches/optimism+0.18.0.patch b/patches/optimism+0.18.0.patch
@@ -0,0 +1,13 @@
+diff --git a/node_modules/optimism/lib/index.d.ts b/node_modules/optimism/lib/index.d.ts
+index 06c3327..19868ac 100644
+--- a/node_modules/optimism/lib/index.d.ts
++++ b/node_modules/optimism/lib/index.d.ts
+@@ -25,7 +25,7 @@ export interface CommonCacheConstructor<TCacheKey, TResult, TArgs extends any[]>
+ export type OptimisticWrapOptions<TArgs extends any[], TKeyArgs extends any[] = TArgs, TCacheKey = any, TResult = any> = {
+     max?: number;
+     keyArgs?: (...args: TArgs) => TKeyArgs;
+-    makeCacheKey?: (...args: NoInfer<TKeyArgs>) => TCacheKey | undefined;
++    makeCacheKey: (...args: NoInfer<TKeyArgs>) => TCacheKey | undefined;
+     normalizeResult?: (newer: TResult, older: TResult) => TResult;
+     subscribe?: (...args: TArgs) => void | (() => any);
+     cache?: CommonCache<NoInfer<TCacheKey>, Entry<NoInfer<TArgs>, NoInfer<TResult>>> | CommonCacheConstructor<NoInfer<TCacheKey>, NoInfer<TResult>, NoInfer<TArgs>>;
diff --git a/src/__tests__/__snapshots__/exports.ts.snap b/src/__tests__/__snapshots__/exports.ts.snap
@@ -419,6 +419,7 @@ Array [
   "AutoCleanedWeakCache",
   "DeepMerger",
   "argumentsObjectFromField",
+  "bindCacheKey",
   "canUseDOM",
   "canonicalStringify",
   "checkDocument",
diff --git a/src/cache/core/cache.ts b/src/cache/core/cache.ts
@@ -18,6 +18,7 @@ import { cacheSizes } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
 import type { NoInfer } from "@apollo/client/utilities/internal";
 import {
+  bindCacheKey,
   equalByQuery,
   getApolloCacheMemoryInternals,
   getFragmentDefinition,
@@ -427,6 +428,7 @@ export abstract class ApolloCache {
       cacheSizes["cache.fragmentQueryDocuments"] ||
       defaultCacheSizes["cache.fragmentQueryDocuments"],
     cache: WeakCache,
+    makeCacheKey: bindCacheKey(this),
   });
 
   /**
diff --git a/src/cache/inmemory/fragmentRegistry.ts b/src/cache/inmemory/fragmentRegistry.ts
@@ -10,7 +10,10 @@ import { wrap } from "optimism";
 
 import { cacheSizes } from "@apollo/client/utilities";
 import type { FragmentMap } from "@apollo/client/utilities/internal";
-import { getFragmentDefinitions } from "@apollo/client/utilities/internal";
+import {
+  bindCacheKey,
+  getFragmentDefinitions,
+} from "@apollo/client/utilities/internal";
 
 import { defaultCacheSizes } from "../../utilities/caching/sizes.js";
 export interface FragmentRegistryAPI {
@@ -69,18 +72,23 @@ class FragmentRegistry implements FragmentRegistryAPI {
   public resetCaches() {
     const proto = FragmentRegistry.prototype;
     this.invalidate = (this.lookup = wrap(proto.lookup.bind(this), {
+      // This is intentionally an identity function - a string cannot be keyed weakly.
+      // This is not a memory leak, as lifetime is bound to the `FragmentRegistry` instance,
+      // and max size is configurable.
       makeCacheKey: (arg) => arg,
       max:
         cacheSizes["fragmentRegistry.lookup"] ||
         defaultCacheSizes["fragmentRegistry.lookup"],
     })).dirty; // This dirty function is bound to the wrapped lookup method.
     this.transform = wrap(proto.transform.bind(this), {
+      makeCacheKey: bindCacheKey(this),
       cache: WeakCache,
       max:
         cacheSizes["fragmentRegistry.transform"] ||
         defaultCacheSizes["fragmentRegistry.transform"],
     });
     this.findFragmentSpreads = wrap(proto.findFragmentSpreads.bind(this), {
+      makeCacheKey: bindCacheKey(this),
       cache: WeakCache,
       max:
         cacheSizes["fragmentRegistry.findFragmentSpreads"] ||
diff --git a/src/core/__tests__/ApolloClient/general.test.ts b/src/core/__tests__/ApolloClient/general.test.ts
@@ -8511,6 +8511,24 @@ describe("ApolloClient", () => {
       );
     });
   });
+
+  test("`client.watchQuery` should forward symbol keys on `options` even with `defaultOptions` present on `ApolloClient`", () => {
+    const client = new ApolloClient({
+      cache: new InMemoryCache(),
+      link: ApolloLink.empty(),
+      defaultOptions: {
+        watchQuery: {},
+      },
+    });
+
+    const obsQuery = client.watchQuery({
+      query: gql`query Test { hello }`,
+      [variablesUnknownSymbol]: true,
+      fetchPolicy: "standby",
+    });
+
+    expect(obsQuery["variablesUnknown"]).toBe(true);
+  });
 });
 
 describe.skip("type tests", () => {
diff --git a/src/link/remove-typename/removeTypenameFromVariables.ts b/src/link/remove-typename/removeTypenameFromVariables.ts
@@ -7,7 +7,7 @@ import type { OperationVariables } from "@apollo/client";
 import { ApolloLink } from "@apollo/client/link";
 import { cacheSizes, stripTypename } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { isPlainObject } from "@apollo/client/utilities/internal";
+import { bindCacheKey, isPlainObject } from "@apollo/client/utilities/internal";
 
 import { defaultCacheSizes } from "../../utilities/caching/sizes.js";
 
@@ -159,7 +159,7 @@ export class RemoveTypenameFromVariablesLink extends ApolloLink {
       if (variables) {
         operation.variables =
           except ?
-            maybeStripTypenameUsingConfig(query, variables, except)
+            this.maybeStripTypenameUsingConfig(query, variables, except)
           : stripTypename(variables);
       }
 
@@ -169,100 +169,101 @@ export class RemoveTypenameFromVariablesLink extends ApolloLink {
       this,
       __DEV__ ?
         {
-          getMemoryInternals() {
+          getMemoryInternals(this: RemoveTypenameFromVariablesLink) {
             return {
               removeTypenameFromVariables: {
-                getVariableDefinitions: getVariableDefinitions?.size ?? 0,
+                getVariableDefinitions: this.getVariableDefinitions?.size ?? 0,
               },
             };
           },
         }
       : {}
     );
   }
-}
 
-function maybeStripTypenameUsingConfig(
-  query: DocumentNode,
-  variables: OperationVariables,
-  config: RemoveTypenameFromVariablesLink.KeepTypenameConfig
-) {
-  const variableDefinitions = getVariableDefinitions(query);
+  private maybeStripTypenameUsingConfig(
+    query: DocumentNode,
+    variables: OperationVariables,
+    config: RemoveTypenameFromVariablesLink.KeepTypenameConfig
+  ) {
+    const variableDefinitions = this.getVariableDefinitions(query);
 
-  return Object.fromEntries(
-    Object.entries(variables).map((keyVal) => {
-      const [key, value] = keyVal;
-      const typename = variableDefinitions[key];
-      const typenameConfig = config[typename];
+    return Object.fromEntries(
+      Object.entries(variables).map((keyVal) => {
+        const [key, value] = keyVal;
+        const typename = variableDefinitions[key];
+        const typenameConfig = config[typename];
 
-      keyVal[1] =
-        typenameConfig ?
-          maybeStripTypename(value, typenameConfig)
-        : stripTypename(value);
+        keyVal[1] =
+          typenameConfig ?
+            this.maybeStripTypename(value, typenameConfig)
+          : stripTypename(value);
 
-      return keyVal;
-    })
-  );
-}
+        return keyVal;
+      })
+    );
+  }
 
-type JSONPrimitive = string | number | null | boolean;
-type JSONValue = JSONPrimitive | JSONValue[] | { [key: string]: JSONValue };
+  private maybeStripTypename(
+    value: JSONValue,
+    config: RemoveTypenameFromVariablesLink.KeepTypenameConfig[string]
+  ): JSONValue {
+    if (config === KEEP) {
+      return value;
+    }
 
-function maybeStripTypename(
-  value: JSONValue,
-  config: RemoveTypenameFromVariablesLink.KeepTypenameConfig[string]
-): JSONValue {
-  if (config === KEEP) {
-    return value;
-  }
+    if (Array.isArray(value)) {
+      return value.map((item) => this.maybeStripTypename(item, config));
+    }
 
-  if (Array.isArray(value)) {
-    return value.map((item) => maybeStripTypename(item, config));
-  }
+    if (isPlainObject(value)) {
+      const modified: Record<string, any> = {};
 
-  if (isPlainObject(value)) {
-    const modified: Record<string, any> = {};
+      Object.keys(value).forEach((key) => {
+        const child = value[key];
 
-    Object.keys(value).forEach((key) => {
-      const child = value[key];
+        if (key === "__typename") {
+          return;
+        }
 
-      if (key === "__typename") {
-        return;
-      }
+        const fieldConfig = config[key];
 
-      const fieldConfig = config[key];
+        modified[key] =
+          fieldConfig ?
+            this.maybeStripTypename(child, fieldConfig)
+          : stripTypename(child);
+      });
 
-      modified[key] =
-        fieldConfig ?
-          maybeStripTypename(child, fieldConfig)
-        : stripTypename(child);
-    });
+      return modified;
+    }
 
-    return modified;
+    return value;
   }
 
-  return value;
-}
+  private getVariableDefinitions = wrap(
+    (document: DocumentNode) => {
+      const definitions: Record<string, string> = {};
 
-const getVariableDefinitions = wrap(
-  (document: DocumentNode) => {
-    const definitions: Record<string, string> = {};
+      visit(document, {
+        VariableDefinition(node) {
+          definitions[node.variable.name.value] = unwrapType(node.type);
+        },
+      });
 
-    visit(document, {
-      VariableDefinition(node) {
-        definitions[node.variable.name.value] = unwrapType(node.type);
-      },
-    });
+      return definitions;
+    },
+    {
+      max:
+        cacheSizes["removeTypenameFromVariables.getVariableDefinitions"] ||
+        defaultCacheSizes["removeTypenameFromVariables.getVariableDefinitions"],
+      cache: WeakCache,
+      makeCacheKey: bindCacheKey(this),
+    }
+  );
+}
 
-    return definitions;
-  },
-  {
-    max:
-      cacheSizes["removeTypenameFromVariables.getVariableDefinitions"] ||
-      defaultCacheSizes["removeTypenameFromVariables.getVariableDefinitions"],
-    cache: WeakCache,
-  }
-);
+type JSONPrimitive = string | number | null | boolean;
+type JSONValue = JSONPrimitive | JSONValue[] | { [key: string]: JSONValue };
 
 function unwrapType(node: TypeNode): string {
   switch (node.kind) {
diff --git a/src/utilities/internal/__tests__/compact.test.ts b/src/utilities/internal/__tests__/compact.test.ts
@@ -54,3 +54,31 @@ test("should not leave undefined properties in result object", () => {
   expect(hasOwn.call(result, "c")).toBe(false);
   expect(result).toEqual({ a: 2 });
 });
+
+test("should preserve symbol options", () => {
+  const symA = Symbol("a");
+  const symB = Symbol("b");
+
+  const result = compact(
+    {
+      [symA]: 123,
+      [symB]: 456,
+      foo: "bar",
+    },
+    {
+      [symA]: 789,
+      baz: "qux",
+    },
+    {
+      [symA]: void 0,
+      byd: "tbd",
+    }
+  );
+  expect(result).toStrictEqualTyped({
+    [symA]: 789,
+    [symB]: 456,
+    foo: "bar",
+    baz: "qux",
+    byd: "tbd",
+  });
+});
diff --git a/src/utilities/internal/bindCacheKey.ts b/src/utilities/internal/bindCacheKey.ts
diff --git a/src/utilities/internal/compact.ts b/src/utilities/internal/compact.ts
diff --git a/src/utilities/internal/index.ts b/src/utilities/internal/index.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`		`- "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44088,`
`3`		`- "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38925,`
`4`		`- "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33546,`
`5`		`- "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27621`
	`2`	`+ "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 44208,`
	`3`	`+ "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 39079,`
	`4`	`+ "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33629,`
	`5`	`+ "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27641`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@apollo/client",`
`3`		`- "version": "4.0.11",`
	`3`	`+ "version": "4.0.13",`
`4`	`4`	`"description": "A fully-featured caching GraphQL client.",`
`5`	`5`	`"private": true,`
`6`	`6`	`"keywords": [`