Merge pull request #460 from TimeWarpEngineering/Cramer/2024-07-25/Next

Add TimeWarp.State.Rules and Architecture Tests Add Cancelation Tokens to State and TimeWarpStateComponent.

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
   <!-- Set common properties regarding assembly information and nuget packages -->
   <PropertyGroup>
-    <TimeWarpStateVersion>11.0.0-beta.75+8.0.303</TimeWarpStateVersion>
+    <TimeWarpStateVersion>11.0.0-beta.76+8.0.303</TimeWarpStateVersion>
     <Authors>Steven T. Cramer</Authors>
     <Product>TimeWarp State</Product>
     <PackageVersion>$(TimeWarpStateVersion)</PackageVersion>

Directory.Packages.props

@@ -42,6 +42,7 @@
     <PackageVersion Include="Microsoft.TypeScript.MSBuild" Version="5.5.3" />
     <PackageVersion Include="MSTest.TestAdapter" Version="3.5.0" />
     <PackageVersion Include="MSTest.TestFramework" Version="3.5.0" />
+    <PackageVersion Include="NetArchTest.eNhancedEdition" Version="1.4.3" />
     <PackageVersion Include="NUnit" Version="4.1.0" />
     <PackageVersion Include="NUnit.Analyzers" Version="4.2.0" />
     <PackageVersion Include="NUnit3TestAdapter" Version="4.5.0" />
@@ -59,4 +60,4 @@
     <PackageVersion Include="coverlet.msbuild" Version="6.0.0" />
     <PackageVersion Include="timewarp-heroicons" Version="2.0.19" />
   </ItemGroup>
-</Project>
+</Project>

Samples/00-StateActionHandler/Sample/Sample.Client/Features/Counter/Actions/CounterState.IncrementCount.cs

@@ -3,11 +3,11 @@ namespace Sample.Client.Features.Counter;
 
 using TimeWarp.State;
 
