Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Add reference to redis projects; remove need for json constructors in redis project; do not process saga actions on completed sagas #42

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
Open

Add reference to redis projects; remove need for json constructors in redis project; do not process saga actions on completed sagas #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d5bf79d
Add Redis persistence to Chronicle Solution; Json; Refactor to remove…
nick-cromwell Jan 21, 2020
665e913
Do not process saga actions for sagas that have been completed
nick-cromwell Feb 18, 2020
d80c3f4
Merge branch 'master' into master
nick-cromwell Feb 18, 2020
958bdd9
Merge pull request #1 from snatch-dev/master
nick-cromwell Apr 14, 2020
108d4ba
Merge pull request #2 from rangerlabs/develop
nick-cromwell Apr 14, 2020
9f97f81
Merge branch 'develop' into master
nick-cromwell Apr 14, 2020
f48571c
Update packages
nick-cromwell Aug 31, 2020
47c71b3
Merge branch 'develop' into master
nick-cromwell Sep 2, 2020
234e9a5
Add IChronicleConfiguration and default settings; AllowConcurrentWrit…
nick-cromwell Sep 2, 2020
86227af
Merge branch 'master' of https://github.com/rangerlabs/Chronicle
nick-cromwell Sep 2, 2020
c281314
Register default IChronicleConfiguration
nick-cromwell Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Chronicle.Integrations.MongoDB/src/Chronicle.Integrations.MongoDB.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Chronicle_" Version="3.*" />
<PackageReference Include="Microsoft.Extensions.Configuration" Version="3.0.0" />
<PackageReference Include="MongoDB.Driver" Version="2.9.2" />
<PackageReference Include="Chronicle_" Version="3.2.1" />
<PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.7" />
<PackageReference Include="MongoDB.Driver" Version="2.11.1" />
</ItemGroup>

</Project>
6 changes: 3 additions & 3 deletions src/Chronicle.Integrations.Redis/src/Chronicle.Integrations.Redis.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
<FileVersion>2.0</FileVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="3.1.0" />
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="3.1.7" />
<PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
<PackageReference Include="Chronicle_" Version="3.*" />
<PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.0" />
<PackageReference Include="Chronicle_" Version="3.2.1" />
<PackageReference Include="Microsoft.Extensions.Configuration" Version="3.1.7" />
</ItemGroup>

</Project>
6 changes: 3 additions & 3 deletions src/Chronicle.Integrations.Redis/src/Persistence/RedisSagaLog.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ public async Task<IEnumerable<ISagaLogData>> ReadAsync(SagaId id, Type sagaType)
var sagaLogDatas = new List<RedisSagaLogData>();
var deserializedSagaLogDatas = new List<RedisSagaLogData>();
var cachedSagaLogDatas = await cache.GetStringAsync(LogId(id, sagaType));

if (!string.IsNullOrWhiteSpace(cachedSagaLogDatas))
{
sagaLogDatas = JsonConvert.DeserializeObject<List<RedisSagaLogData>>(cachedSagaLogDatas);
sagaLogDatas.ForEach(sld =>
{
{
var message = (sld.Message as JObject)?.ToObject(sld.MessageType);
deserializedSagaLogDatas.Add(new RedisSagaLogData(sld.Id, sld.Type, sld.CreatedAt, message, sld.MessageType));
deserializedSagaLogDatas.Add(new RedisSagaLogData { SagaId = sld.Id, Type = sld.Type, CreatedAt = sld.CreatedAt, Message = message, MessageType = sld.MessageType });
}
});
}
Expand All @@ -54,7 +54,7 @@ public async Task WriteAsync(ISagaLogData logData)
}
var sagaLogDatas = (await ReadAsync(logData.Id, logData.Type)).ToList();

var sagaLogData = new RedisSagaLogData(logData.Id, logData.Type, logData.CreatedAt, logData.Message, logData.Message.GetType());
var sagaLogData = new RedisSagaLogData { SagaId = logData.Id, Type = logData.Type, CreatedAt = logData.CreatedAt, Message = logData.Message, MessageType = logData.Message.GetType() };

sagaLogDatas.Add(sagaLogData);

