Merge pull request #384 from TimeWarpEngineering/Cramer/2024-03-03/Fe…

…atureNamespaces Change BlazorState.Features to TimeWarp.Features
TimeWarpEngineering · Mar 3, 2024 · b54d2da · b54d2da
2 parents 5559fb7 + 75d0e8b
commit b54d2da
Show file tree

Hide file tree

Showing 41 changed files with 173 additions and 157 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Authors>Steven T. Cramer</Authors>
     <Product>Blazor State</Product>
-    <PackageVersion>11.0.0-beta.8+8.0.101</PackageVersion>
+    <PackageVersion>11.0.0-beta.9+8.0.101</PackageVersion>
     <PackageProjectUrl>https://timewarpengineering.github.io/blazor-state/</PackageProjectUrl>
     <PackageTags>TimeWarp-State; TimeWarpState; BlazorState; Blazor; State; Blazor-State; MediatR; Mediator; Pipeline; Redux; Flux</PackageTags>
     <PackageIcon>Logo.png</PackageIcon>

diff --git a/Samples/01-StateActionsHandlers/Sample/Client/App.razor.cs b/Samples/01-StateActionsHandlers/Sample/Client/App.razor.cs
@@ -2,8 +2,8 @@
 
 using System.Threading.Tasks;
 using BlazorState.Pipeline.ReduxDevTools;
-using BlazorState.Features.JavaScriptInterop;
-using BlazorState.Features.Routing;
+using TimeWarp.Features.JavaScriptInterop;
+using TimeWarp.Features.Routing;
 using Microsoft.AspNetCore.Components;
 
 public partial class App : ComponentBase

diff --git a/...ionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/Components/Counter.razor b/...ionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/Components/Counter.razor
@@ -1,4 +1,4 @@
-@using BlazorState.Features.Developer.Components
+@using TimeWarp.Features.Developer.Components
 @inherits BlazorState.Pipeline.ReduxDevTools.BlazorStateDevToolsComponent
 <h3>Counter</h3>
 @RenderModeDisplay

diff --git a/...nsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/CounterState.LoadAction.cs b/...nsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/CounterState.LoadAction.cs
@@ -1,8 +1,6 @@
 namespace SampleDotNet8.Client.Features.Counter;
 
-using BlazorState.Features.Persistence.Abstractions;
-using BlazorState.Features.Persistence.Attributes;
-using BlazorState.Services;
+using TimeWarp.Features.Persistence.Abstractions;
 using System.Diagnostics.CodeAnalysis;
 
 public partial class CounterState

diff --git a/...-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/CounterState.cs b/...-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter/CounterState.cs
@@ -1,6 +1,6 @@
 namespace SampleDotNet8.Client.Features.Counter;
 
-using BlazorState.Features.Persistence.Attributes;
+using TimeWarp.Features.Persistence.Attributes;
 using System.Text.Json.Serialization;
 
 [PersistentState(PersistentStateMethod.LocalStorage)]

diff --git a/...Handlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter2/Counter2State.LoadAction.cs b/...Handlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter2/Counter2State.LoadAction.cs
@@ -1,7 +1,7 @@
 namespace SampleDotNet8.Client.Features.Counter2;
 
-using BlazorState.Features.Persistence.Abstractions;
-using BlazorState.Features.Persistence.Attributes;
+using TimeWarp.Features.Persistence.Abstractions;
+using TimeWarp.Features.Persistence.Attributes;
 using BlazorState.Services;
 using System.Diagnostics.CodeAnalysis;
 
@@ -35,7 +35,7 @@ public override async Task Handle(Action aAction, CancellationToken aCancellatio
         }
         catch (Exception e)
         {
-          // if this is a JavaScript not avaailable exception then we are prerendering and just ignore it
+          // if this is a JavaScript not available exception then we are prerendering and just ignore it
           Console.WriteLine("**********************************");
           Console.WriteLine(e);
           Console.WriteLine("**********************************");

diff --git a/...tateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter2/Counter2State.cs b/...tateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Features/Counter2/Counter2State.cs
@@ -1,6 +1,6 @@
 namespace SampleDotNet8.Client.Features.Counter2;
 
-using BlazorState.Features.Persistence.Attributes;
+using TimeWarp.Features.Persistence.Attributes;
 using System.Text.Json.Serialization;
 
 [PersistentState(PersistentStateMethod.LocalStorage)]

diff --git a/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Pages/CounterPage.razor b/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Pages/CounterPage.razor
@@ -33,6 +33,6 @@ else
   <button class="btn btn-primary" @onclick="IncrementCount2">Click me</button>
 }
 
