👷 Deploy request forapollo-client-docs pending review.

Visit the deploys page to approve it

🦋 Changeset detected

Latest commit:13dc2f6

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

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branchrelease-3.13 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

• !docs set-base-branch version-2.6
• !docs set-base-branch main

Build ID: cf5f6b966b3da7413a0e7f8e

@Cellule we want to keep theignoreResults inuseSubscription as that one makes a lot more sense. That hook has a much higher likelyhood that it may update very often if subscription events come in very quickly. In this case, sometimes you don't want/need the rerender behavior, especially if you're using those subscriptions to do something like logging. In that case, you may prefer to use the callbacks.

That option was added touseSubscription in3.11 via#11921.#10216 provides some great context on what problem that change solved if you're curious on learning more (be sure to check out the linked articles in the issue.)

@Cellule we want to keep theignoreResults inuseSubscription as that one makes a lot more sense. That hook has a much higher likelyhood that it may update very often if subscription events come in very quickly. In this case, sometimes you don't want/need the rerender behavior, especially if you're using those subscriptions to do something like logging. In that case, you may prefer to use the callbacks.

That option was added touseSubscription in3.11 via#11921.#10216 provides some great context on what problem that change solved if you're curious on learning more (be sure to check out the linked articles in the issue.)

Thanks for the details! It does make a lot of sense.
We're slowly starting to migrate away fromsubscribeToMore in favor ofuseSubscription. The query update mechanism is not as easy/clean, but it works great
I'll definitely look intoignoreResults inuseSubscription

Oops, I repointed this branch to our 3.13 release before I merged the latest frommain into that one. Do you mind rebasing this against therelease-3.13 branch?

As foruseSubscription, I also want to give another angle: it makes sense as a hook, even with the option.

What do I mean by that?

Hooks are mostly defined by the fact that they call a React hook. That means they need to do one of the following:

1. dependency injection - access context
2. synchronize with the lifecycle of a component (mount, unmount etc) - useEffect etc.
3. inject something happen outside the component (user interaction, subscriptions) into the component - useState

useMutation withoutignoreResults does 1. and 3. - but as soon as you addignoreResults, 3. goes away and you're left with 1.useApolloClient does that already. There's no need foruseMutation in that case anymore.

useSubscription withoutignoreResults does 1., 2., and 3., - and as soon as you addignoreResults, 3. goes away, but 1. and 2. stays

useSubscription withignoreResults is still useful because it synchronizes an external system with the component lifecyclye: once the component mounts, the subscription starts - when it unmounts, it unsubscribes. You can't do that without a hook and also not with one of the other hooks we provide.

useSubscription withignoreResults is still useful because it synchronizes an external system with the component lifecyclye: once the component mounts, the subscription starts - when it unmounts, it unsubscribes. You can't do that without a hook and also not with one of the other hooks we provide.

Really good explanation of the difference between both use cases!