Merge branch 'master' into transaction

Author: glucaci

.github/workflows/dotnet.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 3.1.301
+        dotnet-version: 5.0.*
     - name: Restore dependencies
       run: dotnet restore
     - name: Build

ReleaseNotes/3.4.0.md

@@ -38,18 +38,27 @@ public class MetricsMiddleware : IWorkflowMiddleware
         switch (workflow.Status)
         {
             case WorkflowStatus.Complete:
-                if (_suspendedWorkflows.TryRemove(workflow.Id))
-                {
-                    _suspended.Dec();
-                }
+                TryDecrementSuspended(workflow);
                 _completed.Inc();
                 break;
             case WorkflowStatus.Suspended:
+                _suspendedWorkflows.Add(workflow.Id);
                 _suspended.Inc();
                 break;
+            default:
+                TryDecrementSuspended(workflow);
+                break;
         }
 
         return next();
     }
+
+    private void TryDecrementSuspended(WorkflowInstance workflow)
+    {
+        if (_suspendedWorkflows.TryRemove(workflow.Id))
+        {
+            _suspended.Dec();
+        }
+    }
 }
 ```

WorkflowCore.sln

@@ -7,7 +7,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{EF47161E-E39
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{F6AC9AEB-24EF-475A-B190-AA4D9E01270A}"
 	ProjectSection(SolutionItems) = preProject
-		readme.md = readme.md
+		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{5080DB09-CBE8-4C45-9957-C3BB7651755E}"

docs/getting-started.md

@@ -142,7 +142,7 @@ public class MyDataClass
 {
     public int Value1 { get; set; }
     public int Value2 { get; set; }
-    public int Value3 { get; set; }
+    public int Answer { get; set; }
 }
 
 //Our workflow definition with strongly typed internal data and mapped inputs & outputs
@@ -154,9 +154,9 @@ public class PassingDataWorkflow : IWorkflow<MyDataClass>
             .StartWith<AddNumbers>()
                 .Input(step => step.Input1, data => data.Value1)
                 .Input(step => step.Input2, data => data.Value2)
-                .Output(data => data.Value3, step => step.Output)
+                .Output(data => data.Answer, step => step.Output)
             .Then<CustomMessage>()
-                .Input(step => step.Message, data => "The answer is " + data.Value3.ToString());
+                .Input(step => step.Message, data => "The answer is " + data.Answer.ToString());
     }
     ...
 }
@@ -175,8 +175,8 @@ or in jSON format
       "StepType": "MyApp.AddNumbers, MyApp",
       "NextStepId": "ShowResult",
       "Inputs": { 
-          "Value1": "data.Value1",
-          "Value2": "data.Value2" 
+          "Input1": "data.Value1",
+          "Input2": "data.Value2" 
        },
       "Outputs": { 
           "Answer": "step.Output" 
@@ -186,7 +186,7 @@ or in jSON format
       "Id": "ShowResult",
       "StepType": "MyApp.CustomMessage, MyApp",
       "Inputs": { 
-          "Message": "\"The answer is \" + data.Value1" 
+          "Message": "\"The answer is \" + data.Answer" 
        }
     }
   ]
@@ -203,14 +203,14 @@ Steps:
   StepType: MyApp.AddNumbers, MyApp
   NextStepId: ShowResult
   Inputs:
-    Value1: data.Value1
-    Value2: data.Value2
+    Input1: data.Value1
+    Input2: data.Value2
   Outputs:
     Answer: step.Output
 - Id: ShowResult
   StepType: MyApp.CustomMessage, MyApp
   Inputs:
-    Message: '"The answer is " + data.Value1'
+    Message: '"The answer is " + data.Answer'
 ```
 
 

src/Directory.Build.props

@@ -0,0 +1,13 @@
+<Project>
+  <PropertyGroup>
+    <PackageProjectUrl>https://github.com/danielgerlag/workflow-core</PackageProjectUrl>
+    <PackageLicenseUrl>https://github.com/danielgerlag/workflow-core/blob/master/LICENSE.md</PackageLicenseUrl>
+    <RepositoryType>git</RepositoryType>
+    <RepositoryUrl>https://github.com/danielgerlag/workflow-core.git</RepositoryUrl>
+    <Version>3.5.3</Version>
+    <AssemblyVersion>3.5.4.0</AssemblyVersion>
+    <FileVersion>3.5.4.0</FileVersion>
+    <PackageIconUrl>https://github.com/danielgerlag/workflow-core/raw/master/src/logo.png</PackageIconUrl>
+    <PackageVersion>3.5.4</PackageVersion>
+  </PropertyGroup>
+</Project>

src/WorkflowCore.DSL/WorkflowCore.DSL.csproj

