Batch link can cancel operations that are in queue or in flight #9248
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PowerKiKi
added a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Dec 28, 2021
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
3 tasks
After an operation has been subscribed to, and so queued, it is possible to unsubscribe from it, and it will be removed from the queue. Unsubscribing will not impact the debounce, so other operations, if any, will not be delayed by an unsubscription. If a batch of operation is already in flight, and all operations are unsubscribed then the entire XHR will be cancelled. If only some operations are unsubscribed the XHR will be left untouched.
Since BatchHandler is an exported type, it seems appropriate to preserve its optional fields (with their expected types), then override those fields (next, error, complete) with non-optional versions in the QueuedRequest subtype. The field/types of QueuedRequest will end up the same either way.
Since ECMAScript Set and Map preserve the order of their keys (by order of first insertion), they can often be used to keep track of queues or LRU usage chains, while also supporting constant-time deletion of keys (no need for indexOf/splice).
Since we're already changing the type of this pseudo-private property, it seems like a good idea also to privatize/rename it for real, so we can test the hypothesis "nobody is using this field directly" by trialing these changes in beta releases of Apollo Client v3.6.
benjamn
approved these changes
Jan 12, 2022
There was a problem hiding this comment.
Thanks for implementing this functionality and adding tests @PowerKiKi!
I started making a few tweaks and got perhaps a little carried away (not everything I changed is in direct response to your code, just general cleanup). That said, please let me know if anything I added doesn't look right to you. Otherwise I'll merge this into release-3.6 and publish another beta release soon (this week) so you can try it out.
benjamn
reviewed
Jan 12, 2022
benjamn
added
2022-01
⏮ compatibility
PowerKiKi
commented
Jan 14, 2022
Closed
sztadii
reviewed
Jan 18, 2022
sztadii
reviewed
Jan 18, 2022
sztadii
approved these changes
Jan 18, 2022
Because those are never used inside this project, and they are very likely to break our indices based callback calls and throw an `server returned results with length...`.
|
I did a new series of (small) commits. IMHO it address all things we said until now, and it could be final reviewed/merged. |
kamilkisiela
pushed a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Feb 16, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
PowerKiKi
added a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Apr 28, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
benjamn
added a commit
that referenced
this pull request
Jun 7, 2022
…cel" This reverts commit cefd24c, reversing changes made to d98f1de. I plan to publish this version in the next v3.7.0 beta release, then immediately reinstate most of this functionality, with a narrower attempt to solve issue #9773 in a follow-up beta release, to allow folks to compare the behavior of those two versions.
This was referenced Jun 7, 2022
PowerKiKi
added a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Sep 6, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
PowerKiKi
added a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Oct 13, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
PowerKiKi
added a commit
to PowerKiKi/apollo-angular
that referenced
this pull request
Oct 13, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled.
kamilkisiela
added a commit
to kamilkisiela/apollo-angular
that referenced
this pull request
Oct 24, 2022
This is dependent on apollographql/apollo-client#9248, so it is not strictly specific to `apollo-angular`, but it seemed important to ensure that this package does indeed allow to cancel XHR even when batching is enabled. Co-authored-by: Kamil Kisiela <kamil.kisiela@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After an operation has been subscribed to, and so queued, it is possible
to unsubscribe from it, and it will be removed from the queue.
Unsubscribing will not impact the debounce, so other operations, if any, will
not be delayed by an unsubscription.
If a batch of operation is already in flight, and all operations are unsubscribed
then the entire XHR will be cancelled. If only some operations are unsubscribed
the XHR will be left untouched.
Checklist: