Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TaskEx: AwaitTaskCorrect / Task.toAsync / Async.ofTask #141

Open
bartelink opened this issue Jan 5, 2023 · 0 comments
Open

TaskEx: AwaitTaskCorrect / Task.toAsync / Async.ofTask #141

bartelink opened this issue Jan 5, 2023 · 0 comments
Labels
feature request New feature or enhancement request topic: task-ex Related to the proposed new TaskEx library, which should get its own oss haven
Milestone

Comments

@bartelink
Copy link
Member

bartelink commented Jan 5, 2023

Replaces #129. TaskEx top level issue: #139

The default implementation of the Async.AwaitTask methods in FSharp.Core have some key shortcomings:

  1. when the Task faults, yielding an exception, that exception is typically (always?) wrapped in an egregious AggregateException
  2. the default implementation does not abort/cancel when the ambient CancellationToken of the async expr within which Async.AwaitTask is triggered
  3. cancelling an Async computation should not just abort the processing, it should also propagate a TaskCancelledException to align with the behavior of Task

While it can be argued that the current behavior is 'wrong', it's also obvious that breaking it would be untenable, and the semantic differences are beyond what one might cover with subtle overloads and/or adding optional arguments etc.

Current proposed APIs (will be updated inline based on any discussion below):

module Async =
    let inline ofTask (t : Task<'t>) : Async<'t> = AwaitTaskCorrect t
    let inline ofUnitTask (t : Task) : Async<'t> = AwaitTaskCorrect t
module Task =
    let inline toAsync (t : Task<'t>) : Async<'t> = Async.ofTask t

NOTES:

  • the above naming is taken from the helpers within TaskSeq, which are exposed in the FSharp.Control namespace. NOTE the current implementations use Async.AwaitTask, but that was not as a conscious choice, and there is a desire` to fix at least some of the shortcomings noted
  • given the fact that task and async are now first class citizens of FSharp.Core, having an of/to pairing would seem to make sense. This is open to debate; not sure the degree to which the prior art is consistent wrt this beyond collection types/modules
  • There is an fslang-suggestion regarding this. The purpose of this issue is as a placeholder for potentially filling the gap until this issue can be more thoroughly resolved in FSharp.Core proper.
  • Equinox, Propulsion and FSharp.AWS.DynamoDB all have copies of the canonical impl in Eirik's fssnip. Not ruling out tweaks to the semantics, but ideally those libraries, and others, would all share the same semantics
  • if this is handled as a module, one also frequently needs an ofUnitTask alongside as above (Async.AwaitTask is a pair of overloaded methods, which often brings its own issues with intellisense and error messages etc)
This was referenced Jan 5, 2023
@bartelink bartelink changed the title TaskShims: AwaitTaskCorrect / Task.toAsync / Async.ofTask TaskEx: AwaitTaskCorrect / Task.toAsync / Async.ofTask Jan 10, 2023
@abelbraaksma abelbraaksma added feature request New feature or enhancement request topic: task-ex Related to the proposed new TaskEx library, which should get its own oss haven labels Oct 29, 2023
@abelbraaksma abelbraaksma added this to the vFuture milestone Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or enhancement request topic: task-ex Related to the proposed new TaskEx library, which should get its own oss haven
Projects
None yet
Development

No branches or pull requests

2 participants