SWEEP: PrintStackTrace cleanup, #932 (#1101)

* SWEEP: Exception.StackTrace cleanup, #932 * Add unit tests for StackTraceHelper, #932 * Better assert for PrintCurrentStackTrace that caller is the top line * PR feedback * Add string.Contains extension method for .NET Framework and Standard 2.0 * Use MemoryExtensions.Contains * Revert test code to use extension method * Use is null
apache · Jan 18, 2025 · 5374caa · 5374caa
1 parent dcfa0e2
commit 5374caa
Show file tree

Hide file tree

Showing 70 changed files with 645 additions and 352 deletions.
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -80,7 +80,7 @@
     <DebugType>portable</DebugType>
   </PropertyGroup>
 
-  <!-- Features in .NET Standard 2.1, .NET 5.x, .NET 6.x, .NET 7.x, .NET 8.x, and .NET 9.x only -->
+  <!-- Features in .NET Standard 2.1, .NET Core 3.x, .NET 5.x, .NET 6.x, .NET 7.x, .NET 8.x, and .NET 9.x only -->
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.1' Or $(TargetFramework.StartsWith('netcoreapp3.')) Or $(TargetFramework.StartsWith('net5.')) Or $(TargetFramework.StartsWith('net6.')) Or $(TargetFramework.StartsWith('net7.')) Or $(TargetFramework.StartsWith('net8.')) Or $(TargetFramework.StartsWith('net9.')) ">
 
     <DefineConstants>$(DefineConstants);FEATURE_ARRAY_FILL</DefineConstants>
@@ -93,6 +93,13 @@
 
   </PropertyGroup>
 
+  <!-- Features in .NET Standard 2.1, .NET Core 2.1-2.2, .NET Core 3.x, .NET 5.x, .NET 6.x, .NET 7.x, .NET 8.x, and .NET 9.x only -->
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.1' Or '$(TargetFramework)' == 'netcoreapp2.1' Or '$(TargetFramework)' == 'netcoreapp2.2' Or $(TargetFramework.StartsWith('netcoreapp3.')) Or $(TargetFramework.StartsWith('net5.')) Or $(TargetFramework.StartsWith('net6.')) Or $(TargetFramework.StartsWith('net7.')) Or $(TargetFramework.StartsWith('net8.')) Or $(TargetFramework.StartsWith('net9.')) ">
+
+    <DefineConstants>$(DefineConstants);FEATURE_STRING_CONTAINS_STRINGCOMPARISON</DefineConstants>
+
+  </PropertyGroup>
+
   <!-- Features in .NET Standard 2.x, .NET Core 2.x, .NET Core 3.x, .NET 5.x, .NET 6.x, .NET 7.x, .NET 8.x, and .NET 9.x -->
   <PropertyGroup Condition=" $(TargetFramework.StartsWith('netstandard2.')) Or $(TargetFramework.StartsWith('netcoreapp2.')) Or $(TargetFramework.StartsWith('netcoreapp3.')) Or $(TargetFramework.StartsWith('net5.')) Or $(TargetFramework.StartsWith('net6.')) Or $(TargetFramework.StartsWith('net7.')) Or $(TargetFramework.StartsWith('net8.')) Or $(TargetFramework.StartsWith('net9.')) ">
 

diff --git a/src/Lucene.Net.Benchmark/ByTask/Benchmark.cs b/src/Lucene.Net.Benchmark/ByTask/Benchmark.cs
@@ -58,8 +58,7 @@ public Benchmark(TextReader algReader)
             }
             catch (Exception e) when (e.IsException())
             {
-                //e.printStackTrace();
-                Console.Error.WriteLine(e.ToString());
+                e.PrintStackTrace();
                 throw new Exception("Error: cannot init PerfRunData!", e);
             }
 
@@ -145,7 +144,7 @@ public static void Exec(string[] args)
             }
             catch (Exception e) when (e.IsException())
             {
-                Console.Error.WriteLine(e.ToString());
+                e.PrintStackTrace();
                 Environment.Exit(1);
             }
 
