Merge pull request github#16036 from tamasvajk/autobuilder/disposable

C#: Properly dispose diagnostic writer objects

Author: tamasvajk

cpp/autobuilder/Semmle.Autobuild.Cpp.Tests/BuildScripts.cs

@@ -203,6 +203,8 @@ internal class TestDiagnosticWriter : IDiagnosticsWriter
         public IList<DiagnosticMessage> Diagnostics { get; } = new List<DiagnosticMessage>();
 
         public void AddEntry(DiagnosticMessage message) => this.Diagnostics.Add(message);
+
+        public void Dispose() { }
     }
 
     /// <summary>

cpp/autobuilder/Semmle.Autobuild.Cpp/Program.cs

@@ -17,7 +17,7 @@ static int Main()
                 try
                 {
                     Console.WriteLine("CodeQL C++ autobuilder");
-                    var builder = new CppAutobuilder(actions, options);
+                    using var builder = new CppAutobuilder(actions, options);
                     return builder.AttemptBuild();
                 }
                 catch (InvalidEnvironmentException ex)

csharp/autobuilder/Semmle.Autobuild.CSharp.Tests/BuildScripts.cs

@@ -218,6 +218,8 @@ internal class TestDiagnosticWriter : IDiagnosticsWriter
         public IList<DiagnosticMessage> Diagnostics { get; } = new List<DiagnosticMessage>();
 
         public void AddEntry(DiagnosticMessage message) => this.Diagnostics.Add(message);
+
+        public void Dispose() { }
     }
 
     /// <summary>

csharp/autobuilder/Semmle.Autobuild.CSharp/Program.cs

@@ -17,7 +17,7 @@ public static int Main()
                 try
                 {
                     Console.WriteLine("CodeQL C# autobuilder");
-                    var builder = new CSharpAutobuilder(actions, options);
+                    using var builder = new CSharpAutobuilder(actions, options);
                     return builder.AttemptBuild();
                 }
                 catch (InvalidEnvironmentException ex)

csharp/autobuilder/Semmle.Autobuild.Shared/Autobuilder.cs

@@ -92,7 +92,7 @@ public interface IAutobuilder<out TAutobuildOptions> where TAutobuildOptions : A
     /// The overall design is intended to be extensible so that in theory,
     /// it should be possible to add new build rules without touching this code.
     /// </summary>
-    public abstract class Autobuilder<TAutobuildOptions> : IAutobuilder<TAutobuildOptions> where TAutobuildOptions : AutobuildOptionsShared
+    public abstract class Autobuilder<TAutobuildOptions> : IDisposable, IAutobuilder<TAutobuildOptions> where TAutobuildOptions : AutobuildOptionsShared
     {
         /// <summary>
         /// Full file paths of files found in the project directory, as well as
@@ -351,6 +351,20 @@ protected BuildScript AutobuildFailure() =>
             }
         });
 
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                diagnostics.Dispose();
+            }
+        }
+
         /// <summary>
         /// Value of CODEQL_EXTRACTOR_<LANG>_ROOT environment variable.
         /// </summary>

csharp/extractor/Semmle.Util/ToolStatusPage.cs renamed to csharp/extractor/Semmle.Util/ToolStatusPage/DiagnosticMessage.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Globalization;
-using System.IO;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Serialization;
@@ -179,64 +178,4 @@ public DiagnosticMessage(
             this.PlaintextMessage = plaintextMessage;
         }
     }
