[Snyk] Upgrade @apollo/client from 3.7.7 to 3.11.1 #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade @apollo/client from 3.7.7 to 3.11.1.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 87 versions ahead of your current version.
The recommended version was released on 22 days ago.
Release notes
Package name: @apollo/client
Patch Changes
#11969
061cab6
Thanks @ jerelmiller! - Remove check forwindow.__APOLLO_CLIENT__
when determining whether to connect to Apollo Client Devtools whenconnectToDevtools
ordevtools.enabled
is not specified. This now simply checks to see if the application is in development mode.#11971
ecf77f6
Thanks @ jerelmiller! - Prevent thesetTimeout
for suggesting devtools from running in non-browser environments.Potentially Breaking Fixes
#11789
5793301
Thanks @ phryneas! - Changes usages of theGraphQLError
type toGraphQLFormattedError
.This was a type bug - these errors were never
GraphQLError
instancesto begin with, and the
GraphQLError
class has additional properties that cannever 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 typesare for use on the server only, but don't get transported over the network.
#11626
228429a
Thanks @ phryneas! - CallnextFetchPolicy
with "variables-changed" even if there is afetchPolicy
specified.Previously this would only be called when the current
fetchPolicy
was equal to thefetchPolicy
option or the option was not specified. If you usenextFetchPolicy
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 initialfetchPolicy
, even when you specified anextFetchPolicy
function. If you previously relied on this behavior, you will need to update yournextFetchPolicy
callback function to implement this resetting behavior.As an example, if your code looked like the following:
Update your function to the following to reimplement the resetting behavior:
Minor Changes
#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseQueryRefHandlers
.#11854
3812800
Thanks @ jcostello-atlassian! - Support extensions in useSubscription#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseLoadableQuery
.#11863
98e44f7
Thanks @ phryneas! - ReimplementuseSubscription
to fix rules of React violations.#11869
a69327c
Thanks @ phryneas! - Rewrite big parts ofuseQuery
anduseLazyQuery
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 theconnectToDevtools
option in favor of a newdevtools
configuration.This option is backwards-compatible with
connectToDevtools
and will be used in the absense of adevtools
option.#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseBackgroundQuery
.#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 topeerDependencies
#11927
2941824
Thanks @ phryneas! - Addrestart
function touseSubscription
.#11949
4528918
Thanks @ alessbell! - Remove deprecatedwatchFragment
option,canonizeResults
#11937
78332be
Thanks @ phryneas! -createSchemaFetch
: simulate serialized errors instead of anApolloError
instance#11902
96422ce
Thanks @ phryneas! - Addcause
field toApolloError
.#11806
8df6013
Thanks @ phryneas! - MockLink: add query default variables if not specified in mock request#11926
3dd6432
Thanks @ phryneas! -watchFragment
: forward additional options todiffOptions
#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! - AllowIgnoreModifier
to be returned from aoptimisticResponse
function when inferring from aTypedDocumentNode
when used with a generic argument.#11954
4a6e86a
Thanks @ phryneas! - Document (and deprecate) the previously undocumentederrors
property on theuseQuery
QueryResult
type.#11719
09a6677
Thanks @ phryneas! - Allow wrappingcreateQueryPreloader
#11921
70406bf
Thanks @ phryneas! - addignoreResults
option touseSubscription
Patch Changes
#11951
0de03af
Thanks @ phryneas! - add React 19 RC topeerDependencies
#11937
78332be
Thanks @ phryneas! -createSchemaFetch
: simulate serialized errors instead of anApolloError
instance#11944
8f3d7eb
Thanks @ sneyderdev! - AllowIgnoreModifier
to be returned from aoptimisticResponse
function when inferring from aTypedDocumentNode
when used with a generic argument.#11954
4a6e86a
Thanks @ phryneas! - Document (and deprecate) the previously undocumentederrors
property on theuseQuery
QueryResult
type.Patch Changes
#11949
4528918
Thanks @ alessbell! - Remove deprecatedwatchFragment
option,canonizeResults
#11926
3dd6432
Thanks @ phryneas! -watchFragment
: forward additional options todiffOptions
#11946
7d833b8
Thanks @ jerelmiller! - Fix issue where mutations were not accessible by Apollo Client Devtools in 3.11.0-rc.0.Minor Changes
#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseQueryRefHandlers
.#11854
3812800
Thanks @ jcostello-atlassian! - Support extensions in useSubscription#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseLoadableQuery
.#11863
98e44f7
Thanks @ phryneas! - ReimplementuseSubscription
to fix rules of React violations.#11869
a69327c
Thanks @ phryneas! - Rewrite big parts ofuseQuery
anduseLazyQuery
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 theconnectToDevtools
option in favor of a newdevtools
configuration.This option is backwards-compatible with
connectToDevtools
and will be used in the absense of adevtools
option.#11923
d88c7f8
Thanks @ jerelmiller! - Add support forsubscribeToMore
function touseBackgroundQuery
.#11789
5793301
Thanks @ phryneas! - Changes usages of theGraphQLError
type toGraphQLFormattedError
.This was a type bug - these errors were never
GraphQLError
instancesto begin with, and the
GraphQLError
class has additional properties that cannever 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 typesare for use on the server only, but don't get transported over the network.
#11930
a768575
Thanks @ jerelmiller! - Deprecates experimental schema testing utilities introduced in 3.10 in favor of recommending@ apollo/graphql-testing-library
.Patch Changes
#11927
2941824
Thanks @ phryneas! - Addrestart
function touseSubscription
.#11902
96422ce
Thanks @ phryneas! - Addcause
field toApolloError
.#11806
8df6013
Thanks @ phryneas! - MockLink: add query default variables if not specified in mock request#11626
228429a
Thanks @ phryneas! - CallnextFetchPolicy
with "variables-changed" even if there is afetchPolicy
specified. (fixes #11365)#11719
09a6677
Thanks @ phryneas! - Allow wrappingcreateQueryPreloader
#11921
70406bf
Thanks @ phryneas! - addignoreResults
option touseSubscription
Patch Changes
1f0460a
Thanks @ jerelmiller! - Allowundefined
to be returned from acache.modify
modifier function when a generic type argument is used.Patch Changes
#11901
10a8c0a
Thanks @ phryneas! - updatecanUseLayoutEffect
check to also allow for layout effects in React Native#11861
1aed0e8
Thanks @ henryqdineen! - Defend against non-serializable params ininvariantWrappers
#11905
29755da
Thanks @ phryneas! - Add.d.cts
files for cjs bundles#11906
d104759
Thanks @ phryneas! - chore: update TypeScript to 5.5Patch Changes
f745558
Thanks @ phryneas! -useMutation
: useuseIsomorphicLayoutEffect
instead ofuseLayoutEffect
Patch Changes
#11888
7fb7939
Thanks @ phryneas! - switchuseRenderGuard
to an approach not accessing React's internals#11511
6536369
Thanks @ phryneas! -useLoadableQuery
: ensure thatloadQuery
is updated if the ApolloClient instance changes#11860
8740f19
Thanks @ alessbell! - Fixes #11849 by reevaluatingwindow.fetch
each timeBatchHttpLink
uses it, if not configured viaoptions.fetch
. Takes the same approach as PR #8603 which fixed the same issue inHttpLink
.#11852
d502a69
Thanks @ phryneas! - Fix a bug where calling theuseMutation
reset
function would point the hook to an outdatedclient
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 inuseMutation
.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 toMockedResponse
#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 whereuseLazyQuery
would not pick up a client change.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 usingcache.watchFragment
or theuseFragment
hook to avoid rerendering when using these directives.#11824
47ad806
Thanks @ phryneas! - Create brandedQueryRef
type without exposed properties.This change deprecates
QueryReference
in favor of aQueryRef
type that doesn't expose any properties.This change also updates
preloadQuery
to return a newPreloadedQueryRef
type, which exposes thetoPromise
function as it does today. This means that query refs produced byuseBackgroundQuery
anduseLoadableQuery
now returnQueryRef
types that do not have access to atoPromise
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 thePreloadedQueryRef
use case.Migration is as simple as replacing all references to
QueryReference
withQueryRef
, so it should be possible to do this with a search & replace in most code bases:+import { QueryRef } from '@ apollo/client'
- function Component({ queryRef }: { queryRef: QueryReference<TData> }) {
+ function Component({ queryRef }: { queryRef: QueryRef<TData> }) {
// ...
}
#11845
4c5c820
Thanks @ jerelmiller! - Remove@ nonreactive
directives from queries passed toMockLink
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 thecache-and-network
fetch policy.Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information: