Merge branch 'main' into v028

Author: waldekmastykarz

.github/workflows/codeql-analysis.yml

@@ -53,7 +53,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
+      uses: github/codeql-action/init@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -81,4 +81,4 @@ jobs:
       run: dotnet build --no-restore -c Release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
+      uses: github/codeql-action/analyze@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17

dev-proxy-abstractions/CommandLineExtensions.cs

@@ -21,4 +21,37 @@ public static class CommandLineExtensions
 
         return parseResult.GetValueForOption(option);
     }
+
+    private static string ByName<T>(T symbol) where T : Symbol => symbol.Name;
+
+    public static IEnumerable<T> OrderByName<T>(this IEnumerable<T> symbols) where T : Symbol
+    {
+        ArgumentNullException.ThrowIfNull(symbols);
+
+        return symbols.OrderBy(ByName, StringComparer.Ordinal);
+    }
+
+    public static Command AddCommands(this Command command, IEnumerable<Command> subcommands)
+    {
+        ArgumentNullException.ThrowIfNull(command);
+        ArgumentNullException.ThrowIfNull(subcommands);
+
+        foreach (var subcommand in subcommands)
+        {
+            command.AddCommand(subcommand);
+        }
+        return command;
+    }
+
+    public static Command AddOptions(this Command command, IEnumerable<Option> options)
+    {
+        ArgumentNullException.ThrowIfNull(command);
+        ArgumentNullException.ThrowIfNull(options);
+
+        foreach (var option in options)
+        {
+            command.AddOption(option);
+        }
+        return command;
+    }
 }

dev-proxy-plugins/Inspection/DevToolsPlugin.cs

@@ -148,23 +148,14 @@ private void InitInspector()
             return;
         }
 
-        // find if the process is already running
-        var processes = GetBrowserProcesses(browserPath);
-
-        if (processes.Any())
-        {
-            var ids = string.Join(", ", processes.Select(p => p.Id.ToString()));
-            Logger.LogError("Found existing browser process {processName} with IDs {processIds}. Could not start {plugin}. Please close existing browser processes and restart Dev Proxy", browserPath, ids, Name);
-            return;
-        }
-
         var port = GetFreePort();
         webSocket = new WebSocketServer(port, Logger);
         webSocket.MessageReceived += SocketMessageReceived;
         _ = webSocket.StartAsync();
 
         var inspectionUrl = $"http://localhost:9222/devtools/inspector.html?ws=localhost:{port}";
-        var args = $"{inspectionUrl} --remote-debugging-port=9222 --profile-directory=devproxy";
+        var profilePath = Path.Combine(Path.GetTempPath(), "devtools-devproxy");
+        var args = $"{inspectionUrl} --remote-debugging-port=9222 --user-data-dir=\"{profilePath}\"";
 
         Logger.LogInformation("{name} available at {inspectionUrl}", Name, inspectionUrl);
 

dev-proxy-plugins/Mocks/MockResponsePlugin.cs

@@ -15,6 +15,7 @@
 using DevProxy.Plugins.Behavior;
 using System.Text;
 using Microsoft.Extensions.Logging;
+using System.Collections.Concurrent;
 
 namespace DevProxy.Plugins.Mocks;
 