-internal partial class CounterState
+public partial class CounterState
 {
-  public static class IncrementCountActionSet
+  internal static class IncrementCountActionSet
   {
-    public sealed class Action : IAction
+    internal sealed class Action : IAction
     {
       public int Amount { get; }
       public Action(int amount)
@@ -16,7 +16,7 @@ public Action(int amount)
       }
     }
 
-    public sealed class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       public Handler(IStore store) : base(store) {}
 

Samples/00-StateActionHandler/Sample/Sample.Client/Features/Counter/CounterState.cs

@@ -3,7 +3,7 @@ namespace Sample.Client.Features.Counter;
 
 using TimeWarp.State;
 
-internal sealed partial class CounterState : State<CounterState>
+public sealed partial class CounterState : State<CounterState>
 {
   public int Count { get; private set; }
   public override void Initialize()

Samples/03-ServerSide/Sample/Features/Counter/Actions/CounterState.IncrementCount.cs

@@ -7,7 +7,7 @@ internal partial class CounterState
 {
   public static class IncrementCountActionSet
   {
-    public sealed class Action : IAction
+    internal sealed class Action : IAction
     {
       public int Amount { get; }
       public Action(int amount)
@@ -16,7 +16,7 @@ public Action(int amount)
       }
     }
 
-    public sealed class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       public Handler(IStore store) : base(store) {}
 

Source/TimeWarp.State.Plus/Features/ActionTracking/ActionTrackingState.cs

@@ -1,6 +1,6 @@
 namespace TimeWarp.Features.ActionTracking;
 
-public partial class ActionTrackingState : State<ActionTrackingState>, ICloneable
+public sealed partial class ActionTrackingState : State<ActionTrackingState>, ICloneable
 {
   private List<IAction> ActiveActionList = [];
   public ActionTrackingState(ISender sender) : base(sender) {}

Source/TimeWarp.State.Plus/Features/ActionTracking/Actions/ActionTrackingState.CompleteProcessing.cs

@@ -4,7 +4,7 @@ public partial class ActionTrackingState
 {
   public static class CompleteProcessingActionSet
   {
-    public class Action : IAction
+    internal sealed class Action : IAction
     {
       public IAction TheAction { get; }
       public Action(IAction theAction)
@@ -14,7 +14,7 @@ public Action(IAction theAction)
     }
 
     [UsedImplicitly]
-    internal class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       private readonly ILogger<Handler> Logger;
       public Handler(IStore store, ILogger<Handler> logger) : base(store)
@@ -42,6 +42,16 @@ public override Task Handle(Action action, CancellationToken cancellationToken)
     }
   }
 
-  // public async Task CompleteProcessing(IAction theAction, CancellationToken cancellationToken) =>
-  //   await Sender.Send(new ActionTrackingState.CompleteProcessingActionSet.Action(theAction), cancellationToken);
+  public async Task CompleteProcessing(IAction theAction, CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new ActionTrackingState.CompleteProcessingActionSet.Action(theAction),
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/ActionTracking/Actions/ActionTrackingState.StartProcessing.cs

@@ -4,7 +4,7 @@ public partial class ActionTrackingState
 {
   public static class StartProcessingActionSet
   {
-    internal class Action : IAction
+    internal sealed class Action : IAction
     {
       public Action(IAction theAction) 
       {
@@ -13,12 +13,9 @@ public Action(IAction theAction)
       public IAction TheAction { get; }
     }
 
-    [UsedImplicitly]
-    internal class Handler
-    (
-      IStore store
-    ): ActionHandler<Action>(store)
+    internal sealed class Handler : ActionHandler<Action>
     {
+      public Handler(IStore store) : base(store) {}
       private ActionTrackingState ActionTrackingState => Store.GetState<ActionTrackingState>();
 
       public override Task Handle(Action action, CancellationToken cancellationToken)
@@ -29,6 +26,16 @@ public override Task Handle(Action action, CancellationToken cancellationToken)
     }
   }
 
-  // public async Task StartProcessing(IAction theAction, CancellationToken cancellationToken) =>
-  //   await Sender.Send(new ActionTrackingState.StartProcessingActionSet.Action(theAction), cancellationToken);
+  public async Task StartProcessing(IAction theAction, CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new ActionTrackingState.StartProcessingActionSet.Action(theAction),
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/FeatureFlags/Actions/FeatureFlagState.cs

@@ -1,6 +1,6 @@
 namespace TimeWarp.State.Plus.Features.FeatureFlags.Actions;
 
-public class FeatureFlagState : State<FeatureFlagState>
+public sealed class FeatureFlagState : State<FeatureFlagState>
 {
   public FeatureFlagState(ISender sender) : base(sender) {}
 

Source/TimeWarp.State.Plus/Features/Persistentence/StateInitializedNotificationHandler.cs

@@ -19,7 +19,7 @@ public async Task Handle(StateInitializedNotification stateInitializedNotificati
     string fullName = stateInitializedNotification.StateType.FullName ?? throw new InvalidOperationException();
     string assemblyQualifiedName = stateInitializedNotification.StateType.AssemblyQualifiedName ?? throw new InvalidOperationException();
 
-    string typeName = assemblyQualifiedName.Replace(fullName, $"{fullName}+Load+Action");
+    string typeName = assemblyQualifiedName.Replace(fullName, $"{fullName}+LoadActionSet+Action");
     Logger.LogDebug(EventIds.StateInitializedNotificationHandler_Handling, "StateInitializedNotificationHandler: {StateTypeName}", stateInitializedNotification.StateType.Name);
     var actionType = Type.GetType(typeName);
 

Source/TimeWarp.State.Plus/Features/Routing/Actions/RouteState.ChangeRoute.cs

@@ -4,7 +4,7 @@ public partial class RouteState
 {
   public static class ChangeRouteActionSet
   {
-    public class Action : IAction
+    internal sealed class Action : IAction
     {
       public Action(string newRoute) 
       {
@@ -13,7 +13,7 @@ public Action(string newRoute)
       public string NewRoute { get; }
     }
 
-    internal class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       private readonly ILogger Logger;
       private readonly NavigationManager NavigationManager;
@@ -42,6 +42,16 @@ public override Task Handle(Action action, CancellationToken cancellationToken)
       }
     }
   }
-  public async Task ChangeRoute(string newRoute, CancellationToken cancellationToken = default) =>
-    await Sender.Send(new RouteState.ChangeRouteActionSet.Action(newRoute), cancellationToken);
+  public async Task ChangeRoute(string newRoute, CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new RouteState.ChangeRouteActionSet.Action(newRoute),
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/Routing/Actions/RouteState.GoBack.cs

@@ -5,7 +5,7 @@ public partial class RouteState
   public static class GoBackActionSet
   {
     [UsedImplicitly]
-    public class Action : IAction
+    internal sealed class Action : IAction
     {
       public int Amount { get; }
       public Action(int amount = 1)
@@ -14,7 +14,7 @@ public Action(int amount = 1)
       }
     }
 
-    internal class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       private readonly NavigationManager NavigationManager;
       public Handler
@@ -45,6 +45,16 @@ public override Task Handle(Action action, CancellationToken cancellationToken)
     }
   }
 
-  public async Task GoBack(int amount = 1, CancellationToken cancellationToken = default) => 
-    await Sender.Send(new GoBackActionSet.Action(amount), cancellationToken);
+  public async Task GoBack(int amount = 1, CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new GoBackActionSet.Action(amount),
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/Routing/Actions/RouteState.PushRouteInfo.cs

@@ -4,9 +4,9 @@ public partial class RouteState
 {
   public static class PushRouteInfoActionSet
   {
-    public class Action : IAction;
+    internal sealed class Action : IAction;
 
-    internal class Handler : ActionHandler<Action>
+    internal sealed class Handler : ActionHandler<Action>
     {
       private readonly NavigationManager NavigationManager;
       private readonly IJSRuntime JsRuntime;
@@ -44,6 +44,16 @@ public override async Task Handle(Action action, CancellationToken cancellationT
       }
     }
   }
-  public async Task PushRouteInfo(CancellationToken cancellationToken = default) => 
-    await Sender.Send(new PushRouteInfoActionSet.Action(), cancellationToken);
+  public async Task PushRouteInfo(CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new PushRouteInfoActionSet.Action(),
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/Routing/State/RouteState.cs

@@ -5,7 +5,7 @@ namespace TimeWarp.Features.Routing;
 /// <summary>
 /// Maintain the Route in TimeWarp.State
 /// </summary>
-public partial class RouteState : State<RouteState>
+public sealed partial class RouteState : State<RouteState>
 {
   private readonly Stack<RouteInfo> RouteStack = new();
   public RouteState(ISender sender) : base(sender) {}

Source/TimeWarp.State.Plus/Features/Theme/Actions/ThemeState.Update.cs

@@ -5,14 +5,12 @@ public partial class ThemeState
 {
   public static class UpdateActionSet
   {
-    [UsedImplicitly]
-    public class Action : IAction
+    internal sealed class Action : IAction
     {
       public Theme NewTheme { get; init; }
     }
-
-    [UsedImplicitly]
-    internal class Handler
+
+    internal sealed class Handler
     (
       IStore store
     ): ActionHandler<Action>(store)
@@ -32,6 +30,16 @@ CancellationToken cancellationToken
     }
   }
 
-  public async Task Update(Theme newTheme, CancellationToken cancellationToken = default) => 
-    await Sender.Send(new UpdateActionSet.Action { NewTheme = newTheme }, cancellationToken);
+  public async Task Update(Theme newTheme, CancellationToken? externalCancellationToken = null)
+  {
+    using CancellationTokenSource? linkedCts = externalCancellationToken.HasValue
+      ? CancellationTokenSource.CreateLinkedTokenSource(externalCancellationToken.Value, CancellationToken)
+      : null;
+
+    await Sender.Send
+    (
+      new UpdateActionSet.Action { NewTheme = newTheme },
+      linkedCts?.Token ?? CancellationToken
+    );
+  }
 }

Source/TimeWarp.State.Plus/Features/Theme/ThemeState.cs

@@ -1,6 +1,6 @@
 namespace TimeWarp.Features.Theme;
 
-public partial class ThemeState : State<ThemeState>
+public sealed partial class ThemeState : State<ThemeState>
 {
   public Theme CurrentTheme { get; private set; }