@@ -2,14 +2,10 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>3.3.1</Version>
     <Description>DSL extenstion for Workflow Core provding support for JSON and YAML workflow definitions.</Description>
     <Authors>Daniel Gerlag</Authors>
     <Company />
     <Product>WorkflowCore</Product>
-    <PackageProjectUrl>https://github.com/danielgerlag/workflow-core</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/danielgerlag/workflow-core.git</RepositoryUrl>
-    <RepositoryType>git</RepositoryType>
   </PropertyGroup>
 
   <ItemGroup>

src/WorkflowCore/Interface/IDistributedLockProvider.cs

@@ -9,6 +9,12 @@ namespace WorkflowCore.Interface
     /// </remarks>
     public interface IDistributedLockProvider
     {
+        /// <summary>
+        /// Acquire a lock on the specified resource.
+        /// </summary>
+        /// <param name="Id">Resource ID to lock.</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns>`true`, if the lock was acquired.</returns>
         Task<bool> AcquireLock(string Id, CancellationToken cancellationToken);
 
         Task ReleaseLock(string Id);

src/WorkflowCore/Interface/Persistence/IEventRepository.cs

@@ -1,23 +1,24 @@
 using System;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using WorkflowCore.Models;
 
 namespace WorkflowCore.Interface
 {
     public interface IEventRepository
     {
-        Task<string> CreateEvent(Event newEvent);
+        Task<string> CreateEvent(Event newEvent, CancellationToken cancellationToken = default);
 
-        Task<Event> GetEvent(string id);
+        Task<Event> GetEvent(string id, CancellationToken cancellationToken = default);
 
-        Task<IEnumerable<string>> GetRunnableEvents(DateTime asAt);
+        Task<IEnumerable<string>> GetRunnableEvents(DateTime asAt, CancellationToken cancellationToken = default);
 
-        Task<IEnumerable<string>> GetEvents(string eventName, string eventKey, DateTime asOf);
+        Task<IEnumerable<string>> GetEvents(string eventName, string eventKey, DateTime asOf, CancellationToken cancellationToken = default);
 
-        Task MarkEventProcessed(string id);
+        Task MarkEventProcessed(string id, CancellationToken cancellationToken = default);
 
-        Task MarkEventUnprocessed(string id);
+        Task MarkEventUnprocessed(string id, CancellationToken cancellationToken = default);
 
     }
 }

src/WorkflowCore/Interface/Persistence/IPersistenceProvider.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using WorkflowCore.Models;
 
@@ -8,7 +9,7 @@ namespace WorkflowCore.Interface
     public interface IPersistenceProvider : IWorkflowRepository, ISubscriptionRepository, IEventRepository
     {        
 
-        Task PersistErrors(IEnumerable<ExecutionError> errors);
+        Task PersistErrors(IEnumerable<ExecutionError> errors, CancellationToken cancellationToken = default);
 
         void EnsureStoreExists();
 

src/WorkflowCore/Interface/Persistence/ISubscriptionRepository.cs

@@ -1,25 +1,26 @@
 using System;
 using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using WorkflowCore.Models;
 
 namespace WorkflowCore.Interface
 {
     public interface ISubscriptionRepository
     {        
-        Task<string> CreateEventSubscription(EventSubscription subscription);
+        Task<string> CreateEventSubscription(EventSubscription subscription, CancellationToken cancellationToken = default);
 
-        Task<IEnumerable<EventSubscription>> GetSubscriptions(string eventName, string eventKey, DateTime asOf);
+        Task<IEnumerable<EventSubscription>> GetSubscriptions(string eventName, string eventKey, DateTime asOf, CancellationToken cancellationToken = default);
 
-        Task TerminateSubscription(string eventSubscriptionId);
+        Task TerminateSubscription(string eventSubscriptionId, CancellationToken cancellationToken = default);
 
-        Task<EventSubscription> GetSubscription(string eventSubscriptionId);
+        Task<EventSubscription> GetSubscription(string eventSubscriptionId, CancellationToken cancellationToken = default);
 
-        Task<EventSubscription> GetFirstOpenSubscription(string eventName, string eventKey, DateTime asOf);
+        Task<EventSubscription> GetFirstOpenSubscription(string eventName, string eventKey, DateTime asOf, CancellationToken cancellationToken = default);
 
-        Task<bool> SetSubscriptionToken(string eventSubscriptionId, string token, string workerId, DateTime expiry);
+        Task<bool> SetSubscriptionToken(string eventSubscriptionId, string token, string workerId, DateTime expiry, CancellationToken cancellationToken = default);
 
-        Task ClearSubscriptionToken(string eventSubscriptionId, string token);
+        Task ClearSubscriptionToken(string eventSubscriptionId, string token, CancellationToken cancellationToken = default);
 
     }
 }