(#181) Use new .NET 9.0 Lock class

Author: colinangusmackay

src/Stravaig.Extensions.Logging.Diagnostics/LogEntry.cs

@@ -5,6 +5,10 @@
 using System.Text;
 using Microsoft.Extensions.Logging;
 
+#if NET9_0_OR_GREATER
+using System.Threading;
+#endif
+
 namespace Stravaig.Extensions.Logging.Diagnostics;
 
 /// <summary>
@@ -14,45 +18,49 @@ namespace Stravaig.Extensions.Logging.Diagnostics;
 public class LogEntry : IComparable<LogEntry>
 {
     private static int _sequence;
-    private static readonly object SequenceSyncLock = new ();
+#if NET9_0_OR_GREATER
+    private static readonly Lock SequenceSyncLock = new();
+#else
+    private static readonly object SequenceSyncLock = new();
+#endif
 
     private const string OriginalMessagePropertyName = "{OriginalFormat}";
-        
+
     private readonly Lazy<IReadOnlyDictionary<string, object>> _lazyPropertyDictionary;
-        
+
     /// <summary>
     /// The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> that the item was logged at.
     /// </summary>
     public LogLevel LogLevel { get; }
-        
+
     /// <summary>
     /// An <see cref="T:Microsoft.Extensions.Logging.EventId"/> that identifies a logging event.
     /// </summary>
     public EventId EventId { get; }
-        
+
     /// <summary>
     /// The entry to be written. Can be also an object.
     /// </summary>
     public object? State { get; }
-        
+
     /// <summary>
     /// The <see cref="T:System.Exception"/> that was attached to the log.
     /// </summary>
     public Exception? Exception { get; }
-        
+
     /// <summary>
     /// The formatted message.
     /// </summary>
     public string FormattedMessage { get; }
-        
+
     /// <summary>
     /// The sequence number of the log message.
     /// </summary>
-    /// <remarks>In a multi-threaded environment there may be gaps between adjacent log messages.</remarks>
+    /// <remarks>In a multithreaded environment there may be gaps between adjacent log messages.</remarks>
     public int Sequence { get; }
-        
+
     /// <summary>
-    /// The time the log entry was created in UTC. 
+    /// The time the log entry was created in UTC.
     /// </summary>
     public DateTime TimestampUtc { get; }
 
@@ -74,7 +82,7 @@ public DateTimeOffset TimestampLocal
     /// </summary>
     public IReadOnlyList<KeyValuePair<string, object>> Properties =>
         State as IReadOnlyList<KeyValuePair<string, object>> ?? Array.Empty<KeyValuePair<string, object>>();
-        
+
     /// <summary>
     /// The properties, if any, for the log entry.
     /// </summary>
@@ -87,7 +95,7 @@ public DateTimeOffset TimestampLocal
         (string) Properties
             .FirstOrDefault(p => p.Key == OriginalMessagePropertyName)
             .Value;
-        
+
     /// <summary>
     /// The category name of the log entry, if available.
     /// </summary>
@@ -178,4 +186,4 @@ public override string ToString()
     }
 
     private string DebuggerDisplayString => $"[#{Sequence} @ {TimestampLocal:HH:mm:ss.fff zzz} {LogLevel} {CategoryName}] {FormattedMessage}";
-}
+}

src/Stravaig.Extensions.Logging.Diagnostics/Stravaig.Extensions.Logging.Diagnostics.csproj

@@ -22,7 +22,7 @@
             Use version 3.x for .NET 6.0, 8.0 & 9.0 onwards.
 	    </Description>
         <Nullable>enable</Nullable>
-        <LangVersion>12</LangVersion>
+        <LangVersion>13</LangVersion>
     </PropertyGroup>
     <ItemGroup>
         <None Include="stravaig-icon.png" Pack="true" PackagePath="/" />

src/Stravaig.Extensions.Logging.Diagnostics/TestCaptureLogger.cs

@@ -2,6 +2,9 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Extensions.Logging;
+#if NET9_0_OR_GREATER
+using System.Threading;
+#endif
 
 namespace Stravaig.Extensions.Logging.Diagnostics;
 
@@ -11,16 +14,18 @@ namespace Stravaig.Extensions.Logging.Diagnostics;
 /// </summary>
 public class TestCaptureLogger : ITestCaptureLogger
 {
-    private readonly List<LogEntry> _logs;
-    private readonly object _syncRoot;
+    private readonly List<LogEntry> _logs = [];
+#if NET9_0_OR_GREATER
+    private readonly Lock _listGuard = new();
+#else
+    private readonly object _listGuard = new object();
+#endif
 
     /// <summary>
     /// Initialises a new instance of the <see cref="T:Stravaig.Extensions.Logging.Diagnostics.TestCaptureLogger"/> class.
     /// </summary>
     public TestCaptureLogger()
     {
-        _logs = new List<LogEntry>();
-        _syncRoot = new object();
         CategoryName = string.Empty;
     }
 
@@ -29,7 +34,6 @@ public TestCaptureLogger()
     /// </summary>
     /// <param name="categoryName">The name of the category</param>
     public TestCaptureLogger(string categoryName)
-        : this()
     {
         CategoryName = categoryName;
     }
@@ -42,7 +46,7 @@ public TestCaptureLogger(string categoryName)
     /// <inheritdoc />
     public IReadOnlyList<LogEntry> GetLogs()
     {
-        lock (_syncRoot)
+        lock (_listGuard)
         {
             _logs.Sort();
             return _logs.ToArray();
@@ -52,7 +56,7 @@ public IReadOnlyList<LogEntry> GetLogs()
     /// <inheritdoc />
     public IReadOnlyList<LogEntry> GetLogs(Func<LogEntry, bool> predicate)
     {
-        lock (_syncRoot)
+        lock (_listGuard)
         {
             return _logs
                 .Where(predicate)
@@ -78,7 +82,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
     {
         var formattedMessage = formatter(state, exception);
         var logEntry = CreateLogEntry(logLevel, eventId, state, exception, formattedMessage);
-        lock (_syncRoot)
+        lock (_listGuard)
         {
             _logs.Add(logEntry);
         }
@@ -131,7 +135,7 @@ public void Dispose()
     /// <inheritdoc />
     public void Reset()
     {
-        lock (_syncRoot)
+        lock (_listGuard)
         {
             _logs.Clear();
         }