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.

Sign up for GitHub

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

Fix Disposes not happening on cancellation #50

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Fix Disposes not happening on cancellation #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 92 additions & 1 deletion src/IcedTasks/CancellableTaskBuilderBase.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,95 @@ module CancellableTaskBase =
sm.ResumptionDynamicInfo.ResumptionFunc <- cont
false


/// <summary>
/// The entry point for the dynamic implementation of the corresponding operation. Do not use directly, only used when executing quotations that involve tasks or other reflective execution of F# code.
/// </summary>
[<NoEagerConstraintApplication>]
static member inline internal BindDynamicNoCancellation
(
sm:
byref<ResumableStateMachine<CancellableTaskBaseStateMachineData<'TOverall, 'Builder>>>,
awaiter: 'Awaiter,
continuation:
('TResult1 -> CancellableTaskBaseCode<'TOverall, 'TResult2, 'Builder>)
) : bool =
let mutable awaiter = awaiter

let cont =
(CancellableTaskBaseResumptionFunc<'TOverall, 'Builder>(fun sm ->
let result = Awaiter.GetResult awaiter
(continuation result).Invoke(&sm)
))

// shortcut to continue immediately
if Awaiter.IsCompleted awaiter then
cont.Invoke(&sm)
else
sm.ResumptionDynamicInfo.ResumptionData <-
(awaiter :> ICriticalNotifyCompletion)

sm.ResumptionDynamicInfo.ResumptionFunc <- cont
false


/// <summary>Creates A CancellableTask that runs computation, and when
/// computation generates a result T, runs binder res.</summary>
///
/// <remarks>A cancellation check is performed when the computation is executed.
///
/// The existence of this method permits the use of let! in the
/// cancellableTask { ... } computation expression syntax.</remarks>
///
/// <param name="getAwaiter">The computation to provide an unbound result.</param>
/// <param name="continuation">The function to bind the result of computation.</param>
///
/// <returns>A CancellableTask that performs a monadic bind on the result
/// of computation.</returns>
[<NoEagerConstraintApplication>]
member inline internal _.BindNoCancellation
(
awaiter: 'Awaiter,
continuation:
('TResult1 -> CancellableTaskBaseCode<'TOverall, 'TResult2, 'Builder>)
) : CancellableTaskBaseCode<'TOverall, 'TResult2, 'Builder> =

CancellableTaskBaseCode<'TOverall, 'TResult2, 'Builder>(fun sm ->
if __useResumableCode then
//-- RESUMABLE CODE START
// Get an awaiter from the Awaiter
let mutable awaiter = awaiter

let mutable __stack_fin = true

if not (Awaiter.IsCompleted awaiter) then
// This will yield with __stack_yield_fin = false
// This will resume with __stack_yield_fin = true
let __stack_yield_fin = ResumableCode.Yield().Invoke(&sm)
__stack_fin <- __stack_yield_fin

if __stack_fin then
let result = Awaiter.GetResult awaiter
(continuation result).Invoke(&sm)
else
let mutable awaiter = awaiter :> ICriticalNotifyCompletion

MethodBuilder.AwaitUnsafeOnCompleted(
&sm.Data.MethodBuilder,
&awaiter,
&sm
)

false
else
CancellableTaskBuilderBase.BindDynamicNoCancellation(
&sm,
awaiter,
continuation
)
//-- RESUMABLE CODE END
)

/// <summary>Creates A CancellableTask that runs computation, and when
/// computation generates a result T, runs binder res.</summary>
///
Expand Down Expand Up @@ -673,7 +762,9 @@ module CancellableTaskBase =
) : CancellableTaskBaseCode<'TOverall, 'T, 'Builder> =
ResumableCode.TryFinallyAsync(
computation,
ResumableCode<_, _>(fun sm -> x.Bind((compensation ()), (x.Zero)).Invoke(&sm))
ResumableCode<_, _>(fun sm ->
x.BindNoCancellation((compensation ()), (x.Zero)).Invoke(&sm)
)
)


