Update persisted query link error handling to match the rest of the client #12704

jerelmiller · 2025-06-17T00:51:52Z

Updates createPersistedQueryLink to combine graphQLErrors and networkError properties into a single error property to match the rest of the client. error is of type ErrorLike.

The response property has also been removed in favor of accessing data from the CombinedGraphQLErrors instance.

changeset-bot · 2025-06-17T00:51:56Z

🦋 Changeset detected

Latest commit: e5b8e87

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

pkg-pr-new · 2025-06-17T00:53:32Z

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@12704

commit: e5b8e87

github-actions · 2025-06-17T00:53:52Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.52 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.67 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.52 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	26.95 KB (0%)
import { ApolloProvider } from "@apollo/client/react"	5.68 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	963 B (0%)
import { useQuery } from "@apollo/client/react"	7.51 KB (0%)
import { useQuery } from "@apollo/client/react" (production)	2.73 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	6.94 KB (0%)
import { useLazyQuery } from "@apollo/client/react" (production)	2.2 KB (0%)
import { useMutation } from "@apollo/client/react"	6.52 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	1.76 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.62 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	1.86 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.48 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.75 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.22 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.51 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.52 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.82 KB (0%)
import { useReadQuery } from "@apollo/client/react"	6.43 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.68 KB (0%)
import { useFragment } from "@apollo/client/react"	6.47 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.74 KB (0%)

jerelmiller · 2025-06-17T00:54:07Z

.changeset/sharp-glasses-sneeze.md

+});
+```
+
+The `response` property has also been removed. To access partial data returned in GraphQL responses, access the `data` property on the `CombinedGraphQLErrors` instance.


I think it makes sense to remove this, but one thing we did lose in this process is access to extensions since CombinedGraphQLErrors doesn't have an extensions property. Is that something we want to add? Seems more relevant here especially since persisted queries does a lot with extensions.

Yeah, it sounds like a good idea to add that to CombinedGraphQLErrors!

jerelmiller · 2025-06-17T00:54:43Z

src/link/persisted-queries/__tests__/persisted-queries.test.ts

@@ -789,3 +796,693 @@ describe("failure path", () => {
    });
  });
 });
+
+test("disables persisted queries from future requests when `disable` returns true", async () => {


We didn't test disable or retry at all 😱

jerelmiller · 2025-06-17T00:56:02Z

src/link/persisted-queries/index.ts


-            const graphQLErrors: GraphQLFormattedError[] = [];
+        function handleRetry(errorResponse: ErrorResponse, cb: () => void) {


The diff is a bit horrendous, but if you want to look at the refactor to see how I got here, check out the diff commit-by-commit.

jerelmiller · 2025-06-17T14:32:39Z

src/link/persisted-queries/index.ts

@@ -24,9 +29,7 @@ import { defaultCacheSizes } from "../../utilities/caching/sizes.js";
 export const VERSION = 1;

 export interface ErrorResponse {
-  graphQLErrors?: ReadonlyArray<GraphQLFormattedError>;
-  networkError?: Error | ServerParseError | ServerError | null;
-  response?: FormattedExecutionResult;


Response seems to also be available in onError link so we should probably keep this around.

Keep this. Rename it to result. Rename the interface and have both a RetryFunctionOptions and DisableFunctionOptions that point to the same type.

phryneas · 2025-06-17T18:24:21Z

.changeset/sharp-glasses-sneeze.md

+
+-   if (errorResponse.networkError) {
+   if (errorResponse.error) {
+      // ... handle a NetworkError errors


Suggested change

// ... handle a NetworkError errors

// ... handle NetworkError-type errors

not sure if this is strictly better, but the a was irritiating me,.

phryneas · 2025-06-17T18:25:18Z

.changeset/sharp-glasses-sneeze.md

+});
+```
+
+The `response` property has also been removed. To access partial data returned in GraphQL responses, access the `data` property on the `CombinedGraphQLErrors` instance.


Yeah, it sounds like a good idea to add that to CombinedGraphQLErrors!

phryneas · 2025-06-17T18:26:55Z

.changeset/sharp-glasses-sneeze.md

