From a14ae23de40f6d2462fbc0bd56ad75f276dc0943 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:49:19 +0700 Subject: [PATCH 01/18] Add ServerSidePersistenceTestPage.razor --- .../Test.App.Client/Components/NavMenu.razor | 27 ++++-- .../Purple/Actions/PurpleState.Load.cs | 42 +++++++++ .../Pages/ServerSidePersistenceTestPage.razor | 88 +++++++++++++++++++ 3 files changed, 150 insertions(+), 7 deletions(-) create mode 100644 Tests/Test.App/Test.App.Client/Features/Purple/Actions/PurpleState.Load.cs create mode 100644 Tests/Test.App/Test.App.Client/Pages/ServerSidePersistenceTestPage.razor diff --git a/Tests/Test.App/Test.App.Client/Components/NavMenu.razor b/Tests/Test.App/Test.App.Client/Components/NavMenu.razor index 924fddd32..53e98eaaa 100644 --- a/Tests/Test.App/Test.App.Client/Components/NavMenu.razor +++ b/Tests/Test.App/Test.App.Client/Components/NavMenu.razor @@ -2,6 +2,15 @@ @using Test.App.Client.Pages @inherits BaseComponent +@code +{ + private async Task GoBack() + { + await RouteState.GoBack(); + } +} + +
Test.App.Server @@ -86,6 +95,12 @@ @PersistenceTestPage.Title
+ +
+ + @ServerSidePersistenceTestPage.Title + +
@@ -150,10 +165,8 @@
-@code -{ - private async Task GoBack() - { - await RouteState.GoBack(); - } -} + diff --git a/Tests/Test.App/Test.App.Client/Features/Purple/Actions/PurpleState.Load.cs b/Tests/Test.App/Test.App.Client/Features/Purple/Actions/PurpleState.Load.cs new file mode 100644 index 000000000..2b828a8dc --- /dev/null +++ b/Tests/Test.App/Test.App.Client/Features/Purple/Actions/PurpleState.Load.cs @@ -0,0 +1,42 @@ +namespace Test.App.Client.Features.Purple; + +using TimeWarp.Features.Persistence; +using TimeWarp.State; + +public partial class PurpleState +{ + public static class Load2 + { + public class Action : IAction { } + + public class Handler : ActionHandler + { + private readonly IPersistenceService PersistenceService1; + private readonly ILogger Logger; + public Handler + ( + IStore store, + IPersistenceService PersistenceService, + ILogger logger + ) : base(store) + { + PersistenceService1 = PersistenceService; + Logger = logger; + } + public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) + { + try + { + object? state = await PersistenceService1.LoadState(typeof(PurpleState), PersistentStateMethod.LocalStorage); + if (state is PurpleState purpleState) Store.SetState(purpleState); + else Logger.LogTrace("PurpleState is null"); + } + catch (Exception exception) + { + Logger.LogError(exception, "Error loading PurpleState"); + // if this is a JavaScript not available exception then we are prerendering and just swallow it + } + } + } + } +} diff --git a/Tests/Test.App/Test.App.Client/Pages/ServerSidePersistenceTestPage.razor b/Tests/Test.App/Test.App.Client/Pages/ServerSidePersistenceTestPage.razor new file mode 100644 index 000000000..59a06ef0f --- /dev/null +++ b/Tests/Test.App/Test.App.Client/Pages/ServerSidePersistenceTestPage.razor @@ -0,0 +1,88 @@ +@rendermode InteractiveServer +@attribute [Route(Route)] +@inherits BaseComponent + +@Title +

@Title

+@RenderModeDisplay +
+ + +

+ The purpose of this page is to test two different persistent states, LocalStorage and SessionStorage.
+ The two counters are independent of each other and will persist across page refreshes.
+ Opening a new tab will share the state of the Purple counter (LocalStorage), but not the Blue counter (SessionStorage). +
+

+
+

System Under Test

+

Purple (Local)

+ + @if (IsPreRendering) + { +
PurpleState.Guid:
+
Purple Count:
+ } + else + { +
PurpleState.Guid: @PurpleState.Guid
+
Purple Count: @PurpleState.Count
+ + } +
+
+ +

Blue (Session)

+ @if (IsPreRendering) + { +
BlueState.Guid:
+
Blue Count:
+ } + else + { +
BlueState.Guid: @BlueState.Guid
+
Blue Count: @BlueState.Count
+ + } +
+
+ +

Act:
+ Click the `Increment Purple Count` button
+ Click the `Increment Blue Count` button
+ Make note of the `Guid` and `Count` for both PurpleState and BlueState`
+ Refresh the page
+

+ + +

+ Assert:
+ `Current Render Mode` == Wasm.
+ The `Guid` and `Count` for both PurpleState and BlueState are the same as before the refresh. +

+ + +

Act:Open a new tab to this page

+ + +

+ Assert:
The `Guid` and `Count` for PurpleState are the same as the previous tab.
+ The `Guid` for BlueState is different and the Count is 2.
+

+
+ +@code +{ + /// + /// The title of the page + /// + public const string Title = "Server Side Persistence"; + + /// + /// The route for the page + /// + public const string Route = "/ServerSidePersistenceTestPage"; + + private async Task IncrementPurpleCount() => await Send(new PurpleState.IncrementCount.Action { Amount = 5 }); + private async Task IncrementBlueCount() => await Send(new BlueState.IncrementCount.Action { Amount = 3 }); +} From 9f42df9587747472e8b1fa55632dae6d4069cdbe Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:50:52 +0700 Subject: [PATCH 02/18] Update the SourceGenerator to add Logging and not use Primary constructor. --- .../PersistenceStateSourceGenerator.cs | 57 +++++++++++-------- 1 file changed, 34 insertions(+), 23 deletions(-) diff --git a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs index fec070704..bca95a879 100644 --- a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs +++ b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs @@ -46,41 +46,52 @@ private static string GenerateLoadClassCode(string namespaceName, string classNa { string camelCaseClassName = ToCamelCase(className); - return $$""" + return $$$""" #nullable enable #pragma warning disable CS1591 - namespace {{namespaceName}}; + namespace {{{namespaceName}}}; using TimeWarp.Features.Persistence; using TimeWarp.State; - public partial class {{className}} + public partial class {{{className}}} { - public static class Load - { - public class Action : IAction { } + public static class Load + { + public class Action : IAction { } - public class Handler - ( - IStore store, - IPersistenceService PersistenceService - ): ActionHandler(store) + public class Handler : ActionHandler + { + private readonly IPersistenceService PersistenceService; + private readonly ILogger Logger; + + public Handler + ( + IStore store, + IPersistenceService persistenceService, + ILogger logger + ) : base(store) + { + PersistenceService = persistenceService; + Logger = logger; + } + public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) + { + try { - public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) - { - try - { - object? state = await PersistenceService.LoadState(typeof({{className}}), PersistentStateMethod.{{persistentStateMethod}}); - if (state is {{className}} {{camelCaseClassName}}) Store.SetState({{camelCaseClassName}}); - } - catch (Exception) - { - // if this is a JavaScript not available exception then we are prerendering and just swallow it - } - } + object? state = await PersistenceService.LoadState(typeof({{{className}}}), PersistentStateMethod.{{{persistentStateMethod}}}); + if (state is {{{className}}} {{{camelCaseClassName}}}) Store.SetState({{{camelCaseClassName}}}); + else Logger.LogTrace("{{{className}}} is null"); } + catch (Exception exception) + { + Logger.LogError(exception, "Error loading {{className}}"); + // if this is a JavaScript not available exception then we are prerendering and just swallow it + } + } } + } } #pragma warning restore CS1591 From f44f117928be5255af7b21148313567137ee30de Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:51:05 +0700 Subject: [PATCH 03/18] New generated code --- ...t.Features.Blue.BlueState_Persistence.g.cs | 51 +++++++++++-------- ...atures.Purple.PurpleState_Persistence.g.cs | 51 +++++++++++-------- 2 files changed, 62 insertions(+), 40 deletions(-) diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs index a80cbd85a..10a500186 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs @@ -8,29 +8,40 @@ namespace Test.App.Client.Features.Blue; public partial class BlueState { - public static class Load - { - public class Action : IAction { } + public static class Load + { + public class Action : IAction { } - public class Handler - ( - IStore store, - IPersistenceService PersistenceService - ): ActionHandler(store) + public class Handler : ActionHandler + { + private readonly IPersistenceService PersistenceService; + private readonly ILogger Logger; + + public Handler + ( + IStore store, + IPersistenceService persistenceService, + ILogger logger + ) : base(store) + { + PersistenceService = persistenceService; + Logger = logger; + } + public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) + { + try + { + object? state = await PersistenceService.LoadState(typeof(BlueState), PersistentStateMethod.SessionStorage); + if (state is BlueState blueState) Store.SetState(blueState); + else Logger.LogTrace("BlueState is null"); + } + catch (Exception exception) { - public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) - { - try - { - object? state = await PersistenceService.LoadState(typeof(BlueState), PersistentStateMethod.SessionStorage); - if (state is BlueState blueState) Store.SetState(blueState); - } - catch (Exception) - { - // if this is a JavaScript not available exception then we are prerendering and just swallow it - } - } + Logger.LogError(exception, "Error loading {{className}}"); + // if this is a JavaScript not available exception then we are prerendering and just swallow it } + } } + } } #pragma warning restore CS1591 diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs index 6fdd9c8f2..c9e6c110d 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs @@ -8,29 +8,40 @@ namespace Test.App.Client.Features.Purple; public partial class PurpleState { - public static class Load - { - public class Action : IAction { } + public static class Load + { + public class Action : IAction { } - public class Handler - ( - IStore store, - IPersistenceService PersistenceService - ): ActionHandler(store) + public class Handler : ActionHandler + { + private readonly IPersistenceService PersistenceService; + private readonly ILogger Logger; + + public Handler + ( + IStore store, + IPersistenceService persistenceService, + ILogger logger + ) : base(store) + { + PersistenceService = persistenceService; + Logger = logger; + } + public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) + { + try + { + object? state = await PersistenceService.LoadState(typeof(PurpleState), PersistentStateMethod.LocalStorage); + if (state is PurpleState purpleState) Store.SetState(purpleState); + else Logger.LogTrace("PurpleState is null"); + } + catch (Exception exception) { - public override async System.Threading.Tasks.Task Handle(Action action, System.Threading.CancellationToken cancellationToken) - { - try - { - object? state = await PersistenceService.LoadState(typeof(PurpleState), PersistentStateMethod.LocalStorage); - if (state is PurpleState purpleState) Store.SetState(purpleState); - } - catch (Exception) - { - // if this is a JavaScript not available exception then we are prerendering and just swallow it - } - } + Logger.LogError(exception, "Error loading {{className}}"); + // if this is a JavaScript not available exception then we are prerendering and just swallow it } + } } + } } #pragma warning restore CS1591 From b4b23945a7c680c99e125af63983cfd37864994f Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:51:23 +0700 Subject: [PATCH 04/18] Add more EventIds --- Source/TimeWarp.State.Plus/EventIds.cs | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Source/TimeWarp.State.Plus/EventIds.cs b/Source/TimeWarp.State.Plus/EventIds.cs index ec18b5879..77574ac16 100644 --- a/Source/TimeWarp.State.Plus/EventIds.cs +++ b/Source/TimeWarp.State.Plus/EventIds.cs @@ -2,10 +2,22 @@ internal class EventIds { - // Features - ActionTracking + // Feature - ActionTracking // Pipeline - Middleware public static readonly EventId ActionTrackingBehavior_StartTracking = new(1000, nameof(ActionTrackingBehavior_StartTracking)); public static readonly EventId ActionTrackingBehavior_StartProcessing = new(1001, nameof(ActionTrackingBehavior_StartProcessing)); public static readonly EventId ActionTrackingBehavior_CompletedProcessing = new(1002, nameof(ActionTrackingBehavior_CompletedProcessing)); public static readonly EventId ActionTrackingBehavior_CompletedTracking = new(1003, nameof(ActionTrackingBehavior_CompletedTracking)); + + // Feature - PersistentStatePostProcessor + public static readonly EventId PersistentStatePostProcessor_StartProcessing = new(1100, nameof(PersistentStatePostProcessor_StartProcessing)); + public static readonly EventId PersistentStatePostProcessor_SaveToSessionStorage = new(1101, nameof(PersistentStatePostProcessor_SaveToSessionStorage)); + public static readonly EventId PersistentStatePostProcessor_SaveToLocalStorage = new(1102, nameof(PersistentStatePostProcessor_SaveToLocalStorage)); + + // Feature - StateInitializedNotificationHandler + public static readonly EventId StateInitializedNotificationHandler_Handling = new(1200, nameof(StateInitializedNotificationHandler_Handling)); + + // Feature - PersistenceService + public static readonly EventId PersistenceService_LoadState = new(1300, nameof(PersistenceService_LoadState)); + public static readonly EventId PersistenceService_LoadState_SerializedState = new(1301, nameof(PersistenceService_LoadState_SerializedState)); } From 35bfedd6dc4668c2218c2b90541302cffdd11765 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:52:21 +0700 Subject: [PATCH 05/18] Improve Logging --- .../Pipeline/PersistentStatePostProcessor.cs | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/Source/TimeWarp.State.Plus/Features/Persistentence/Pipeline/PersistentStatePostProcessor.cs b/Source/TimeWarp.State.Plus/Features/Persistentence/Pipeline/PersistentStatePostProcessor.cs index 831613283..10b1e941e 100644 --- a/Source/TimeWarp.State.Plus/Features/Persistentence/Pipeline/PersistentStatePostProcessor.cs +++ b/Source/TimeWarp.State.Plus/Features/Persistentence/Pipeline/PersistentStatePostProcessor.cs @@ -33,7 +33,7 @@ public async Task Process(TRequest request, TResponse response, CancellationToke if (persistentStateAttribute is null) return; - Logger.LogDebug("PersistentStatePostProcessor: {FullName}", typeof(TRequest).FullName); + Logger.LogTrace(EventIds.PersistentStatePostProcessor_StartProcessing, "Start Processing: {FullName}", typeof(TRequest).FullName); object state = Store.GetState(currentType); @@ -43,11 +43,23 @@ public async Task Process(TRequest request, TResponse response, CancellationToke // TODO: break; case PersistentStateMethod.SessionStorage: - Logger.LogDebug("Save to Session Storage {StateTypeName}", currentType.Name); + Logger.LogTrace + ( + EventIds.PersistentStatePostProcessor_SaveToSessionStorage + ,"Save {StateTypeName} to Session Storage with value {json}" + , currentType.Name + , JsonSerializer.Serialize(state) + ); await SessionStorageService.SetItemAsync(currentType.Name, state, cancellationToken); break; case PersistentStateMethod.LocalStorage: - Logger.LogDebug("Save to Local Storage {StateTypeName}", currentType.Name); + Logger.LogTrace + ( + EventIds.PersistentStatePostProcessor_SaveToLocalStorage + ,"Save {StateTypeName} to Local Storage with value {json}" + , currentType.Name + , JsonSerializer.Serialize(state) + ); await LocalSessionStorageService.SetItemAsync(currentType.Name, state, cancellationToken); break; case PersistentStateMethod.PreRender: From 6de9b13ac5e6847725a5b6c73871bf0205b12f20 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Wed, 31 Jul 2024 21:52:44 +0700 Subject: [PATCH 06/18] Improve logging --- .../Persistentence/StateInitializedNotificationHandler.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Source/TimeWarp.State.Plus/Features/Persistentence/StateInitializedNotificationHandler.cs b/Source/TimeWarp.State.Plus/Features/Persistentence/StateInitializedNotificationHandler.cs index 9793d80e1..df908d0c9 100644 --- a/Source/TimeWarp.State.Plus/Features/Persistentence/StateInitializedNotificationHandler.cs +++ b/Source/TimeWarp.State.Plus/Features/Persistentence/StateInitializedNotificationHandler.cs @@ -20,7 +20,7 @@ public async Task Handle(StateInitializedNotification stateInitializedNotificati string assemblyQualifiedName = stateInitializedNotification.StateType.AssemblyQualifiedName ?? throw new InvalidOperationException(); string typeName = assemblyQualifiedName.Replace(fullName, $"{fullName}+Load+Action"); - Logger.LogDebug("StateInitializedNotificationHandler: {StateTypeName}", stateInitializedNotification.StateType.Name); + Logger.LogDebug(EventIds.StateInitializedNotificationHandler_Handling, "StateInitializedNotificationHandler: {StateTypeName}", stateInitializedNotification.StateType.Name); var actionType = Type.GetType(typeName); if (actionType != null) From a9ff561c8642bc891ea8666f9986fc06aafa22b9 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 00:13:29 +0700 Subject: [PATCH 07/18] Improve Logging --- .../Services/PersistenceService.cs | 25 +++++++++++-------- Source/TimeWarp.State.Plus/GlobalUsings.cs | 1 + 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/Source/TimeWarp.State.Plus/Features/Persistentence/Services/PersistenceService.cs b/Source/TimeWarp.State.Plus/Features/Persistentence/Services/PersistenceService.cs index 78dd69929..b2a54396a 100644 --- a/Source/TimeWarp.State.Plus/Features/Persistentence/Services/PersistenceService.cs +++ b/Source/TimeWarp.State.Plus/Features/Persistentence/Services/PersistenceService.cs @@ -22,25 +22,30 @@ ILogger logger } public async Task LoadState(Type stateType, PersistentStateMethod persistentStateMethod) { - string typeName = - stateType.Name ?? + string typeName = + stateType.Name ?? throw new InvalidOperationException("The type provided has a null full name, which is not supported for persistence operations."); - - Logger.LogInformation("PersistenceService.LoadState Loading State for {stateType}", stateType); + + Logger.LogInformation(EventIds.PersistenceService_LoadState, "Loading State for {stateType}", stateType); string? serializedState = persistentStateMethod switch { PersistentStateMethod.SessionStorage => await SessionStorageService.GetItemAsStringAsync(typeName), PersistentStateMethod.LocalStorage => await LocalStorageService.GetItemAsStringAsync(typeName), - PersistentStateMethod.PreRender => null,// TODO - PersistentStateMethod.Server => null,// TODO + PersistentStateMethod.PreRender => null, // TODO + PersistentStateMethod.Server => null, // TODO _ => null }; - object? result = - serializedState != null ? - JsonSerializer.Deserialize(serializedState, stateType, JsonSerializerOptions) : - null; + Logger.LogTrace + ( + EventIds.PersistenceService_LoadState_SerializedState, + "Serialized State: {serializedState}", + serializedState + ); + + object? result = + serializedState != null ? JsonSerializer.Deserialize(serializedState, stateType, JsonSerializerOptions) : null; if (result is IState state) { diff --git a/Source/TimeWarp.State.Plus/GlobalUsings.cs b/Source/TimeWarp.State.Plus/GlobalUsings.cs index 5e5020ccd..724aff486 100644 --- a/Source/TimeWarp.State.Plus/GlobalUsings.cs +++ b/Source/TimeWarp.State.Plus/GlobalUsings.cs @@ -10,3 +10,4 @@ global using Microsoft.JSInterop; global using System.Reflection; global using System.Text.Json; +global using TimeWarp.State.Plus; From 6cf9948c6c39b9247e626477bc373b956c020048 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 00:15:08 +0700 Subject: [PATCH 08/18] add StateInitializationTasks to the Store Inerface so our Middleware can make sure they are complete before running actions. --- Source/TimeWarp.State/Store/IStore.cs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Source/TimeWarp.State/Store/IStore.cs b/Source/TimeWarp.State/Store/IStore.cs index 2cc423057..301748c35 100644 --- a/Source/TimeWarp.State/Store/IStore.cs +++ b/Source/TimeWarp.State/Store/IStore.cs @@ -24,4 +24,6 @@ public interface IStore void RemoveState() where TState : IState; void Reset(); + + ConcurrentDictionary StateInitializationTasks { get; } } From 4b33c8583773f966901191b8f6a10f32619a242c Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:09:38 +0700 Subject: [PATCH 09/18] was missing a bracket --- .../PersistenceStateSourceGenerator.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs index bca95a879..1ada2b0fa 100644 --- a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs +++ b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs @@ -86,7 +86,7 @@ public override async System.Threading.Tasks.Task Handle(Action action, System.T } catch (Exception exception) { - Logger.LogError(exception, "Error loading {{className}}"); + Logger.LogError(exception, "Error loading {{{className}}}"); // if this is a JavaScript not available exception then we are prerendering and just swallow it } } From 7883557825d7463aa510d5a5d130fb18eaf2a472 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:10:06 +0700 Subject: [PATCH 10/18] remove primary constructor --- ...ePipelineNotificationRequestPreProcessor.cs | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/Tests/Test.App/Test.App.Client/Pipeline/NotificationPreProcessor/PrePipelineNotificationRequestPreProcessor.cs b/Tests/Test.App/Test.App.Client/Pipeline/NotificationPreProcessor/PrePipelineNotificationRequestPreProcessor.cs index d4ff5a0ac..f988bfe23 100644 --- a/Tests/Test.App/Test.App.Client/Pipeline/NotificationPreProcessor/PrePipelineNotificationRequestPreProcessor.cs +++ b/Tests/Test.App/Test.App.Client/Pipeline/NotificationPreProcessor/PrePipelineNotificationRequestPreProcessor.cs @@ -1,13 +1,19 @@ namespace Test.App.Client.Pipeline.NotificationPreProcessor; -internal class PrePipelineNotificationRequestPreProcessor -( - ILogger> logger, - IPublisher Publisher -) : IRequestPreProcessor +internal class PrePipelineNotificationRequestPreProcessor : IRequestPreProcessor where TRequest : IAction { - private readonly ILogger Logger = logger; + private readonly ILogger Logger; + private readonly IPublisher Publisher; + public PrePipelineNotificationRequestPreProcessor + ( + ILogger> logger, + IPublisher publisher + ) + { + Publisher = publisher; + Logger = logger; + } public Task Process(TRequest request, CancellationToken cancellationToken) { From f2b8978f892ae761c61379138430c178587659a6 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:10:21 +0700 Subject: [PATCH 11/18] newly generated code --- .../Test.App.Client.Features.Blue.BlueState_Persistence.g.cs | 2 +- ...Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs index 10a500186..79aea86c8 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs @@ -37,7 +37,7 @@ public override async System.Threading.Tasks.Task Handle(Action action, System.T } catch (Exception exception) { - Logger.LogError(exception, "Error loading {{className}}"); + Logger.LogError(exception, "Error loading BlueState"); // if this is a JavaScript not available exception then we are prerendering and just swallow it } } diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs index c9e6c110d..8d66971df 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs @@ -37,7 +37,7 @@ public override async System.Threading.Tasks.Task Handle(Action action, System.T } catch (Exception exception) { - Logger.LogError(exception, "Error loading {{className}}"); + Logger.LogError(exception, "Error loading PurpleState"); // if this is a JavaScript not available exception then we are prerendering and just swallow it } } From 82c7afc6419595b5fc93b44fa16d4f8456ca5ad6 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:11:01 +0700 Subject: [PATCH 12/18] Update Globals --- Tests/TimeWarp.State.Tests/ConventionTests.cs | 2 -- Tests/TimeWarp.State.Tests/GlobalUsings.cs | 2 ++ .../TimeWarpStateComponent/RegisterRenderTriggerTests.cs | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Tests/TimeWarp.State.Tests/ConventionTests.cs b/Tests/TimeWarp.State.Tests/ConventionTests.cs index 0764c7942..82f456fd9 100644 --- a/Tests/TimeWarp.State.Tests/ConventionTests.cs +++ b/Tests/TimeWarp.State.Tests/ConventionTests.cs @@ -1,7 +1,5 @@ namespace ConventionTest_; -using TimeWarp.Fixie; - [TestTag(TestTags.Fast)] public class SimpleNoApplicationTest_Should_ { diff --git a/Tests/TimeWarp.State.Tests/GlobalUsings.cs b/Tests/TimeWarp.State.Tests/GlobalUsings.cs index 976835c11..d8b1a31b2 100644 --- a/Tests/TimeWarp.State.Tests/GlobalUsings.cs +++ b/Tests/TimeWarp.State.Tests/GlobalUsings.cs @@ -1,5 +1,7 @@ global using FluentAssertions; global using MediatR; +global using System.Collections.Concurrent; global using System.Linq.Expressions; global using System.Reflection; +global using TimeWarp.Fixie; global using TimeWarp.State; diff --git a/Tests/TimeWarp.State.Tests/TimeWarpStateComponent/RegisterRenderTriggerTests.cs b/Tests/TimeWarp.State.Tests/TimeWarpStateComponent/RegisterRenderTriggerTests.cs index 2fe9754db..4e49530a0 100644 --- a/Tests/TimeWarp.State.Tests/TimeWarpStateComponent/RegisterRenderTriggerTests.cs +++ b/Tests/TimeWarp.State.Tests/TimeWarpStateComponent/RegisterRenderTriggerTests.cs @@ -1,7 +1,5 @@ namespace RegisterRenderTrigger; -using TimeWarp.Fixie; - public class Should_ { public static void RegisterRenderTrigger_NullPropertySelector_ThrowsArgumentNullException() @@ -281,5 +279,6 @@ public void SetComponentStore(TimeWarpStateComponent component) public Guid Guid { get; } = Guid.Empty; public SemaphoreSlim GetSemaphore(Type stateType) => throw new NotImplementedException(); public void Reset() => throw new NotImplementedException(); + public ConcurrentDictionary StateInitializationTasks { get; } = new(); public void RemoveState() where TState : IState => throw new NotImplementedException(); } From e58a5d083945263bcb5280358e3625b36b8f1155 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:12:42 +0700 Subject: [PATCH 13/18] Add StateInitializationPreProcessor EventIds --- Source/TimeWarp.State/EventIds.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Source/TimeWarp.State/EventIds.cs b/Source/TimeWarp.State/EventIds.cs index 623c8eb96..bbbd71f67 100644 --- a/Source/TimeWarp.State/EventIds.cs +++ b/Source/TimeWarp.State/EventIds.cs @@ -27,7 +27,6 @@ internal class EventIds public static readonly EventId Subscriptions_RemovingComponentSubscriptions = new(302, nameof(Subscriptions_RemovingComponentSubscriptions)); public static readonly EventId Subscriptions_ReRenderingSubscribers = new(303, nameof(Subscriptions_ReRenderingSubscribers)); public static readonly EventId Subscriptions_RemoveSubscription = new(304, nameof(Subscriptions_RemoveSubscription)); - // Routing // Pipeline - Middleware @@ -72,4 +71,8 @@ internal class EventIds public static readonly EventId TimeWarpStateComponent_ShouldReRender = new(701, nameof(TimeWarpStateComponent_ShouldReRender)); public static readonly EventId TimeWarpStateComponent_Disposing = new(702, nameof(TimeWarpStateComponent_Disposing)); public static readonly EventId TimeWarpStateComponent_RenderCount = new(702, nameof(TimeWarpStateComponent_RenderCount)); + + // StateInitializationPreProcessor + public static readonly EventId StateInitializationPreProcessor_Waiting = new(800, nameof(StateInitializationPreProcessor_Waiting)); + public static readonly EventId StateInitializationPreProcessor_Completed = new(801, nameof(StateInitializationPreProcessor_Completed)); } From ea1914d7553ae4f8d04230dacab2d32b38dbad6a Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:15:16 +0700 Subject: [PATCH 14/18] Keep StateInitializationTasks list so we can wait for them to complete with our preprocessor. --- Source/TimeWarp.State/Store/Store.cs | 39 ++++++++++++++++------------ 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/Source/TimeWarp.State/Store/Store.cs b/Source/TimeWarp.State/Store/Store.cs index fca73b360..7e8a42858 100644 --- a/Source/TimeWarp.State/Store/Store.cs +++ b/Source/TimeWarp.State/Store/Store.cs @@ -19,6 +19,7 @@ internal partial class Store : IStore /// /// Useful when logging public Guid Guid { get; } = Guid.NewGuid(); + public ConcurrentDictionary StateInitializationTasks { get; } = new(); public Store ( @@ -103,38 +104,44 @@ public object GetState(Type stateType) if (!States.TryGetValue(typeName, out IState? state)) { Logger.LogDebug(EventIds.Store_CreateState, "Creating State of type: {typeName}", typeName); - + // will use default constructor if none exists state = (IState)ServiceProvider.GetRequiredService(stateType); - + // we need to set the sender if the default constructor was used state.Sender = ServiceProvider.GetRequiredService(); - + state.Initialize(); if (!States.TryAdd(typeName, state)) { throw new InvalidOperationException($"An element with the key '{typeName}' already exists in the States dictionary."); } + + // Publish the state initialization notification asynchronously + Task initializationTask = Publisher.Publish(new StateInitializedNotification(stateType)) + .ContinueWith + ( + t => + { + if (t.Exception != null) + { + Logger.LogError(t.Exception, "Error occurred while publishing state initialization notification."); + } + }, + TaskScheduler.Default + ); - // Fire-and-forget publishing the state initialization notification with exception handling - Task.Run(async () => - { - try - { - await Publisher.Publish(new StateInitializedNotification(stateType)); - } - catch (Exception ex) - { - Logger.LogError(ex, "Error occurred while publishing state initialization notification."); - } - }); + StateInitializationTasks[typeName] = initializationTask; } else + { Logger.LogDebug(EventIds.Store_GetState, "State of type ({typeName}) exists with Guid: {state_Guid}", typeName, state.Guid); + } + return state; } } - + public object? GetPreviousState(Type stateType) { string typeName = stateType.FullName ?? throw new InvalidOperationException(); From 8892fa294f40bf6cdf6a962376f03c4a38e40aa7 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:15:54 +0700 Subject: [PATCH 15/18] A Preprocessor that waits for Initialize to complete. --- .../StateInitializationPreProcessor.cs | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 Source/TimeWarp.State/Features/StateInitialization/StateInitializationPreProcessor.cs diff --git a/Source/TimeWarp.State/Features/StateInitialization/StateInitializationPreProcessor.cs b/Source/TimeWarp.State/Features/StateInitialization/StateInitializationPreProcessor.cs new file mode 100644 index 000000000..9639cfab9 --- /dev/null +++ b/Source/TimeWarp.State/Features/StateInitialization/StateInitializationPreProcessor.cs @@ -0,0 +1,46 @@ +namespace TimeWarp.State; + +public class StateInitializationPreProcessor : IRequestPreProcessor where TRequest : IAction +{ + private readonly IStore Store; + private readonly ILogger> Logger; + + public StateInitializationPreProcessor(IStore store, ILogger> logger) + { + Store = store; + Logger = logger; + } + + public async Task Process(TRequest request, CancellationToken cancellationToken) + { + string typeName = typeof(TRequest).GetEnclosingStateType().FullName ?? throw new InvalidOperationException(); + + // Wait for the state initialization to complete before processing the action + if (Store.StateInitializationTasks.TryGetValue(typeName, out Task? initializationTask)) + { + try + { + Logger.LogTrace + ( + EventIds.StateInitializationPreProcessor_Waiting, + "Waiting for state initialization to complete. State type: {StateType}", + typeName + ); + + await initializationTask; + + Logger.LogTrace + ( + EventIds.StateInitializationPreProcessor_Completed, + "State initialization completed. State type: {StateType}", + typeName + ); + } + catch (Exception ex) + { + Logger.LogError(ex, "Error occurred while waiting for state initialization."); + throw; + } + } + } +} From d531dc839b79c09e1aa7c4f8e0688bff6ab9f9af Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:16:19 +0700 Subject: [PATCH 16/18] Register our StateInitializationPreProcessor --- .../ServiceCollectionExtensions.AddTimeWarpState.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Source/TimeWarp.State/Extensions/ServiceCollectionExtensions.AddTimeWarpState.cs b/Source/TimeWarp.State/Extensions/ServiceCollectionExtensions.AddTimeWarpState.cs index c0ce33efe..1e0cca800 100644 --- a/Source/TimeWarp.State/Extensions/ServiceCollectionExtensions.AddTimeWarpState.cs +++ b/Source/TimeWarp.State/Extensions/ServiceCollectionExtensions.AddTimeWarpState.cs @@ -44,11 +44,14 @@ public static IServiceCollection AddTimeWarpState EnsureHttpClient(serviceCollection); EnsureStates(serviceCollection, timeWarpStateOptions); EnsureMediator(serviceCollection, timeWarpStateOptions); - + + serviceCollection.AddTransient(typeof(IRequestPreProcessor<>), typeof(StateInitializationPreProcessor<>)); + if (timeWarpStateOptions.UseStateTransactionBehavior) { serviceCollection.AddScoped(typeof(IPipelineBehavior<,>), typeof(StateTransactionBehavior<,>)); } + return serviceCollection; } From b5c563e0e425a16a864e9d57a9729eab2387ba51 Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:17:21 +0700 Subject: [PATCH 17/18] Bump version --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index d9c96c9e1..f3c955970 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,7 +1,7 @@ - 11.0.0-beta.74+8.0.303 + 11.0.0-beta.75+8.0.303 Steven T. Cramer TimeWarp State $(TimeWarpStateVersion) From 61b3caca0383111b8e57c6f4e7aea60caa8ef6fb Mon Sep 17 00:00:00 2001 From: "Steven T. Cramer" Date: Thu, 1 Aug 2024 01:33:26 +0700 Subject: [PATCH 18/18] Update sourcegen to remove empty brackets. --- .../PersistenceStateSourceGenerator.cs | 2 +- .../Test.App.Client.Features.Blue.BlueState_Persistence.g.cs | 2 +- ...Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs index 1ada2b0fa..96af0966f 100644 --- a/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs +++ b/Source/TimeWarp.State.SourceGenerator/PersistenceStateSourceGenerator.cs @@ -59,7 +59,7 @@ public partial class {{{className}}} { public static class Load { - public class Action : IAction { } + public class Action : IAction; public class Handler : ActionHandler { diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs index 79aea86c8..9778d119a 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Blue.BlueState_Persistence.g.cs @@ -10,7 +10,7 @@ public partial class BlueState { public static class Load { - public class Action : IAction { } + public class Action : IAction; public class Handler : ActionHandler { diff --git a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs index 8d66971df..067678274 100644 --- a/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs +++ b/Tests/Test.App/Test.App.Client/Generated/TimeWarp.State.SourceGenerator/TimeWarp.State.SourceGenerator.PersistenceStateSourceGenerator/Test.App.Client.Features.Purple.PurpleState_Persistence.g.cs @@ -10,7 +10,7 @@ public partial class PurpleState { public static class Load { - public class Action : IAction { } + public class Action : IAction; public class Handler : ActionHandler {