fix(AsyncOperation): cancel() and isCancelled behavior #801
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
Without setting the result the completion handler will never be called, but users of the API should expect a callback with a cancellation error as failure result.
VladislavFitz
suggested changes
Jun 22, 2023
There was a problem hiding this comment.
Hi @KaiOelfke ,
Thank you for your contribution and sorry for delay.
Just remove the commented code and it's all good 👍
# Conflicts: # .github/workflows/carthage.yml # .github/workflows/pods.yml
VladislavFitz
changed the title
VladislavFitz
approved these changes
Aug 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The operations returned by the SDK didn't behave as I expected regarding cancellation. I am by no means an expert on the intricacies of (NS)Operation.
AsyncOperation doesn't override isCancelled and doesn't call super.cancel() so isCancelled never becomes true as far as I understand. But there's checks for isCancelled in HTTPRequest and AsyncOperation.start().
I added some unit tests with AsyncOperation and a BlockOperation to see the standard behavior.
To pass the tests I came up with two possible solutions. Either remove the cancel override so that the super implementation of Operation is used or override and manage isCancelled.
Result
With these changes cancellation works as I'd expect. The behavior differs also as the state is not immediately set to finished anymore. Either the operation didn't yet start and will be set to finished once start() is called or the operation is already executing. For the second case it's up to the subclass to optionally handle cancellation and to set the state to finished.
I also added a line in the HTTPRequest isCancelled guard to set the result variable to a cancellation error. So that the completion block gets also called once for an operation that's cancelled early before the URL task is created.