Added immutable keys for state items Name and ManagedThreadId.

Author: eben-roux

Shuttle.Core.Threading/ProcessorThread.cs

@@ -14,7 +14,6 @@ public class ProcessorThread
     private readonly CancellationTokenSource _cancellationTokenSource = new();
     private readonly ProcessorThreadOptions _processorThreadOptions;
 
-    private readonly Dictionary<string, object> _state = new();
     private readonly ProcessorThreadEventArgs _eventArgs;
 
     private bool _started;
@@ -36,6 +35,9 @@ public ProcessorThread(string name, IServiceScopeFactory serviceScopeFactory, IP
         _thread.Priority = _processorThreadOptions.Priority;
 
         _eventArgs = new(Name, _thread.ManagedThreadId);
+
+        State.Add("Name", Name);
+        State.Add("ManagedThreadId", _thread.ManagedThreadId);
     }
 
     public CancellationToken CancellationToken { get; }

Shuttle.Core.Threading/Resources.Designer.cs

@@ -154,4 +154,8 @@
   <data name="ProcessorThreadJoinTimeoutException" xml:space="preserve">
     <value>Processor thread did not join within the required time.</value>
   </data>
+  <data name="ImmutableKeyException" xml:space="preserve">
+    <value>Cannot remove or replace key '{0}'.</value>
+    <comment>{0} = the immutable key</comment>
+  </data>
 </root>

Shuttle.Core.Threading/Resources.resx

@@ -1,10 +1,13 @@
+using System;
 using System.Collections.Generic;
+using System.Threading;
 using Shuttle.Core.Contract;
 
 namespace Shuttle.Core.Threading;
 
 public class State : IState
 {
+    private readonly List<string> _immutableKeys = ["Name", "ManagedThreadId"];
     private readonly Dictionary<string, object?> _state = new();
 
     public void Clear()
@@ -14,29 +17,37 @@ public void Clear()
 
     public void Add(string key, object? value)
     {
-        _state.Add(Guard.AgainstNull(key), value);
+        _state.Add(Guard.AgainstNullOrEmptyString(key), value);
     }
 
     public void Replace(string key, object? value)
     {
-        Guard.AgainstNull(key);
+        if (_immutableKeys.Contains(Guard.AgainstNullOrEmptyString(key)))
+        {
+            throw new InvalidOperationException(string.Format(Resources.ImmutableKeyException, key));
+        }
 
         _state.Remove(key);
         _state.Add(key, value);
     }
 
     public object? Get(string key)
     {
-        return _state.TryGetValue(Guard.AgainstNull(key), out var result) ? result : default;
+        return _state.TryGetValue(Guard.AgainstNullOrEmptyString(key), out var result) ? result : default;
     }
 
     public bool Contains(string key)
     {
-        return _state.ContainsKey(Guard.AgainstNull(key));
+        return _state.ContainsKey(Guard.AgainstNullOrEmptyString(key));
     }
 
     public bool Remove(string key)
     {
+        if (_immutableKeys.Contains(Guard.AgainstNullOrEmptyString(key)))
+        {
+            throw new InvalidOperationException(string.Format(Resources.ImmutableKeyException, key));
+        }
+
         return _state.Remove(key);
     }
 }