@@ -42,7 +43,7 @@ public class MockResponsePlugin(IPluginEvents pluginEvents, IProxyContext contex
     private IProxyConfiguration? _proxyConfiguration;
     // tracks the number of times a mock has been applied
     // used in combination with mocks that have an Nth property
-    private readonly Dictionary<string, int> _appliedMocks = [];
+    private readonly ConcurrentDictionary<string, int> _appliedMocks = [];
 
     public override Option[] GetOptions()
     {
@@ -243,12 +244,7 @@ _configuration.Mocks is null ||
 
         if (mockResponse is not null && mockResponse.Request is not null)
         {
-            if (!_appliedMocks.TryGetValue(mockResponse.Request.Url, out int value))
-            {
-                value = 0;
-                _appliedMocks.Add(mockResponse.Request.Url, value);
-            }
-            _appliedMocks[mockResponse.Request.Url] = ++value;
+            _appliedMocks.AddOrUpdate(mockResponse.Request.Url, 1, (_, value) => ++value);
         }
 
         return mockResponse;

dev-proxy/Logging/ProxyConsoleFormatter.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Concurrent;
 using System.Text;
 using DevProxy.Abstractions;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -17,7 +18,7 @@ public class ProxyConsoleFormatter : ConsoleFormatter
     private const string _boxBottomLeft = "\u2570 ";
     // used to align single-line messages
     private const string _boxSpacing = "  ";
-    private readonly Dictionary<int, List<RequestLog>> _requestLogs = [];
+    private readonly ConcurrentDictionary<int, List<RequestLog>> _requestLogs = [];
     private readonly ProxyConsoleFormatterOptions _options;
     const string labelSpacing = " ";
     // label length + 2
@@ -62,24 +63,21 @@ private void LogRequest(RequestLog requestLog, string category, IExternalScopePr
         {
             if (messageType == MessageType.FinishedProcessingRequest)
             {
-                var lastMessage = _requestLogs[requestId.Value].Last();
                 // log all request logs for the request
-                foreach (var log in _requestLogs[requestId.Value])
+                var currentRequestLogs = _requestLogs[requestId.Value];
+                var lastIndex = currentRequestLogs.Count - 1;
+                for (var i = 0; i < currentRequestLogs.Count; ++i)
                 {
-                    WriteLogMessageBoxedWithInvertedLabels(log, scopeProvider, textWriter, log == lastMessage);
+                    var log = currentRequestLogs[i];
+                    WriteLogMessageBoxedWithInvertedLabels(log, scopeProvider, textWriter, i == lastIndex);
                 }
-                _requestLogs.Remove(requestId.Value);
+                _requestLogs.Remove(requestId.Value, out _);
             }
             else
             {
                 // buffer request logs until the request is finished processing
-                if (!_requestLogs.TryGetValue(requestId.Value, out List<RequestLog>? value))
-                {
-                    value = ([]);
-                    _requestLogs[requestId.Value] = value;
-                }
-
                 requestLog.PluginName = category == DefaultCategoryName ? null : category;
+                var value = _requestLogs.GetOrAdd(requestId.Value, []);
                 value.Add(requestLog);
             }
         }

dev-proxy/Program.cs

@@ -41,9 +41,6 @@
 IProxyContext context = new ProxyContext(ProxyCommandHandler.Configuration, ProxyEngine.Certificate, lmClient);
 ProxyHost proxyHost = new();
 
-// this is where the root command is created which contains all commands and subcommands
-RootCommand rootCommand = proxyHost.GetRootCommand(logger);
-
 // store the global options that are created automatically for us
 // rootCommand doesn't return the global options, so we have to store them manually
 string[] globalOptions = ["--version"];
@@ -62,20 +59,22 @@
 // load plugins to get their options and commands
 var pluginLoader = new PluginLoader(isDiscover, logger, loggerFactory);
 PluginLoaderResult loaderResults = await pluginLoader.LoadPluginsAsync(pluginEvents, context);
-var options = loaderResults.ProxyPlugins
+
+var pluginOptions = loaderResults.ProxyPlugins
     .SelectMany(p => p.GetOptions())
     // remove duplicates by comparing the option names
     .GroupBy(o => o.Name)
     .Select(g => g.First())
-    .ToList();
-options.ForEach(rootCommand.AddOption);
-// register all plugin commands
-loaderResults.ProxyPlugins
+    .ToArray();
+
+var pluginCommands = loaderResults.ProxyPlugins
     .SelectMany(p => p.GetCommands())
-    .ToList()
-    .ForEach(rootCommand.AddCommand);
+    .ToArray();
+
+// this is where the root command is created which contains all commands and subcommands
+RootCommand rootCommand = proxyHost.CreateRootCommand(logger, pluginOptions, pluginCommands);
 
-// get the list of available subcommands
+// get the list of available subcommand's names
 var subCommands = rootCommand.Children.OfType<Command>().Select(c => c.Name).ToArray();
 
 // check if any of the subcommands are present
@@ -132,7 +131,7 @@
         pluginEvents.RaiseInit(new InitArgs());
     }
 
-    rootCommand.Handler = proxyHost.GetCommandHandler(pluginEvents, [.. options], loaderResults.UrlsToWatch, logger);
+    rootCommand.Handler = proxyHost.GetCommandHandler(pluginEvents, [.. pluginOptions], loaderResults.UrlsToWatch, logger);
     var exitCode = await rootCommand.InvokeAsync(args);
     loggerFactory.Dispose();
     Environment.Exit(exitCode);

dev-proxy/ProxyEngine.cs

@@ -4,6 +4,7 @@
 
 using DevProxy.Abstractions;
 using Microsoft.VisualStudio.Threading;
+using System.Collections.Concurrent;
 using System.Diagnostics;
 using System.Net;
 using System.Security.Cryptography.X509Certificates;
@@ -38,7 +39,7 @@ public class ProxyEngine(IProxyConfiguration config, ISet<UrlToWatch> urlsToWatc
     private readonly IProxyState _proxyState = proxyState ?? throw new ArgumentNullException(nameof(proxyState));
     // Dictionary for plugins to store data between requests
     // the key is HashObject of the SessionEventArgs object
-    private readonly Dictionary<int, Dictionary<string, object>> _pluginData = [];
+    private readonly ConcurrentDictionary<int, Dictionary<string, object>> _pluginData = [];
     private InactivityTimer? _inactivityTimer;
 
     public static X509Certificate2? Certificate => _proxyServer?.CertificateManager.RootCertificate;
@@ -469,7 +470,10 @@ async Task OnRequestAsync(object sender, SessionEventArgs e)
         if (IsProxiedHost(e.HttpClient.Request.RequestUri.Host) &&
             IsIncludedByHeaders(e.HttpClient.Request.Headers))
         {
-            _pluginData.Add(e.GetHashCode(), []);
+            if (!_pluginData.TryAdd(e.GetHashCode(), []))
+            {
+                throw new Exception($"Unable to initialize the plugin data storage for hash key {e.GetHashCode()}");
+            }
             var responseState = new ResponseState();
             var proxyRequestArgs = new ProxyRequestArgs(e, responseState)
             {
@@ -607,7 +611,7 @@ async Task OnAfterResponseAsync(object sender, SessionEventArgs e)
             if (!proxyResponseArgs.HasRequestUrlMatch(_urlsToWatch))
             {
                 // clean up
-                _pluginData.Remove(e.GetHashCode());
+                _pluginData.Remove(e.GetHashCode(), out _);
                 return;
             }
 
@@ -623,7 +627,7 @@ async Task OnAfterResponseAsync(object sender, SessionEventArgs e)
             _logger.LogRequest(message, MessageType.FinishedProcessingRequest, new LoggingContext(e));
 
             // clean up
-            _pluginData.Remove(e.GetHashCode());
+            _pluginData.Remove(e.GetHashCode(), out _);
         }
     }