@@ -160,7 +159,7 @@ public static void Exec(string[] args)
             catch (Exception e) when (e.IsException())
             {
                 Console.Error.WriteLine("Error: cannot execute the algorithm! " + e.Message);
-                Console.Error.WriteLine(e.ToString());
+                e.PrintStackTrace();
             }
 
             Console.WriteLine("####################");

diff --git a/src/Lucene.Net.Benchmark/ByTask/Feeds/EnwikiQueryMaker.cs b/src/Lucene.Net.Benchmark/ByTask/Feeds/EnwikiQueryMaker.cs
@@ -123,7 +123,7 @@ private static Query[] CreateQueries(IList<object> qs, Analyzer a)
                 }
                 catch (Exception e) when (e.IsException())
                 {
-                    Console.Error.WriteLine(e.ToString());
+                    e.PrintStackTrace();
                 }
             }
 

diff --git a/src/Lucene.Net.Benchmark/ByTask/Feeds/ReutersQueryMaker.cs b/src/Lucene.Net.Benchmark/ByTask/Feeds/ReutersQueryMaker.cs
@@ -103,7 +103,7 @@ private static Query[] CreateQueries(IList<object> qs, Analyzer a)
                 }
                 catch (Exception e) when (e.IsException())
                 {
-                    Console.Error.WriteLine(e.ToString());
+                    e.PrintStackTrace();
                 }
             }
 

diff --git a/src/Lucene.Net.Benchmark/ByTask/Feeds/TrecContentSource.cs b/src/Lucene.Net.Benchmark/ByTask/Feeds/TrecContentSource.cs
@@ -38,7 +38,7 @@ namespace Lucene.Net.Benchmarks.ByTask.Feeds
     /// <list type="bullet">
     ///     <item><term>work.dir</term><description>specifies the working directory. Required if "docs.dir"
     ///         denotes a relative path (<b>default=work</b>).</description></item>
-    ///     <item><term>docs.dir</term><description>specifies the directory where the TREC files reside. 
+    ///     <item><term>docs.dir</term><description>specifies the directory where the TREC files reside.
     ///         Can be set to a relative path if "work.dir" is also specified
     ///         (<b>default=trec</b>).
     ///     </description></item>
@@ -161,7 +161,7 @@ private void Read(StringBuilder buf, string lineStart,
         internal virtual void OpenNextFile()
         {
             DoClose();
-            //currPathType = null; 
+            //currPathType = null;
             while (true)
             {
                 if (nextFile >= inputFiles.Count)
@@ -181,7 +181,7 @@ internal virtual void OpenNextFile()
                 }
                 try
                 {
-                    Stream inputStream = StreamUtils.GetInputStream(f); // support either gzip, bzip2, or regular text file, by extension  
+                    Stream inputStream = StreamUtils.GetInputStream(f); // support either gzip, bzip2, or regular text file, by extension
                     reader = new StreamReader(inputStream, m_encoding);
                     currPathType = TrecDocParser.PathType(f);
                     return;
@@ -234,7 +234,7 @@ private void DoClose() // LUCENENET specific - separate disposing from closing s
                 if (m_verbose)
                 {
                     Console.WriteLine("failed to dispose reader !");
-                    Console.WriteLine(e.ToString());
+                    e.PrintStackTrace(Console.Out);
                 }
             }
             reader = null;
@@ -275,7 +275,7 @@ public override DocData GetNextDocData(DocData docData)
                 docBuf.Length = 0;
                 Read(docBuf, DOC, false, false);
 
-                // save parsedFile for passing trecDataParser after the sync block, in 
+                // save parsedFile for passing trecDataParser after the sync block, in
                 // case another thread will open another file in between.
                 parsedPathType = currPathType;
 
@@ -302,7 +302,7 @@ public override DocData GetNextDocData(DocData docData)
             // count char length of text to be parsed (may be larger than the resulted plain doc body text).
             AddBytes(docBuf.Length);
 
-            // This code segment relies on HtmlParser being thread safe. When we get 
+            // This code segment relies on HtmlParser being thread safe. When we get
             // here, everything else is already private to that thread, so we're safe.
             docData = trecDocParser.Parse(docData, name, this, docBuf, parsedPathType);
             AddItem();
@@ -367,7 +367,7 @@ public override void SetConfig(Config config)
             {
                 m_encoding = Encoding.GetEncoding("iso-8859-1"); //StandardCharsets.ISO_8859_1.name();
             }
-            // iteration exclusion in doc name 
+            // iteration exclusion in doc name
             excludeDocnameIteration = config.Get("content.source.excludeIteration", false);
         }
     }

