Merge pull request #17214 from tamasvajk/fix/message-limit

C#: Minor adjustment to limiting the number of extractor messages
github · Aug 14, 2024 · 4e02e34 · 4e02e34
2 parents a782952 + 5f74ead
commit 4e02e34
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 12 deletions.
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/CompilerDiagnostic.cs b/csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/CompilerDiagnostic.cs
@@ -21,7 +21,6 @@ public CompilerDiagnostic(Context cx, Microsoft.CodeAnalysis.Diagnostic diag, Co
 
         protected override void Populate(TextWriter trapFile)
         {
-            // The below doesn't limit the extractor messages to the exact limit, but it's good enough.
             var key = diagnostic.Id;
             var messageCount = compilation.messageCounts.AddOrUpdate(key, 1, (_, c) => c + 1);
             if (messageCount > limit)

diff --git a/csharp/extractor/Semmle.Extraction/Entities/ExtractionMessage.cs b/csharp/extractor/Semmle.Extraction/Entities/ExtractionMessage.cs
@@ -10,27 +10,36 @@ internal class ExtractionMessage : FreshEntity
         private static int messageCount = 0;
 
         private readonly Message msg;
+        private readonly bool bypassLimit;
 
-        public ExtractionMessage(Context cx, Message msg) : base(cx)
+        public ExtractionMessage(Context cx, Message msg) : this(cx, msg, bypassLimit: false)
         {
+        }
+
+        private ExtractionMessage(Context cx, Message msg, bool bypassLimit) : base(cx)
+        {
+            this.bypassLimit = bypassLimit;
             this.msg = msg;
             TryPopulate();
         }
 
         protected override void Populate(TextWriter trapFile)
         {
-            // The below doesn't limit the extractor messages to the exact limit, but it's good enough.
-            Interlocked.Increment(ref messageCount);
-            if (messageCount > limit)
+            if (!bypassLimit)
             {
-                if (messageCount == limit + 1)
+                var val = Interlocked.Increment(ref messageCount);
+                if (val > limit)
                 {
-                    Context.ExtractionContext.Logger.LogWarning($"Stopped logging extractor messages after reaching {limit}");
+                    if (val == limit + 1)
+                    {
+                        Context.ExtractionContext.Logger.LogWarning($"Stopped logging extractor messages after reaching {limit}");
+                        _ = new ExtractionMessage(Context, new Message($"Stopped logging extractor messages after reaching {limit}", null, null, null, Util.Logging.Severity.Warning), bypassLimit: true);
+                    }
+                    return;
                 }
-                return;
             }
 
-            trapFile.extractor_messages(this, msg.Severity, "C# extractor", msg.Text, msg.EntityText ?? string.Empty,
+            trapFile.extractor_messages(this, msg.Severity, msg.Text, msg.EntityText ?? string.Empty,
                 msg.Location ?? Context.CreateLocation(), msg.StackTrace ?? string.Empty);
         }
     }

diff --git a/csharp/extractor/Semmle.Extraction/Tuples.cs b/csharp/extractor/Semmle.Extraction/Tuples.cs
@@ -12,9 +12,9 @@ public static void containerparent(this System.IO.TextWriter trapFile, Folder pa
             trapFile.WriteTuple("containerparent", parent, child);
         }
 
-        internal static void extractor_messages(this System.IO.TextWriter trapFile, ExtractionMessage error, Semmle.Util.Logging.Severity severity, string origin, string errorMessage, string entityText, Location location, string stackTrace)
+        internal static void extractor_messages(this System.IO.TextWriter trapFile, ExtractionMessage error, Semmle.Util.Logging.Severity severity, string errorMessage, string entityText, Location location, string stackTrace)
         {
-            trapFile.WriteTuple("extractor_messages", error, (int)severity, origin, errorMessage, entityText, location, stackTrace);
+            trapFile.WriteTuple("extractor_messages", error, (int)severity, "C# extractor", errorMessage, entityText, location, stackTrace);
         }
 
         public static void files(this System.IO.TextWriter trapFile, File file, string fullName)

diff --git a/csharp/ql/integration-tests/all-platforms/standalone/Diag.expected b/csharp/ql/integration-tests/all-platforms/standalone/Diag.expected
@@ -1,7 +1,9 @@
 extractorMessages
-| 5 |
+| 6 |
 compilerDiagnostics
 | 4 |
+extractorMessagesLeachedLimit
+| Program.cs:1:1:1:0 | Stopped logging extractor messages after reaching 5 |
 compilationInfo
 | Compiler diagnostic count for CS0103 | 3.0 |
 | Compiler diagnostic count for CS8019 | 7.0 |
diff --git a/csharp/ql/integration-tests/all-platforms/standalone/Diag.ql b/csharp/ql/integration-tests/all-platforms/standalone/Diag.ql
@@ -5,6 +5,10 @@ query predicate extractorMessages(int c) { c = count(ExtractorMessage msg) }
 
 query predicate compilerDiagnostics(int c) { c = count(Diagnostic diag) }
 
+query predicate extractorMessagesLeachedLimit(ExtractorMessage msg) {
+  msg.getText().indexOf("Stopped logging") = 0
+}
+
 query predicate compilationInfo(string key, float value) {
   exists(Compilation c, string infoValue |
     infoValue = c.getInfo(key) and key.matches("Compiler diagnostic count for%")