Update @apollo/client and related dependencies #3187

renovate · 2025-01-16T17:36:21Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@apollo/client (source)	`^3.7.0` -> `^3.12.8`
apollo-link-rest	`^0.8.0-beta.0` -> `^0.9.0`
graphql-anywhere (source)	`^4.2.7` -> `^4.2.8`
graphql-tag	`^2.0.0` -> `^2.12.6`

Release Notes

apollographql/apollo-client (@apollo/client)

`v3.12.8`

Compare Source

Patch Changes

#12292 3abd944 Thanks @phryneas! - Remove unused dependency response-iterator
#12287 bf313a3 Thanks @phryneas! - Fixes an issue where client.watchFragment/useFragment with @includes crashes when a separate cache update writes to the conditionally included fields.

`v3.12.7`

Compare Source

Patch Changes

#12281 d638ec3 Thanks @jerelmiller! - Make fatal tranport-level errors from multipart subscriptions available to the error link with the protocolErrors property.
```
const errorLink = onError(({ protocolErrors }) => {
  if (protocolErrors) {
    console.log(protocolErrors);
  }
});
```
#12281 d638ec3 Thanks @jerelmiller! - Fix the array type for the errors field on the ApolloPayloadResult type. This type was always in the shape of the GraphQL error format, per the multipart subscriptions protocol and never a plain string or a JavaScript error object.

`v3.12.6`

Compare Source

Patch Changes

#12267 d57429d Thanks @jerelmiller! - Maintain the TData type when used with Unmasked when TData is not a masked type generated from GraphQL Codegen.
#12270 3601246 Thanks @jerelmiller! - Fix handling of tagged/branded primitive types when used as scalar values with Unmasked.

`v3.12.5`

Compare Source

Patch Changes

#12252 cb9cd4e Thanks @jerelmiller! - Changes the default behavior of the MaybeMasked type to preserve types unless otherwise specified. This change makes it easier to upgrade from older versions of the client where types could have unexpectedly changed in the application due to the default of trying to unwrap types into unmasked types. This change also fixes the compilation performance regression experienced when simply upgrading the client since types are now preserved by default.

A new mode option has now been introduced to allow for the old behavior. See the next section on migrating if you wish to maintain the old default behavior after upgrading to this version.

Migrating from <= v3.12.4

If you've adopted data masking and have opted in to using masked types by setting the enabled property to true, you can remove this configuration entirely:

-declare module "@&#8203;apollo/client" {
-  interface DataMasking {
-    mode: "unmask"
-  }
-}

If you prefer to specify the behavior explicitly, change the property from enabled: true, to mode: "preserveTypes":

declare module "@&#8203;apollo/client" {
  interface DataMasking {
-    enabled: true
+    mode: "preserveTypes"
  }
}

If you rely on the default behavior in 3.12.4 or below and would like to continue to use unmasked types by default, set the mode to unmask:

declare module "@&#8203;apollo/client" {
  interface DataMasking {
    mode: "unmask";
  }
}

`v3.12.4`

Compare Source

Patch Changes

#12236 4334d30 Thanks @charpeni! - Fix an issue with refetchQueries where comparing DocumentNodes internally by references could lead to an unknown query, even though the DocumentNode was indeed an active query—with a different reference.

`v3.12.3`

Compare Source

Patch Changes

#12214 8bfee88 Thanks @phryneas! - Data masking: prevent infinite recursion of ContainsFragmentsRefs type
#12204 851deb0 Thanks @jerelmiller! - Fix Unmasked unwrapping tuple types into an array of their subtypes.
#12204 851deb0 Thanks @jerelmiller! - Ensure MaybeMasked does not try and unwrap types that contain index signatures.
#12204 851deb0 Thanks @jerelmiller! - Ensure MaybeMasked does not try to unwrap the type as Unmasked if the type contains any.

`v3.12.2`

Compare Source

Patch Changes

#12175 84af347 Thanks @jerelmiller! - Update peer deps to allow for React 19 stable release.

`v3.12.1`

Compare Source

Patch Changes