diff --git a/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs b/src/Lucene.Net.Misc/Index/CompoundFileExtractor.cs
@@ -144,8 +144,7 @@ public static void Main(string[] args)
             }
             catch (Exception ioe) when (ioe.IsIOException())
             {
-                Console.Error.WriteLine(ioe.ToString());
-                //Console.Write(ioe.StackTrace);
+                ioe.PrintStackTrace();
             }
             finally
             {
@@ -162,8 +161,7 @@ public static void Main(string[] args)
                 }
                 catch (Exception ioe) when (ioe.IsIOException())
                 {
-                    Console.Error.WriteLine(ioe.ToString());
-                    //Console.Write(ioe.StackTrace);
+                    ioe.PrintStackTrace();
                 }
             }
         }

diff --git a/src/Lucene.Net.Replicator/ReplicationClient.cs b/src/Lucene.Net.Replicator/ReplicationClient.cs
@@ -291,7 +291,8 @@ private void WriteToInfoStream(string message)
         /// </remarks>
         protected virtual void HandleUpdateException(Exception exception)
         {
-            WriteToInfoStream(string.Format("an error occurred during revision update: {0}", exception));
+            // LUCENENET specific - use utility method, and print full exception to be equivalent to printStackTrace in Java
+            WriteToInfoStream($"an error occurred during revision update: {exception}");
         }
 
         /// <summary>

diff --git a/src/Lucene.Net.TestFramework/Analysis/BaseTokenStreamTestCase.cs b/src/Lucene.Net.TestFramework/Analysis/BaseTokenStreamTestCase.cs
@@ -5,7 +5,6 @@
 using Lucene.Net.Documents;
 using Lucene.Net.Index;
 using Lucene.Net.Support;
-using Lucene.Net.Support.Threading;
 using Lucene.Net.Util;
 using RandomizedTesting.Generators;
 using System;
@@ -545,7 +544,7 @@ internal static void CheckResetException(Analyzer a, string input)
             }
             catch (Exception unexpected) when (unexpected.IsException())
             {
-                unexpected.printStackTrace(Console.Error);
+                unexpected.PrintStackTrace(Console.Error);
                 Assert.Fail("Got wrong exception when Reset() not called: " + unexpected);
             }
             finally

diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene3x/PreFlexRWPostingsFormat.cs b/src/Lucene.Net.TestFramework/Codecs/Lucene3x/PreFlexRWPostingsFormat.cs
@@ -1,4 +1,5 @@
 using Lucene.Net.Index;
+using Lucene.Net.Support;
 using Lucene.Net.Util;
 using Console = Lucene.Net.Util.SystemConsole;
 
@@ -81,4 +82,4 @@ protected override bool SortTermsByUnicode
         }
     }
 #pragma warning restore 612, 618
-}
+}
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene3x/PreFlexRWTermVectorsFormat.cs b/src/Lucene.Net.TestFramework/Codecs/Lucene3x/PreFlexRWTermVectorsFormat.cs
@@ -1,5 +1,6 @@
 using Lucene.Net.Index;
 using Lucene.Net.Store;
+using Lucene.Net.Support;
 using Lucene.Net.Util;
 using System;
 
@@ -65,4 +66,4 @@ protected internal override bool SortTermsByUnicode()
         }
     }
 #pragma warning restore 612, 618