+  disable: (errorResponse) => {
+-   if (errorResponse.response) {
+-     const data = errorResponse.response.data;
+   if (CombinedGraphQLErrors.is(errorResponse.error)) {


Maybe we should rename errorResponse and the ErrorResponse type here? errorResponse.error is seriously weird. Otoh., errorResponse.response wasn't strictly better previously.
Just as food for thought: What about disablePayload or even just payload?

Maybe we should just destructure in these examples? 🤔

Good call! I did a bunch of updates in 0ed0931 to give better examples and use destructuring.

And I agree, I'm not a huge fan of ErrorResponse, but it does match what we have in onError link. the only thing about something like disablePayload is that this object is also passed to retry.

phryneas

Generally approved, but needs the incremental error handling like the error link.

phryneas · 2025-06-18T13:03:24Z

src/link/persisted-queries/index.ts

+                error: new CombinedGraphQLErrors(response),
+                meta: processErrors(response.errors),


I added a better way to handle incremental stuff here - take a look at

apollo-client/src/link/error/index.ts

Lines 47 to 51 in 61cfe94

const handler = operation.client["queryManager"].incrementalHandler;

const errors =

handler?.isIncrementalResult(result) ?

handler.extractErrors(result)

: (result as FormattedExecutionResult).errors;

src/link/persisted-queries/index.ts

phryneas · 2025-06-18T13:43:14Z

src/link/persisted-queries/__tests__/persisted-queries.test.ts

+  });
+});
+
+test("calls `retry` with GraphQL errors when parsed from non-2xx response", async () => {


I'm thinking here... do we want to do that kind of parsing or go the "GraphQL over Http" route and only do this with the right mime-type (in which case we don't need any extra logic)?

Let's leave this for now until servers catch up with the GraphQL over HTTP spec.

…arate error properties

…orResponse

jerelmiller requested a review from phryneas June 17, 2025 00:51

jerelmiller commented Jun 17, 2025

View reviewed changes

jerelmiller linked an issue Jun 17, 2025 that may be closed by this pull request

[4.0] Update PersistedQueryLink to work with new error structure #12569

Closed

jerelmiller commented Jun 17, 2025

View reviewed changes

phryneas reviewed Jun 17, 2025

View reviewed changes

jerelmiller mentioned this pull request Jun 17, 2025

pluggable incremental handlers #12700

Merged

jerelmiller force-pushed the jerel/persisted-query-link-error branch from 00e32f0 to 0ed0931 Compare June 18, 2025 03:10

jerelmiller mentioned this pull request Jun 18, 2025

Add extensions to CombinedGraphQLErrors #12711

Merged

phryneas approved these changes Jun 18, 2025

View reviewed changes

github-actions bot added the auto-cleanup 🤖 label Jun 18, 2025

jerelmiller added 15 commits June 18, 2025 10:58

Use actual link name in tests

95e64f0

Update test to use ObservableStream

5b5f00b

Update test to ObservableStream

c92a326

Add tests for disable

2e7e9ff

Add tests for retry function

3210854

Add test to ensure retry only happens once

d58f40f

Use early return

74e447f

Use optional chaining

380cd4f

Rename supportsPersistedQueries to enabled

4cb5949

Rename disablePayload to errorResponse

1127291

Make networkError arg to maybeRetry an ErrorLike

4fe86d2

Remove unneeded non-null assertion

04eaa15

Split out networkError handling from persisted query function

91e67ac

Take response as first arg instead of object

d8cb98c

Remove unneeded optional chaining

ec8acee

jerelmiller added 5 commits June 18, 2025 10:58

Add error to ErrorResponse for disable/retry callbacks and remove sep…

006fd03

…arate error properties

Remove response property from ErrorResponse

8054d4e

Rerun api report

89a3a4b

Add changeset

173f1dd

Update changeset

e1f553e

jerelmiller force-pushed the jerel/persisted-query-link-error branch from 0ed0931 to e1f553e Compare June 18, 2025 16:59

jerelmiller and others added 20 commits June 18, 2025 10:59

Remove unneeded type annotation

6efca09

Add additional types for retry and disable function. Don't export Err…

67718fb

…orResponse

Fix observer.next not called when result is an incremental result

1d62240

Add back result property to retry/disable

37ccea1

Ensure raw error is passed along

52e72da

Rename for clarity

19e8c1a

Include result if parsed from server error

7b66b6a

Update changeset

3640ee8

Clean up Prettier, Size-limit, and Api-Extractor

c2b248b

Rename response to result in onError link. Rename type

80caa4a

Rename argument

9bde128

Rename argument

0af08d2

Add changeset

7f2a820

Formatting

aa80ddb

Clean up Prettier, Size-limit, and Api-Extractor

8273807

Run prettify on the type

966ee94

Clean up Prettier, Size-limit, and Api-Extractor

0847d4b

Remove unneeded type cast in test

17f8194

Fix link/error tests

cef261f

Remove unused import

e5b8e87

jerelmiller merged commit 45dba43 into release-4.0 Jun 18, 2025
41 of 42 checks passed

jerelmiller deleted the jerel/persisted-query-link-error branch June 18, 2025 17:44

jerelmiller mentioned this pull request Jun 18, 2025

[4.0] Update PersistedQueryLink to work with new error structure #12569

Closed

github-actions bot mentioned this pull request Jun 18, 2025

Version Packages (alpha) #12710

Merged


		const graphQLErrors: GraphQLFormattedError[] = [];
		function handleRetry(errorResponse: ErrorResponse, cb: () => void) {

	// ... handle a NetworkError errors
	// ... handle NetworkError-type errors

		error: new CombinedGraphQLErrors(response),
		meta: processErrors(response.errors),

	const handler = operation.client["queryManager"].incrementalHandler;
	const errors =
	handler?.isIncrementalResult(result) ?
	handler.extractErrors(result)
	: (result as FormattedExecutionResult).errors;

Update persisted query link error handling to match the rest of the client #12704

Update persisted query link error handling to match the rest of the client #12704

Conversation

jerelmiller commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

pkg-pr-new bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phryneas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jerelmiller commented Jun 17, 2025 •

edited

Loading

changeset-bot bot commented Jun 17, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 17, 2025 •

edited

Loading

github-actions bot commented Jun 17, 2025 •

edited

Loading