Merge pull request #180 from apache/Feature/177-fix-ThreadName-again

#177 use ManagedThreadId for long running tasks

Author: FreeAndNil

doc/RELEASING.md

@@ -32,7 +32,7 @@ release version 2.0.123:
         - pom.xml: update version
 4. Sign release artifacts (zips & nupkg) under `build/artifacts`
     - eg `gpg --armor --output log4net-2.0.123.nupkg.asc --detach-sig log4net-2.0.123.nupkg`
-    - there is an accompanying `sign-log4net-libraries.sh` which you could invoke if you cd
+    - there is an accompanying `sign-log4net-libraries.sh/ps1` under scripts which you could invoke if you cd
         into the `build/artifacts` folder
         - I build on Windows and sign on Linux as my build machine belongs to my company
             and I don't want to store keys there. Always protect your keys fervently!

scripts/build-preview.ps1

@@ -0,0 +1 @@
+dotnet build -c Release '-p:GeneratePackages=true' $PSScriptRoot/../src/log4net/log4net.csproj

install-dotnet-sdk.ps1 renamed to scripts/install-dotnet-sdk.ps1

@@ -17,31 +17,31 @@
 //
 #endregion
 
-// net8 deprecates BinaryFormatter used in testing.
-#if NET462_OR_GREATER
-
-using log4net.Core;
-using log4net.Util;
-using NUnit.Framework;
 using System;
 using System.Globalization;
 using System.IO;
+using System.Reflection;
 using System.Runtime.Serialization.Formatters.Binary;
+using log4net.Core;
+using log4net.Util;
+using NUnit.Framework;
 
 namespace log4net.Tests.Core;
 
 [TestFixture]
 public sealed class LoggingEventTest
 {
+  // net8 deprecates BinaryFormatter used in testing.
+#if NET462_OR_GREATER
   private static readonly DateTime localTime
-    = new DateTime(2000, 7, 1, 0, 0, 0, 0, CultureInfo.InvariantCulture.Calendar, DateTimeKind.Local);
+    = new(2000, 7, 1, 0, 0, 0, 0, CultureInfo.InvariantCulture.Calendar, DateTimeKind.Local);
 
   [Test]
   public void SerializeDeserialize_BinaryFormatter()
   {
     Utils.InconclusiveOnMono();
-    var timestamp = localTime.ToUniversalTime();
-    var ev = new LoggingEvent(new LoggingEventData
+    DateTime timestamp = localTime.ToUniversalTime();
+    LoggingEvent ev = new(new()
     {
       LoggerName = "aLogger",
       Level = Level.Log4Net_Debug,
@@ -56,11 +56,11 @@ public void SerializeDeserialize_BinaryFormatter()
       Properties = new PropertiesDictionary { ["foo"] = "bar" },
     });
 
-    var formatter = new BinaryFormatter();
-    using var stream = new MemoryStream();
+    BinaryFormatter formatter = new();
+    using MemoryStream stream = new();
     formatter.Serialize(stream, ev);
     stream.Position = 0;
-    var ev2 = (LoggingEvent)formatter.Deserialize(stream);
+    LoggingEvent ev2 = (LoggingEvent)formatter.Deserialize(stream);
 
     Assert.AreEqual("aLogger", ev2.LoggerName);
     Assert.AreEqual(Level.Log4Net_Debug, ev2.Level);
@@ -90,8 +90,8 @@ public void DeserializeV2()
   {
     Utils.InconclusiveOnMono();
     const string datPath = @"..\..\..\..\integration-testing\log4net2-SerializeEvent\SerializeV2Event.dat";
-    using var stream = File.OpenRead(datPath);
-    var formatter = new BinaryFormatter();
+    using Stream stream = File.OpenRead(datPath);
+    BinaryFormatter formatter = new();
     LoggingEvent ev = (LoggingEvent)formatter.Deserialize(stream);
     Assert.IsNotNull(ev);
 
@@ -114,5 +114,28 @@ public void DeserializeV2()
     Assert.AreEqual("bar", ev.Properties["foo"]);
     Assert.AreEqual(localTime.ToUniversalTime(), ev.TimeStampUtc);
   }
-}
-#endif // NET462_OR_GREATER
+#endif // NET462_OR_GREATER
+
+  /// <summary>
+  /// Tests <see cref="LoggingEvent.ReviseThreadName"/>
+  /// </summary>
+  [Test]
+  public void ReviseThreadNameTest()
+  {
+    Assert.AreEqual("PoolBoy", ReviseThreadName("PoolBoy"));
+    AssertIsCurrentThreadId(ReviseThreadName(null));
+    AssertIsCurrentThreadId(ReviseThreadName(string.Empty));
+    AssertIsCurrentThreadId(ReviseThreadName(".NET ThreadPool Worker"));
+    AssertIsCurrentThreadId(ReviseThreadName(".NET TP Worker"));
+    AssertIsCurrentThreadId(ReviseThreadName(".NET Long Running Task"));
+
+    static string ReviseThreadName(string? name)
+    {
+      return (string)typeof(LoggingEvent).GetMethod(nameof(ReviseThreadName),
+        BindingFlags.Static | BindingFlags.NonPublic)!.Invoke(null, [name])!;
+    }
+
+    static void AssertIsCurrentThreadId(string name)
+      => Assert.AreEqual(name, SystemInfo.CurrentThreadId.ToString(CultureInfo.InvariantCulture));
+  }
+}

doc/sign-log4net-libraries.ps1 renamed to scripts/sign-log4net-libraries.ps1

@@ -40,7 +40,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "log4net2-SerializeEvent", "
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".doc", ".doc", "{33D80AD3-8048-4220-8BB0-38E3BDE5FCF4}"
 	ProjectSection(SolutionItems) = preProject
-		build-preview.ps1 = build-preview.ps1
 		..\doc\BUILDING.md = ..\doc\BUILDING.md
 		site\xdoc\release\config-examples.xml = site\xdoc\release\config-examples.xml
 		site\xdoc\download_log4net.xml = site\xdoc\download_log4net.xml
@@ -50,6 +49,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".doc", ".doc", "{33D80AD3-8
 		..\doc\RELEASING.md = ..\doc\RELEASING.md
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".scripts", ".scripts", "{050E0D0D-D916-42FD-AE58-32965336D357}"
+	ProjectSection(SolutionItems) = preProject
+		..\scripts\build-preview.ps1 = ..\scripts\build-preview.ps1
+		..\scripts\install-dotnet-sdk.ps1 = ..\scripts\install-dotnet-sdk.ps1
+		..\scripts\sign-log4net-libraries.ps1 = ..\scripts\sign-log4net-libraries.ps1
+		..\scripts\sign-log4net-libraries.sh = ..\scripts\sign-log4net-libraries.sh
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

doc/sign-log4net-libraries.sh renamed to scripts/sign-log4net-libraries.sh

@@ -648,40 +648,46 @@ public string? ThreadName
       {
         if (m_data.ThreadName is null && m_cacheUpdatable)
         {
-          // '.NET ThreadPool Worker' appears as a default thread name in the .NET 6-7 thread pool.
-          // '.NET TP Worker' is the default thread name in the .NET 8+ thread pool.
-          // Prefer the numeric thread ID instead.
-          if (Thread.CurrentThread.Name is string { Length: > 0 } threadName
-              && threadName is not ".NET TP Worker" or ".NET ThreadPool Worker")
-          {
-            m_data.ThreadName = threadName;
-          }
-          else
-          {
-            // The thread name is not available or unsuitable. Therefore we
-            // go to the AppDomain to get the ID of the
-            // current thread. (Why don't Threads know their own ID?)
-            try
-            {
-              m_data.ThreadName = SystemInfo.CurrentThreadId.ToString(NumberFormatInfo.InvariantInfo);
-            }
-            catch (SecurityException)
-            {
-              // This security exception will occur if the caller does not have 
-              // some undefined set of SecurityPermission flags.
-              LogLog.Debug(declaringType,
-                  "Security exception while trying to get current thread ID. Error Ignored. Empty thread name.");
-
-              // As a last resort use the hash code of the Thread object
-              m_data.ThreadName = Thread.CurrentThread.GetHashCode().ToString(CultureInfo.InvariantCulture);
-            }
-          }
+          m_data.ThreadName = ReviseThreadName(Thread.CurrentThread.Name);
         }
 
         return m_data.ThreadName;
       }
     }
 
