Compare commits

..
12 Commits
171 changed files with 2353 additions and 327 deletions
+7 -1
View File
@@ -15,8 +15,14 @@
<PackageIcon>icon.png</PackageIcon>
<!-- For NuGet browsers that currently don't support <PackageIcon> yet -->
<PackageIconUrl>https://v3.elsaworkflows.io/nuget-icon.png</PackageIconUrl>
<!--<PackageIconUrl>https://v3.elsaworkflows.io/nuget-icon.png</PackageIconUrl>-->
<PackageIcon>icon.png</PackageIcon>
<!-- Package output -->
<PackageOutputPath>
$(MSBuildThisFileDirectory)packages
</PackageOutputPath>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AnalysisModeDocumentation>Default</AnalysisModeDocumentation>
<AnalysisLevelDocumentation>latest</AnalysisLevelDocumentation>
+1
View File
@@ -151,6 +151,7 @@
<PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Binder" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="$(MicrosoftVersion)" />
<PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="$(MicrosoftVersion)" />
+21
View File
@@ -419,6 +419,12 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Caspian.WorkflowFramework",
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Caspian.WorkflowFramework.Sample", "src\apps\Caspian.WorkflowFramework.Sample\Caspian.WorkflowFramework.Sample.csproj", "{C260D75F-19EB-4982-A98B-D8E126776910}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Caching.Redis", "src\modules\Elsa.Caching.Redis\Elsa.Caching.Redis.csproj", "{CEB64AF4-A63C-4204-828A-53E6096095A0}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Caching.UnitTests", "test\unit\Elsa.Caching.UnitTests\Elsa.Caching.UnitTests.csproj", "{86197750-6B7F-4F65-8456-E30E82F53F1C}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Caching.ProcessTests", "test\integration\Elsa.Caching.ProcessTests\Elsa.Caching.ProcessTests.csproj", "{0368A4B4-FA10-489D-B390-F141A6225720}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
@@ -875,6 +881,18 @@ Global
{C260D75F-19EB-4982-A98B-D8E126776910}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C260D75F-19EB-4982-A98B-D8E126776910}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C260D75F-19EB-4982-A98B-D8E126776910}.Release|Any CPU.Build.0 = Release|Any CPU
{CEB64AF4-A63C-4204-828A-53E6096095A0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{CEB64AF4-A63C-4204-828A-53E6096095A0}.Debug|Any CPU.Build.0 = Debug|Any CPU
{CEB64AF4-A63C-4204-828A-53E6096095A0}.Release|Any CPU.ActiveCfg = Release|Any CPU
{CEB64AF4-A63C-4204-828A-53E6096095A0}.Release|Any CPU.Build.0 = Release|Any CPU
{86197750-6B7F-4F65-8456-E30E82F53F1C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{86197750-6B7F-4F65-8456-E30E82F53F1C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{86197750-6B7F-4F65-8456-E30E82F53F1C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{86197750-6B7F-4F65-8456-E30E82F53F1C}.Release|Any CPU.Build.0 = Release|Any CPU
{0368A4B4-FA10-489D-B390-F141A6225720}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{0368A4B4-FA10-489D-B390-F141A6225720}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0368A4B4-FA10-489D-B390-F141A6225720}.Release|Any CPU.ActiveCfg = Release|Any CPU
{0368A4B4-FA10-489D-B390-F141A6225720}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
@@ -1030,6 +1048,9 @@ Global
{C583AF05-D517-4B7F-8955-6B61500ED3D8} = {7FD1FD1E-5778-4065-AAA5-1F878129EF77}
{A0F413B7-FA0F-472D-8BC2-6193DA440072} = {D92BEAB2-60D6-4BB4-885A-6BA681C6CCF1}
{C260D75F-19EB-4982-A98B-D8E126776910} = {D92BEAB2-60D6-4BB4-885A-6BA681C6CCF1}
{CEB64AF4-A63C-4204-828A-53E6096095A0} = {5BA4A8FA-F7F4-45B3-AEC8-8886D35AAC79}
{86197750-6B7F-4F65-8456-E30E82F53F1C} = {18453B51-25EB-4317-A4B3-B10518252E92}
{0368A4B4-FA10-489D-B390-F141A6225720} = {1B8D5897-902E-4632-8698-E89CAF3DDF54}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {D4B5CEAA-7D70-4FCB-A68E-B03FBE5E0E5E}
BIN
View File
Binary file not shown.
+31
View File
@@ -0,0 +1,31 @@
param(
[Parameter(Mandatory = $true)]
[string] $RedisConnection
)
$cacheRepoRoot = [IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..'))
$cachePreviousConnection = $env:REDIS_TEST_CONNECTION
$cacheValidationRoot = Join-Path $cacheRepoRoot 'artifacts/cache-validation'
New-Item -ItemType Directory -Path $cacheValidationRoot -Force | Out-Null
$env:REDIS_TEST_CONNECTION = $RedisConnection
try {
Push-Location $cacheRepoRoot
dotnet test test/unit/Elsa.Caching.UnitTests/Elsa.Caching.UnitTests.csproj -m:1 -p:BuildInParallel=false -p:GeneratePackageOnBuild=false
if ($LASTEXITCODE -ne 0) { throw 'Workflow cache tests failed.' }
dotnet build test/integration/Elsa.Caching.ProcessTests/Elsa.Caching.ProcessTests.csproj -m:1 -p:BuildInParallel=false -p:GeneratePackageOnBuild=false
if ($LASTEXITCODE -ne 0) { throw 'Workflow cache process test build failed.' }
$cacheTestRun = [Guid]::NewGuid().ToString('N')
$cacheDatabasePath = Join-Path $cacheValidationRoot ($cacheTestRun + '.db')
$cacheKeyPrefix = 'workflow-process-tests:' + $cacheTestRun + ':'
$cacheProcessProgram = Join-Path $cacheRepoRoot 'test/integration/Elsa.Caching.ProcessTests/bin/Debug/net9.0/Elsa.Caching.ProcessTests.dll'
foreach ($cacheProcessMode in @('write', 'read', 'invalidate', 'read-updated', 'pending', 'bypass')) {
dotnet $cacheProcessProgram $cacheDatabasePath $cacheKeyPrefix $cacheProcessMode
if ($LASTEXITCODE -ne 0) { throw "Independent process test failed: $cacheProcessMode" }
}
}
finally {
Pop-Location
$env:REDIS_TEST_CONNECTION = $cachePreviousConnection
}
@@ -97,7 +97,8 @@ public class WorkflowController : Controller, ILoggable
{
_logger.Log("Start of Cancel action", WFInstanceId: input.WorkflowInstanceId, JsonConvert.SerializeObject(input));
var result = await _workflowService.CancelInstanceAsync(input);
//var result = await _workflowService.CancelInstanceAsync(input);
var result = await _workflowService.ForceCancelAsync(input);
_logger.Log("End of Cancel action", WFInstanceId: input.WorkflowInstanceId, JsonConvert.SerializeObject(result));
@@ -160,4 +161,25 @@ public class WorkflowController : Controller, ILoggable
return Json(result);
}
#endregion
#region GetNextPossibleEvents
[HttpPost("GetNextPossibleEvents")]
public async Task<ActionResult<WorkflowResponse<WorkflowModel>>> GetNextPossibleEvents(string workflowInstanceId)
{
var result = await _workflowService.GetNextPossibleEventsAsync(workflowInstanceId);
return Ok(result);
}
#endregion
#region ResetCache
[HttpGet("ResetCache")]
public async Task ResetCache([FromQuery] string key)
{
_logger.Log("Start of ResetCache action", key);
await _workflowService.EvictDefFromCacheAsync(key);
_logger.Log("End of ResetCache action", key);
}
#endregion
}
@@ -40,7 +40,7 @@
"ConnectionStrings": {
//"DefaultConnection": "Data Source=.;Initial Catalog=WfDb;User ID=sa;Password=123456;Integrated Security=false;TrustServerCertificate=True;"
//"DefaultConnection": "Server=.;Database=CaspianWfDb;User Id=sa;Password=123456;TrustServerCertificate=True;"
//"DefaultConnection": "Server=.;Database=Workflow_Db;User Id=sa;Password=123456;TrustServerCertificate=True;"
"DefaultConnection": "Server=192.168.251.161;Database=Workflow_Db;User Id=sa;Password=cLL{3N29D@n2;MultipleActiveResultSets=true;TrustServerCertificate=True"
"DefaultConnection": "Server=.;Database=WfLive;User Id=sa;Password=123456;TrustServerCertificate=True;"
//"DefaultConnection": "Server=192.168.251.161;Database=Workflow_Db;User Id=sa;Password=cLL{3N29D@n2;MultipleActiveResultSets=true;TrustServerCertificate=True"
}
}
@@ -9,6 +9,7 @@
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" />
<PackageReference Include="Microsoft.Extensions.Hosting" />
<PackageReference Include="Microsoft.Extensions.Configuration" />
<PackageReference Include="San.MongoLogger" />
</ItemGroup>
@@ -127,9 +127,9 @@ public static class DependencyInjection
// engine.Execute("function sayHelloWorld() { return greet('World'); }");
//});
})
// برای ثبت Activityهایی مانند Elsa.SendHttpRequest
.UseHttp()
.UseWorkflowContexts();
elsa.AddFastEndpointsAssembly<Program>();
});
// Optionally configure recurring tasks using alternative schedules.
@@ -171,8 +171,8 @@ public static class DependencyInjection
// Captures unhandled exceptions and returns a JSON response.
app.UseJsonSerializationErrorHandler();
//app.UseWorkflows();
app.UseWorkflows();
}
}
@@ -50,8 +50,12 @@ public interface IWorkflowService
/// </summary>
Task<WorkflowResponse<dynamic>> CancelInstanceAsync(CancelWorkflowInstanceModel input);
///// <summary>
///// Evicts a workflow definition from cache (optional, commented out in service).
///// </summary>
//Task<WorkflowResponse<WorkflowModel>> EvictDefFromCacheAsync(string definitionId);
Task<WorkflowResponse<dynamic>> ForceCancelAsync(CancelWorkflowInstanceModel input);
Task<WorkflowResponse<WorkflowModel>> GetNextPossibleEventsAsync(string workflowInstanceId);
/// <summary>
/// Evicts a workflow definition from cache (optional, commented out in service).
/// </summary>
Task EvictDefFromCacheAsync(string name, CancellationToken cancellationToken = default);
}
@@ -0,0 +1,13 @@
namespace Caspian.WorkflowFramework.Models;
public sealed class PossibleEventDto
{
public string EventName { get; set; } = default!;
public string? BookmarkId { get; set; }
public string? ActivityId { get; set; }
public string? ActivityNodeId { get; set; }
public string? ActivityInstanceId { get; set; }
public DateTimeOffset? CreatedAt { get; set; }
public bool? AutoBurn { get; set; }
public string? CallbackMethodName { get; set; }
public IDictionary<string, string>? Metadata { get; set; }
}
@@ -19,4 +19,6 @@ public class PublishEventModel
[Required]
public JsonElement EventData { get; set; }
public string? SessionId { get; set; }
}
@@ -11,13 +11,18 @@ using Elsa.Workflows.Management;
using Elsa.Workflows.Management.Filters;
using Elsa.Workflows.Models;
using Elsa.Workflows.Runtime;
using Elsa.Workflows.Runtime.Filters;
using Elsa.Workflows.Runtime.Messages;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Linq;
using San.MongoLogger;
namespace Caspian.WorkflowFramework.Services;
public class WorkflowService : IWorkflowService, ILoggable
{
#region Fields
@@ -30,6 +35,8 @@ public class WorkflowService : IWorkflowService, ILoggable
private readonly IEventPublisher _eventPublisher;
private readonly IWorkflowDefinitionCacheManager _workflowDefinitionCacheManager;
private readonly IMdbLogger<WorkflowService> _logger;
private readonly IBookmarkStore _bookmarkStore;
private readonly IActivityExecutionStore _activityExecutionStore;
#endregion
#region Ctor
@@ -43,6 +50,9 @@ public class WorkflowService : IWorkflowService, ILoggable
_workflowInstanceManager = _serviceProvider.GetRequiredService<IWorkflowInstanceManager>();
_workflowInstanceStore = _serviceProvider.GetRequiredService<IWorkflowInstanceStore>();
_eventPublisher = _serviceProvider.GetRequiredService<IEventPublisher>();
_workflowDefinitionCacheManager = _serviceProvider.GetRequiredService<IWorkflowDefinitionCacheManager>();
_bookmarkStore = _serviceProvider.GetRequiredService<IBookmarkStore>();
_activityExecutionStore = _serviceProvider.GetRequiredService<IActivityExecutionStore>();
_logger = logger;
}
#endregion
@@ -102,7 +112,7 @@ public class WorkflowService : IWorkflowService, ILoggable
var workflowModel = dictionary.ConvertToWorkflowModel();
workflowModel.InstanceId = workflowClient.WorkflowInstanceId;
workflowModel.UserId = input.UserId;
workflowModel.InstanceMode = "exist";
workflowModel.InstanceMode = "new";
response = new WorkflowResponse<WorkflowModel>()
{
@@ -128,6 +138,7 @@ public class WorkflowService : IWorkflowService, ILoggable
sw.Stop();
_logger.Log("Exception occurs in CreateAndExecuteAsync", WFInstanceId: response.Data?.InstanceId, response, sw.ElapsedMilliseconds, ex);
return response;
@@ -222,7 +233,7 @@ public class WorkflowService : IWorkflowService, ILoggable
var workflowModel = dictionary.ConvertToWorkflowModel();
workflowModel.InstanceId = workflowInstanceId;
workflowModel.UserId = input.UserId;
workflowModel.InstanceId = runningWorkflowInstance != null ? "exist" : "new";
workflowModel.InstanceMode = runningWorkflowInstance != null ? "exist" : "new";
response = new WorkflowResponse<WorkflowModel>()
{
@@ -256,65 +267,122 @@ public class WorkflowService : IWorkflowService, ILoggable
#endregion
#region PublishEventAsync
/// <inheritdoc />
public async Task<WorkflowResponse<WorkflowModel>> PublishEventAsync(PublishEventModel input)
public async Task<WorkflowResponse<WorkflowModel>> PublishEventAsync(
PublishEventModel input)
{
var sw = Stopwatch.StartNew();
try
{
_logger.Log("Start of PublishEventAsync", WFInstanceId: input.WorkflowInstanceId, input);
_logger.Log(
"Start of PublishEventAsync",
WFInstanceId: input.WorkflowInstanceId,
input);
WorkflowResponse<WorkflowModel> response;
var instance = await _workflowInstanceManager.FindByIdAsync(input.WorkflowInstanceId);
var instance = await _workflowInstanceManager.FindByIdAsync(
input.WorkflowInstanceId);
if (instance == null)
{
var msg = $"Workflow instance with id '{input.WorkflowInstanceId}' not found";
response = new WorkflowResponse<WorkflowModel>()
var notFoundResponse = new WorkflowResponse<WorkflowModel>
{
Status = 1,
Message = msg,
Message =
$"Workflow instance with id " +
$"'{input.WorkflowInstanceId}' not found",
Data = null
};
sw.Stop();
_logger.Log("End of PublishEventAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds);
_logger.Log(
"End of PublishEventAsync",
WFInstanceId: input.WorkflowInstanceId,
notFoundResponse,
sw.ElapsedMilliseconds);
return response;
return notFoundResponse;
}
dynamic payload = null;
/*
* مهم:
* ساخت Payload را مانند نسخه قبلی نگه می‌داریم:
*
* JsonElement
* ↓
* ExpandoObject
* ↓
* اضافه‌شدن SessionId
* ↓
* PublishEvent
*/
if (input.EventData.ValueKind != JsonValueKind.Undefined &&
input.EventData.ValueKind != JsonValueKind.Null)
ExpandoObject payload = new();
if (input.EventData.ValueKind is not JsonValueKind.Undefined
and not JsonValueKind.Null)
{
if (input.EventData.ValueKind != JsonValueKind.Object)
{
throw new InvalidOperationException(
"EventData must be a JSON object.");
}
var json = input.EventData.GetRawText();
var settings = new JsonSerializerSettings
var serializerSettings = new JsonSerializerSettings
{
Converters = { new ExpandoObjectConverter() }
Converters =
{
new ExpandoObjectConverter()
}
};
// تبدیل JSON به object داینامیک
payload = JsonConvert.DeserializeObject<ExpandoObject>(json, settings);
payload =
JsonConvert.DeserializeObject<ExpandoObject>(
json,
serializerSettings)
?? new ExpandoObject();
}
//await _eventPublisher.PublishAsync(input.EventName, null, input.WorkflowInstanceId, null, input.EventData, asynchronous: true);
await _eventPublisher.PublishAsync(input.EventName, null, input.WorkflowInstanceId, null, payload);
/*
* ExpandoObject پیاده‌سازی IDictionary است؛
* بنابراین بدون Serialize/Deserialize مجدد می‌توانیم
* SessionId را به Payload اضافه کنیم.
*/
if (!string.IsNullOrWhiteSpace(input.SessionId))
{
var payloadDictionary =
(IDictionary<string, object?>)payload;
var variables = await _workflowInstanceVariableManager.GetVariablesAsync(input.WorkflowInstanceId);
payloadDictionary["SessionId"] = input.SessionId;
}
// تبدیل به دیکشنری
var dictionary = variables.ToDictionary(a => a.Variable.Name, a => a.Value);
await _eventPublisher.PublishAsync(
eventName: input.EventName,
correlationId: null,
workflowInstanceId: input.WorkflowInstanceId,
activityInstanceId: null,
payload: payload,
asynchronous: false);
var variables =
await _workflowInstanceVariableManager.GetVariablesAsync(
input.WorkflowInstanceId);
var dictionary = variables.ToDictionary(
x => x.Variable.Name,
x => x.Value);
var workflowModel = dictionary.ConvertToWorkflowModel();
workflowModel.InstanceId = instance.Id;
workflowModel.UserId = instance.ExternalUserId;
workflowModel.InstanceMode = "exist";
response = new WorkflowResponse<WorkflowModel>()
var response = new WorkflowResponse<WorkflowModel>
{
Status = 0,
Message = "Success",
@@ -323,26 +391,36 @@ public class WorkflowService : IWorkflowService, ILoggable
sw.Stop();
_logger.Log("End of PublishEventAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds);
_logger.Log(
"End of PublishEventAsync",
WFInstanceId: input.WorkflowInstanceId,
response,
sw.ElapsedMilliseconds);
return response;
}
catch (Exception ex)
{
var response = new WorkflowResponse<WorkflowModel>()
sw.Stop();
var response = new WorkflowResponse<WorkflowModel>
{
Status = 100,
Message = ex.Message,
Data = null
};
sw.Stop();
_logger.Log("Exception occurs in PublishEventAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds, ex);
_logger.Log(
"Exception occurs in PublishEventAsync",
WFInstanceId: input.WorkflowInstanceId,
response,
sw.ElapsedMilliseconds,
ex);
return response;
}
}
#endregion
#region InquiryStateAsync
@@ -725,65 +803,280 @@ public class WorkflowService : IWorkflowService, ILoggable
}
#endregion
//#region EvictDefFromCacheAsync
///// <inheritdoc />
//public async Task<WorkflowResponse<WorkflowModel>> EvictDefFromCacheAsync(string definitionId)
//{
// var sw = Stopwatch.StartNew();
// try
// {
// _logger.Log("Start of EvictDefFromCacheAsync", definitionId);
#region ForceCancelAsync
public async Task<WorkflowResponse<dynamic>> ForceCancelAsync(CancelWorkflowInstanceModel input)
{
var sw = Stopwatch.StartNew();
try
{
_logger.Log("Start ForceCancelAsync", WFInstanceId: input.WorkflowInstanceId, input);
// var key = _workflowDefinitionCacheManager.CreateWorkflowDefinitionChangeTokenKey(definitionId);
// await _workflowDefinitionCacheManager.EvictWorkflowDefinitionAsync(definitionId);
var instance = await _workflowInstanceManager.FindByIdAsync(input.WorkflowInstanceId);
// WorkflowResponse<WorkflowModel> response;
if (instance == null)
return new WorkflowResponse<dynamic> { Status = 1, Message = "Instance not found", Data = false };
// if (instance == null)
// {
// var msg = $"Workflow instance with id '{input.WorkflowInstanceId}' not found";
// response = new WorkflowResponse<WorkflowModel>()
// {
// Status = 1,
// Message = msg,
// Data = null
// };
// جلوگری از Resume شدن دوباره
instance.Status = WorkflowStatus.Finished;
instance.SubStatus = WorkflowSubStatus.Cancelled;
// sw.Stop();
// پاک‌سازی bookmarks از دیتابیس واقعی
var bookmarkFilter = new BookmarkFilter()
{
WorkflowInstanceId = input.WorkflowInstanceId
};
await _bookmarkStore.DeleteAsync(bookmarkFilter);
// _logger.Log("End of InquiryStateAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds);
// پاک‌سازی scheduled activities (در صورتی که runtime distributed باشد)
var activityFilter = new ActivityExecutionRecordFilter()
{
WorkflowInstanceId = input.WorkflowInstanceId
};
await _activityExecutionStore.DeleteManyAsync(activityFilter);
// return response;
// }
//// پاک‌سازی incidents (در پروژه‌های بزرگ ضروری است)
//await _incidentStore.DeleteManyAsync(
// x => x.WorkflowInstanceId == input.WorkflowInstanceId
//);
// response = new WorkflowResponse<WorkflowModel>()
// {
// Status = 0,
// Message = "Success",
// Data = workflowModel
// };
// ذخیره instance تغییر یافته
await _workflowInstanceManager.SaveAsync(instance);
// sw.Stop();
sw.Stop();
// _logger.Log("End of InquiryStateAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds);
var response = new WorkflowResponse<dynamic>
{
Status = 0,
Message = "Force cancel completed",
Data = true
};
// return response;
// }
// catch (Exception ex)
// {
// var response = new WorkflowResponse<WorkflowModel>()
// {
// Status = 100,
// Message = ex.Message,
// Data = null
// };
_logger.Log("End ForceCancelAsync", WFInstanceId: instance.Id, response, sw.ElapsedMilliseconds);
// sw.Stop();
return response;
}
catch (Exception ex)
{
sw.Stop();
// _logger.Log("Exception occurs in InquiryStateAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds, ex);
var response = new WorkflowResponse<dynamic>
{
Status = 100,
Message = ex.Message,
Data = false
};
// return response;
// }
//}
//#endregion
}
_logger.Log("Exception in ForceCancelAsync", WFInstanceId: input.WorkflowInstanceId, response, sw.ElapsedMilliseconds, ex);
return response;
}
}
#endregion
#region GetNextPossibleEventsAsync
public async Task<WorkflowResponse<WorkflowModel>> GetNextPossibleEventsAsync(string workflowInstanceId)
{
var sw = Stopwatch.StartNew();
try
{
_logger.Log("Start of GetNextPossibleEventsAsync", WFInstanceId: workflowInstanceId, workflowInstanceId);
var instance = await _workflowInstanceManager.FindByIdAsync(workflowInstanceId);
if (instance == null)
{
sw.Stop();
return new WorkflowResponse<WorkflowModel>
{
Status = 1,
Message = $"Workflow instance with id '{workflowInstanceId}' not found",
Data = null
};
}
var variables = await _workflowInstanceVariableManager.GetVariablesAsync(workflowInstanceId);
var dict = variables.ToDictionary(a => a.Variable.Name, a => a.Value);
var model = dict.ConvertToWorkflowModel();
model.InstanceId = instance.Id;
model.UserId = instance.ExternalUserId;
model.InstanceMode = "exist";
var bookmarks = instance.WorkflowState?.Bookmarks ?? new List<Bookmark>();
var possible = bookmarks
.Select(b => new PossibleEventDto
{
EventName = ExtractEventName(b) ?? "",
BookmarkId = b.Id,
ActivityId = b.ActivityId,
ActivityNodeId = b.ActivityNodeId,
ActivityInstanceId = b.ActivityInstanceId,
CreatedAt = b.CreatedAt,
AutoBurn = b.AutoBurn,
CallbackMethodName = b.CallbackMethodName,
Metadata = b.Metadata
})
.Where(x => !string.IsNullOrWhiteSpace(x.EventName))
.GroupBy(x => x.EventName, StringComparer.OrdinalIgnoreCase)
.Select(g => g.First())
.ToList();
// fallback
if (possible.Count == 0 && !string.IsNullOrWhiteSpace(model.NextPageEventName))
{
possible.Add(new PossibleEventDto
{
EventName = model.NextPageEventName!
});
}
model.NextPageData = System.Text.Json.JsonSerializer.SerializeToElement(new { possibleEvents = possible });
sw.Stop();
_logger.Log("End of GetNextPossibleEventsAsync", WFInstanceId: workflowInstanceId, model, sw.ElapsedMilliseconds);
return new WorkflowResponse<WorkflowModel>
{
Status = 0,
Message = "Success",
Data = model
};
}
catch (Exception ex)
{
sw.Stop();
_logger.Log("Exception in GetNextPossibleEventsAsync", WFInstanceId: workflowInstanceId, ex.Message, sw.ElapsedMilliseconds, ex);
return new WorkflowResponse<WorkflowModel>
{
Status = 100,
Message = ex.Message,
Data = null
};
}
}
private static string? ExtractEventName(Elsa.Workflows.Models.Bookmark b)
{
// حالت غالب: خود Name همان eventName است
//if (!string.IsNullOrWhiteSpace(b.Name))
// return b.Name;
//var eventName = ((Elsa.Workflows.Runtime.Stimuli.EventStimulus)b.Payload)?.EventName;
// اگر جایی Name خالی بود، از Payload هم تلاش می‌کنیم.
var payload = b.Payload;
if (payload == null) return null;
// اگر payload دیکشنری باشد:
if (payload is IDictionary<string, object> dict)
{
if (dict.TryGetValue("EventName", out var v) && v is string s1 && !string.IsNullOrWhiteSpace(s1)) return s1;
if (dict.TryGetValue("eventName", out v) && v is string s2 && !string.IsNullOrWhiteSpace(s2)) return s2;
if (dict.TryGetValue("Name", out v) && v is string s3 && !string.IsNullOrWhiteSpace(s3)) return s3;
}
// اگر payload شیء باشد و property داشته باشد (Reflection سبک):
var t = payload.GetType();
foreach (var prop in new[] { "EventName", "eventName", "Name" })
{
var p = t.GetProperty(prop);
if (p?.GetValue(payload) is string s && !string.IsNullOrWhiteSpace(s))
return s;
}
return null;
}
#endregion
#region EvictDefFromCacheAsync
/// <inheritdoc />
public async Task EvictDefFromCacheAsync(string name, CancellationToken cancellationToken = default)
{
var sw = Stopwatch.StartNew();
try
{
_logger.Log("Start of EvictDefFromCacheAsync", name);
var defFilter = new WorkflowDefinitionFilter()
{
Name = name,
VersionOptions = VersionOptions.Published
};
var definition = await _workflowDefinitionService
.FindWorkflowDefinitionAsync(defFilter);
//if (definition == null)
//{
// _logger.Log("No definition found to evict", name);
// return;
//}
//// 1. Evict definition cache
//await _workflowDefinitionCacheManager.EvictWorkflowDefinitionAsync(definition.DefinitionId, cancellationToken);
//_logger.Log($"Definition cache evicted for definitionId '{definition.DefinitionId}'", definition.DefinitionId);
//// 2. Re-index triggers (this rebuilds runtime cache)
//await _triggerIndexer.IndexTriggersAsync(definition, cancellationToken);
//_logger.Log($"Trigger indexing completed for definitionId '{definition.DefinitionId}'", definition.DefinitionId);
//var cacheKey = _workflowDefinitionCacheManager.CreateWorkflowFilterCacheKey(new WorkflowDefinitionFilter()
//{
// DefinitionHandle = WorkflowDefinitionHandle.ByDefinitionId(definition.DefinitionId, VersionOptions.Published)
//});
//await workflowDefinitionCacheManager.EvictWorkflowDefinitionAsync(notification.WorkflowDefinition.DefinitionId, cancellationToken);
//var cacheKey = cacheManager.CreateWorkflowDefinitionVersionCacheKey(definitionId, versionOptions);
//var cacheKey = cacheManager.CreateWorkflowDefinitionVersionCacheKey(definitionVersionId);
//var cacheKey = cacheManager.CreateWorkflowDefinitionFilterCacheKey(filter);
//var cacheKey = cacheManager.CreateWorkflowVersionCacheKey(definitionId, versionOptions);
//var cacheKey = cacheManager.CreateWorkflowVersionCacheKey(definitionVersionId);
//Definition cache
await _workflowDefinitionCacheManager.EvictWorkflowDefinitionAsync(definition.DefinitionId);
//Runtime Workflow Graph Cache
//await _notificationSender.SendAsync(new InvalidateWorkflowsCache());
//await _workflowDefinitionsReloader.ReloadWorkflowDefinitionsAsync();
//Trigger Cache
//await _workflowDefinitionCacheManager.Cache.TriggerTokenAsync(CachingTriggerStore.CacheInvalidationTokenKey, cancellationToken);
//await _triggerIndexer.IndexTriggersAsync(definition);
//_workflowDefinitionCacheManager.Cache.Remove("WorkflowDefinition:B0196B2A1FCF07CE8730A48F3E0238C6D8F52F7DB4C79A3C3B44A97C2BB10DB4");
var workflowDefinitionFilter = new WorkflowDefinitionFilter()
{
DefinitionHandle = WorkflowDefinitionHandle.ByDefinitionId(definition.DefinitionId, VersionOptions.Published)
};
var createWorkflowDefinitionFilterCacheKey = _workflowDefinitionCacheManager.CreateWorkflowDefinitionFilterCacheKey(workflowDefinitionFilter);
_workflowDefinitionCacheManager.Cache.Remove(createWorkflowDefinitionFilterCacheKey);
//await _workflowDefinitionCacheManager.Cache.TriggerTokenAsync(createWorkflowDefinitionFilterCacheKey);
var createWorkflowFilterCacheKey = _workflowDefinitionCacheManager.CreateWorkflowFilterCacheKey(workflowDefinitionFilter);
_workflowDefinitionCacheManager.Cache.Remove(createWorkflowFilterCacheKey);
//await _workflowDefinitionCacheManager.Cache.TriggerTokenAsync(createWorkflowFilterCacheKey);
//_workflowDefinitionCacheManager.Cache.Remove("WorkflowDefinition:FAFFD28A8B17585222747A0B10C16311BCCAF7744F1C41274BBDC652356D99A6");
//_workflowDefinitionCacheManager.Cache.Remove("Workflow:FAFFD28A8B17585222747A0B10C16311BCCAF7744F1C41274BBDC652356D99A6");
//_workflowDefinitionCacheManager.Cache.Remove("WorkflowDefinition:49B1E9FD1A0244512E8D2916B0A1B880E4473AA9F4E9341F6A69D331C9843B22");
//_workflowDefinitionCacheManager.Cache.Remove("Workflow:49B1E9FD1A0244512E8D2916B0A1B880E4473AA9F4E9341F6A69D331C9843B22");
//_workflowDefinitionCacheManager.Cache.Remove("Workflow:398a80072c638a83");
}
finally
{
sw.Stop();
_logger.Log("End of EvictDefFromCacheAsync", name, sw.ElapsedMilliseconds, null);
}
}
#endregion
}
@@ -18,6 +18,9 @@ namespace Caspian.WorkflowFramework.Utility
if (dictionary == null || dictionary.Count == 0)
return workflowModel;
// قبل از تبدیل به مدل خروجی، sessionId حذف می‌شود.
dictionary.RemoveSessionId();
//Map dictionary values to WorkflowModel properties
workflowModel.InstanceId = dictionary.ContainsKey(nameof(workflowModel.InstanceId))
? dictionary[nameof(workflowModel.InstanceId)]?.ToString()
@@ -0,0 +1,28 @@
namespace Caspian.WorkflowFramework.Utility;
public static class WorkflowVariableExtensions
{
private const string SessionIdKey = "SessionId";
/// <summary>
/// SessionId را فقط از سطح اول دیکشنری متغیرهای Workflow حذف می‌کند.
/// مقایسه نام کلید به حروف بزرگ و کوچک حساس نیست.
/// </summary>
public static Dictionary<string, object?> RemoveSessionId(
this Dictionary<string, object?> variables)
{
if (variables is null || variables.Count == 0)
return variables!;
var sessionIdKey = variables.Keys.FirstOrDefault(
key => string.Equals(
key,
SessionIdKey,
StringComparison.OrdinalIgnoreCase));
if (sessionIdKey is not null)
variables.Remove(sessionIdKey);
return variables;
}
}
@@ -0,0 +1,22 @@
namespace Elsa.Server.Web.Configuration;
/// <summary>Host connection settings, separate from the workflow cache policy.</summary>
public class RedisSettings
{
public bool AllowAdmin { get; set; }
public bool Ssl { get; set; }
public int ConnectTimeout { get; set; } = 5000;
public int ConnectRetry { get; set; } = 2;
public int SyncTimeout { get; set; } = 5000;
public int Database { get; set; } = 1;
public string? ServiceName { get; set; }
public string? User { get; set; }
public string? Password { get; set; }
public List<RedisHostSettings> Hosts { get; set; } = new();
}
public class RedisHostSettings
{
public string Host { get; set; } = string.Empty;
public int Port { get; set; } = 6379;
}
@@ -4,6 +4,8 @@
<ProjectReference Include="..\..\modules\Elsa.Agents.Persistence.EntityFrameworkCore.MySql\Elsa.Agents.Persistence.EntityFrameworkCore.MySql.csproj" Condition=" '$(TargetFramework)' != 'net9.0' " />
<ProjectReference Include="..\..\modules\Elsa.Caching.Distributed.MassTransit\Elsa.Caching.Distributed.MassTransit.csproj" />
<ProjectReference Include="..\..\modules\Elsa.Caching.Distributed.ProtoActor\Elsa.Caching.Distributed.ProtoActor.csproj" />
<ProjectReference Include="..\..\modules\Elsa.Caching.Redis\Elsa.Caching.Redis.csproj" />
<ProjectReference Include="..\..\modules\Elsa.Caching\Elsa.Caching.csproj" />
<ProjectReference Include="..\..\modules\Elsa.EntityFrameworkCore.MySql\Elsa.EntityFrameworkCore.MySql.csproj" Condition=" '$(TargetFramework)' != 'net9.0' " />
<ProjectReference Include="..\..\modules\Elsa.EntityFrameworkCore.Oracle\Elsa.EntityFrameworkCore.Oracle.csproj" />
<ProjectReference Include="..\..\modules\Elsa.EntityFrameworkCore.PostgreSql\Elsa.EntityFrameworkCore.PostgreSql.csproj" />
@@ -0,0 +1,43 @@
using Elsa.Server.Web.Configuration;
using Microsoft.Extensions.DependencyInjection.Extensions;
using StackExchange.Redis;
namespace Elsa.Server.Web.Extensions;
public static class RedisServiceCollectionExtensions
{
public static IServiceCollection AddWorkflowRedis(this IServiceCollection services, IConfiguration configuration)
{
services.TryAddSingleton<IConnectionMultiplexer>(_ => ConnectionMultiplexer.Connect(
CreateConfiguration(configuration.GetSection("Redis").Get<RedisSettings>() ?? new())));
return services;
}
public static ConfigurationOptions CreateConfiguration(RedisSettings settings)
{
var options = new ConfigurationOptions
{
AllowAdmin = settings.AllowAdmin,
Ssl = settings.Ssl,
AbortOnConnectFail = false,
ConnectTimeout = settings.ConnectTimeout,
ConnectRetry = settings.ConnectRetry,
SyncTimeout = settings.SyncTimeout,
DefaultDatabase = settings.Database,
User = string.IsNullOrWhiteSpace(settings.User) ? null : settings.User,
Password = string.IsNullOrWhiteSpace(settings.Password) ? null : settings.Password
};
foreach (var host in settings.Hosts.Where(x => !string.IsNullOrWhiteSpace(x.Host)))
{
if (host.Port is < 1 or > 65535) throw new InvalidOperationException("Redis host port must be between 1 and 65535.");
options.EndPoints.Add(host.Host, host.Port);
}
if (options.EndPoints.Count == 0) throw new InvalidOperationException("Redis:Hosts must contain a Redis or Sentinel endpoint.");
if (!string.IsNullOrWhiteSpace(settings.ServiceName))
{
options.ServiceName = settings.ServiceName;
options.TieBreaker = string.Empty;
}
return options;
}
}
@@ -0,0 +1,62 @@
using Elsa.Common.DistributedHosting.DistributedLocks;
using Elsa.Workflows.Runtime.Features;
using Medallion.Threading;
using Medallion.Threading.FileSystem;
using Medallion.Threading.Postgres;
using Medallion.Threading.Redis;
using StackExchange.Redis;
namespace Elsa.Server.Web.Extensions;
public static class WorkflowRuntimeFeatureExtensions
{
public static WorkflowRuntimeFeature UseConfiguredDistributedLocking(this WorkflowRuntimeFeature runtime, IConfiguration configuration)
{
var legacySettings = configuration.GetSection("Runtime:DistributedLocking");
var settings = configuration.GetSection("Workflow:Runtime:DistributedLocking");
runtime.DistributedLockingOptions = options =>
{
legacySettings.Bind(options);
settings.Bind(options);
};
var providerName = settings["Provider"] ?? legacySettings["Provider"];
runtime.DistributedLockProvider = sp =>
{
switch (providerName?.ToUpperInvariant())
{
case "REDIS":
{
var database = settings.GetValue<int?>("Database")
?? legacySettings.GetValue<int?>("Database")
?? configuration.GetValue<int?>("Redis:Database") ?? -1;
var prefix = settings["KeyPrefix"] ?? legacySettings["KeyPrefix"] ?? "nextbank:workflow:locks:";
if (database < -1) throw new InvalidOperationException("Workflow lock database must be -1 or a non-negative number.");
if (string.IsNullOrWhiteSpace(prefix)) throw new InvalidOperationException("Workflow lock KeyPrefix must not be empty.");
var connection = sp.GetRequiredService<IConnectionMultiplexer>();
return new PrefixedDistributedLockProvider(new RedisDistributedSynchronizationProvider(connection.GetDatabase(database)), prefix);
}
case "POSTGRES":
return new PostgresDistributedSynchronizationProvider(configuration.GetConnectionString("PostgreSql")!, options =>
{
options.KeepaliveCadence(TimeSpan.FromMinutes(5));
options.UseMultiplexing();
});
case "FILE":
return new FileDistributedSynchronizationProvider(new(Path.Combine(Directory.GetCurrentDirectory(), "App_Data", "locks")));
case null:
case "NOOP":
return new NoopDistributedSynchronizationProvider();
default:
throw new InvalidOperationException($"Unsupported workflow lock provider '{providerName}'. Configure Redis, File, Postgres or Noop.");
}
};
return runtime;
}
private sealed class PrefixedDistributedLockProvider(IDistributedLockProvider provider, string prefix) : IDistributedLockProvider
{
public IDistributedLock CreateLock(string name) => provider.CreateLock(prefix + name);
}
}
+6 -35
View File
@@ -3,7 +3,6 @@ using Elsa.Alterations.Extensions;
using Elsa.Alterations.MassTransit.Extensions;
using Elsa.Caching.Options;
using Elsa.Common.Codecs;
using Elsa.Common.DistributedHosting.DistributedLocks;
using Elsa.Common.RecurringTasks;
using Elsa.Common.Serialization;
using Elsa.Dapper.Extensions;
@@ -64,9 +63,6 @@ using Hangfire.PostgreSql.Factories;
using Hangfire.SqlServer;
using Hangfire.Storage.SQLite;
using JetBrains.Annotations;
using Medallion.Threading.FileSystem;
using Medallion.Threading.Postgres;
using Medallion.Threading.Redis;
using Microsoft.Extensions.Options;
using OpenTelemetry.Metrics;
using OpenTelemetry.Resources;
@@ -76,7 +72,6 @@ using Proto.Persistence.Sqlite;
using Proto.Persistence.SqlServer;
using Proto.Remote;
using Proto.Remote.GrpcNet;
using StackExchange.Redis;
// ReSharper disable RedundantAssignment
const PersistenceProvider persistenceProvider = PersistenceProvider.EntityFrameworkCore;
@@ -119,8 +114,6 @@ var cockroachDbConnectionString = configuration.GetConnectionString("CockroachDb
var mongoDbConnectionString = configuration.GetConnectionString("MongoDb")!;
var azureServiceBusConnectionString = configuration.GetConnectionString("AzureServiceBus")!;
var rabbitMqConnectionString = configuration.GetConnectionString("RabbitMq")!;
var redisConnectionString = configuration.GetConnectionString("Redis")!;
var distributedLockProviderName = configuration.GetSection("Runtime:DistributedLocking")["Provider"];
var appRole = Enum.Parse<ApplicationRole>(configuration["AppRole"] ?? "Default");
var sqlDatabaseProvider = Enum.Parse<SqlDatabaseProvider>(configuration["DatabaseProvider"] ?? "Sqlite");
@@ -164,10 +157,13 @@ if (useManualOtelInstrumentation)
}
// Add Elsa services.
services.AddWorkflowRedis(configuration);
services.AddScoped<IPropertyUIHandler, CustomCheckListOptionsProvider>();
services
.AddElsa(elsa =>
{
elsa.UseCaching(cache => cache.RegisterRedis());
if (persistenceProvider == PersistenceProvider.MongoDb)
elsa.UseMongoDb(mongoDbConnectionString);
@@ -324,7 +320,7 @@ services
management.UseMassTransitDispatcher();
if (useCaching)
management.UseCache();
management.UseCache(configuration.GetSection("Workflow:Cache"));
management.SetDefaultLogPersistenceMode(LogPersistenceMode.Inherit);
management.UseReadOnlyMode(useReadOnlyMode);
@@ -394,31 +390,7 @@ services
if (useCaching)
runtime.UseCache();
runtime.DistributedLockingOptions = options => configuration.GetSection("Runtime:DistributedLocking").Bind(options);
runtime.DistributedLockProvider = _ =>
{
switch (distributedLockProviderName)
{
case "Postgres":
return new PostgresDistributedSynchronizationProvider(postgresConnectionString, options =>
{
options.KeepaliveCadence(TimeSpan.FromMinutes(5));
options.UseMultiplexing();
});
case "Redis":
{
var connectionMultiplexer = ConnectionMultiplexer.Connect(redisConnectionString);
var database = connectionMultiplexer.GetDatabase();
return new RedisDistributedSynchronizationProvider(database);
}
case "File":
return new FileDistributedSynchronizationProvider(new(Path.Combine(Directory.GetCurrentDirectory(), "App_Data", "locks")));
case "Noop":
default:
return new NoopDistributedSynchronizationProvider();
}
};
runtime.UseConfiguredDistributedLocking(configuration);
})
.UseEnvironments(environments => environments.EnvironmentsOptions = options => configuration.GetSection("Environments").Bind(options))
.UseScheduling(scheduling =>
@@ -758,7 +730,6 @@ services.Configure<RecurringTaskOptions>(options =>
services.Configure<RuntimeOptions>(options => { options.InactivityThreshold = TimeSpan.FromSeconds(15); });
services.Configure<BookmarkQueuePurgeOptions>(options => options.Ttl = TimeSpan.FromSeconds(10));
services.Configure<CachingOptions>(options => options.CacheDuration = TimeSpan.FromDays(1));
services.Configure<IncidentOptions>(options => options.DefaultIncidentStrategy = typeof(ContinueWithIncidentsStrategy));
services.AddHealthChecks();
services.AddControllers();
@@ -825,4 +796,4 @@ public partial class Program
/// Set by the test runner to configure the module for testing.
/// </summary>
public static Action<IModule>? ConfigureForTest { get; set; }
}
}
@@ -0,0 +1,31 @@
{
"Redis": {
"AllowAdmin": true,
"Ssl": false,
"ConnectTimeout": 5000,
"ConnectRetry": 2,
"Database": 1,
"ServiceName": "",
"Hosts": [
{ "Host": "localhost", "Port": 6379 }
]
},
"Workflow": {
"Cache": {
"Enabled": true,
"Provider": "Redis",
"Duration": "1.00:00:00",
"Redis": {
"Database": 1,
"KeyPrefix": "nextbank:workflow:cache:"
}
},
"Runtime": {
"DistributedLocking": {
"Provider": "Redis",
"Database": 1,
"KeyPrefix": "nextbank:workflow:locks:"
}
}
}
}
+2 -2
View File
@@ -40,8 +40,8 @@
"Sqlite": "", //"Data Source=App_Data/elsa.sqlite.db;Cache=Shared;",
//"SqlServer": "Server=localhost,1433;Initial Catalog=Elsa;User=sa;Password=!Elsa2025@;Encrypt=false;PersistSecurityInfo=false",
//"SqlServer": "Server=.;Database=CaspianWfDb;User Id=sa;Password=123456;TrustServerCertificate=True;",
//"SqlServer": "Server=.;Database=Workflow_Db;User Id=sa;Password=123456;TrustServerCertificate=True;",
"SqlServer": "Server=192.168.251.161;Database=Workflow_Db;User Id=sa;Password=cLL{3N29D@n2;MultipleActiveResultSets=true;TrustServerCertificate=True",
"SqlServer": "Server=.;Database=WfLive;User Id=sa;Password=123456;TrustServerCertificate=True;",
//"SqlServer": "Server=192.168.251.161;Database=Workflow_Db;User Id=sa;Password=cLL{3N29D@n2;MultipleActiveResultSets=true;TrustServerCertificate=True",
"MySql": "", //"Server=localhost;Database=elsa;Uid=admin;Pwd=password;",
"PostgreSql": "", //"Server=localhost;Username=elsa;Database=elsa;Port=5432;Password=elsa;SSLMode=Prefer;MaxPoolSize=2000;Timeout=60",
"Citus": "", //"Server=localhost;Username=citus;Database=citus;Port=9700;Password=citus;SSLMode=Prefer;MaxPoolSize=2000;Timeout=60",
@@ -39,7 +39,8 @@
"Sqlite": "", //"Data Source=elsa.sqlite.db;Cache=Shared;",
"RabbitMq": "", //"rabbitmq://guest:guest@localhost:5672",
"MySql": "", //"Server=localhost;Database=elsa;Uid=user;Pwd=password;",
"SqlServer": "Server=.;Database=WfDb;User Id=sa;Password=123456;TrustServerCertificate=True;",
//"SqlServer": "Server=.;Database=WfDb;User Id=sa;Password=123456;TrustServerCertificate=True;",
"SqlServer": "Server=192.168.251.161;Database=Workflow_Db;User Id=sa;Password=cLL{3N29D@n2;MultipleActiveResultSets=true;TrustServerCertificate=True",
"PostgreSql": "" //"Server=localhost;Username=elsa;Database=elsa;Port=5432;Password=elsa;SSLMode=Prefer;MaxPoolSize=2000;Timeout=60"
},
"DatabaseProvider": "SqlServer", //"Sqlite",
+1 -1
View File
@@ -18,7 +18,7 @@ if (!app.Environment.IsDevelopment())
app.UseHsts();
}
app.UseHttpsRedirection();
//app.UseHttpsRedirection();
app.UseBlazorFrameworkFiles();
app.UseRouting();
app.UseStaticFiles();
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Api.Client</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides HTTP clients for the Elsa Workflows REST API.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Api.Common</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides common features to modules that expose API endpoints.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.DropIns.Core</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Reference this package when developing drop-ins for Elsa Workflows.
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.DropIns</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides drop-in features for Elsa workflows.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Features</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides utilities to turn your class library into a module that provides features.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Mediator</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides a mediator service inspired by MediatR.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Testing.Shared.Component</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides common utilities that are helpful when writing component tests against Elsa Workflows functionality.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Testing.Shared.Integration</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides common utilities that are helpful when writing integration tests against Elsa Workflows functionality.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Testing.Shared</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides common utilities that are helpful when writing tests against Elsa Workflows functionality.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Alterations.Core</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides core interfaces, models and services that support the alteration engine.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Alterations.MassTransit</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides alteration background job runners using MassTransit.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Alterations</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides alterations for workflow instances.
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.CSharp</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides a CSharp expression provider.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Caching.Distributed.MassTransit</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides distributed caching services leveraging MassTransit for transport of signals.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Caching.Distributed.ProtoActor</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides distributed caching services leveraging Proto.Actor for transport of signals.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Caching.Distributed</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides distributed caching services and utility functions common to Elsa modules.
@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<PackageId>Caspian.Elsa.Caching.Redis</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Bundles the most commonly-used packages when building an Elsa workflows application.
</Description>
<RootNamespace>Elsa</RootNamespace>
<PackageTags>elsa bundle</PackageTags>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\Elsa.Caching\Elsa.Caching.csproj" />
<ProjectReference Include="..\Elsa.Workflows.Core\Elsa.Workflows.Core.csproj" />
<PackageReference Include="StackExchange.Redis" />
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
</ItemGroup>
</Project>
@@ -0,0 +1,31 @@
using Elsa.Caching.Features;
using Elsa.Caching.Redis.Features;
using Elsa.Caching.Redis.Options;
using Elsa.Caching.Redis.Services;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
namespace Elsa.Extensions;
public static class RedisCacheFeatureExtensions
{
public static CacheFeature RegisterRedis(this CacheFeature cache)
=> cache.RegisterProvider("Redis", section => cache.UseRedis(options => { if (section != null) section.Bind(options); }));
public static CacheFeature UseRedis(this CacheFeature cache, Action<RedisCacheOptions>? configure = null)
{
cache.Module.Configure<RedisCacheFeature>(redis =>
{
// Bind first; explicit property assignments then override individual settings.
cache.Configuration?.GetSection("Redis").Bind(redis.Options);
configure?.Invoke(redis.Options);
});
return cache.SelectProvider("Redis", sp => sp.GetRequiredService<RedisCacheProvider>());
}
public static T UseRedis<T>(this T feature, Action<RedisCacheOptions>? configure = null) where T : CacheConsumerFeature
{
feature.Cache.UseRedis(configure);
return feature;
}
}
@@ -0,0 +1,33 @@
using Elsa.Caching.Features;
using Elsa.Caching.Redis.Options;
using Elsa.Caching.Redis.Services;
using Elsa.Features.Abstractions;
using Elsa.Features.Attributes;
using Elsa.Features.Services;
using Microsoft.Extensions.DependencyInjection;
using StackExchange.Redis;
namespace Elsa.Caching.Redis.Features;
[DependsOn(typeof(CacheFeature))]
public class RedisCacheFeature(IModule module) : FeatureBase(module)
{
public RedisCacheOptions Options { get; } = new();
public override void Apply()
{
if (Options.Database < -1) throw new InvalidOperationException("Redis cache database must be -1 or a non-negative number.");
if (string.IsNullOrWhiteSpace(Options.KeyPrefix)) throw new InvalidOperationException("Redis cache KeyPrefix must not be empty.");
Services.AddSingleton(Options);
if (!Options.HasExplicitConnectionFactory && !string.IsNullOrWhiteSpace(Options.ConnectionString))
{
Services.AddSingleton<OwnedRedisCacheConnection>(_ => new(ConnectionMultiplexer.Connect(Options.ConnectionString)));
Options.ConnectionFactory = sp => sp.GetRequiredService<OwnedRedisCacheConnection>().Connection;
}
Services.AddSingleton<RedisCacheProvider>();
}
private sealed class OwnedRedisCacheConnection(IConnectionMultiplexer connection) : IDisposable
{
public IConnectionMultiplexer Connection => connection;
public void Dispose() => connection.Dispose();
}
}
@@ -0,0 +1,3 @@
<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
<ConfigureAwait />
</Weavers>
@@ -0,0 +1,20 @@
using StackExchange.Redis;
namespace Elsa.Caching.Redis.Options;
public class RedisCacheOptions
{
/// <summary>Uses the host's singleton connection by default. The cache does not dispose host connections.</summary>
private Func<IServiceProvider, IConnectionMultiplexer> _connectionFactory
= sp => (IConnectionMultiplexer)(sp.GetService(typeof(IConnectionMultiplexer))
?? throw new InvalidOperationException("Register IConnectionMultiplexer or configure Redis ConnectionFactory/ConnectionString."));
internal bool HasExplicitConnectionFactory { get; private set; }
public Func<IServiceProvider, IConnectionMultiplexer> ConnectionFactory
{
get => _connectionFactory;
set { _connectionFactory = value ?? throw new ArgumentNullException(nameof(value)); HasExplicitConnectionFactory = true; }
}
public string? ConnectionString { get; set; }
public int Database { get; set; } = -1;
public string KeyPrefix { get; set; } = "nextbank:workflow:cache:";
}
@@ -0,0 +1,80 @@
using System.Text.Json;
using Elsa.Caching.Models;
using Elsa.Caching.Redis.Options;
using Elsa.Workflows;
using Microsoft.Extensions.Logging;
using StackExchange.Redis;
namespace Elsa.Caching.Redis.Services;
/// <summary>Stores serializable payloads only. Redis failures bypass caching; never fall back to local payloads.</summary>
public class RedisCacheProvider(IServiceProvider services, RedisCacheOptions options, IPayloadSerializer serializer,
ILogger<RedisCacheProvider> logger) : ICacheProvider
{
public bool IsShared => true;
private IDatabase Database => options.ConnectionFactory(services).GetDatabase(options.Database);
private string Key(string key) => options.KeyPrefix + key;
private const string ReadScript = """
local payload = redis.call('HGET', KEYS[1], 'payload')
if not payload then return false end
local slide = tonumber(redis.call('HGET', KEYS[1], 'slide')) or 0
local deadline = tonumber(redis.call('HGET', KEYS[1], 'deadline')) or 0
if slide > 0 then
local ttl = slide
if deadline > 0 then
local t = redis.call('TIME')
ttl = math.min(ttl, deadline - (tonumber(t[1])*1000 + math.floor(tonumber(t[2])/1000)))
end
if ttl <= 0 then redis.call('DEL', KEYS[1]); return false end
redis.call('PEXPIRE', KEYS[1], ttl)
end
return payload
""";
private const string WriteScript = """
local absolute = tonumber(ARGV[2])
local slide = tonumber(ARGV[3])
local ttl = absolute
if ttl <= 0 or (slide > 0 and slide < ttl) then ttl = slide end
local deadline = 0
if absolute > 0 then
local t = redis.call('TIME')
deadline = tonumber(t[1])*1000 + math.floor(tonumber(t[2])/1000) + absolute
end
redis.call('HSET', KEYS[1], 'payload', ARGV[1], 'slide', slide, 'deadline', deadline)
redis.call('PEXPIRE', KEYS[1], ttl)
return 1
""";
public async Task<CacheResult<T>> GetAsync<T>(string key, CancellationToken cancellationToken = default)
{
cancellationToken.ThrowIfCancellationRequested();
try
{
var data = await Database.ScriptEvaluateAsync(ReadScript, new RedisKey[] { Key(key) }).WaitAsync(cancellationToken);
if (data.IsNull) return new(false, default);
return new(true, JsonSerializer.Deserialize<T>((string)data!, serializer.GetOptions()));
}
catch (RedisException ex) { logger.LogWarning(ex, "Redis workflow cache read failed; using the persistent store."); return new(false, default); }
catch (JsonException ex) { logger.LogWarning(ex, "Invalid Redis workflow cache payload; rebuilding the entry."); return new(false, default); }
}
public async Task SetAsync<T>(string key, T? value, CacheEntryOptions entryOptions, CancellationToken cancellationToken = default)
{
var absolute = Milliseconds(entryOptions.AbsoluteExpirationRelativeToNow);
var sliding = Milliseconds(entryOptions.SlidingExpiration);
if (absolute <= 0 && sliding <= 0) throw new ArgumentException("A Redis cache entry must have a positive lifetime.");
var data = JsonSerializer.Serialize(value, serializer.GetOptions());
try
{
await Database.ScriptEvaluateAsync(WriteScript, new RedisKey[] { Key(key) }, new RedisValue[] { data, absolute, sliding }).WaitAsync(cancellationToken);
}
catch (RedisException ex) { logger.LogWarning(ex, "Redis workflow cache write failed; the SQL revision remains authoritative."); }
}
public async Task RemoveAsync(string key, CancellationToken cancellationToken = default)
{
try { await Database.KeyDeleteAsync(Key(key)).WaitAsync(cancellationToken); }
catch (RedisException ex) { logger.LogWarning(ex, "Redis workflow cache removal failed."); }
}
private static long Milliseconds(TimeSpan? duration) => duration.HasValue ? Math.Max(1, (long)duration.Value.TotalMilliseconds) : 0;
}
@@ -0,0 +1,15 @@
namespace Elsa.Caching;
/// <summary>
/// Authoritative cache revision and durable write fences. A pending mutation disables cache reads and writes.
/// Shared providers require a durable store shared by every node, independently of the cache payload storage.
/// </summary>
public interface ICacheConsistencyStore
{
bool IsDurable { get; }
Task<CacheConsistencyState> ReadAsync(CancellationToken cancellationToken = default);
Task<string> BeginMutationAsync(CancellationToken cancellationToken = default, string scope = "workflow");
Task CompleteMutationAsync(string mutationId, CancellationToken cancellationToken = default);
}
public record CacheConsistencyState(string Revision, bool HasPendingMutations, string? RouteRevision = null, bool HasPendingRouteMutations = false);
@@ -10,6 +10,21 @@ namespace Elsa.Caching;
/// </summary>
public interface ICacheManager
{
bool IsShared => false;
bool IsEnabled => true;
Task<string> BeginMutationAsync(CancellationToken cancellationToken = default) => Task.FromResult(string.Empty);
Task<string> BeginRouteMutationAsync(CancellationToken cancellationToken = default) => BeginMutationAsync(cancellationToken);
Task CompleteMutationAsync(string id, CancellationToken cancellationToken = default) => Task.CompletedTask;
Task<CacheConsistencyState> GetConsistencyStateAsync(CancellationToken cancellationToken = default)
=> Task.FromResult(new CacheConsistencyState("0", false));
Task<T?> GetOrCreateAsync<T>(string key, Func<Task<T>> factory, Elsa.Caching.Models.CacheEntryOptions options, CancellationToken cancellationToken = default)
=> GetOrCreateAsync(key, entry =>
{
entry.AbsoluteExpirationRelativeToNow = options.AbsoluteExpirationRelativeToNow;
entry.SlidingExpiration = options.SlidingExpiration;
foreach (var tag in options.Tags) entry.ExpirationTokens.Add(GetToken(tag));
return factory();
});
/// <summary>
/// Provides options for configuring caching.
/// </summary>
@@ -29,4 +44,10 @@ public interface ICacheManager
/// Gets an item from the cache, or creates it if it doesn't exist.
/// </summary>
Task<TItem?> GetOrCreateAsync<TItem>(object key, Func<ICacheEntry, Task<TItem>> factory);
}
/// <summary>
/// remove an item from the cache
/// </summary>
/// <param name="key"></param>
void Remove(string key);
}
@@ -0,0 +1,14 @@
using Elsa.Caching.Models;
namespace Elsa.Caching;
/// <summary>Storage for cache entries. Implementations must distinguish a miss from a cached null.</summary>
public interface ICacheProvider
{
bool IsShared { get; }
Task<CacheResult<T>> GetAsync<T>(string key, CancellationToken cancellationToken = default);
Task SetAsync<T>(string key, T? value, CacheEntryOptions options, CancellationToken cancellationToken = default);
Task RemoveAsync(string key, CancellationToken cancellationToken = default);
}
public record CacheResult<T>(bool Found, T? Value);
+4 -2
View File
@@ -1,10 +1,10 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<PackageId>Caspian.Elsa.Caching</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides caching services and utility functions common to Elsa modules.
@@ -19,6 +19,8 @@
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Caching.Memory" />
<PackageReference Include="Scrutor" />
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
</ItemGroup>
</Project>
@@ -0,0 +1,13 @@
using Elsa.Caching.Features;
using Elsa.Features.Services;
namespace Elsa.Extensions;
public static class CacheFeatureExtensions
{
public static IModule UseCaching(this IModule module, Action<CacheFeature>? configure = null)
{
module.Configure(configure);
return module;
}
}
@@ -0,0 +1,34 @@
using Elsa.Caching;
namespace Elsa.Extensions;
public static class CacheMutationExtensions
{
public static async Task MutateRoutesAsync(this ICacheManager cache, Func<Task> operation, CancellationToken cancellationToken = default)
{
var id = await cache.BeginRouteMutationAsync(cancellationToken);
await operation();
await cache.CompleteMutationAsync(id, CancellationToken.None);
}
public static async Task<T> MutateRoutesAsync<T>(this ICacheManager cache, Func<Task<T>> operation, CancellationToken cancellationToken = default)
{
var id = await cache.BeginRouteMutationAsync(cancellationToken);
var value = await operation();
await cache.CompleteMutationAsync(id, CancellationToken.None);
return value;
}
public static async Task MutateAsync(this ICacheManager cache, Func<Task> operation, CancellationToken cancellationToken = default)
{
var id = await cache.BeginMutationAsync(cancellationToken);
await operation();
// Once SQL has committed, request cancellation must not leave a fence unfinished.
await cache.CompleteMutationAsync(id, CancellationToken.None);
}
public static async Task<T> MutateAsync<T>(this ICacheManager cache, Func<Task<T>> operation, CancellationToken cancellationToken = default)
{
var id = await cache.BeginMutationAsync(cancellationToken);
var value = await operation();
await cache.CompleteMutationAsync(id, CancellationToken.None);
return value;
}
}
@@ -0,0 +1,14 @@
using Elsa.Features.Abstractions;
using Elsa.Features.Services;
namespace Elsa.Caching.Features;
/// <summary>Common configuration entry point for workflow cache consumers.</summary>
public abstract class CacheConsumerFeature(IModule module) : FeatureBase(module)
{
public CacheFeature Cache => Module.Configure<CacheFeature>();
public bool Enabled { get => Cache.Enabled; set => Cache.Enabled = value; }
public TimeSpan Duration { get => Cache.Duration; set => Cache.Duration = value; }
public void UseMemory() => Cache.UseMemory();
public void UseConfiguration(Microsoft.Extensions.Configuration.IConfigurationSection section) => Cache.UseConfiguration(section);
}
@@ -0,0 +1,80 @@
using Elsa.Caching.Services;
using Elsa.Caching.Options;
using Elsa.Features.Abstractions;
using Elsa.Features.Attributes;
using Elsa.Features.Services;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
namespace Elsa.Caching.Features;
/// <summary>Configures one provider for the entire Elsa module.</summary>
[DependsOn(typeof(MemoryCacheFeature))]
public class CacheFeature(IModule module) : FeatureBase(module)
{
private readonly Dictionary<string, Action<IConfigurationSection?>> _providers = new(StringComparer.OrdinalIgnoreCase);
private string? _explicitProvider;
private bool _selectingConfiguration;
public bool Enabled { get; set; } = true;
public TimeSpan Duration { get; set; } = TimeSpan.FromMinutes(1);
public Func<IServiceProvider, ICacheProvider> Provider { get; private set; } = sp => sp.GetRequiredService<MemoryCacheProvider>();
public Func<IServiceProvider, ICacheConsistencyStore> ConsistencyStore { get; set; } = sp => sp.GetRequiredService<MemoryCacheConsistencyStore>();
public CacheFeature RegisterProvider(string name, Action<IConfigurationSection?> configure)
{
_providers[name] = configure;
return this;
}
public CacheFeature SelectProvider(string name, Func<IServiceProvider, ICacheProvider> factory)
{
if (_explicitProvider != null && !string.Equals(_explicitProvider, name, StringComparison.OrdinalIgnoreCase))
throw new InvalidOperationException($"Conflicting Elsa cache providers: '{_explicitProvider}' and '{name}'. Select one provider per module.");
if (!_selectingConfiguration) _explicitProvider = name;
Provider = factory;
return this;
}
public CacheFeature UseMemory() => SelectProvider("Memory", sp => sp.GetRequiredService<MemoryCacheProvider>());
public CacheFeature UseConfiguration(IConfigurationSection section)
{
if (section["Enabled"] is { } enabledValue)
Enabled = bool.TryParse(enabledValue, out var enabled) ? enabled
: throw new InvalidOperationException("Workflow cache Enabled must be true or false.");
if (section["Duration"] is { } durationValue)
Duration = TimeSpan.TryParse(durationValue, out var duration) ? duration
: throw new InvalidOperationException("Workflow cache Duration must be a valid TimeSpan.");
Configuration = section;
var name = section["Provider"] ?? "Memory";
if (_explicitProvider == null)
{
_selectingConfiguration = true;
try
{
if (name.Equals("Memory", StringComparison.OrdinalIgnoreCase)) UseMemory();
else if (_providers.TryGetValue(name, out var select)) select(section.GetSection(name));
else throw new InvalidOperationException($"Elsa cache provider '{name}' is not registered.");
}
finally { _selectingConfiguration = false; }
}
Configuration = section;
return this;
}
public IConfigurationSection? Configuration { get; private set; }
public override void Apply()
{
if (Duration <= TimeSpan.Zero) throw new InvalidOperationException("Elsa cache duration must be positive.");
Services.Configure<CachingOptions>(options => options.CacheDuration = Duration);
Services.AddSingleton(Provider);
Services.AddSingleton(ConsistencyStore);
Services.AddSingleton(this);
Services.AddSingleton<ICacheManager>(sp =>
{
if (sp.GetRequiredService<ICacheProvider>().IsShared && !sp.GetRequiredService<ICacheConsistencyStore>().IsDurable)
throw new InvalidOperationException("Shared Elsa caching requires a durable ICacheConsistencyStore. Configure the EF Core consistency store.");
return ActivatorUtilities.CreateInstance<ProviderCacheManager>(sp);
});
}
}
@@ -3,6 +3,7 @@ using Elsa.Caching.Services;
using Elsa.Features.Abstractions;
using Elsa.Features.Services;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
namespace Elsa.Caching.Features;
@@ -23,9 +24,12 @@ public class MemoryCacheFeature(IModule module) : FeatureBase(module)
Services
.AddMemoryCache()
.AddSingleton<ICacheManager, CacheManager>()
.AddSingleton<IChangeTokenSignalInvoker, ChangeTokenSignalInvoker>()
.AddSingleton<IChangeTokenSignaler, ChangeTokenSignaler>()
;
// Keep local script/template caches independent of the workflow provider.
Services.TryAddSingleton<MemoryCacheProvider>();
Services.TryAddSingleton<MemoryCacheConsistencyStore>();
Services.TryAddSingleton<ICacheManager, CacheManager>();
}
}
}
@@ -0,0 +1,9 @@
namespace Elsa.Caching.Models;
/// <summary>Provider-independent lifetime and invalidation dependencies.</summary>
public class CacheEntryOptions
{
public TimeSpan? AbsoluteExpirationRelativeToNow { get; set; }
public TimeSpan? SlidingExpiration { get; set; }
public ICollection<string> Tags { get; } = new List<string>();
}
@@ -22,10 +22,17 @@ public class CacheManager(IMemoryCache memoryCache, IChangeTokenSignaler changeT
{
return changeTokenSignaler.TriggerTokenAsync(key, cancellationToken);
}
/// <inheritdoc />
public async Task<TItem?> GetOrCreateAsync<TItem>(object key, Func<ICacheEntry, Task<TItem>> factory)
{
return await memoryCache.GetOrCreateAsync(key, async entry => await factory(entry));
var result = await memoryCache.GetOrCreateAsync(key, async entry => await factory(entry));
return result;
}
/// <inheritdoc />
public void Remove(string key)
{
memoryCache.Remove(key);
}
}
@@ -0,0 +1,34 @@
namespace Elsa.Caching.Services;
public class MemoryCacheConsistencyStore : ICacheConsistencyStore
{
private readonly object _sync = new();
private readonly Dictionary<string, string> _pending = new();
private long _revision;
private long _routeRevision;
public bool IsDurable => false;
public Task<CacheConsistencyState> ReadAsync(CancellationToken cancellationToken = default)
{
lock (_sync) return Task.FromResult(new CacheConsistencyState(_revision.ToString(), _pending.Values.Any(x => x == "workflow"), _routeRevision.ToString(), _pending.Count != 0));
}
public Task<string> BeginMutationAsync(CancellationToken cancellationToken = default, string scope = "workflow")
{
lock (_sync)
{
var id = Guid.NewGuid().ToString("N");
_pending.Add(id, scope);
if (scope == "workflow") _revision++;
_routeRevision++;
return Task.FromResult(id);
}
}
public Task CompleteMutationAsync(string mutationId, CancellationToken cancellationToken = default)
{
lock (_sync)
{
if (_pending.Remove(mutationId, out var scope) && scope == "workflow") _revision++;
_routeRevision++;
}
return Task.CompletedTask;
}
}
@@ -0,0 +1,32 @@
using Elsa.Caching.Models;
using Microsoft.Extensions.Caching.Memory;
namespace Elsa.Caching.Services;
public class MemoryCacheProvider(IMemoryCache cache, IChangeTokenSignaler signaler) : ICacheProvider
{
public bool IsShared => false;
public Task<CacheResult<T>> GetAsync<T>(string key, CancellationToken cancellationToken = default)
{
var found = cache.TryGetValue(key, out T? value);
return Task.FromResult(new CacheResult<T>(found, value));
}
public Task SetAsync<T>(string key, T? value, CacheEntryOptions options, CancellationToken cancellationToken = default)
{
var memoryOptions = new MemoryCacheEntryOptions
{
AbsoluteExpirationRelativeToNow = options.AbsoluteExpirationRelativeToNow,
SlidingExpiration = options.SlidingExpiration
};
foreach (var tag in options.Tags) memoryOptions.AddExpirationToken(signaler.GetToken(tag));
cache.Set(key, value, memoryOptions);
return Task.CompletedTask;
}
public Task RemoveAsync(string key, CancellationToken cancellationToken = default)
{
cache.Remove(key);
return Task.CompletedTask;
}
}
@@ -0,0 +1,122 @@
using System.Security.Cryptography;
using System.Text;
using System.Transactions;
using Elsa.Caching.Features;
using Elsa.Caching.Models;
using Elsa.Caching.Options;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.Primitives;
using Microsoft.Extensions.Logging;
namespace Elsa.Caching.Services;
/// <summary>Coordinates cache payloads using an authoritative revision, independent of the provider.</summary>
public class ProviderCacheManager(ICacheProvider provider, ICacheConsistencyStore consistency,
IChangeTokenSignaler signaler, IOptions<CachingOptions> options, CacheFeature feature, IMemoryCache memoryCache,
ILogger<ProviderCacheManager> logger) : ICacheManager
{
public IOptions<CachingOptions> CachingOptions => options;
public bool IsShared => provider.IsShared;
public bool IsEnabled => feature.Enabled;
public IChangeToken GetToken(string key) => signaler.GetToken(key);
public Task<CacheConsistencyState> GetConsistencyStateAsync(CancellationToken cancellationToken = default) => consistency.ReadAsync(cancellationToken);
public async Task<string> BeginMutationAsync(CancellationToken cancellationToken = default)
=> await BeginMutationCoreAsync("workflow", cancellationToken);
public Task<string> BeginRouteMutationAsync(CancellationToken cancellationToken = default)
=> BeginMutationCoreAsync("routes", cancellationToken);
public async Task CompleteMutationAsync(string id, CancellationToken cancellationToken = default)
{
// Begin registered the transaction-completed callback. Do not close a fence before the outer commit.
if (Transaction.Current != null) return;
await consistency.CompleteMutationAsync(id, cancellationToken);
}
private async Task<string> BeginMutationCoreAsync(string scope, CancellationToken cancellationToken)
{
var transaction = Transaction.Current;
string id;
using (new TransactionScope(TransactionScopeOption.Suppress, TransactionScopeAsyncFlowOption.Enabled))
id = await consistency.BeginMutationAsync(cancellationToken, scope);
if (transaction != null)
{
void CompleteAfterTransaction(TransactionStatus status)
{
if (status is not (TransactionStatus.Committed or TransactionStatus.Aborted)) return;
try
{
using var suppressed = new TransactionScope(TransactionScopeOption.Suppress, TransactionScopeAsyncFlowOption.Enabled);
consistency.CompleteMutationAsync(id, CancellationToken.None).GetAwaiter().GetResult();
}
catch (Exception ex) { logger.LogError(ex, "Workflow cache mutation {MutationId} remains pending after transaction completion.", id); }
}
transaction.TransactionCompleted += (_, args) => CompleteAfterTransaction(args.Transaction!.TransactionInformation.Status);
if (transaction.TransactionInformation.Status != TransactionStatus.Active)
CompleteAfterTransaction(transaction.TransactionInformation.Status);
}
return id;
}
public async ValueTask TriggerTokenAsync(string key, CancellationToken cancellationToken = default)
{
var id = await BeginMutationAsync(cancellationToken);
await CompleteMutationAsync(id, cancellationToken);
await signaler.TriggerTokenAsync(key, cancellationToken);
}
public async Task<TItem?> GetOrCreateAsync<TItem>(object key, Func<ICacheEntry, Task<TItem>> factory)
{
if (Transaction.Current != null) { using var transactionEntry = new CompatibilityCacheEntry(key); return await factory(transactionEntry); }
if (!feature.Enabled) { using var uncached = new CompatibilityCacheEntry(key); return await factory(uncached); }
if (!IsShared) return await memoryCache.GetOrCreateAsync(key, factory);
// Compatibility entry for older extensions. New consumers use CacheEntryOptions.
using var entry = new CompatibilityCacheEntry(key);
return await GetOrCreateAsync(key.ToString()!, () => factory(entry), entry.Options);
}
public async Task<T?> GetOrCreateAsync<T>(string key, Func<Task<T>> factory, CacheEntryOptions entryOptions, CancellationToken cancellationToken = default)
{
if (!feature.Enabled || Transaction.Current != null) return await factory();
if (IsShared && !consistency.IsDurable)
throw new InvalidOperationException("Shared Elsa caching requires a durable ICacheConsistencyStore. Configure the EF Core consistency store.");
var before = await consistency.ReadAsync(cancellationToken);
if (before.HasPendingMutations) return await factory();
var storageKey = CreateKey<T>(key, before.Revision);
var cached = await provider.GetAsync<T>(storageKey, cancellationToken);
if (cached.Found) return cached.Value;
var value = await factory();
var after = await consistency.ReadAsync(cancellationToken);
if (!after.HasPendingMutations && after.Revision == before.Revision)
{
if (entryOptions.AbsoluteExpirationRelativeToNow == null && entryOptions.SlidingExpiration == null)
entryOptions.AbsoluteExpirationRelativeToNow = options.Value.CacheDuration;
await provider.SetAsync(storageKey, value, entryOptions, cancellationToken);
}
return value;
}
public void Remove(string key) => TriggerTokenAsync(key).AsTask().GetAwaiter().GetResult();
private static string CreateKey<T>(string key, string revision)
=> $"v1:{revision}:" + Convert.ToHexString(SHA256.HashData(Encoding.UTF8.GetBytes($"{typeof(T).FullName}:{key}")));
private sealed class CompatibilityCacheEntry(object key) : ICacheEntry
{
public CacheEntryOptions Options { get; } = new();
public object Key => key;
public object? Value { get; set; }
private DateTimeOffset? _absoluteExpiration;
public DateTimeOffset? AbsoluteExpiration
{
get => _absoluteExpiration;
set { _absoluteExpiration = value; Options.AbsoluteExpirationRelativeToNow = value - DateTimeOffset.UtcNow; }
}
public TimeSpan? AbsoluteExpirationRelativeToNow { get => Options.AbsoluteExpirationRelativeToNow; set => Options.AbsoluteExpirationRelativeToNow = value; }
public TimeSpan? SlidingExpiration { get => Options.SlidingExpiration; set => Options.SlidingExpiration = value; }
public IList<IChangeToken> ExpirationTokens { get; } = new List<IChangeToken>();
public IList<PostEvictionCallbackRegistration> PostEvictionCallbacks { get; } = new List<PostEvictionCallbackRegistration>();
public CacheItemPriority Priority { get; set; }
public long? Size { get; set; }
public void Dispose() { }
}
}
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Common</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides services and utility functions common to Elsa modules.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Api</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides Activity Connection API endpoints</Description>
<PackageTags>elsa module activity connection abstraction api</PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Core</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides an connection framework to use connection abtraction in activities</Description>
<PackageTags>elsa module connection abstratction</PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Models</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides models that can be shared between the API and API clients</Description>
<PackageTags>elsa module connections api</PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Persistence.EntityFrameworkCore.Sqlite</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides an EF Core migrations for SQLite for the Connection Persistence module.</Description>
<PackageTags>elsa module persistence efcore entity framework core sqlite</PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Persistence.EntityFrameworkCore</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides an Entity Framework Core provider for the persistence layer of the Connection module</Description>
<PackageTags>elsa connection persistence efcore entity framework core</PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Connections.Persistence</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>Provides Connections persistence services</Description>
<PackageTags>elsa module connections persistence </PackageTags>
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Dapper.Migrations</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Dapper migrations for Dapper perisstence providers from various modules.
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Dapper</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Dapper implementations of various persistence abstractions from various modules.
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Dsl</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides a custom DSL to write workflows with in a syntax similar to JavaScript but with native keywords translating to workflow functionality.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Elasticsearch</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Elasticsearch implementation for workflow state persistence.
+1 -1
View File
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Email</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides a SendEmail activity that lets you send emails from a workflow.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.Common</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides common Entity Framework Core types for implementing EF Core persistence of varipus ELsa modules.
@@ -5,7 +5,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.MySql</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides MySQL EF Core migrations for various modules.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.Oracle</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Oracle EF Core migrations for various modules.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.PostgreSql</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides PostgreSQL EF Core migrations for various modules.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.SqlServer</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides SQL Server EF Core migrations for various modules.
@@ -0,0 +1,26 @@
using Elsa.EntityFrameworkCore.Modules.Management;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
namespace Elsa.EntityFrameworkCore.SqlServer.Migrations.Management;
[DbContext(typeof(ManagementElsaDbContext))]
[Migration("20261007000000_AddCacheMutationFences")]
public class AddCacheMutationFences : Migration
{
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.CreateTable("CacheMutations", schema: "Elsa", columns: table => new
{
Id = table.Column<long>(nullable: false).Annotation("SqlServer:Identity", "1, 1"),
MutationId = table.Column<string>(maxLength: 32, nullable: false),
Scope = table.Column<string>(maxLength: 32, nullable: false),
OwnerInstance = table.Column<string>(maxLength: 256, nullable: false),
IsCompleted = table.Column<bool>(nullable: false),
CreatedAt = table.Column<DateTimeOffset>(nullable: false)
}, constraints: table => table.PrimaryKey("PK_CacheMutations", x => x.Id));
migrationBuilder.CreateIndex("IX_CacheMutations_MutationId", "CacheMutations", "MutationId", "Elsa", unique: true);
migrationBuilder.CreateIndex("IX_CacheMutations_IsCompleted", "CacheMutations", "IsCompleted", "Elsa");
}
protected override void Down(MigrationBuilder migrationBuilder) => migrationBuilder.DropTable("CacheMutations", "Elsa");
}
@@ -1,4 +1,4 @@
// <auto-generated />
// <auto-generated />
using System;
using Elsa.EntityFrameworkCore.Modules.Management;
using Microsoft.EntityFrameworkCore;
@@ -23,6 +23,21 @@ namespace Elsa.EntityFrameworkCore.SqlServer.Migrations.Management
SqlServerModelBuilderExtensions.UseIdentityColumns(modelBuilder);
modelBuilder.Entity("Elsa.EntityFrameworkCore.Modules.Management.CacheMutation", b =>
{
b.Property<long>("Id").ValueGeneratedOnAdd().HasColumnType("bigint");
SqlServerPropertyBuilderExtensions.UseIdentityColumn(b.Property<long>("Id"));
b.Property<string>("MutationId").IsRequired().HasMaxLength(32).HasColumnType("nvarchar(32)");
b.Property<string>("Scope").IsRequired().HasMaxLength(32).HasColumnType("nvarchar(32)");
b.Property<string>("OwnerInstance").IsRequired().HasMaxLength(256).HasColumnType("nvarchar(256)");
b.Property<bool>("IsCompleted").HasColumnType("bit");
b.Property<DateTimeOffset>("CreatedAt").HasColumnType("datetimeoffset");
b.HasKey("Id");
b.HasIndex("MutationId").IsUnique();
b.HasIndex("IsCompleted");
b.ToTable("CacheMutations", "Elsa");
});
modelBuilder.Entity("Elsa.Workflows.Management.Entities.WorkflowDefinition", b =>
{
b.Property<string>("Id")
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore.Sqlite</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides SQLite EF Core migrations for various modules.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.EntityFrameworkCore</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Entity Framework Core implementations of various abstractions from various modules.
@@ -0,0 +1,13 @@
namespace Elsa.EntityFrameworkCore.Modules.Management;
/// <summary>Durable write fence. Pending records must never expire automatically.</summary>
public class CacheMutation
{
public static string CurrentOwnerInstance { get; } = $"{Environment.MachineName}:{Environment.ProcessId}:{Guid.NewGuid():N}";
public long Id { get; set; }
public string MutationId { get; set; } = Guid.NewGuid().ToString("N");
public string Scope { get; set; } = "workflow";
public string OwnerInstance { get; set; } = CurrentOwnerInstance;
public bool IsCompleted { get; set; }
public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow;
}
@@ -24,6 +24,7 @@ public class ManagementElsaDbContext : ElsaDbContextBase
/// The workflow instances.
/// </summary>
public DbSet<WorkflowInstance> WorkflowInstances { get; set; } = default!;
public DbSet<CacheMutation> CacheMutations { get; set; } = default!;
/// <inheritdoc />
protected override void OnModelCreating(ModelBuilder modelBuilder)
@@ -34,6 +35,17 @@ public class ManagementElsaDbContext : ElsaDbContextBase
var config = new Configurations();
modelBuilder.ApplyConfiguration<WorkflowDefinition>(config);
modelBuilder.ApplyConfiguration<WorkflowInstance>(config);
modelBuilder.Entity<CacheMutation>(b =>
{
b.ToTable("CacheMutations");
b.HasKey(x => x.Id);
b.Property(x => x.Id).ValueGeneratedOnAdd();
b.Property(x => x.MutationId).HasMaxLength(32).IsRequired();
b.HasIndex(x => x.MutationId).IsUnique();
b.Property(x => x.Scope).HasMaxLength(32).IsRequired();
b.Property(x => x.OwnerInstance).HasMaxLength(256).IsRequired();
b.HasIndex(x => x.IsCompleted);
});
base.OnModelCreating(modelBuilder);
}
@@ -0,0 +1,57 @@
using Elsa.Caching;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using System.Transactions;
namespace Elsa.EntityFrameworkCore.Modules.Management;
/// <summary>Reads SQL before cache access, so missed messages and Redis failover cannot revive old revisions.</summary>
public class EFCoreCacheConsistencyStore(IServiceScopeFactory scopes) : ICacheConsistencyStore
{
public bool IsDurable => true;
public async Task<CacheConsistencyState> ReadAsync(CancellationToken cancellationToken = default)
{
using var suppressed = new TransactionScope(TransactionScopeOption.Suppress, TransactionScopeAsyncFlowOption.Enabled);
using var serviceScope = scopes.CreateScope();
var factory = serviceScope.ServiceProvider.GetRequiredService<IDbContextFactory<ManagementElsaDbContext>>();
await using var db = await factory.CreateDbContextAsync(cancellationToken);
// One SQL statement gives a consistent view of the revision and pending fences.
var state = await db.CacheMutations.AsNoTracking().GroupBy(_ => 1)
.Select(g => new { Revision = g.Max(x => x.Scope == "workflow" ? (long?)x.Id : null) ?? 0,
Pending = g.Any(x => !x.IsCompleted && x.Scope == "workflow"),
RouteRevision = g.Max(x => x.Id), PendingRoutes = g.Any(x => !x.IsCompleted) })
.SingleOrDefaultAsync(cancellationToken);
return new CacheConsistencyState(state?.Revision.ToString() ?? "0", state?.Pending ?? false, state?.RouteRevision.ToString() ?? "0", state?.PendingRoutes ?? false);
}
public async Task<string> BeginMutationAsync(CancellationToken cancellationToken = default, string scope = "workflow")
{
using var suppressed = new TransactionScope(TransactionScopeOption.Suppress, TransactionScopeAsyncFlowOption.Enabled);
if (scope is not ("workflow" or "routes")) throw new ArgumentException("Unknown workflow cache mutation scope.", nameof(scope));
using var serviceScope = scopes.CreateScope();
var factory = serviceScope.ServiceProvider.GetRequiredService<IDbContextFactory<ManagementElsaDbContext>>();
await using var db = await factory.CreateDbContextAsync(cancellationToken);
var mutation = new CacheMutation { Scope = scope };
db.CacheMutations.Add(mutation);
await db.SaveChangesAsync(cancellationToken);
return mutation.MutationId;
}
public async Task CompleteMutationAsync(string mutationId, CancellationToken cancellationToken = default)
{
using var suppressed = new TransactionScope(TransactionScopeOption.Suppress, TransactionScopeAsyncFlowOption.Enabled);
using var serviceScope = scopes.CreateScope();
var factory = serviceScope.ServiceProvider.GetRequiredService<IDbContextFactory<ManagementElsaDbContext>>();
await using var db = await factory.CreateDbContextAsync(cancellationToken);
var mutation = await db.CacheMutations.SingleOrDefaultAsync(x => x.MutationId == mutationId, cancellationToken);
if (mutation == null || mutation.IsCompleted) return;
mutation.IsCompleted = true;
// A begin marker can commit out of identity order. Always allocate a new revision AFTER the data write.
// Closing the fence and publishing that revision must commit in the same SQL transaction.
db.CacheMutations.Add(new CacheMutation { Scope = mutation.Scope, IsCompleted = true });
await db.SaveChangesAsync(cancellationToken);
// Never delete a row newer than the maximum observed for its scope: another node may complete meanwhile.
var latest = await db.CacheMutations.GroupBy(x => x.Scope)
.Select(g => new { Scope = g.Key, Maximum = g.Max(x => x.Id) }).ToListAsync(cancellationToken);
foreach (var item in latest)
await db.CacheMutations.Where(x => x.IsCompleted && x.Scope == item.Scope && x.Id < item.Maximum).ExecuteDeleteAsync(cancellationToken);
}
}
@@ -3,6 +3,7 @@ using Elsa.Features.Services;
using Elsa.Workflows.Management.Entities;
using Elsa.Workflows.Management.Features;
using Microsoft.Extensions.DependencyInjection;
using Elsa.Caching.Features;
namespace Elsa.EntityFrameworkCore.Modules.Management;
@@ -16,6 +17,10 @@ public class EFCoreWorkflowDefinitionPersistenceFeature(IModule module) : Persis
/// <inheritdoc />
public override void Configure()
{
Module.Configure<CacheFeature>(feature => feature.ConsistencyStore = sp =>
sp.GetRequiredService<Elsa.Caching.ICacheProvider>().IsShared
? ActivatorUtilities.CreateInstance<EFCoreCacheConsistencyStore>(sp)
: sp.GetRequiredService<Elsa.Caching.Services.MemoryCacheConsistencyStore>());
Module.Configure<WorkflowDefinitionsFeature>(feature =>
{
feature.WorkflowDefinitionStore = sp => sp.GetRequiredService<EFCoreWorkflowDefinitionStore>();
@@ -28,4 +33,4 @@ public class EFCoreWorkflowDefinitionPersistenceFeature(IModule module) : Persis
base.Apply();
AddEntityStore<WorkflowDefinition, EFCoreWorkflowDefinitionStore>();
}
}
}
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Environments</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides API endpoints for client applications to enumerate available environments.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Expressions</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides infrastructure for registering and executing workflow expressions.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.FileStorage</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides activities to save and load files to and from a confogurable storage provider.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Hangfire</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides Hangfire integration and an implementation of Elsa's IJobQueue implementation.
@@ -4,7 +4,7 @@
<PackageId>Caspian.Elsa.Hosting.Management</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides hosting management functionality.
@@ -5,6 +5,12 @@ namespace Elsa.Http;
/// </summary>
public interface IRouteTable : IEnumerable<HttpRouteData>
{
/// <summary>Replaces the local snapshot. Implementations should publish it atomically.</summary>
void Replace(IEnumerable<HttpRouteData> routes)
{
RemoveRange(this.Select(x => x.Route).ToArray());
foreach (var route in routes) Add(route);
}
/// <summary>
/// Adds a route to the table.
/// </summary>
@@ -34,4 +40,4 @@ public interface IRouteTable : IEnumerable<HttpRouteData>
/// </summary>
/// <param name="routes">The routes to remove.</param>
void RemoveRange(IEnumerable<string> routes);
}
}
+2 -2
View File
@@ -1,10 +1,10 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<PackageId>Caspian.Elsa.Http</PackageId>
<Company>Caspian</Company>
<Authors>Behzad Alizadeh</Authors>
<Version>1.1.0-preview.4</Version>
<Version>1.1.0-preview.11</Version>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Description>
Provides HTTP activities to listen for and send out HTTP requests.
@@ -26,4 +26,13 @@ public static class ModuleExtensions
feature.Module.Configure(configure);
return feature;
}
}
public static HttpFeature UseCache(this HttpFeature feature,
Microsoft.Extensions.Configuration.IConfigurationSection section, Action<HttpCacheFeature>? configure = null)
{
return feature.UseCache(cache =>
{
cache.UseConfiguration(section);
configure?.Invoke(cache);
});
}
}
@@ -1,4 +1,5 @@
using Elsa.Features.Abstractions;
using Elsa.Caching.Features;
using Elsa.Features.Attributes;
using Elsa.Features.Services;
using Elsa.Http.Handlers;
@@ -13,7 +14,7 @@ namespace Elsa.Http.Features;
/// </summary>
[DependsOn(typeof(HttpFeature))]
[DependsOn(typeof(CachingWorkflowDefinitionsFeature))]
public class HttpCacheFeature : FeatureBase
public class HttpCacheFeature : CacheConsumerFeature
{
/// <inheritdoc />
public HttpCacheFeature(IModule module) : base(module)
@@ -28,4 +29,4 @@ public class HttpCacheFeature : FeatureBase
.Decorate<IHttpWorkflowLookupService, CachingHttpWorkflowLookupService>()
.AddNotificationHandler<InvalidateHttpWorkflowsCache>();
}
}
}
@@ -167,6 +167,8 @@ public class HttpFeature(IModule module) : FeatureBase(module)
.AddScoped<IRouteTable, RouteTable>()
.AddScoped<IAbsoluteUrlProvider, DefaultAbsoluteUrlProvider>()
.AddScoped<IRouteTableUpdater, DefaultRouteTableUpdater>()
.AddScoped<RouteTableRevisionRefresher>()
.AddSingleton<RouteTableRevisionState>()
.AddScoped<IHttpWorkflowLookupService, HttpWorkflowLookupService>()
.AddScoped(ContentTypeProvider)
.AddHttpContextAccessor()
@@ -253,4 +255,4 @@ public class HttpFeature(IModule module) : FeatureBase(module)
options.AddTypeAlias<Downloadable[]>("Downloadable[]");
});
}
}
}
@@ -36,6 +36,8 @@ public class HttpWorkflowsMiddleware(RequestDelegate next, IOptions<HttpActivity
public async Task InvokeAsync(HttpContext httpContext, IServiceProvider serviceProvider)
{
var path = httpContext.Request.Path.Value!.NormalizeRoute();
await serviceProvider.GetRequiredService<Elsa.Http.Services.RouteTableRevisionRefresher>()
.EnsureFreshAsync(httpContext.RequestAborted);
var matchingPath = GetMatchingRoute(serviceProvider, path).Route;
var basePath = options.Value.BasePath?.ToString().NormalizeRoute();
@@ -370,4 +372,4 @@ public class HttpWorkflowsMiddleware(RequestDelegate next, IOptions<HttpActivity
var bookmarkHasher = serviceProvider.GetRequiredService<IStimulusHasher>();
return bookmarkHasher.Hash(HttpStimulusNames.HttpEndpoint, bookmarkPayload);
}
}
}
@@ -11,7 +11,8 @@ namespace Elsa.Http.Services;
public class CachingHttpWorkflowLookupService(
IHttpWorkflowLookupService decoratedService,
IHttpWorkflowsCacheManager cacheManager,
ITenantAccessor tenantAccessor) : IHttpWorkflowLookupService
ITenantAccessor tenantAccessor,
Elsa.Workflows.Management.IWorkflowDefinitionService definitionService) : IHttpWorkflowLookupService
{
/// <inheritdoc />
public async Task<HttpWorkflowLookupResult?> FindWorkflowAsync(string bookmarkHash, CancellationToken cancellationToken = default)
@@ -21,6 +22,21 @@ public class CachingHttpWorkflowLookupService(
var tenantIdPrefix = !string.IsNullOrEmpty(tenantId) ? $"{tenantId}:" : string.Empty;
var key = $"{tenantIdPrefix}http-workflow:{bookmarkHash}";
var cache = cacheManager.Cache;
if (!cache.IsEnabled) return await decoratedService.FindWorkflowAsync(bookmarkHash, cancellationToken);
if (cache.IsShared)
{
// Redis stores the definition version reference and trigger data, never an executable graph.
var entryOptions = new Elsa.Caching.Models.CacheEntryOptions { SlidingExpiration = cache.CachingOptions.Value.CacheDuration };
var cached = await cache.GetOrCreateAsync(key, async () =>
{
var found = await decoratedService.FindWorkflowAsync(bookmarkHash, cancellationToken);
return found == null ? null : new CachedHttpLookup(found.WorkflowGraph?.Workflow.Identity.Id, found.Triggers);
}, entryOptions, cancellationToken);
if (cached == null) return null;
var graph = cached.DefinitionVersionId == null ? null
: await definitionService.FindWorkflowGraphAsync(cached.DefinitionVersionId, cancellationToken);
return new HttpWorkflowLookupResult(graph, cached.Triggers);
}
return await cache.GetOrCreateAsync(key, async entry =>
{
var cachingOptions = cache.CachingOptions.Value;
@@ -43,4 +59,5 @@ public class CachingHttpWorkflowLookupService(
return result;
});
}
}
public record CachedHttpLookup(string? DefinitionVersionId, ICollection<Elsa.Workflows.Runtime.Entities.StoredTrigger> Triggers);
}
@@ -23,17 +23,29 @@ public class DefaultRouteTableUpdater(
var stimulusName = HttpStimulusNames.HttpEndpoint;
var triggerFilter = new TriggerFilter
{
Name = stimulusName
Name = stimulusName,
TenantAgnostic = true
};
var bookmarkFilter = new BookmarkFilter
{
Name = stimulusName
Name = stimulusName,
TenantAgnostic = true
};
var triggers = (await triggerStore.FindManyAsync(triggerFilter, cancellationToken)).ToList();
var bookmarks = (await bookmarkStore.FindManyAsync(bookmarkFilter, cancellationToken)).ToList();
await AddRoutesAsync(triggers, cancellationToken);
await AddRoutesAsync(bookmarks, cancellationToken);
var routes = new List<HttpRouteData>();
foreach (var trigger in Filter(triggers))
{
var context = new HttpEndpointRouteProviderContext(trigger.GetPayload<HttpEndpointBookmarkPayload>(), trigger.TenantId, cancellationToken);
routes.AddRange(await httpEndpointRoutesProvider.GetRoutesAsync(context));
}
foreach (var bookmark in Filter(bookmarks))
{
var context = new HttpEndpointRouteProviderContext(bookmark.GetPayload<HttpEndpointBookmarkPayload>(), bookmark.TenantId, cancellationToken);
routes.AddRange(await httpEndpointRoutesProvider.GetRoutesAsync(context));
}
routeTable.Replace(routes);
}
public async Task AddRoutesAsync(IEnumerable<StoredTrigger> triggers, CancellationToken cancellationToken = default)
@@ -107,4 +119,4 @@ public class DefaultRouteTableUpdater(
var stimulusName = HttpStimulusNames.HttpEndpoint;
return bookmarks.Where(x => x.Name == stimulusName && x.Payload != null);
}
}
}
+8 -1
View File
@@ -12,6 +12,13 @@ public class RouteTable(IMemoryCache cache, ILogger<RouteTable> logger) : IRoute
private static readonly object Key = new();
private ConcurrentDictionary<string, HttpRouteData> Routes => cache.GetOrCreate(Key, _ => new ConcurrentDictionary<string, HttpRouteData>())!;
public void Replace(IEnumerable<HttpRouteData> routes)
{
var snapshot = new ConcurrentDictionary<string, HttpRouteData>();
foreach (var route in routes.Where(x => !x.Route.Contains("//")))
snapshot.TryAdd(route.Route.NormalizeRoute(), route);
cache.Set(Key, snapshot);
}
/// <inheritdoc />
public void Add(string route)
@@ -56,4 +63,4 @@ public class RouteTable(IMemoryCache cache, ILogger<RouteTable> logger) : IRoute
public IEnumerator<HttpRouteData> GetEnumerator() => Routes.Values.GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}
}
@@ -0,0 +1,34 @@
using Elsa.Caching;
namespace Elsa.Http.Services;
/// <summary>A local route snapshot with a revision checked against SQL on each inbound workflow request.</summary>
public class RouteTableRevisionState : IDisposable
{
public SemaphoreSlim Gate { get; } = new(1, 1);
public string? Revision { get; set; }
public void Dispose() => Gate.Dispose();
}
public class RouteTableRevisionRefresher(ICacheManager cache, IRouteTableUpdater updater, RouteTableRevisionState state)
{
public async Task EnsureFreshAsync(CancellationToken cancellationToken)
{
if (!cache.IsShared) return;
// A process-wide route snapshot must not be built from a request's ambient transaction snapshot.
using var suppressed = new System.Transactions.TransactionScope(System.Transactions.TransactionScopeOption.Suppress,
System.Transactions.TransactionScopeAsyncFlowOption.Enabled);
var before = await cache.GetConsistencyStateAsync(cancellationToken);
if (!before.HasPendingRouteMutations && (before.RouteRevision ?? before.Revision) == state.Revision) return;
await state.Gate.WaitAsync(cancellationToken);
try
{
before = await cache.GetConsistencyStateAsync(cancellationToken);
if (!before.HasPendingRouteMutations && (before.RouteRevision ?? before.Revision) == state.Revision) return;
await updater.UpdateAsync(cancellationToken);
var after = await cache.GetConsistencyStateAsync(cancellationToken);
state.Revision = !after.HasPendingRouteMutations && (before.RouteRevision ?? before.Revision) == (after.RouteRevision ?? after.Revision) ? after.RouteRevision ?? after.Revision : null;
}
finally { state.Gate.Release(); }
}
}

Some files were not shown because too many files have changed in this diff Show More