From 6d9da72a57685ff1d134ff4a4107054493de9bdc Mon Sep 17 00:00:00 2001 From: Connor McMahon Date: Thu, 29 Jul 2021 16:19:10 -0700 Subject: [PATCH 1/3] Tweak C# docs for CreateTimer APIs Resolves #1893 --- .../ContextInterfaces/IDurableOrchestrationContext.cs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/WebJobs.Extensions.DurableTask/ContextInterfaces/IDurableOrchestrationContext.cs b/src/WebJobs.Extensions.DurableTask/ContextInterfaces/IDurableOrchestrationContext.cs index bff3125f3..f2961e491 100644 --- a/src/WebJobs.Extensions.DurableTask/ContextInterfaces/IDurableOrchestrationContext.cs +++ b/src/WebJobs.Extensions.DurableTask/ContextInterfaces/IDurableOrchestrationContext.cs @@ -328,7 +328,8 @@ public interface IDurableOrchestrationContext /// /// All durable timers created using this method must either expire or be cancelled /// using the before the orchestrator function completes. - /// Otherwise the underlying framework will keep the instance alive until the timer expires. + /// Otherwise the underlying framework will keep the instance in the "Running" state + /// even after the orchestrator function has completed. /// /// The type of . /// The time at which the timer should expire. @@ -343,7 +344,8 @@ public interface IDurableOrchestrationContext /// /// All durable timers created using this method must either expire or be cancelled /// using the before the orchestrator function completes. - /// Otherwise the underlying framework will keep the instance alive until the timer expires. + /// Otherwise the underlying framework will keep the instance in the "Running" state + /// even after the orchestrator function has completed. /// /// The time at which the timer should expire. /// The CancellationToken to use for cancelling the timer. From e5e40eec8ef8ea13a2495b188762137fec3f7303 Mon Sep 17 00:00:00 2001 From: Connor McMahon Date: Thu, 29 Jul 2021 16:23:38 -0700 Subject: [PATCH 2/3] Add to release_notes.md --- release_notes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/release_notes.md b/release_notes.md index 68b06ba95..b149a920f 100644 --- a/release_notes.md +++ b/release_notes.md @@ -4,5 +4,6 @@ * Fix message loss bug in ContinueAsNew scenarios ([Azure/durabletask#544](https://github.com/Azure/durabletask/pull/544)) * Allow custom connection string names when creating a DurableClient in an ASP.NET Core app (external app) (#1895) +* Improve API documentation regarding uncancelled timers (#1903) ## Breaking Changes \ No newline at end of file From 27352eddd8a5483fb420d4926702f359a1dc52bd Mon Sep 17 00:00:00 2001 From: Connor McMahon Date: Thu, 29 Jul 2021 16:24:21 -0700 Subject: [PATCH 3/3] Add xml --- ...Azure.WebJobs.Extensions.DurableTask-net461.xml | 6 ++++-- ...rosoft.Azure.WebJobs.Extensions.DurableTask.xml | 14 ++++---------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask-net461.xml b/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask-net461.xml index 04d2f6dc2..ef82bfa66 100644 --- a/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask-net461.xml +++ b/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask-net461.xml @@ -1322,7 +1322,8 @@ All durable timers created using this method must either expire or be cancelled using the before the orchestrator function completes. - Otherwise the underlying framework will keep the instance alive until the timer expires. + Otherwise the underlying framework will keep the instance in the "Running" state + even after the orchestrator function has completed. The type of . The time at which the timer should expire. @@ -1337,7 +1338,8 @@ All durable timers created using this method must either expire or be cancelled using the before the orchestrator function completes. - Otherwise the underlying framework will keep the instance alive until the timer expires. + Otherwise the underlying framework will keep the instance in the "Running" state + even after the orchestrator function has completed. The time at which the timer should expire. The CancellationToken to use for cancelling the timer. diff --git a/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask.xml b/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask.xml index 842705265..b01f738cd 100644 --- a/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask.xml +++ b/src/WebJobs.Extensions.DurableTask/Microsoft.Azure.WebJobs.Extensions.DurableTask.xml @@ -1330,7 +1330,8 @@ All durable timers created using this method must either expire or be cancelled using the before the orchestrator function completes. - Otherwise the underlying framework will keep the instance alive until the timer expires. + Otherwise the underlying framework will keep the instance in the "Running" state + even after the orchestrator function has completed. The type of . The time at which the timer should expire. @@ -1345,7 +1346,8 @@ All durable timers created using this method must either expire or be cancelled using the before the orchestrator function completes. - Otherwise the underlying framework will keep the instance alive until the timer expires. + Otherwise the underlying framework will keep the instance in the "Running" state + even after the orchestrator function has completed. The time at which the timer should expire. The CancellationToken to use for cancelling the timer. @@ -2508,14 +2510,6 @@ Populate default configurations of to create Durable Clients. Returns the provided . - - - Adds the Durable Task extension to the provided . - - The to configure. - Populate configurations of to create Durable Clients. - Returns the provided . - Adds the Durable Task extension to the provided .