#12171 e1efe74 Thanks @phryneas! - Fix import extension in masking entry point.

`v3.12.0`

Compare Source

Minor Changes

Data masking 🎭

#12042 1c0ecbf Thanks @jerelmiller! - Introduces data masking in Apollo Client.

Data masking enforces that only the fields requested by the query or fragment is available to that component. Data masking is best paired with colocated fragments.

To enable data masking in Apollo Client, set the dataMasking option to true.
```
new ApolloClient({
  dataMasking: true,
  // ... other options
});
```
For detailed information on data masking, including how to incrementally adopt it in an existing applications, see the data masking documentation.
#12131 21c3f08 Thanks @jerelmiller! - Allow null as a valid from value in useFragment.

More Patch Changes

#12126 d10d702 Thanks @jerelmiller! - Maintain the existing document if its unchanged by the codemod and move to more naive whitespace formatting
#12150 9ed1e1e Thanks @jerelmiller! - Fix issue when using Unmasked with older versions of TypeScript when used with array fields.
#12116 8ae6e4e Thanks @jerelmiller! - Prevent field accessor warnings when using @unmask(mode: "migrate") on objects that are passed into cache.identify.
#12120 6a98e76 Thanks @jerelmiller! - Provide a codemod that applies @unmask to all named fragments for all operations and fragments.

Learn how to use the codemod in the incremental adoption documentation.
#12134 cfaf4ef Thanks @jerelmiller! - Fix issue where data went missing when an unmasked fragment in migrate mode selected fields that the parent did not.
#12154 d933def Thanks @phryneas! - Data masking types: handle overlapping nested array types and fragments on interface types.
#12139 5a53e15 Thanks @phryneas! - Fix issue where masked data would sometimes get returned when the field was part of a child fragment from a fragment unmasked by the parent query.
#12123 8422a30 Thanks @jerelmiller! - Warn when using data masking with "no-cache" operations.
#12139 5a53e15 Thanks @phryneas! - Fix issue where the warning emitted by @unmask(mode: "migrate") would trigger unnecessarily when the fragment was used alongside a masked fragment inside an inline fragment.
#12114 1d4ce00 Thanks @jerelmiller! - Fix error when combining @unmask and @defer directives on a fragment spread when data masking is enabled.
#12130 1e7d009 Thanks @jerelmiller! - Fix error thrown when applying unmask migrate mode warnings on interface types with selection sets that contain inline fragment conditions.
#12152 78137ec Thanks @phryneas! - Add a helper that will skip the TS unmasking alorithm when no fragments are present on type level
#12126 d10d702 Thanks @jerelmiller! - Ensure documents unchanged by the codemod are left untouched.
#12133 a6ece37 Thanks @jerelmiller! - Ensure null is retained in nullable types when unmasking a type with the Unmasked helper type.
#12139 5a53e15 Thanks @phryneas! - Fix issue that threw errors when masking partial data with @unmask(mode: "migrate").

`v3.11.10`

Compare Source

Patch Changes

#12093 1765668 Thanks @mgmolisani! - Fixed a bug when evaluating the devtools flag with the new syntax devtools.enabled that could result to true when explicitly set to false.

`v3.11.9`

Compare Source

Patch Changes

#12110 a3f95c6 Thanks @jerelmiller! - Fix an issue where errors returned from a fetchMore call from a Suspense hook would cause a Suspense boundary to be shown indefinitely.

`v3.11.8`

Compare Source

Patch Changes

#12054 35cf186 Thanks @phryneas! - Fixed a bug where incorrect object access in some Safari extensions could cause a crash.

`v3.11.7`

Compare Source

Patch Changes

#12052 e471cef Thanks @jerelmiller! - Fixes a regression from where passing an invalid identifier to from in useFragment would result in the warning TypeError: Cannot read properties of undefined (reading '__typename').

`v3.11.6`

Compare Source

Patch Changes

#12049 9c26892 Thanks @phryneas and @maciesielka! - Fix a bug where useFragment did not re-render as expected
#12044 04462a2 Thanks @DoctorJohn! - Cache the useSubscription hook's restart function definition between re-renders.

