Prevent canceled @stream tasks from breaking subsequent @stream query #5712
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.
This fix largely prevents canceled
@stream
tasks from breaking subsequent@stream
queries.When a query containing deferred
@stream
is canceled (e.g. due to http connection closing),DeferResultStream.GetAsyncEnumerator()
disposes the work state owner, invokingDeferredWorkState.Reset()
, before the tasks waiting for items from async enumerators being@stream
'ed are canceled. When these tasks are canceled, they addIQueryResults
withError
s set toOperationCanceledException
to the freshly resetDeferredWorkState
. The next query which rents thisDeferredWorkState
picks up these stale results and quits inDeferredWorkState.TryDequeueResultsAsync()
after sending its initial result, so that the client invoking the query receives an empty result withhasNext:false
and no@stream
items.ETA: this change doesn't fix the problem completely, but it does reduce the window of the underlying race condition very substantially. Instead of every other subscription being truncated as described above, I now observe truncation rarely and sporadically.