Expand Down
24 changes: 7 additions & 17 deletions src/Chronicle.Integrations.Redis/src/Persistence/RedisSagaLogData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,13 @@ namespace Chronicle.Integrations.Redis.Persistence
{
internal sealed class RedisSagaLogData : ISagaLogData
{
public SagaId Id { get; }
public Type Type { get; }
public long CreatedAt { get; }
public object Message { get; }
public Type MessageType { get; }
public string SagaId { get; set; }
[JsonIgnore]
public SagaId Id => SagaId;
public Type Type { get; set; }
public long CreatedAt { get; set; }
public object Message { get; set; }
public Type MessageType { get; set; }

[JsonConstructor]
public RedisSagaLogData(SagaId id, Type type, long createdAt, object message, Type messageType)
{
Id = id;
Type = type;
CreatedAt = createdAt;
Message = message;
MessageType = messageType;
}

public static ISagaLogData Create(SagaId sagaId, Type sagaType, object message)
=> new RedisSagaLogData(sagaId, sagaType, DateTimeOffset.Now.ToUnixTimeMilliseconds(), message, message.GetType());
}
}
19 changes: 7 additions & 12 deletions src/Chronicle.Integrations.Redis/src/Persistence/RedisSagaState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,13 @@ namespace Chronicle.Integrations.Redis.Persistence
{
internal sealed class RedisSagaState : ISagaState
{
public SagaId Id { get; }
public Type Type { get; }
public SagaStates State { get; private set; }
public object Data { get; private set; }
public Type DataType { get; }

[JsonConstructor]
public RedisSagaState(SagaId id, Type type, SagaStates state, object data = null, Type dataType = null)
=> (Id, Type, State, Data, DataType) = (id, type, state, data, dataType);

public static ISagaState Create(SagaId sagaId, Type sagaType, SagaStates state, object data = null, Type dataType = null)
=> new RedisSagaState(sagaId, sagaType, state, data, dataType);
public string SagaId { get; set; }
[JsonIgnore]
public SagaId Id => SagaId;
public Type Type { get; set; }
public SagaStates State { get; set; }
public object Data { get; set; }
public Type DataType { get; set; }

public void Update(SagaStates state, object data = null)
{
Expand Down
7 changes: 3 additions & 4 deletions src/Chronicle.Integrations.Redis/src/Persistence/RedisSagaStateRepository.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal sealed class RedisSagaStateRepository : ISagaStateRepository

public RedisSagaStateRepository(IDistributedCache cache)
=> _cache = cache;

public async Task<ISagaState> ReadAsync(SagaId sagaId, Type sagaType)
{
if (string.IsNullOrWhiteSpace(sagaId))
Expand All @@ -26,7 +26,7 @@ public async Task<ISagaState> ReadAsync(SagaId sagaId, Type sagaType)

RedisSagaState state = null;
var cachedSagaState = await _cache.GetStringAsync(StateId(sagaId, sagaType));

if (!string.IsNullOrWhiteSpace(cachedSagaState))
{
state = JsonConvert.DeserializeObject<RedisSagaState>(cachedSagaState);
Expand All @@ -42,8 +42,7 @@ public async Task WriteAsync(ISagaState state)
throw new ChronicleException($"{nameof(state)} was null.");
}

var sagaState = new RedisSagaState(state.Id, state.Type, state.State, state.Data, state.Data.GetType());

var sagaState = new RedisSagaState { SagaId = state.Id, Type = state.Type, State = state.State, Data = state.Data, DataType = state.Data.GetType() };

var serializedSagaState = JsonConvert.SerializeObject(sagaState);
await _cache.SetStringAsync(StateId(state.Id, state.Type), serializedSagaState);
Expand Down
13 changes: 8 additions & 5 deletions src/Chronicle.Tests/Chronicle.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.7.0" />
<PackageReference Include="NSubstitute" Version="4.0.0" />
<PackageReference Include="Shouldly" Version="3.0.1" />
<PackageReference Include="xunit" Version="2.3.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
<PackageReference Include="NSubstitute" Version="4.2.2" />
<PackageReference Include="Shouldly" Version="3.0.2" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
</ItemGroup>

Expand Down
19 changes: 19 additions & 0 deletions src/Chronicle.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Chronicle.Tests", "Chronicl
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Chronicle.Integrations.MongoDB", "Chronicle.Integrations.MongoDB\src\Chronicle.Integrations.MongoDB.csproj", "{DFB344D1-3121-43F9-9E66-20BC6B0DD9CC}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Chronicle.Integrations.Redis", "Chronicle.Integrations.Redis", "{3B661443-315C-4A0F-A67E-62A792AF35D3}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Chronicle.Integrations.Redis", "Chronicle.Integrations.Redis\src\Chronicle.Integrations.Redis.csproj", "{755F7A4D-7FC3-444E-86D3-528787961B2F}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -69,11 +73,26 @@ Global
{DFB344D1-3121-43F9-9E66-20BC6B0DD9CC}.Release|x64.Build.0 = Release|Any CPU
{DFB344D1-3121-43F9-9E66-20BC6B0DD9CC}.Release|x86.ActiveCfg = Release|Any CPU
{DFB344D1-3121-43F9-9E66-20BC6B0DD9CC}.Release|x86.Build.0 = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|x64.ActiveCfg = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|x64.Build.0 = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|x86.ActiveCfg = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Debug|x86.Build.0 = Debug|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|Any CPU.ActiveCfg = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|Any CPU.Build.0 = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|x64.ActiveCfg = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|x64.Build.0 = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|x86.ActiveCfg = Release|Any CPU
{755F7A4D-7FC3-444E-86D3-528787961B2F}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {F6DDA96B-847E-4F6D-86EC-126800155219}
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{755F7A4D-7FC3-444E-86D3-528787961B2F} = {3B661443-315C-4A0F-A67E-62A792AF35D3}
EndGlobalSection
EndGlobal
10 changes: 10 additions & 0 deletions src/Chronicle/Builders/ChronicleBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,15 @@ public IChronicleBuilder UseSagaStateRepository<TRepository>() where TRepository
Services.AddTransient(typeof(ISagaStateRepository), typeof(TRepository));
return this;
}

public IChronicleBuilder UseChronicleConfiguration(IChronicleConfiguration configuration)
{
if (configuration is null)
{
configuration = new ChronicleConfiguration();
}
Services.AddSingleton<IChronicleConfiguration>(configuration);
return this;
}
}
}
4 changes: 2 additions & 2 deletions src/Chronicle/Chronicle.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.0" />
<PackageReference Include="Scrutor" Version="3.1.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.7" />
<PackageReference Include="Scrutor" Version="3.2.2" />
</ItemGroup>

</Project>
8 changes: 8 additions & 0 deletions src/Chronicle/ChronicleConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
namespace Chronicle
{

public class ChronicleConfiguration : IChronicleConfiguration
{
public bool AllowConcurrentWrites { get; set; } = true;
}
}
1 change: 1 addition & 0 deletions src/Chronicle/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ public static IServiceCollection AddChronicle(this IServiceCollection services,
services.AddTransient<ISagaInitializer, SagaInitializer>();
services.AddTransient<ISagaProcessor, SagaProcessor>();
services.AddTransient<ISagaPostProcessor, SagaPostProcessor>();
services.AddSingleton<IChronicleConfiguration, ChronicleConfiguration>();

var chronicleBuilder = new ChronicleBuilder(services);

Expand Down
1 change: 1 addition & 0 deletions src/Chronicle/IChronicleBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ public interface IChronicleBuilder
IChronicleBuilder UseInMemoryPersistence();
IChronicleBuilder UseSagaLog<TSagaLog>() where TSagaLog : ISagaLog;
IChronicleBuilder UseSagaStateRepository<TRepository>() where TRepository : ISagaStateRepository;
IChronicleBuilder UseChronicleConfiguration(IChronicleConfiguration configuration);
}
}
7 changes: 7 additions & 0 deletions src/Chronicle/IChronicleConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
namespace Chronicle
{
public interface IChronicleConfiguration
{
bool AllowConcurrentWrites { get; set; }
}
}
2 changes: 1 addition & 1 deletion src/Chronicle/Managers/SagaCoordinator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private async Task ProcessAsync<TMessage>(TMessage message, ISagaAction<TMessage
{
var (isInitialized, state) = await _initializer.TryInitializeAsync(saga, id, message);

if (!isInitialized)
if (!isInitialized || state.State is SagaStates.Completed)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note, this is useful to avoid redundant processing. Some sagas may require interaction from a user outside of the normal flow - like clicking on a link in an e-mail, which they could do multiple times. I couldn't think of a case where one would want to process a message for a saga after it has already been marked Completed.

{
return;
}
Expand Down
22 changes: 16 additions & 6 deletions src/Chronicle/Managers/SagaProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ namespace Chronicle.Managers
internal sealed class SagaProcessor : ISagaProcessor
{
private readonly ISagaStateRepository _repository;
private readonly IChronicleConfiguration _configuration;
private readonly ISagaLog _log;

public SagaProcessor(ISagaStateRepository repository, ISagaLog log)
public SagaProcessor(ISagaStateRepository repository, IChronicleConfiguration configuration, ISagaLog log)
{
_repository = repository;
_configuration = configuration;
_log = log;
}

Expand Down Expand Up @@ -49,13 +51,21 @@ private async Task UpdateSagaAsync<TMessage>(TMessage message, ISaga saga, ISaga
state.Update(saga.State, updatedSagaData);
var logData = SagaLogData.Create(saga.Id, sagaType, message);

var persistenceTasks = new []
if (_configuration.AllowConcurrentWrites)
{
_repository.WriteAsync(state),
_log.WriteAsync(logData)
};
var persistenceTasks = new[]
{
_repository.WriteAsync(state),
_log.WriteAsync(logData)
};

await Task.WhenAll(persistenceTasks).ConfigureAwait(false);
await Task.WhenAll(persistenceTasks).ConfigureAwait(false);
}
else
{
await _repository.WriteAsync(state);
await _log.WriteAsync(logData);
}
}
}
}