Skip to content

Add deprecations and warnings to ApolloClient options and methods #12736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 33 commits into from
Jun 26, 2025
Merged

Add deprecations and warnings to ApolloClient options and methods #12736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
3d1e1c2
Add warning for connectToDevTools option
jerelmiller Jun 24, 2025
788949c
Add warning for missing link
jerelmiller Jun 24, 2025
ffc0e37
Add warning for uri, credentials, and headers options
jerelmiller Jun 24, 2025
a1eaee3
Add `@deprecated` for for uri, context, headers
jerelmiller Jun 24, 2025
7f24193
Use future tense
jerelmiller Jun 24, 2025
a6b82ce
Update deprecation for connectToDevTools
jerelmiller Jun 24, 2025
88f906e
Add additional deprecations
jerelmiller Jun 24, 2025
b4f645e
Add `clientAwareness` option and deprecate name/version
jerelmiller Jun 24, 2025
6bd8714
Deprecate disableNetworkFetches and add get/set prioritizeCacheValues
jerelmiller Jun 24, 2025
d85dacf
Make `localState` a public property
jerelmiller Jun 24, 2025
8a52c0d
Add deprecations for local state functions in ApolloClient
jerelmiller Jun 24, 2025
ce58d57
Add changeset
jerelmiller Jun 24, 2025
e5f140d
Rerun api report
jerelmiller Jun 24, 2025
a8f32e4
Update size limits
jerelmiller Jun 24, 2025
174d2e0
Add warning for client awareness
jerelmiller Jun 24, 2025
d0a03db
Fix half written comment
jerelmiller Jun 24, 2025
f6d55e4
Add warning for fragmentMatcher
jerelmiller Jun 24, 2025
f546705
Add warning for typeDefs
jerelmiller Jun 24, 2025
b124e0a
Use devtools option in MockedProvider
jerelmiller Jun 24, 2025
36264a2
Fix dataMasking test
jerelmiller Jun 24, 2025
6f24c4d
Fix useFragment tests that checked # of warnings
jerelmiller Jun 24, 2025
3bbdbdf
Update size limits
jerelmiller Jun 24, 2025
0189f32
Update deprecation messages
jerelmiller Jun 25, 2025
0f1df0c
Remove warning for fragmentMatcher
jerelmiller Jun 25, 2025
c8fa6f4
Update deprecation messages
jerelmiller Jun 25, 2025
3269128
Update size limits
jerelmiller Jun 25, 2025
2f55fdb
Fix typo
jerelmiller Jun 25, 2025
c806091
Add devtools option to `MockedProvider`.
jerelmiller Jun 25, 2025
c70b242
Add warning for `connectToDevTools` in MockedProvider
jerelmiller Jun 25, 2025
aef5637
Fix typo
jerelmiller Jun 25, 2025
bcfcd8d
Ensure devtools is used in config
jerelmiller Jun 25, 2025
d4be07c
Rerun api report
jerelmiller Jun 25, 2025
c1929fd
Update size limits
jerelmiller Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions .api-reports/api-report-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export class ApolloClient<TCacheShape> implements DataProxy {
constructor(options: ApolloClientOptions<TCacheShape>);
// (undocumented)
__requestRaw(payload: GraphQLRequest): Observable<FormattedExecutionResult>;
// @deprecated
addResolvers(resolvers: Resolvers | Resolvers[]): void;
// (undocumented)
cache: ApolloCache<TCacheShape>;
Expand All @@ -111,19 +112,26 @@ export class ApolloClient<TCacheShape> implements DataProxy {
//
// (undocumented)
readonly devtoolsConfig: DevtoolsOptions;
// (undocumented)
// @deprecated (undocumented)
disableNetworkFetches: boolean;
get documentTransform(): DocumentTransform;
extract(optimistic?: boolean): TCacheShape;
// Warning: (ae-forgotten-export) The symbol "getApolloClientMemoryInternals" needs to be exported by the entry point index.d.ts
getMemoryInternals?: typeof getApolloClientMemoryInternals;
getObservableQueries(include?: RefetchQueriesInclude): Map<string, ObservableQuery<any>>;
// @deprecated
getResolvers(): Resolvers;
// (undocumented)
link: ApolloLink;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
localState: LocalState<TCacheShape>;
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
onClearStore(cb: () => Promise<any>): () => void;
onResetStore(cb: () => Promise<any>): () => void;
get prioritizeCacheValues(): boolean;
set prioritizeCacheValues(value: boolean);
query<T = any, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, T>): Promise<ApolloQueryResult<MaybeMasked<T>>>;
// (undocumented)
queryDeduplication: boolean;
Expand All @@ -134,7 +142,9 @@ export class ApolloClient<TCacheShape> implements DataProxy {
resetStore(): Promise<ApolloQueryResult<any>[] | null>;
restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
setLink(newLink: ApolloLink): void;
// @deprecated
setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
// @deprecated
setResolvers(resolvers: Resolvers | Resolvers[]): void;
stop(): void;
subscribe<T = any, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, T>): Observable<FetchResult<MaybeMasked<T>>>;
Expand All @@ -152,9 +162,14 @@ export class ApolloClient<TCacheShape> implements DataProxy {
export interface ApolloClientOptions<TCacheShape> {
assumeImmutableResults?: boolean;
cache: ApolloCache<TCacheShape>;
// (undocumented)
clientAwareness?: {
name?: string;
version?: string;
};
// @deprecated
connectToDevTools?: boolean;
// (undocumented)
// @deprecated (undocumented)
credentials?: string;
dataMasking?: boolean;
// (undocumented)
Expand All @@ -163,19 +178,23 @@ export interface ApolloClientOptions<TCacheShape> {
devtools?: DevtoolsOptions;
// (undocumented)
documentTransform?: DocumentTransform;
// (undocumented)
// @deprecated (undocumented)
fragmentMatcher?: FragmentMatcher;
// @deprecated
headers?: Record<string, string>;
link?: ApolloLink;
// @deprecated
name?: string;
queryDeduplication?: boolean;
// (undocumented)
// @deprecated (undocumented)
resolvers?: Resolvers | Resolvers[];
ssrForceFetchDelay?: number;
ssrMode?: boolean;
// (undocumented)
// @deprecated (undocumented)
typeDefs?: string | string[] | DocumentNode | DocumentNode[];
// @deprecated
uri?: string | UriFunction;
// @deprecated
version?: string;
}

Expand Down Expand Up @@ -1935,8 +1954,6 @@ class QueryManager<TStore> {
//
// (undocumented)
getDocumentInfo(document: DocumentNode): TransformCacheEntry;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getLocalState(): LocalState<TStore>;
// (undocumented)
Expand Down
34 changes: 27 additions & 7 deletions .api-reports/api-report-react.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ class ApolloClient<TCacheShape> implements DataProxy {
// (undocumented)
__requestRaw(payload: GraphQLRequest): Observable<FormattedExecutionResult>;
// Warning: (ae-forgotten-export) The symbol "Resolvers" needs to be exported by the entry point index.d.ts
//
// @deprecated
addResolvers(resolvers: Resolvers | Resolvers[]): void;
// Warning: (ae-forgotten-export) The symbol "ApolloCache" needs to be exported by the entry point index.d.ts
//
Expand All @@ -124,7 +126,7 @@ class ApolloClient<TCacheShape> implements DataProxy {
//
// (undocumented)
readonly devtoolsConfig: DevtoolsOptions;
// (undocumented)
// @deprecated (undocumented)
disableNetworkFetches: boolean;
// Warning: (ae-forgotten-export) The symbol "DocumentTransform" needs to be exported by the entry point index.d.ts
get documentTransform(): DocumentTransform;
Expand All @@ -133,16 +135,23 @@ class ApolloClient<TCacheShape> implements DataProxy {
getMemoryInternals?: typeof getApolloClientMemoryInternals;
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesInclude" needs to be exported by the entry point index.d.ts
getObservableQueries(include?: RefetchQueriesInclude): Map<string, ObservableQuery<any>>;
// @deprecated
getResolvers(): Resolvers;
// Warning: (ae-forgotten-export) The symbol "ApolloLink" needs to be exported by the entry point index.d.ts
//
// (undocumented)
link: ApolloLink;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
localState: LocalState<TCacheShape>;
// Warning: (ae-forgotten-export) The symbol "MutationOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "FetchResult" needs to be exported by the entry point index.d.ts
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = Context, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
onClearStore(cb: () => Promise<any>): () => void;
onResetStore(cb: () => Promise<any>): () => void;
get prioritizeCacheValues(): boolean;
set prioritizeCacheValues(value: boolean);
// Warning: (ae-forgotten-export) The symbol "QueryOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ApolloQueryResult" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "MaybeMasked" needs to be exported by the entry point index.d.ts
Expand All @@ -159,7 +168,10 @@ class ApolloClient<TCacheShape> implements DataProxy {
restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
setLink(newLink: ApolloLink): void;
// Warning: (ae-forgotten-export) The symbol "FragmentMatcher" needs to be exported by the entry point index.d.ts
//
// @deprecated
setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
// @deprecated
setResolvers(resolvers: Resolvers | Resolvers[]): void;
stop(): void;
// Warning: (ae-forgotten-export) The symbol "SubscriptionOptions" needs to be exported by the entry point index.d.ts
Expand All @@ -182,9 +194,14 @@ class ApolloClient<TCacheShape> implements DataProxy {
interface ApolloClientOptions<TCacheShape> {
assumeImmutableResults?: boolean;
cache: ApolloCache<TCacheShape>;
// (undocumented)
clientAwareness?: {
name?: string;
version?: string;
};
// @deprecated
connectToDevTools?: boolean;
// (undocumented)
// @deprecated (undocumented)
credentials?: string;
dataMasking?: boolean;
// (undocumented)
Expand All @@ -193,20 +210,25 @@ interface ApolloClientOptions<TCacheShape> {
devtools?: DevtoolsOptions;
// (undocumented)
documentTransform?: DocumentTransform;
// (undocumented)
// @deprecated (undocumented)
fragmentMatcher?: FragmentMatcher;
// @deprecated
headers?: Record<string, string>;
link?: ApolloLink;
// @deprecated
name?: string;
queryDeduplication?: boolean;
// (undocumented)
// @deprecated (undocumented)
resolvers?: Resolvers | Resolvers[];
ssrForceFetchDelay?: number;
ssrMode?: boolean;
// (undocumented)
// @deprecated (undocumented)
typeDefs?: string | string[] | DocumentNode | DocumentNode[];
// Warning: (ae-forgotten-export) The symbol "UriFunction" needs to be exported by the entry point index.d.ts
//
// @deprecated
uri?: string | UriFunction;
// @deprecated
version?: string;
}

Expand Down Expand Up @@ -1706,8 +1728,6 @@ class QueryManager<TStore> {
//
// (undocumented)
getDocumentInfo(document: DocumentNode): TransformCacheEntry;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getLocalState(): LocalState<TStore>;
// (undocumented)
Expand Down
34 changes: 27 additions & 7 deletions .api-reports/api-report-react_components.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ class ApolloClient<TCacheShape> implements DataProxy {
// (undocumented)
__requestRaw(payload: GraphQLRequest): Observable<FormattedExecutionResult>;
// Warning: (ae-forgotten-export) The symbol "Resolvers" needs to be exported by the entry point index.d.ts
//
// @deprecated
addResolvers(resolvers: Resolvers | Resolvers[]): void;
// Warning: (ae-forgotten-export) The symbol "ApolloCache" needs to be exported by the entry point index.d.ts
//
Expand All @@ -124,7 +126,7 @@ class ApolloClient<TCacheShape> implements DataProxy {
//
// (undocumented)
readonly devtoolsConfig: DevtoolsOptions;
// (undocumented)
// @deprecated (undocumented)
disableNetworkFetches: boolean;
// Warning: (ae-forgotten-export) The symbol "DocumentTransform" needs to be exported by the entry point index.d.ts
get documentTransform(): DocumentTransform;
Expand All @@ -133,17 +135,24 @@ class ApolloClient<TCacheShape> implements DataProxy {
getMemoryInternals?: typeof getApolloClientMemoryInternals;
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesInclude" needs to be exported by the entry point index.d.ts
getObservableQueries(include?: RefetchQueriesInclude): Map<string, ObservableQuery<any>>;
// @deprecated
getResolvers(): Resolvers;
// Warning: (ae-forgotten-export) The symbol "ApolloLink" needs to be exported by the entry point index.d.ts
//
// (undocumented)
link: ApolloLink;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
localState: LocalState<TCacheShape>;
// Warning: (ae-forgotten-export) The symbol "DefaultContext" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "MutationOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "FetchResult" needs to be exported by the entry point index.d.ts
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
onClearStore(cb: () => Promise<any>): () => void;
onResetStore(cb: () => Promise<any>): () => void;
get prioritizeCacheValues(): boolean;
set prioritizeCacheValues(value: boolean);
// Warning: (ae-forgotten-export) The symbol "QueryOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ApolloQueryResult" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "MaybeMasked" needs to be exported by the entry point index.d.ts
Expand All @@ -160,7 +169,10 @@ class ApolloClient<TCacheShape> implements DataProxy {
restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
setLink(newLink: ApolloLink): void;
// Warning: (ae-forgotten-export) The symbol "FragmentMatcher" needs to be exported by the entry point index.d.ts
//
// @deprecated
setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
// @deprecated
setResolvers(resolvers: Resolvers | Resolvers[]): void;
stop(): void;
// Warning: (ae-forgotten-export) The symbol "SubscriptionOptions" needs to be exported by the entry point index.d.ts
Expand All @@ -183,9 +195,14 @@ class ApolloClient<TCacheShape> implements DataProxy {
interface ApolloClientOptions<TCacheShape> {
assumeImmutableResults?: boolean;
cache: ApolloCache<TCacheShape>;
// (undocumented)
clientAwareness?: {
name?: string;
version?: string;
};
// @deprecated
connectToDevTools?: boolean;
// (undocumented)
// @deprecated (undocumented)
credentials?: string;
dataMasking?: boolean;
// (undocumented)
Expand All @@ -194,20 +211,25 @@ interface ApolloClientOptions<TCacheShape> {
devtools?: DevtoolsOptions;
// (undocumented)
documentTransform?: DocumentTransform;
// (undocumented)
// @deprecated (undocumented)
fragmentMatcher?: FragmentMatcher;
// @deprecated
headers?: Record<string, string>;
link?: ApolloLink;
// @deprecated
name?: string;
queryDeduplication?: boolean;
// (undocumented)
// @deprecated (undocumented)
resolvers?: Resolvers | Resolvers[];
ssrForceFetchDelay?: number;
ssrMode?: boolean;
// (undocumented)
// @deprecated (undocumented)
typeDefs?: string | string[] | DocumentNode | DocumentNode[];
// Warning: (ae-forgotten-export) The symbol "UriFunction" needs to be exported by the entry point index.d.ts
//
// @deprecated
uri?: string | UriFunction;
// @deprecated
version?: string;
}

Expand Down Expand Up @@ -1519,8 +1541,6 @@ class QueryManager<TStore> {
//
// (undocumented)
getDocumentInfo(document: DocumentNode): TransformCacheEntry;
// Warning: (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getLocalState(): LocalState<TStore>;
// (undocumented)
Expand Down
Loading