Merge branch 'main' into v210

Author: waldekmastykarz

DevProxy.Abstractions/Plugins/BaseLoader.cs

@@ -21,7 +21,7 @@ public abstract class BaseLoader(HttpClient httpClient, ILogger logger, IProxyCo
 
     private FileSystemWatcher? _watcher;
     private Timer? _debounceTimer;
-    private bool _isDisposed;
+    private volatile bool _isDisposed;
 
     protected abstract string FilePath { get; }
     protected ILogger Logger { get; } = logger;
@@ -65,13 +65,14 @@ protected virtual void Dispose(bool disposing)
             return;
         }
 
+        // Set flag first to prevent in-flight timer callbacks from proceeding
+        _isDisposed = true;
+
         if (disposing)
         {
             _watcher?.Dispose();
             _debounceTimer?.Dispose();
         }
-
-        _isDisposed = true;
     }
 
     private async Task<bool> ValidateFileContentsAsync(string fileContents, CancellationToken cancellationToken)
@@ -104,6 +105,11 @@ private async Task<bool> ValidateFileContentsAsync(string fileContents, Cancella
 
     private async Task LoadFileContentsAsync(CancellationToken cancellationToken)
     {
+        if (_isDisposed)
+        {
+            return;
+        }
+
         if (!File.Exists(FilePath))
         {
             Logger.LogWarning("File {File} not found. No data will be loaded", FilePath);
@@ -129,6 +135,12 @@ private async Task LoadFileContentsAsync(CancellationToken cancellationToken)
 
     private void File_Changed(object sender, FileSystemEventArgs e)
     {
+        // Don't process file changes if this loader has been disposed
+        if (_isDisposed)
+        {
+            return;
+        }
+
         lock (_debounceLock)
         {
             _debounceTimer?.Dispose();

DevProxy.Abstractions/Plugins/BasePlugin.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.CommandLine;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Text.Json;
 using DevProxy.Abstractions.Proxy;
@@ -15,7 +16,7 @@ namespace DevProxy.Abstractions.Plugins;
 
 public abstract class BasePlugin(
     ILogger logger,
-    ISet<UrlToWatch> urlsToWatch) : IPlugin
+    ISet<UrlToWatch> urlsToWatch) : IPlugin, IDisposable
 {
     public bool Enabled { get; protected set; } = true;
     protected ILogger Logger { get; } = logger;
@@ -64,6 +65,17 @@ public virtual Task MockRequestAsync(EventArgs e, CancellationToken cancellation
     {
         return Task.CompletedTask;
     }
+
+    protected virtual void Dispose(bool disposing)
+    {
+        // Override in derived classes to dispose managed resources
+    }
+
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
 }
 
 public abstract class BasePlugin<TConfiguration>(
@@ -74,27 +86,30 @@ public abstract class BasePlugin<TConfiguration>(
     IConfigurationSection pluginConfigurationSection) :
     BasePlugin(logger, urlsToWatch), IPlugin<TConfiguration> where TConfiguration : new()
 {
-    private TConfiguration? _configuration;
+#pragma warning disable CA2213 // HttpClient is injected from DI and should not be disposed by this class
     private readonly HttpClient _httpClient = httpClient;
+#pragma warning restore CA2213
 
     protected IProxyConfiguration ProxyConfiguration { get; } = proxyConfiguration;
+
+    [AllowNull]
     public TConfiguration Configuration
     {
         get
         {
-            if (_configuration is null)
+            if (field is null)
             {
                 if (!ConfigurationSection.Exists())
                 {
-                    _configuration = new();
+                    field = new();
                 }
                 else
                 {
-                    _configuration = ConfigurationSection.Get<TConfiguration>();
+                    field = ConfigurationSection.Get<TConfiguration>();
                 }
             }
 
-            return _configuration!;
+            return field!;
         }
     }
     public IConfigurationSection ConfigurationSection { get; } = pluginConfigurationSection;

DevProxy.Plugins/Behavior/GenericRandomErrorPlugin.cs

@@ -345,4 +345,13 @@ private static bool HasMatchingBody(GenericErrorResponse errorResponse, Request
 
     // throttle requests per host
     private static string BuildThrottleKey(Request r) => r.RequestUri.Host;
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _loader?.Dispose();
+        }
+        base.Dispose(disposing);
+    }
 }

DevProxy.Plugins/Behavior/LanguageModelRateLimitingPlugin.cs

@@ -348,4 +348,13 @@ private void ThrottleResponse(ProxyRequestArgs e)
     }
 
     private static string BuildThrottleKey(Request r) => r.RequestUri.Host;
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _loader?.Dispose();
+        }
+        base.Dispose(disposing);
+    }
 }

DevProxy.Plugins/Behavior/RateLimitingPlugin.cs

@@ -337,4 +337,13 @@ private static string BuildThrottleKey(Request r)
             return r.RequestUri.Host;
         }
     }
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _loader?.Dispose();
+        }
+        base.Dispose(disposing);
+    }
 }

