Merge pull request #15957 from tamasvajk/feature/limit-message-extraction

C#: Limit extracted compilation and extraction messages

Author: tamasvajk

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/Compilation.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Concurrent;
 using System.IO;
 using System.Linq;
 using Microsoft.CodeAnalysis;
@@ -8,6 +9,8 @@ namespace Semmle.Extraction.CSharp.Entities
 {
     internal class Compilation : CachedEntity<object>
     {
+        internal readonly ConcurrentDictionary<string, int> messageCounts = new();
+
         private static (string Cwd, string[] Args) settings;
         private static int hashCode;
 
@@ -78,10 +81,11 @@ public override void Populate(TextWriter trapFile)
                 .ForEach((file, index) => trapFile.compilation_referencing_files(this, index, file));
 
             // Diagnostics
-            Context.Compilation
-                .GetDiagnostics()
-                .Select(d => new Diagnostic(Context, d))
-                .ForEach((diag, index) => trapFile.diagnostic_for(diag, this, 0, index));
+            var diags = Context.Compilation.GetDiagnostics();
+            diags.ForEach((diag, index) => new CompilerDiagnostic(Context, diag, this, index));
+
+            var diagCounts = diags.GroupBy(diag => diag.Id).ToDictionary(group => group.Key, group => group.Count());
+            diagCounts.ForEach(pair => trapFile.compilation_info(this, $"Compiler diagnostic count for {pair.Key}", pair.Value.ToString()));
         }
 
         public void PopulatePerformance(PerformanceMetrics p)

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/CompilerDiagnostic.cs

@@ -0,0 +1,43 @@
+using System.IO;
+using Semmle.Util;
+
+namespace Semmle.Extraction.CSharp.Entities
+{
+    internal class CompilerDiagnostic : FreshEntity
+    {
+        private static readonly int limit = EnvironmentVariables.TryGetExtractorNumberOption<int>("COMPILER_DIAGNOSTIC_LIMIT") ?? 1000;
+
+        private readonly Microsoft.CodeAnalysis.Diagnostic diagnostic;
+        private readonly Compilation compilation;
+        private readonly int index;
+
+        public CompilerDiagnostic(Context cx, Microsoft.CodeAnalysis.Diagnostic diag, Compilation compilation, int index) : base(cx)
+        {
+            diagnostic = diag;
+            this.compilation = compilation;
+            this.index = index;
+            TryPopulate();
+        }
+
+        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)
+            {
+                if (messageCount == limit + 1)
+                {
+                    Context.Extractor.Logger.LogWarning($"Stopped logging {key} compiler diagnostics for the current compilation after reaching {limit}");
+                }
+
+                return;
+            }
+
+            trapFile.diagnostics(this, (int)diagnostic.Severity, key, diagnostic.Descriptor.Title.ToString(),
+                diagnostic.GetMessage(), Context.CreateLocation(diagnostic.Location));
+
+            trapFile.diagnostic_for(this, compilation, 0, index);
+        }
+    }
+}

csharp/extractor/Semmle.Extraction.CSharp/Entities/Compilations/Diagnostic.cs

@@ -122,10 +122,10 @@ internal static void destructor_location(this TextWriter trapFile, Destructor de
         internal static void destructors(this TextWriter trapFile, Destructor destructor, string name, Type containingType, Destructor original) =>
             trapFile.WriteTuple("destructors", destructor, name, containingType, original);
 
-        internal static void diagnostic_for(this TextWriter trapFile, Diagnostic diag, Compilation comp, int fileNo, int index) =>
+        internal static void diagnostic_for(this TextWriter trapFile, CompilerDiagnostic diag, Compilation comp, int fileNo, int index) =>
             trapFile.WriteTuple("diagnostic_for", diag, comp, fileNo, index);
 
-        internal static void diagnostics(this TextWriter trapFile, Diagnostic diag, int severity, string errorTag, string errorMessage, string fullErrorMessage, Location location) =>
+        internal static void diagnostics(this TextWriter trapFile, CompilerDiagnostic diag, int severity, string errorTag, string errorMessage, string fullErrorMessage, Location location) =>
             trapFile.WriteTuple("diagnostics", diag, severity, errorTag, errorMessage, fullErrorMessage, location);
 
         internal static void dynamic_member_name(this TextWriter trapFile, Expression e, string name) =>

csharp/extractor/Semmle.Extraction.CSharp/Tuples.cs

@@ -0,0 +1,37 @@
+using System.IO;
+using System.Threading;
+using Semmle.Util;
+
+namespace Semmle.Extraction.Entities
+{
+    internal class ExtractionMessage : FreshEntity
+    {
+        private static readonly int limit = EnvironmentVariables.TryGetExtractorNumberOption<int>("MESSAGE_LIMIT") ?? 10000;
+        private static int messageCount = 0;
+
+        private readonly Message msg;
+
+        public ExtractionMessage(Context cx, Message msg) : base(cx)
+        {
+            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 (messageCount == limit + 1)
+                {
+                    Context.Extractor.Logger.LogWarning($"Stopped logging extractor messages after reaching {limit}");
+                }
+                return;
+            }
+
+            trapFile.extractor_messages(this, msg.Severity, "C# extractor", msg.Text, msg.EntityText ?? string.Empty,
+                msg.Location ?? Context.CreateLocation(), msg.StackTrace ?? string.Empty);
+        }
+    }
+}

csharp/extractor/Semmle.Extraction/Entities/ExtractionError.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Globalization;
+using System.Numerics;
 
 namespace Semmle.Util
 {
@@ -7,6 +9,16 @@ public class EnvironmentVariables
         public static string? GetExtractorOption(string name) =>
             Environment.GetEnvironmentVariable($"CODEQL_EXTRACTOR_CSHARP_OPTION_{name.ToUpper()}");
 
+        public static T? TryGetExtractorNumberOption<T>(string name) where T : struct, INumberBase<T>
+        {
+            var value = GetExtractorOption(name);
+            if (T.TryParse(value, NumberStyles.Number, CultureInfo.InvariantCulture, out var result))
+            {
+                return result;
+            }
+            return null;
+        }
+
         public static int GetDefaultNumberOfThreads()
         {
             if (!int.TryParse(Environment.GetEnvironmentVariable("CODEQL_THREADS"), out var threads) || threads == -1)

csharp/extractor/Semmle.Extraction/Entities/ExtractionMessage.cs

@@ -0,0 +1,7 @@
+extractorMessages
+| 5 |
+compilerDiagnostics
+| 4 |
+compilationInfo
+| Compiler diagnostic count for CS0103 | 3.0 |
+| Compiler diagnostic count for CS8019 | 7.0 |

csharp/extractor/Semmle.Util/EnvironmentVariables.cs

@@ -0,0 +1,14 @@
+import csharp
+import semmle.code.csharp.commons.Diagnostics
+
+query predicate extractorMessages(int c) { c = count(ExtractorMessage msg) }
+
+query predicate compilerDiagnostics(int c) { c = count(Diagnostic diag) }
+
+query predicate compilationInfo(string key, float value) {
+  exists(Compilation c, string infoValue |
+    infoValue = c.getInfo(key) and key.matches("Compiler diagnostic count for%")
+  |
+    value = infoValue.toFloat()
+  )
+}

csharp/ql/integration-tests/all-platforms/standalone/Diag.expected

@@ -1 +1,2 @@
-var dummy = "dummy";
+var dummy = "dummy";
+dummy = M() + M() + M();