C#: Properly dispose diagnostic writer objects

tamasvajk · tamasvajk · commit 0f980e2b9751 · 2024-04-03T09:47:24.000+02:00
diff --git a/cpp/autobuilder/Semmle.Autobuild.Cpp/Program.cs b/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)
diff --git a/csharp/autobuilder/Semmle.Autobuild.CSharp/Program.cs b/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)
diff --git a/csharp/autobuilder/Semmle.Autobuild.Shared/Autobuilder.cs b/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 as IDisposable)?.Dispose();
+            }
+        }
+
         /// <summary>
         /// Value of CODEQL_EXTRACTOR_<LANG>_ROOT environment variable.
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ static int Main()`
`17`	`17`	`try`
`18`	`18`	`{`
`19`	`19`	`Console.WriteLine("CodeQL C++ autobuilder");`
`20`		`- var builder = new CppAutobuilder(actions, options);`
	`20`	`+ using var builder = new CppAutobuilder(actions, options);`
`21`	`21`	`return builder.AttemptBuild();`
`22`	`22`	`}`
`23`	`23`	`catch (InvalidEnvironmentException ex)`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public static int Main()`
`17`	`17`	`try`
`18`	`18`	`{`
`19`	`19`	`Console.WriteLine("CodeQL C# autobuilder");`
`20`		`- var builder = new CSharpAutobuilder(actions, options);`
	`20`	`+ using var builder = new CSharpAutobuilder(actions, options);`
`21`	`21`	`return builder.AttemptBuild();`
`22`	`22`	`}`
`23`	`23`	`catch (InvalidEnvironmentException ex)`