Expand Down
12 changes: 4 additions & 8 deletions tests/IcedTasks.Tests/CancellablePoolingValueTaskTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,12 +510,12 @@ module CancellablePoolingValueTaskTests =
testCaseAsync "use IAsyncDisposable cancelled"
<| async {
let data = 42
let mutable wasDisposed = TaskCompletionSource<bool>()
let mutable wasDisposed = false

let doDispose () =
task {
do! Task.Yield()
wasDisposed.SetResult true
do! Task.Delay(15)
wasDisposed <- true
}
|> ValueTask

Expand All @@ -537,14 +537,10 @@ module CancellablePoolingValueTaskTests =
timeProvider.ForwardTimeAsync(TimeSpan.FromMilliseconds(100))
|> Async.AwaitTask

let! _ =
do!
Expect.CancellationRequested inProgress
|> Async.AwaitValueTask

let! wasDisposed =
wasDisposed.Task
|> Async.AwaitTask

Expect.isTrue wasDisposed ""
}

Expand Down
27 changes: 16 additions & 11 deletions tests/IcedTasks.Tests/CancellableTaskTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ module CancellableTaskTests =
<| async {
let doDispose () =
task {
do! Task.Yield()
do! Task.Delay(15)
failwith "boom"
}
|> ValueTask
Expand All @@ -492,16 +492,18 @@ module CancellableTaskTests =
testCaseAsync "use IAsyncDisposable cancelled"
<| async {
let data = 42
let mutable wasDisposed = TaskCompletionSource<bool>()
let mutable wasDisposed = false

let timeProvider = ManualTimeProvider()

let doDispose () =
task {
do! Task.Yield()
wasDisposed.SetResult true
do! Task.Delay(15)

wasDisposed <- true
}
|> ValueTask

let timeProvider = ManualTimeProvider()

let actor data =
cancellableTask {
Expand All @@ -519,16 +521,19 @@ module CancellableTaskTests =
timeProvider.ForwardTimeAsync(TimeSpan.FromMilliseconds(100))
|> Async.AwaitTask

Expect.isFalse wasDisposed ""

let! _ =
Expect.CancellationRequested inProgress
do!
timeProvider.ForwardTimeAsync(TimeSpan.FromMilliseconds(100))
|> Async.AwaitTask

let! wasDisposed =
wasDisposed.Task
do!
Expect.CancellationRequested inProgress
|> Async.AwaitTask


Expect.isTrue wasDisposed ""

}


Expand All @@ -540,7 +545,7 @@ module CancellableTaskTests =
let doDispose () =
task {
Expect.isFalse wasDisposed ""
do! Task.Yield()
do! Task.Delay(15)
wasDisposed <- true
}
|> ValueTask
Expand All @@ -565,7 +570,7 @@ module CancellableTaskTests =
let doDispose () =
task {
Expect.isFalse wasDisposed ""
do! Task.Yield()
do! Task.Delay(15)
wasDisposed <- true
}
|> ValueTask
Expand Down
12 changes: 4 additions & 8 deletions tests/IcedTasks.Tests/CancellableValueTaskTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,12 +511,12 @@ module CancellableValueTaskTests =
testCaseAsync "use IAsyncDisposable cancelled"
<| async {
let data = 42
let mutable wasDisposed = TaskCompletionSource<bool>()
let mutable wasDisposed = false

let doDispose () =
task {
do! Task.Yield()
wasDisposed.SetResult true
do! Task.Delay(15)
wasDisposed <- true
}
|> ValueTask

Expand All @@ -538,14 +538,10 @@ module CancellableValueTaskTests =
timeProvider.ForwardTimeAsync(TimeSpan.FromMilliseconds(100))
|> Async.AwaitTask

let! _ =
do!
Expect.CancellationRequested inProgress
|> Async.AwaitValueTask

let! wasDisposed =
wasDisposed.Task
|> Async.AwaitTask

Expect.isTrue wasDisposed ""
}

Expand Down
Loading