gracefully cancel a request #256
Merged
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
Adds a way to gracefully cancel an ongoing request. The `request` method accepts an additional `interrupt` keyword which can be a `Base.Event`. When it is triggered, the [`curl_multi_remove_handle`](https://curl.se/libcurl/c/curl_multi_remove_handle.html) is invoked, which interrupts the easy handle gracefully. It closes the `output` and `progress` channels of the `Easy` handle to unblock the waiting request task, which then terminates with a `RequestError`. Ref: JuliaLang#255
This was referenced Aug 27, 2024
|
Requesting some 👀 on this... |
topolarity
reviewed
Sep 3, 2024
| else | ||
| lock(multi.lock) do | ||
| check_multi_info(multi) | ||
| end |
There was a problem hiding this comment.
Yes. When the easy handle is removed this callback is invoked with CURL_POLL_REMOVE. If I recollect, calling check_multi_info was required to clean up and unblock the request method that's blocking on some of the channels.
topolarity
reviewed
Sep 3, 2024
topolarity
reviewed
Sep 3, 2024
|
@IanButterworth can we use this in Pkg downloads to not get all the curl errors if a user ctrl C during e.g. package downloading? |
|
I'm not sure we can stop the curl async processes from receiving interrupts? |
|
I think we'd need JuliaLang/julia#49541 to intercept it and then call this cancel? |
tanmaykm
added a commit
to tanmaykm/Downloads.jl
that referenced
this pull request
Sep 4, 2024
Cancelling an upload (PUT) request using the mechanism introduced in JuliaLang#256 was not effective. The upload task was not interrupted, which still blocks and the call to `request` does not return. With this change, cancelling also closes the `input` stream of the request to unblock the upload task. Also changed the `interrupted` variable to be an `Atomic{Bool}`. Ref discussion [here](JuliaLang#256 (comment)).
tanmaykm
added a commit
to tanmaykm/Downloads.jl
that referenced
this pull request
Sep 4, 2024
Cancelling an upload (PUT) request using the mechanism introduced in JuliaLang#256 was not effective. The upload task was not interrupted, which still blocked and the call to `request` did not return. With this change, cancelling also closes the `input` stream of the request to unblock the upload task. Also changed the `interrupted` variable to be an `Atomic{Bool}`. Ref discussion [here](JuliaLang#256 (comment)).
tanmaykm
added a commit
to tanmaykm/Downloads.jl
that referenced
this pull request
Sep 5, 2024
Cancelling an upload (PUT) request using the mechanism introduced in JuliaLang#256 was not effective. The upload task was not interrupted, which still blocked and the call to `request` did not return. With this change, cancelling also closes the `input` stream of the request to unblock the upload task. Also changed the `interrupted` variable to be an `Atomic{Bool}`. Ref discussion [here](JuliaLang#256 (comment)).
KristofferC
pushed a commit
that referenced
this pull request
Sep 9, 2024
Cancelling an upload (PUT) request using the mechanism introduced in #256 was not effective. The upload task was not interrupted, which still blocked and the call to `request` did not return. With this change, cancelling also closes the `input` stream of the request to unblock the upload task. Also changed the `interrupted` variable to be an `Atomic{Bool}`. Ref discussion [here](#256 (comment)).
tanmaykm
added a commit
to JuliaComputing/OpenAPI.jl
that referenced
this pull request
Sep 24, 2024
Detect if we are using a newer version of Download.jl that supports interrupting of requests natively and use that instead of throwing `InterruptException`. ref: JuliaLang/Downloads.jl#256 and JuliaLang/Downloads.jl#259 fixes: #81
tanmaykm
added a commit
to JuliaComputing/OpenAPI.jl
that referenced
this pull request
Sep 24, 2024
Detect if we are using a newer version of Download.jl that supports interrupting of requests natively and use that instead of throwing `InterruptException`. ref: JuliaLang/Downloads.jl#256 and JuliaLang/Downloads.jl#259 fixes: #81
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.
Adds a way to gracefully cancel an ongoing request. The
requestmethod accepts an additionalinterruptkeyword which can be aBase.Event. When it is triggered, thecurl_multi_remove_handleis invoked, which interrupts the easy handle gracefully. It closes theoutputandprogresschannels of theEasyhandle to unblock the waiting request task, which then terminates with aRequestError.Ref: #255