`v3.11.5`

Compare Source

Patch Changes

#12027 eb3e21b Thanks @JavaScriptBach! - Type MutationResult.reset as an arrow function
#12020 82d8cb4 Thanks @jerelmiller! - Better conform to Rules of React by avoiding write of ref in render for useFragment.

`v3.11.4`

Compare Source

Patch Changes

#11994 41b17e5 Thanks @jerelmiller! - Update the Modifier function type to allow cache.modify to return deeply partial data.
#11989 e609156 Thanks @phryneas! - Fix a potential crash when calling clearStore while a query was running.

Previously, calling client.clearStore() while a query was running had one of these results:
- useQuery would stay in a loading: true state.
- useLazyQuery would stay in a loading: true state, but also crash with a "Cannot read property 'data' of undefined" error.
Now, in both cases, the hook will enter an error state with a networkError, and the promise returned by the useLazyQuery execute function will return a result in an error state.
#11994 41b17e5 Thanks @jerelmiller! - Prevent accidental distribution on cache.modify field modifiers when a field is a union type array.

`v3.11.3`

Compare Source

Patch Changes

#11984 5db1659 Thanks @jerelmiller! - Fix an issue where multiple fetches with results that returned errors would sometimes set the data property with an errorPolicy of none.
#11974 c95848e Thanks @jerelmiller! - Fix an issue where fetchMore would write its result data to the cache when using it with a no-cache fetch policy.
#11974 c95848e Thanks @jerelmiller! - Fix an issue where executing fetchMore with a no-cache fetch policy could sometimes result in multiple network requests.
#11974 c95848e Thanks @jerelmiller! -

Potentially disruptive change

When calling fetchMore with a query that has a no-cache fetch policy, fetchMore will now throw if an updateQuery function is not provided. This provides a mechanism to merge the results from the fetchMore call with the query's previous result.

`v3.11.2`

Compare Source

Patch Changes

#11980 38c0a2c Thanks @jerelmiller! - Fix missing getServerSnapshot error when using useSubscription on the server.

`v3.11.1`

Compare Source

Patch Changes

#11969 061cab6 Thanks @jerelmiller! - Remove check for window.__APOLLO_CLIENT__ when determining whether to connect to Apollo Client Devtools when connectToDevtools or devtools.enabled is not specified. This now simply checks to see if the application is in development mode.
#11971 ecf77f6 Thanks @jerelmiller! - Prevent the setTimeout for suggesting devtools from running in non-browser environments.

`v3.11.0`

Compare Source

Potentially Breaking Fixes

#11789 5793301 Thanks @phryneas! - Changes usages of the GraphQLError type to GraphQLFormattedError.

This was a type bug - these errors were never GraphQLError instances
to begin with, and the GraphQLError class has additional properties that can
never be correctly rehydrated from a GraphQL result.
The correct type to use here is GraphQLFormattedError.

Similarly, please ensure to use the type FormattedExecutionResult
instead of ExecutionResult - the non-"Formatted" versions of these types
are for use on the server only, but don't get transported over the network.
#11626 228429a Thanks @phryneas! - Call nextFetchPolicy with "variables-changed" even if there is a fetchPolicy specified.

Previously this would only be called when the current fetchPolicy was equal to the fetchPolicy option or the option was not specified. If you use nextFetchPolicy as a function, expect to see this function called more often.

Due to this bug, this also meant that the fetchPolicy might be reset to the initial fetchPolicy, even when you specified a nextFetchPolicy function. If you previously relied on this behavior, you will need to update your nextFetchPolicy callback function to implement this resetting behavior.

As an example, if your code looked like the following:
```
useQuery(QUERY, {
  nextFetchPolicy(currentFetchPolicy, info) {
    // your logic here
  }
);
```
Update your function to the following to reimplement the resetting behavior:
```
useQuery(QUERY, {
  nextFetchPolicy(currentFetchPolicy, info) {
    if (info.reason === 'variables-changed') {
      return info.initialFetchPolicy;
    }
    // your logic here
  }
);
```

