Skip to content
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

deprecate use(Lazy)Query on(Error|Completed) callbacks #12340

Merged
merged 17 commits into from
Feb 7, 2025
+50 −4
Merged

deprecate use(Lazy)Query on(Error|Completed) callbacks #12340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
efc90d8
deprecate `use(Lazy)Query` `on(Error|Completed)` callbacks
phryneas Feb 5, 2025
70c634a
changeset
phryneas Feb 5, 2025
59bb8be
Apply suggestions from code review
phryneas Feb 6, 2025
8d0a397
Update src/react/types/deprecation.md
phryneas Feb 6, 2025
1210f21
Apply suggestions from code review
phryneas Feb 6, 2025
9365f71
Update src/react/types/deprecation.md
phryneas Feb 6, 2025
5ffcdcb
Update src/react/types/deprecation.md
phryneas Feb 6, 2025
19d86ff
Slight tweaks to changes around behavior section
jerelmiller Feb 6, 2025
bce9951
Slight tweak to defer section
jerelmiller Feb 6, 2025
dbd139a
Add section on our recommendation
jerelmiller Feb 6, 2025
11b1103
Update section for bugs
jerelmiller Feb 6, 2025
0fee891
Minor tweak to solutions section
jerelmiller Feb 6, 2025
9f40f2e
Mention switch in behavior
jerelmiller Feb 6, 2025
bb699e8
Slight tweak to end
jerelmiller Feb 6, 2025
0635892
remove draft file, add links to issue
phryneas Feb 7, 2025
48ac146
api-extractor
phryneas Feb 7, 2025
5bea158
Merge branch 'release-3.13' into pr/deprecate-useQuery-callbacks
phryneas Feb 7, 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
4 changes: 4 additions & 0 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 @@ -1048,7 +1048,9 @@ export interface LazyQueryHookExecOptions<TData = any, TVariables extends Operat
export interface LazyQueryHookOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
}

Expand Down Expand Up @@ -1596,7 +1598,9 @@ export interface QueryDataOptions<TData = any, TVariables extends OperationVaria
export interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
2 changes: 2 additions & 0 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 @@ -1419,7 +1419,9 @@ export interface QueryComponentOptions<TData = any, TVariables extends Operation
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
2 changes: 2 additions & 0 deletions .api-reports/api-report-react_context.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,9 @@ interface QueryDataOptions<TData = any, TVariables extends OperationVariables =
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
4 changes: 4 additions & 0 deletions .api-reports/api-report-react_hooks.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,7 +997,9 @@ interface LazyQueryHookExecOptions<TData = any, TVariables extends OperationVari
interface LazyQueryHookOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
}

Expand Down Expand Up @@ -1469,7 +1471,9 @@ const QUERY_REF_BRAND: unique symbol;
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
2 changes: 2 additions & 0 deletions .api-reports/api-report-react_internal.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1566,7 +1566,9 @@ const QUERY_REFERENCE_SYMBOL: unique symbol;
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
2 changes: 2 additions & 0 deletions .api-reports/api-report-react_ssr.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1331,7 +1331,9 @@ interface QueryDataOptions<TData = any, TVariables extends OperationVariables =
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
4 changes: 4 additions & 0 deletions .api-reports/api-report.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1465,7 +1465,9 @@ export interface LazyQueryHookExecOptions<TData = any, TVariables extends Operat
export interface LazyQueryHookOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
}

Expand Down Expand Up @@ -2180,7 +2182,9 @@ export interface QueryDataOptions<TData = any, TVariables extends OperationVaria
export interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables, TData> {
// @internal (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// @deprecated
onCompleted?: (data: MaybeMasked<TData>) => void;
// @deprecated
onError?: (error: ApolloError) => void;
skip?: boolean;
}
Expand Down
6 changes: 6 additions & 0 deletions .changeset/heavy-pumas-boil.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@apollo/client": minor
---

Deprecate the `onCompleted` and `onError` callbacks of `useQuery` and `useLazyQuery`.
For more context, please see the [related issue](https://github.com/apollographql/apollo-client/issues/12352) on GitHub.
28 changes: 24 additions & 4 deletions src/react/types/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,19 @@ export interface QueryFunctionOptions<
> extends BaseQueryOptions<TVariables, TData> {
/** {@inheritDoc @apollo/client!QueryOptionsDocumentation#skip:member} */
skip?: boolean;
/** {@inheritDoc @apollo/client!QueryOptionsDocumentation#onCompleted:member} */
/**
* {@inheritDoc @apollo/client!QueryOptionsDocumentation#onCompleted:member}
*
* @deprecated This option will be removed in the next major version of Apollo Client.
* For more context, please see the [related issue](https://github.com/apollographql/apollo-client/issues/12352) on GitHub.
*/
onCompleted?: (data: MaybeMasked<TData>) => void;
/** {@inheritDoc @apollo/client!QueryOptionsDocumentation#onError:member} */
/**
* {@inheritDoc @apollo/client!QueryOptionsDocumentation#onError:member}
*
* @deprecated This option will be removed in the next major version of Apollo Client.
* For more context, please see the [related issue](https://github.com/apollographql/apollo-client/issues/12352) on GitHub.
*/
onError?: (error: ApolloError) => void;

// Default WatchQueryOptions for this useQuery, providing initial values for
Expand Down Expand Up @@ -167,9 +177,19 @@ export interface LazyQueryHookOptions<
TData = any,
TVariables extends OperationVariables = OperationVariables,
> extends BaseQueryOptions<TVariables, TData> {
/** {@inheritDoc @apollo/client!QueryOptionsDocumentation#onCompleted:member} */
/**
* {@inheritDoc @apollo/client!QueryOptionsDocumentation#onCompleted:member}
*
* @deprecated This option will be removed in the next major version of Apollo Client.
* For more context, please see the [related issue](https://github.com/apollographql/apollo-client/issues/12352) on GitHub.
*/
onCompleted?: (data: MaybeMasked<TData>) => void;
/** {@inheritDoc @apollo/client!QueryOptionsDocumentation#onError:member} */
/**
* {@inheritDoc @apollo/client!QueryOptionsDocumentation#onError:member}
*
* @deprecated This option will be removed in the next major version of Apollo Client.
* For more context, please see the [related issue](https://github.com/apollographql/apollo-client/issues/12352) on GitHub.
*/
onError?: (error: ApolloError) => void;

/** @internal */
Expand Down