typelevel / typelevel/cats-effect
unsafeToFutureCancelable's cancel future completes before setting the result future's cancellation status
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
The following fails fairly quickly:
while (true) {
val (future, cancel) = IO.never.unsafeToFutureCancelable()
Await.result(cancel(), Duration.Inf)
assert(future.isCompleted)
}
I believe future actually has finished it's work, as the following doesn't fail:
while (true) {
@volatile var started = false
@volatile var done = false
val io = IO { started = true }.bracket(_ => IO.never)(_ => IO { done = true })
val (_, cancel) = io.unsafeToFutureCancelable()
while (!started) {}
Await.result(cancel(), Duration.Inf)
assert(done)
}
This was mostly confusing in unit tests that were nondeterministic as they tested that the cancellation worked. I think it'd be more intuitive if the future's cancellation status was set before cancel completes, but maybe there's something else unintuitive that would result from that that I'm not considering.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the two cancellation loops from the issue and inspect the unsafeToFutureCancelable entry point and its cancellation completion ordering. Compare when cancel() completes with when future.isCompleted becomes true; done should make the cancellation status observable before cancel() completes without breaking the demonstrated finalizer behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100