Minor Changes

#11923 d88c7f8 Thanks @jerelmiller! - Add support for subscribeToMore function to useQueryRefHandlers.
#11854 3812800 Thanks @jcostello-atlassian! - Support extensions in useSubscription
#11923 d88c7f8 Thanks @jerelmiller! - Add support for subscribeToMore function to useLoadableQuery.
#11863 98e44f7 Thanks @phryneas! - Reimplement useSubscription to fix rules of React violations.
#11869 a69327c Thanks @phryneas! - Rewrite big parts of useQuery and useLazyQuery to be more compliant with the Rules of React and React Compiler
#11936 1b23337 Thanks @jerelmiller! - Add the ability to specify a name for the client instance for use with Apollo Client Devtools. This is useful when instantiating multiple clients to identify the client instance more easily. This deprecates the connectToDevtools option in favor of a new devtools configuration.
```
new ApolloClient({
  devtools: {
    enabled: true,
    name: "Test Client",
  },
});
```
This option is backwards-compatible with connectToDevtools and will be used in the absense of a devtools option.
#11923 d88c7f8 Thanks @jerelmiller! - Add support for subscribeToMore function to useBackgroundQuery.
#11930 a768575 Thanks @jerelmiller! - Deprecates experimental schema testing utilities introduced in 3.10 in favor of recommending @apollo/graphql-testing-library.

Patch Changes

#11951 0de03af Thanks @phryneas! - add React 19 RC to peerDependencies
#11927 2941824 Thanks @phryneas! - Add restart function to useSubscription.
#11949 4528918 Thanks @alessbell! - Remove deprecated watchFragment option, canonizeResults
#11937 78332be Thanks @phryneas! - createSchemaFetch: simulate serialized errors instead of an ApolloError instance
#11902 96422ce Thanks @phryneas! - Add cause field to ApolloError.
#11806 8df6013 Thanks @phryneas! - MockLink: add query default variables if not specified in mock request
#11926 3dd6432 Thanks @phryneas! - watchFragment: forward additional options to diffOptions
#11946 7d833b8 Thanks @jerelmiller! - Fix issue where mutations were not accessible by Apollo Client Devtools in 3.11.0-rc.0.
#11944 8f3d7eb Thanks @sneyderdev! - Allow IgnoreModifier to be returned from a optimisticResponse function when inferring from a TypedDocumentNode when used with a generic argument.
#11954 4a6e86a Thanks @phryneas! - Document (and deprecate) the previously undocumented errors property on the useQuery QueryResult type.
#11719 09a6677 Thanks @phryneas! - Allow wrapping createQueryPreloader
#11921 70406bf Thanks @phryneas! - add ignoreResults option to useSubscription

`v3.10.8`

Compare Source

Patch Changes

#11911 1f0460a Thanks @jerelmiller! - Allow undefined to be returned from a cache.modify modifier function when a generic type argument is used.

`v3.10.7`

Compare Source

Patch Changes

#11901 10a8c0a Thanks @phryneas! - update canUseLayoutEffect check to also allow for layout effects in React Native
#11861 1aed0e8 Thanks @henryqdineen! - Defend against non-serializable params in invariantWrappers
#11905 29755da Thanks @phryneas! - Add .d.cts files for cjs bundles
#11906 d104759 Thanks @phryneas! - chore: update TypeScript to 5.5

`v3.10.6`

Compare Source

Patch Changes

#11900 f745558 Thanks @phryneas! - useMutation: use useIsomorphicLayoutEffect instead of useLayoutEffect

`v3.10.5`

Compare Source

Patch Changes

