Handle changed suspense query options

[jerelmiller]

Closes #10680

In the current release of the library, changes to some options passed to useSuspenseQuery and useBackgroundQuery were not applied to the underlying ObservableQuery. For example, if someone wanted to change the errorPolicy between renders, the updated errorPolicy was not applied on the next fetch.

This PR now adds proper behavior when changing any option on these hooks. The following options have these behaviors:

• errorPolicy - Apply to the next fetch
• context - Apply to the next fetch
• canonizeResults - Immediately update data to use canonized results
• returnPartialData - Apply to the next fetch
• refetchWritePolicy - Apply to the next refetch
• fetchPolicy - Apply to the next fetch

Checklist:

• If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
• If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
• Make sure all of the significant new logic is covered by tests

[changeset-bot]

🦋 Changeset detected

Latest commit: 5fc6f03

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

This PR includes changesets to release 1 package

Name	Type
@apollo/client	Patch

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

[github-actions]

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	37.03 KB (+0.49% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	43.63 KB (+0.48% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	32.63 KB (+0.08% 🔺)
import { ApolloProvider } from "dist/react/index.js"	1.3 KB (0%)
import { useQuery } from "dist/react/index.js"	4.33 KB (0%)
import { useLazyQuery } from "dist/react/index.js"	4.65 KB (0%)
import { useMutation } from "dist/react/index.js"	2.56 KB (0%)
import { useSubscription } from "dist/react/index.js"	2.32 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	3.69 KB (-0.37% 🔽)
import { useBackgroundQuery } from "dist/react/index.js"	3.9 KB (+3.21% 🔺)
import { useReadQuery } from "dist/react/index.js"	2.64 KB (+6.46% 🔺)
import { useFragment } from "dist/react/index.js"	2.12 KB (0%)

[phryneas]

This would also trigger if the user manually sets a fetchPolicy of "standby" and changes away from that. Is this really the intended behaviour in that case?

[jerelmiller]

We have a validation in the hook that ensures users can't set standby directly:

apollo-client/src/react/hooks/useSuspenseQuery.ts

Lines 265 to 280 in e47cfd0

	function validateFetchPolicy(
	fetchPolicy: WatchQueryFetchPolicy = 'cache-first'
	) {
	const supportedFetchPolicies: WatchQueryFetchPolicy[] = [
	'cache-first',
	'network-only',
	'no-cache',
	'cache-and-network',
	];
	invariant(
	supportedFetchPolicies.includes(fetchPolicy),
	`The fetch policy \`%s\` is not supported with suspense.`,
	fetchPolicy
	);
	}

Agreed though its not super apparent looking at this directly (which means we have an implicit dependency here). But even if we let that be the case (something I've considered), I would agree this should still the same behavior. "standby" is like a "wait to fetch" fetch policy, so we'd want to execute a request as soon as the user switches away from it. In this way, standby is like skip: true (which is exactly how skip is implemented!).

[phryneas]

LGTM!