+    /// <summary>
+    /// Returns a 'meaningful' name for the thread (or its Id)
+    /// </summary>
+    /// <param name="threadName">Name</param>
+    /// <returns>Meaningful name</returns>
+    private static string ReviseThreadName(string? threadName)
+    {
+      // '.NET ThreadPool Worker' appears as a default thread name in the .NET 6-7 thread pool.
+      // '.NET TP Worker' is the default thread name in the .NET 8+ thread pool.
+      // '.NET Long Running Task' is used for long running tasks
+      // Prefer the numeric thread ID instead.
+      if (threadName is string { Length: > 0 } name
+          && !name.StartsWith(".NET ", StringComparison.Ordinal))
+      {
+        return name;
+      }
+      // The thread name is not available or unsuitable, therefore we use the ManagedThreadId.
+      try
+      {
+        return SystemInfo.CurrentThreadId.ToString(NumberFormatInfo.InvariantInfo);
+      }
+      catch (SecurityException)
+      {
+        // This security exception will occur if the caller does not have 
+        // some undefined set of SecurityPermission flags.
+        LogLog.Debug(declaringType,
+          "Security exception while trying to get current thread ID. Error Ignored. Empty thread name.");
+
+        // As a last resort use the hash code of the Thread object
+        return Thread.CurrentThread.GetHashCode().ToString(CultureInfo.InvariantCulture);
+      }
+    }
+
     /// <summary>
     /// Gets the name of the current user.
     /// </summary>
@@ -885,7 +891,7 @@ public PropertiesDictionary Properties
           return m_data.Properties;
         }
 
-        m_eventProperties ??= new PropertiesDictionary();
+        m_eventProperties ??= new();
         return m_eventProperties;
       }
     }