DevProxy.Plugins/Generation/ApiCenterOnboardingPlugin.cs

@@ -402,4 +402,13 @@ async Task ImportApiDefinitionAsync(string apiDefinitionId, string openApiSpecFi
             Logger.LogError("Failed to import API definition for {ApiDefinition}. Status: {Status}, reason: {Reason}", apiDefinitionId, res.StatusCode, resContent);
         }
     }
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _apiCenterClient?.Dispose();
+        }
+        base.Dispose(disposing);
+    }
 }

DevProxy.Plugins/Guidance/GraphSelectGuidancePlugin.cs

@@ -17,7 +17,9 @@ public sealed class GraphSelectGuidancePlugin(
     ISet<UrlToWatch> urlsToWatch,
     MSGraphDb msGraphDb) : BasePlugin(logger, urlsToWatch)
 {
+#pragma warning disable CA2213 // MSGraphDb is DI-injected singleton, disposal is managed by the DI container
     private readonly MSGraphDb _msGraphDb = msGraphDb;
+#pragma warning restore CA2213
 
     public override string Name => nameof(GraphSelectGuidancePlugin);
 
@@ -112,4 +114,5 @@ private static string GetTokenizedUrl(string absoluteUrl)
         var sanitizedUrl = ProxyUtils.SanitizeUrl(absoluteUrl);
         return "/" + string.Join("", new Uri(sanitizedUrl).Segments.Skip(2).Select(Uri.UnescapeDataString));
     }
+
 }

DevProxy.Plugins/Inspection/DevToolsPlugin.cs

@@ -50,7 +50,7 @@ public sealed class DevToolsPlugin(
         logger,
         urlsToWatch,
         proxyConfiguration,
-        pluginConfigurationSection), IDisposable
+        pluginConfigurationSection)
 {
     private readonly Dictionary<string, GetResponseBodyResultParams> _responseBody = [];
 
@@ -471,8 +471,12 @@ private static bool IsTextResponse(string? contentType)
         return isTextResponse;
     }
 
-    public void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        _webSocket?.Dispose();
+        if (disposing)
+        {
+            _webSocket?.Dispose();
+        }
+        base.Dispose(disposing);
     }
 }

DevProxy.Plugins/Inspection/OpenAITelemetryPlugin.cs

@@ -53,7 +53,7 @@ public sealed class OpenAITelemetryPlugin(
         logger,
         urlsToWatch,
         proxyConfiguration,
-        pluginConfigurationSection), IDisposable
+        pluginConfigurationSection)
 {
     private const string ActivitySourceName = "DevProxy.OpenAI";
     private const string OpenAISystem = "openai";
@@ -1008,11 +1008,15 @@ private static string GetOperationName(OpenAIRequest request)
         };
     }
 
-    public void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        _loader?.Dispose();
-        _activitySource?.Dispose();
-        _tracerProvider?.Dispose();
-        _meterProvider?.Dispose();
+        if (disposing)
+        {
+            _loader?.Dispose();
+            _activitySource?.Dispose();
+            _tracerProvider?.Dispose();
+            _meterProvider?.Dispose();
+        }
+        base.Dispose(disposing);
     }
 }

DevProxy.Plugins/Manipulation/RewritePlugin.cs

@@ -104,4 +104,13 @@ public override Task BeforeRequestAsync(ProxyRequestArgs e, CancellationToken ca
         Logger.LogTrace("Left {Name}", nameof(BeforeRequestAsync));
         return Task.CompletedTask;
     }
+
+    protected override void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            _loader?.Dispose();
+        }
+        base.Dispose(disposing);
+    }
 }