-}
+}
diff --git a/src/Lucene.Net.TestFramework/Index/ThreadedIndexingAndSearchingTestCase.cs b/src/Lucene.Net.TestFramework/Index/ThreadedIndexingAndSearchingTestCase.cs
@@ -121,10 +121,10 @@ protected virtual void DoAfterIndexingThreadDone()
         {
         }
 
-        private ThreadJob[] LaunchIndexingThreads(LineFileDocs docs, 
-                                                    int numThreads, 
-                                                    long stopTime, 
-                                                    ISet<string> delIDs, 
+        private ThreadJob[] LaunchIndexingThreads(LineFileDocs docs,
+                                                    int numThreads,
+                                                    long stopTime,
+                                                    ISet<string> delIDs,
                                                     ISet<string> delPackIDs,
                                                     ConcurrentQueue<SubDocs> allSubDocs)
         {
@@ -264,7 +264,7 @@ public override void Run()
                                     outerInstance.m_delCount.AddAndGet(delSubDocs.SubIDs.Count);
                                     if (Verbose)
                                     {
-                                        Console.WriteLine(Thread.CurrentThread.Name + ": update pack packID=" + delSubDocs.PackID + 
+                                        Console.WriteLine(Thread.CurrentThread.Name + ": update pack packID=" + delSubDocs.PackID +
                                             " count=" + docsList.Count + " docs=" + string.Format(J2N.Text.StringFormatter.InvariantCulture, "{0}", docIDs));
                                     }
                                     outerInstance.UpdateDocuments(packIDTerm, docsList);
@@ -273,7 +273,7 @@ public override void Run()
                                 {
                                     if (Verbose)
                                     {
-                                        Console.WriteLine(Thread.CurrentThread.Name + ": add pack packID=" + packID + 
+                                        Console.WriteLine(Thread.CurrentThread.Name + ": add pack packID=" + packID +
                                             " count=" + docsList.Count + " docs=" + string.Format(J2N.Text.StringFormatter.InvariantCulture, "{0}", docIDs));
                                     }
                                     outerInstance.AddDocuments(packIDTerm, docsList);
@@ -378,9 +378,8 @@ public override void Run()
                     catch (Exception t) when (t.IsThrowable())
                     {
                         Console.WriteLine(Thread.CurrentThread.Name + ": hit exc");
-                        Console.WriteLine(t.ToString());
-                        Console.Write(t.StackTrace);
-                        outerInstance.m_failed.Value = (true);
+                        outerInstance.m_failed.Value = true;
+                        t.PrintStackTrace();
                         throw RuntimeException.Create(t);
                     }
                 }
@@ -536,8 +535,8 @@ public override void Run()
                     catch (Exception t) when (t.IsThrowable())
                     {
                         Console.WriteLine(Thread.CurrentThread.Name + ": hit exc");
-                        outerInstance.m_failed.Value = (true);
-                        Console.WriteLine(t.ToString());
+                        outerInstance.m_failed.Value = true;
+                        t.PrintStackTrace(Console.Out);
                         throw RuntimeException.Create(t);
                     }
                 }
@@ -929,4 +928,4 @@ protected virtual void SmokeTestSearcher(IndexSearcher s)
             RunQuery(s, pq);
         }
     }
-}
+}
diff --git a/src/Lucene.Net.TestFramework/Search/ShardSearchingTestBase.cs b/src/Lucene.Net.TestFramework/Search/ShardSearchingTestBase.cs
@@ -736,7 +736,7 @@ public override void Run()
                 catch (Exception t) when (t.IsThrowable())
                 {
                     Console.WriteLine("FAILED:");
-                    Console.Out.WriteLine(t.StackTrace);
+                    t.PrintStackTrace(Console.Out);
                     throw RuntimeException.Create(t);
                 }
             }