-
-    /// <summary>
-    /// Provides the ability to write diagnostic messages to some output.
-    /// </summary>
-    public interface IDiagnosticsWriter
-    {
-        /// <summary>
-        /// Adds <paramref name="message" /> as a new diagnostics entry.
-        /// </summary>
-        /// <param name="message">The diagnostics entry to add.</param>
-        void AddEntry(DiagnosticMessage message);
-    }
-
-    /// <summary>
-    /// A wrapper around an underlying <see cref="StreamWriter" /> which allows
-    /// <see cref="DiagnosticMessage" /> objects to be serialized to it.
-    /// </summary>
-    public sealed class DiagnosticsStream : IDiagnosticsWriter, IDisposable
-    {
-        private readonly JsonSerializer serializer;
-        private readonly StreamWriter writer;
-
-        /// <summary>
-        /// Initialises a new <see cref="DiagnosticsStream" /> for a file at <paramref name="path" />.
-        /// </summary>
-        /// <param name="path">The path to the file that should be created.</param>
-        public DiagnosticsStream(string path)
-        {
-            this.writer = File.CreateText(path);
-
-            var contractResolver = new DefaultContractResolver
-            {
-                NamingStrategy = new CamelCaseNamingStrategy()
-            };
-
-            serializer = new JsonSerializer
-            {
-                ContractResolver = contractResolver,
-                NullValueHandling = NullValueHandling.Ignore
-            };
-        }
-
-        /// <summary>
-        /// Adds <paramref name="message" /> as a new diagnostics entry.
-        /// </summary>
-        /// <param name="message">The diagnostics entry to add.</param>
-        public void AddEntry(DiagnosticMessage message)
-        {
-            serializer.Serialize(writer, message);
-            writer.Flush();
-        }
-
-        /// <summary>
-        /// Releases all resources used by the <see cref="DiagnosticsStream" /> object.
-        /// </summary>
-        public void Dispose()
-        {
-            writer.Dispose();
-        }
-    }
 }

csharp/extractor/Semmle.Util/ToolStatusPage/DiagnosticsStream.cs

@@ -0,0 +1,55 @@
+using System;
+using System.IO;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Serialization;
+
+namespace Semmle.Util
+{
+    /// <summary>
+    /// A wrapper around an underlying <see cref="StreamWriter" /> which allows
+    /// <see cref="DiagnosticMessage" /> objects to be serialized to it.
+    /// </summary>
+    public sealed class DiagnosticsStream : IDiagnosticsWriter
+    {
+        private readonly JsonSerializer serializer;
+        private readonly StreamWriter writer;
+
+        /// <summary>
+        /// Initialises a new <see cref="DiagnosticsStream" /> for a file at <paramref name="path" />.
+        /// </summary>
+        /// <param name="path">The path to the file that should be created.</param>
+        public DiagnosticsStream(string path)
+        {
+            this.writer = File.CreateText(path);
+
+            var contractResolver = new DefaultContractResolver
+            {
+                NamingStrategy = new CamelCaseNamingStrategy()
+            };
+
+            serializer = new JsonSerializer
+            {
+                ContractResolver = contractResolver,
+                NullValueHandling = NullValueHandling.Ignore
+            };
+        }
+
+        /// <summary>
+        /// Adds <paramref name="message" /> as a new diagnostics entry.
+        /// </summary>
+        /// <param name="message">The diagnostics entry to add.</param>
+        public void AddEntry(DiagnosticMessage message)
+        {
+            serializer.Serialize(writer, message);
+            writer.Flush();
+        }
+
+        /// <summary>
+        /// Releases all resources used by the <see cref="DiagnosticsStream" /> object.
+        /// </summary>
+        public void Dispose()
+        {
+            writer.Dispose();
+        }
+    }
+}

csharp/extractor/Semmle.Util/ToolStatusPage/IDiagnosticsWriter.cs

@@ -0,0 +1,16 @@
+using System;
+
+namespace Semmle.Util
+{
+    /// <summary>
+    /// Provides the ability to write diagnostic messages to some output.
+    /// </summary>
+    public interface IDiagnosticsWriter : IDisposable
+    {
+        /// <summary>
+        /// Adds <paramref name="message" /> as a new diagnostics entry.
+        /// </summary>
+        /// <param name="message">The diagnostics entry to add.</param>
+        void AddEntry(DiagnosticMessage message);
+    }
+}