#11888 7fb7939 Thanks @phryneas! - switch useRenderGuard to an approach not accessing React's internals
#11511 6536369 Thanks @phryneas! - useLoadableQuery: ensure that loadQuery is updated if the ApolloClient instance changes
#11860 8740f19 Thanks @alessbell! - Fixes #11849 by reevaluating window.fetch each time BatchHttpLink uses it, if not configured via options.fetch. Takes the same approach as PR #8603 which fixed the same issue in HttpLink.
#11852 d502a69 Thanks @phryneas! - Fix a bug where calling the useMutation reset function would point the hook to an outdated client reference.
#11329 3d164ea Thanks @PaLy! - Fix graphQLErrors in Error Link if networkError.result is an empty string
#11852 d502a69 Thanks @phryneas! - Prevent writing to a ref in render in useMutation.
As a result, you might encounter problems in the future if you call the mutation's execute function during render. Please note that this was never supported behavior, and we strongly recommend against it.
#11848 ad63924 Thanks @phryneas! - Ensure covariant behavior: MockedResponse<X,Y> should be assignable to MockedResponse
#11851 45c47be Thanks @phryneas! - Avoid usage of useRef in useInternalState to prevent ref access in render.
#11877 634d91a Thanks @phryneas! - Add missing name to tuple member (fix TS5084)
#11851 45c47be Thanks @phryneas! - Fix a bug where useLazyQuery would not pick up a client change.

`v3.10.4`

Compare Source

Patch Changes

#11838 8475346 Thanks @alex-kinokon! - Don’t prompt for DevTools installation for browser extension page
#11839 6481fe1 Thanks @jerelmiller! - Fix a regression in 3.9.5 where a merge function that returned an incomplete result would not allow the client to refetch in order to fulfill the query.
#11844 86984f2 Thanks @jerelmiller! - Honor the @nonreactive directive when using cache.watchFragment or the useFragment hook to avoid rerendering when using these directives.
#11824 47ad806 Thanks @phryneas! - Create branded QueryRef type without exposed properties.

This change deprecates QueryReference in favor of a QueryRef type that doesn't expose any properties.
This change also updates preloadQuery to return a new PreloadedQueryRef type, which exposes the toPromise function as it does today. This means that query refs produced by useBackgroundQuery and useLoadableQuery now return QueryRef types that do not have access to a toPromise function, which was never meant to be used in combination with these hooks.

While we tend to avoid any types of breaking changes in patch releases as this, this change was necessary to support an upcoming version of the React Server Component integration, which needed to omit the toPromise function that would otherwise have broken at runtime.
Note that this is a TypeScript-only change. At runtime, toPromise is still present on all queryRefs currently created by this package - but we strongly want to discourage you from accessing it in all cases except for the PreloadedQueryRef use case.

Migration is as simple as replacing all references to QueryReference with QueryRef, so it should be possible to do this with a search & replace in most code bases:
```
-import { QueryReference } from '@&#8203;apollo/client'
+import { QueryRef } from '@&#8203;apollo/client'

- function Component({ queryRef }: { queryRef: QueryReference<TData> }) {
+ function Component({ queryRef }: { queryRef: QueryRef<TData> }) {
  // ...
}
```
#11845 4c5c820 Thanks @jerelmiller! - Remove @nonreactive directives from queries passed to MockLink to ensure they are properly matched.
#11837 dff15b1 Thanks @jerelmiller! - Fix an issue where a polled query created in React strict mode may not stop polling after the component unmounts while using the cache-and-network fetch policy.

`v3.10.3`

Compare Source

Patch Changes

#11811 d67d7f9 Thanks @phryneas! - Adjust some types for React 19 compat
#11834 7d8aad4 Thanks @psamim! - Fix error "Cannot convert object to primitive value"

`v3.10.2`

Compare Source

Patch Changes

#11821 2675d3c Thanks @jerelmiller! - Fix a regression where rerendering a component with useBackgroundQuery would recreate the queryRef instance when used with React's strict mode.
#11821 2675d3c Thanks @jerelmiller! - Revert the change introduced in
3.9.10 via #11738 that disposed of queryRefs synchronously. This change caused too many issues with strict mode.

`v3.10.1`

Compare Source

Patch Changes