diff --git a/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs b/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs
@@ -494,6 +494,7 @@ internal virtual void MaybeThrowIOException(string message)
                 if (LuceneTestCase.Verbose)
                 {
                     Console.WriteLine(Thread.CurrentThread.Name + ": MockDirectoryWrapper: now throw random exception" + (message is null ? "" : " (" + message + ")"));
+                    StackTraceHelper.PrintCurrentStackTrace(Console.Out);
                 }
                 throw new IOException("a random IOException" + (message is null ? "" : " (" + message + ")"));
             }
@@ -505,15 +506,16 @@ internal virtual void MaybeThrowIOExceptionOnOpen(string name)
             {
                 if (LuceneTestCase.Verbose)
                 {
-                  Console.WriteLine(Thread.CurrentThread.Name + ": MockDirectoryWrapper: now throw random exception during open file=" + name);
+                    Console.WriteLine(Thread.CurrentThread.Name + ": MockDirectoryWrapper: now throw random exception during open file=" + name);
+                    StackTraceHelper.PrintCurrentStackTrace(Console.Out);
                 }
                 if (allowRandomFileNotFoundException == false || randomState.NextBoolean())
                 {
                     throw new IOException("a random IOException (" + name + ")");
                 }
                 else
                 {
-                    throw randomState.NextBoolean() ? (IOException)new FileNotFoundException("a random IOException (" + name + ")") : new DirectoryNotFoundException("a random IOException (" + name + ")");
+                    throw randomState.NextBoolean() ? new FileNotFoundException("a random IOException (" + name + ")") : new DirectoryNotFoundException("a random IOException (" + name + ")");
                 }
             }
         }
@@ -1038,7 +1040,7 @@ protected override void Dispose(bool disposing)
                                         catch (Exception t) when (t.IsThrowable())
                                         {
                                             Console.Error.WriteLine("ERROR processing leftover segments file " + file + ":");
-                                            Console.WriteLine(t.ToString());
+                                            t.PrintStackTrace();
                                         }
                                     }
                                 }

diff --git a/src/Lucene.Net.TestFramework/Store/MockIndexOutputWrapper.cs b/src/Lucene.Net.TestFramework/Store/MockIndexOutputWrapper.cs
@@ -1,4 +1,5 @@
-using Lucene.Net.Util;
+using Lucene.Net.Support;
+using Lucene.Net.Util;
 using System;
 using System.IO;
 using System.Threading;
@@ -97,7 +98,7 @@ private void CheckDiskFull(byte[] b, int offset, DataInput @in, long len)
                 if (LuceneTestCase.Verbose)
                 {
                     Console.WriteLine(Thread.CurrentThread.Name + ": MDW: now throw fake disk full");
-                    Console.WriteLine(Environment.StackTrace);
+                    StackTraceHelper.PrintCurrentStackTrace(Console.Out);
                 }
                 throw new IOException(message);
             }
@@ -199,4 +200,4 @@ public override string ToString()
             return "MockIndexOutputWrapper(" + @delegate + ")";
         }
     }
-}
+}
diff --git a/src/Lucene.Net.TestFramework/Support/JavaCompatibility/SystemTypesHelpers.cs b/src/Lucene.Net.TestFramework/Support/JavaCompatibility/SystemTypesHelpers.cs
@@ -8,7 +8,6 @@
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
-using Console = Lucene.Net.Util.SystemConsole;
 using JCG = J2N.Collections.Generic;
 
 namespace Lucene.Net
@@ -290,16 +289,6 @@ public static void retainAll<T>(this ISet<T> s, ISet<T> other)
             }
         }
 
-        public static void printStackTrace(this Exception e)
-        {
-            Console.Error.WriteLine(e.StackTrace);
-        }
-
-        public static void printStackTrace(this Exception e, TextWriter destination)
-        {
-            destination.WriteLine(e.StackTrace);
-        }
-
         /// <summary>
         /// Locates resources in the same directory as this type
         /// </summary>
-Original file line number
+Diff line change
@@ Expand Up @@
                     }
                     catch (Exception e) when (e.IsException())
                     {
-                        Console.Error.WriteLine(e.ToString());
+                        e.PrintStackTrace();
                     }
                 }
@@ Expand Down @@