-<BlazorState.Features.ReduxDevTools.Components.ReduxDevTools />
-<BlazorState.Features.JavaScriptInterop.Components.TimeWarpJavaScriptInterop />
-<BlazorState.Features.Routing.Components.TimeWarpNavigation />
+<TimeWarp.Features.ReduxDevTools.Components.ReduxDevTools />
+<TimeWarp.Features.JavaScriptInterop.Components.TimeWarpJavaScriptInterop />
+<TimeWarp.Features.Routing.Components.TimeWarpNavigation />
diff --git a/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Program.cs b/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8.Client/Program.cs
@@ -2,7 +2,7 @@ namespace SampleDotNet8.Client;
 
 using Blazored.LocalStorage;
 using TimeWarp.State.Plus.PersistentState;
-using BlazorState.Features.Persistence.Abstractions;
+using TimeWarp.Features.Persistence.Abstractions;
 public class Program
 {
   private static async Task Main(string[] args)

diff --git a/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8/Components/Pages/Weather.razor b/Samples/01-StateActionsHandlers/SampleDotNet8/SampleDotNet8/Components/Pages/Weather.razor
@@ -1,78 +1,78 @@
-@page "/weather"
-@attribute [StreamRendering]
-
-<PageTitle>Weather</PageTitle>
-
-<h1>Weather</h1>
-
-<p>This component demonstrates showing data.</p>
-
-@if (System.OperatingSystem.IsBrowser())
-{
-  <p>Render Mode: WebAssembly</p>
-}
-else
-{
-  <p>Render Mode: Server (Not Wasm)</p>
-}
-
-@if (forecasts == null)
-{
-    <p><em>Loading...</em></p>
-}
-else
-{
-    <table class="table">
-        <thead>
-            <tr>
-                <th>Date</th>
-                <th>Temp. (C)</th>
-                <th>Temp. (F)</th>
-                <th>Summary</th>
-            </tr>
-        </thead>
-        <tbody>
-            @foreach (var forecast in forecasts)
-            {
-                <tr>
-                    <td>@forecast.Date.ToShortDateString()</td>
-                    <td>@forecast.TemperatureC</td>
-                    <td>@forecast.TemperatureF</td>
-                    <td>@forecast.Summary</td>
-                </tr>
-            }
-        </tbody>
-    </table>
-}
-
-<BlazorState.Features.ReduxDevTools.Components.ReduxDevTools />
-<BlazorState.Features.JavaScriptInterop.Components.TimeWarpJavaScriptInterop />
-<BlazorState.Features.Routing.Components.TimeWarpNavigation />
-
-
-@code {
-    private WeatherForecast[]? forecasts;
-
-    protected override async Task OnInitializedAsync()
-    {
-        // Simulate asynchronous loading to demonstrate streaming rendering
-        await Task.Delay(500);
-
-        var startDate = DateOnly.FromDateTime(DateTime.Now);
-        var summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" };
-        forecasts = Enumerable.Range(1, 5).Select(index => new WeatherForecast
-        {
-            Date = startDate.AddDays(index),
-            TemperatureC = Random.Shared.Next(-20, 55),
-            Summary = summaries[Random.Shared.Next(summaries.Length)]
-        }).ToArray();
-    }
-
-    private class WeatherForecast
-    {
-        public DateOnly Date { get; set; }
-        public int TemperatureC { get; set; }
-        public string? Summary { get; set; }
-        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
-    }
-}
+@page "/weather"
+@attribute [StreamRendering]
+
+<PageTitle>Weather</PageTitle>
+
+<h1>Weather</h1>
+
+<p>This component demonstrates showing data.</p>
+
+@if (System.OperatingSystem.IsBrowser())
+{
+  <p>Render Mode: WebAssembly</p>
+}
+else
+{
+  <p>Render Mode: Server (Not Wasm)</p>
+}
+
+@if (forecasts == null)
+{
+    <p><em>Loading...</em></p>
+}
+else
+{
+    <table class="table">
+        <thead>
+            <tr>
+                <th>Date</th>
+                <th>Temp. (C)</th>
+                <th>Temp. (F)</th>
+                <th>Summary</th>
+            </tr>
+        </thead>
+        <tbody>
+            @foreach (var forecast in forecasts)
+            {
+                <tr>
+                    <td>@forecast.Date.ToShortDateString()</td>
+                    <td>@forecast.TemperatureC</td>
+                    <td>@forecast.TemperatureF</td>
+                    <td>@forecast.Summary</td>
+                </tr>
+            }
+        </tbody>
+    </table>
+}
+
+<TimeWarp.Features.ReduxDevTools.Components.ReduxDevTools />
+<TimeWarp.Features.JavaScriptInterop.Components.TimeWarpJavaScriptInterop />
+<TimeWarp.Features.Routing.Components.TimeWarpNavigation />
+
+
+@code {
+    private WeatherForecast[]? forecasts;
+
+    protected override async Task OnInitializedAsync()
+    {
+        // Simulate asynchronous loading to demonstrate streaming rendering
+        await Task.Delay(500);
+
+        var startDate = DateOnly.FromDateTime(DateTime.Now);
+        var summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" };
+        forecasts = Enumerable.Range(1, 5).Select(index => new WeatherForecast
+        {
+            Date = startDate.AddDays(index),
+            TemperatureC = Random.Shared.Next(-20, 55),
+            Summary = summaries[Random.Shared.Next(summaries.Length)]
+        }).ToArray();
+    }
+
+    private class WeatherForecast
+    {
+        public DateOnly Date { get; set; }
+        public int TemperatureC { get; set; }
+        public string? Summary { get; set; }
+        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+    }
+}
diff --git a/Source/BlazorState/EventIds.cs b/Source/BlazorState/EventIds.cs
@@ -11,12 +11,12 @@ internal class EventIds
   public static readonly EventId JsonRequestOfInvalidType = new(203, nameof(JsonRequestOfInvalidType));
   //   Routing
   // Pipeline - Middleware
-  //   CloneState
-  public static readonly EventId CloneStateBehavior_Initializing = new(400, nameof(CloneStateBehavior_Initializing));
-  public static readonly EventId CloneStateBehavior_Cloning = new(401, nameof(CloneStateBehavior_Cloning));
-  public static readonly EventId CloneStateBehavior_Ignoring = new(402, nameof(CloneStateBehavior_Ignoring));
-  public static readonly EventId CloneStateBehavior_Exception = new(403, nameof(CloneStateBehavior_Exception));
-  public static readonly EventId CloneStateBehavior_Restored = new(404, nameof(CloneStateBehavior_Restored));
+  //   StateTransaction
+  public static readonly EventId StateTransactionBehavior_Initializing = new(400, nameof(StateTransactionBehavior_Initializing));
+  public static readonly EventId StateTransactionBehavior_Cloning = new(401, nameof(StateTransactionBehavior_Cloning));
+  public static readonly EventId StateTransactionBehavior_Ignoring = new(402, nameof(StateTransactionBehavior_Ignoring));
+  public static readonly EventId StateTransactionBehavior_Exception = new(403, nameof(StateTransactionBehavior_Exception));
+  public static readonly EventId StateTransactionBehavior_Restored = new(404, nameof(StateTransactionBehavior_Restored));
 
   //   ReduxDevTools
   public static readonly EventId StartHandler_Initializing = new(500, nameof(StartHandler_Initializing));

diff --git a/Source/BlazorState/Extensions/BlazorStateOptions.cs b/Source/BlazorState/Extensions/BlazorStateOptions.cs
@@ -7,7 +7,7 @@ public class BlazorStateOptions
   ///// </summary>
   public IEnumerable<Assembly> Assemblies { get; set; }
 
-  public bool UseCloneStateBehavior { get; set; } = true;
+  public bool UseStateTransactionBehavior { get; set; } = true;
 
   public bool UseRouting { get; set; } = true;
 

diff --git a/Source/BlazorState/Extensions/ServiceCollectionExtensions.cs b/Source/BlazorState/Extensions/ServiceCollectionExtensions.cs
@@ -38,9 +38,9 @@ public static IServiceCollection AddBlazorState
     EnsureStates(aServiceCollection, blazorStateOptions);
     EnsureMediator(aServiceCollection, blazorStateOptions);
 
-    if (blazorStateOptions.UseCloneStateBehavior)
+    if (blazorStateOptions.UseStateTransactionBehavior)
     {
-      aServiceCollection.AddScoped(typeof(IPipelineBehavior<,>), typeof(CloneStateBehavior<,>));
+      aServiceCollection.AddScoped(typeof(IPipelineBehavior<,>), typeof(StateTransactionBehavior<,>));
     }
 
     if (blazorStateOptions.UseRouting)
@@ -59,8 +59,8 @@ private static void EnsureHttpClient(IServiceCollection aServiceCollection)
   {
     var blazorHostingLocation = new BlazorHostingLocation();
 
-    // Test.App.Server Side Blazor doesn't register HttpClient by default
-    if (!blazorHostingLocation.IsServerSide) return;
+    // Test.App.Client Side Blazor registers HttpClient by default
+    if (blazorHostingLocation.IsClientSide) return;
 
     // Double check that nothing is registered.
     if (aServiceCollection.HasRegistrationFor(typeof(HttpClient))) return;

diff --git a/...Pipeline/CloneState/CloneStateBehavior.cs → ...tate/Pipeline/StateTransactionBehavior.cs b/...Pipeline/CloneState/CloneStateBehavior.cs → ...tate/Pipeline/StateTransactionBehavior.cs
@@ -1,22 +1,37 @@
 #nullable enable
-namespace BlazorState.Pipeline.State;
+namespace TimeWarp.Features.StateTransaction;
 
-internal sealed class CloneStateBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
+/// <summary>
+///   Represents a pipeline behavior in BlazorState that clones the current state before processing a request.
+///   This behavior ensures that the state can be reverted to its original form in case of an error during the request handling.
+///   The cloning process is contingent upon the state implementing <see cref="ICloneable"/>, allowing for a deep copy.
+///   If the state does not implement <see cref="ICloneable"/>, it falls back to a custom clone method. This behavior is
+///   critical for maintaining application consistency and enables undo functionality.
+/// </summary>
+/// <remarks>
+///   This behavior is part of the BlazorState pipeline, intercepting actions (requests) to clone the relevant state before
+///   proceeding. If an action fails, the system reverts to the cloned state, thus preventing partial state updates
+///   from corrupting the application state. It uses MediatR's pipeline behavior feature to hook into the request handling
+///   process.
+/// </remarks> 
+/// <typeparam name="TRequest"></typeparam>
+/// <typeparam name="TResponse"></typeparam>
+public sealed class StateTransactionBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
   where TRequest : notnull, IAction
 {
   private readonly ILogger Logger;
   private readonly IPublisher Publisher;
   private readonly IStore Store;
 
-  public CloneStateBehavior
+  public StateTransactionBehavior
   (
-    ILogger<CloneStateBehavior<TRequest, TResponse>> logger,
+    ILogger<StateTransactionBehavior<TRequest, TResponse>> logger,
     IStore store,
     IPublisher publisher
   )
   {
     Logger = logger;
-    Logger.LogDebug(EventIds.CloneStateBehavior_Initializing, "constructing");
+    Logger.LogDebug(EventIds.StateTransactionBehavior_Initializing, "constructing");
     Store = store;
     Publisher = publisher;
   }
@@ -43,7 +58,7 @@ CancellationToken aCancellationToken
 
     Logger.LogDebug
     (
-      EventIds.CloneStateBehavior_Cloning,
+      EventIds.StateTransactionBehavior_Cloning,
       "Clone State of type {declaringType} originalState.Guid:{originalState_Guid} newState.Guid:{newState_Guid}",
       enclosingStateType,
       originalState.Guid,
@@ -60,20 +75,20 @@ CancellationToken aCancellationToken
     catch (Exception exception)
     {
       // If something fails we restore system to previous state.
-      Logger.LogWarning(EventIds.CloneStateBehavior_Exception, exception, "Error cloning State");
+      Logger.LogWarning(EventIds.StateTransactionBehavior_Exception, exception, "Error cloning State");
 
       Store.SetState(originalState);
 
       Logger.LogWarning
       (
-        EventIds.CloneStateBehavior_Restored,
+        EventIds.StateTransactionBehavior_Restored,
         "Restored State of type: {enclosingStateType}",
         enclosingStateType
       );
 
       var exceptionNotification = new ExceptionNotification
       {
-        RequestName = nameof(CloneStateBehavior<TRequest, TResponse>),
+        RequestName = nameof(StateTransactionBehavior<TRequest, TResponse>),
         Exception = exception
       };
 

diff --git a/Source/BlazorState/Features/Developer/Components/ReduxDevTools.razor b/Source/BlazorState/Features/Developer/Components/ReduxDevTools.razor
@@ -1,4 +1,5 @@
-@code {
+@namespace TimeWarp.Features.Developer
+@code {
 
   [Inject] private ReduxDevToolsInterop ReduxDevToolsInterop { get; set; }
 

diff --git a/Source/BlazorState/Features/Developer/Components/RenderModeDisplay.razor b/Source/BlazorState/Features/Developer/Components/RenderModeDisplay.razor
@@ -1,3 +1,4 @@
+@namespace TimeWarp.Features.Developer
 <div class="render-mode-display">
     <div>Current Render Mode: @CurrentRenderMode</div>
     <div>Configured Render Mode: @ConfiguredRenderMode</div>

diff --git a/Source/BlazorState/Features/JavaScriptInterop/Components/TimeWarpJavaScriptInterop.razor b/Source/BlazorState/Features/JavaScriptInterop/Components/TimeWarpJavaScriptInterop.razor
@@ -1,5 +1,4 @@
-
-@using BlazorState.Features.JavaScriptInterop;
+@namespace TimeWarp.Features.JavaScriptInterop
 
 @code {