#11792 5876c35 Thanks @phryneas! - AutoCleanedCache: only schedule batched cache cleanup if the cache is full (fixes #11790)
#11799 1aca7ed Thanks @phryneas! - RenderPromises: use canonicalStringify to serialize variables to ensure query deduplication is properly applied even when variables are specified in a different order.
#11803 bf9dd17 Thanks @phryneas! - Update the rehackt dependency to ^0.1.0
#11756 60592e9 Thanks @henryqdineen! - Fix operation.setContext() type

`v3.10.0`

Compare Source

Minor Changes

#11605 e2dd4c9 Thanks @alessbell! - Adds createMockFetch utility for integration testing that includes the link chain
#11760 acd1982 Thanks @alessbell! - createTestSchema now uses graphql-tools mergeResolvers to merge resolvers instead of a shallow merge.
#11764 f046aa9 Thanks @alessbell! - Rename createProxiedSchema to createTestSchema and createMockFetch to createSchemaFetch.
#11777 5dfc79f Thanks @alessbell! - Call createMockSchema inside createTestSchema.
#11774 2583488 Thanks @alessbell! - Add ability to set min and max delay in createSchemaFetch
#11605 e2dd4c9 Thanks @alessbell! - Adds proxiedSchema and createMockSchema testing utilities
#11465 7623da7 Thanks @alessbell! - Add watchFragment method to the cache and expose it on ApolloClient, refactor useFragment using watchFragment.
#11743 78891f9 Thanks @jerelmiller! - Remove alpha designation for queryRef.toPromise() to stabilize the API.
#11743 78891f9 Thanks @jerelmiller! - Remove alpha designation for createQueryPreloader to stabilize the API.
#11783 440563a Thanks @alessbell! - Moves new testing utilities to their own entrypoint, testing/experimental

Patch Changes

#11757 9825295 Thanks @phryneas! - Adjust useReadQuery wrappe

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

johnnyomair · 2025-01-20T12:37:14Z

@manuelblum apollo-link-rest no longer has graphql-anywhere as dependency, so we could probably remove it.

renovate · 2025-02-03T15:15:48Z

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

renovate bot added the dependencies label Jan 16, 2025

renovate bot force-pushed the renovate/@apolloclient-and-related-dependencies branch 4 times, most recently from ee91dbc to 6c0a804 Compare January 20, 2025 12:29

johnnyomair self-assigned this Jan 20, 2025

renovate bot force-pushed the renovate/@apolloclient-and-related-dependencies branch 4 times, most recently from c0c7b5d to c474312 Compare January 27, 2025 17:19

renovate bot force-pushed the renovate/@apolloclient-and-related-dependencies branch 2 times, most recently from b02f439 to dbbe92d Compare February 2, 2025 13:07

Update @apollo/client and related dependencies

7cfced0

renovate bot force-pushed the renovate/@apolloclient-and-related-dependencies branch from dbbe92d to 7cfced0 Compare February 3, 2025 14:28

Remove graphql-anywhere

33c7f04

vivid-planet deleted a comment from sonarqubecloud bot Feb 3, 2025

johnnyomair force-pushed the renovate/@apolloclient-and-related-dependencies branch from 8162ca7 to 2dee644 Compare February 4, 2025 09:21

Fix type errors

a553281

johnnyomair force-pushed the renovate/@apolloclient-and-related-dependencies branch from 2dee644 to a553281 Compare February 4, 2025 09:23

johnnyomair requested a review from manuelblum February 4, 2025 09:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update @apollo/client and related dependencies #3187

Update @apollo/client and related dependencies #3187

renovate bot commented Jan 16, 2025 •

edited

Loading

johnnyomair commented Jan 20, 2025

renovate bot commented Feb 3, 2025

Update @apollo/client and related dependencies #3187

Are you sure you want to change the base?

Update @apollo/client and related dependencies #3187

Conversation

renovate bot commented Jan 16, 2025 • edited Loading

Release Notes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Migrating from <= v3.12.4

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Data masking 🎭

More Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Potentially disruptive change

Patch Changes

Patch Changes

Potentially Breaking Fixes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Configuration

johnnyomair commented Jan 20, 2025

renovate bot commented Feb 3, 2025

Edited/Blocked Notification

renovate bot commented Jan 16, 2025 •

edited

Loading