Merge branch 'main' into optimize-copilot-instructions

Author: waldekmastykarz

.github/workflows/create-release.yml

@@ -103,7 +103,7 @@ jobs:
         run: |
           $(Get-FileHash ./${{ env.release }}.zip -Algorithm SHA256).Hash
       - name: Upload release
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: binaries-${{ env.release }}
           path: ./${{ env.release }}.zip
@@ -131,7 +131,7 @@ jobs:
           exclusions: '*.json'
       - name: Upload abstractions
         if: matrix.architecture == 'win-x64'
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: binaries-dev-proxy-abstractions-${{ github.ref_name }}
           path: ./DevProxy.Abstractions-${{ github.ref_name }}.zip
@@ -185,7 +185,7 @@ jobs:
           --verbosity Debug
       - name: Upload Installer
         if: contains(matrix.architecture, 'win-')
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
         with:
           name: installer-dev-proxy-${{ github.ref_name }}-${{ matrix.architecture }}
           path: ./${{ env.release }}/dev-proxy-installer-${{ matrix.architecture }}-${{ github.ref_name }}.exe
@@ -203,7 +203,7 @@ jobs:
       contents: write
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-      - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0
+      - uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0
         with:
           path: output
       - name: Release

DevProxy.Abstractions/Proxy/IProxyConfiguration.cs

@@ -18,12 +18,12 @@ public enum ReleaseType
     Beta
 }
 
-public enum LogFor
+public enum OutputFormat
 {
-    [EnumMember(Value = "human")]
-    Human,
-    [EnumMember(Value = "machine")]
-    Machine
+    [EnumMember(Value = "text")]
+    Text,
+    [EnumMember(Value = "json")]
+    Json
 }
 
 public interface IProxyConfiguration
@@ -37,10 +37,11 @@ public interface IProxyConfiguration
     IEnumerable<MockRequestHeader>? FilterByHeaders { get; }
     bool InstallCert { get; set; }
     string? IPAddress { get; set; }
-    LogFor LogFor { get; set; }
+    OutputFormat Output { get; set; }
     LogLevel LogLevel { get; }
     ReleaseType NewVersionNotification { get; }
     bool NoFirstRun { get; set; }
+    bool NoWatch { get; set; }
     int Port { get; set; }
     bool Record { get; set; }
     bool ShowTimestamps { get; }

DevProxy.Abstractions/Utils/ProxyUtils.cs

@@ -9,6 +9,7 @@
 using Newtonsoft.Json.Schema;
 using System.Collections.ObjectModel;
 using System.Reflection;
+using System.Text.Encodings.Web;
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using System.Text.RegularExpressions;
@@ -44,6 +45,7 @@ public static class ProxyUtils
     public static JsonSerializerOptions JsonSerializerOptions { get; } = new()
     {
         DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
         PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
         PropertyNameCaseInsensitive = true,
         ReadCommentHandling = JsonCommentHandling.Skip,
@@ -273,6 +275,25 @@ public static void ValidateSchemaVersion(string schemaUrl, ILogger logger)
             return;
         }
 
+        var warning = GetSchemaVersionMismatchWarning(schemaUrl);
+        if (warning is not null)
+        {
+            logger.LogWarning("{Warning}", warning);
+        }
+    }
+
+    /// <summary>
+    /// Checks if the schema URL version matches the current Dev Proxy version.
+    /// Returns a warning message if versions don't match, or null if they match
+    /// or the schema URL cannot be parsed.
+    /// </summary>
+    public static string? GetSchemaVersionMismatchWarning(string schemaUrl)
+    {
+        if (string.IsNullOrWhiteSpace(schemaUrl))
+        {
+            return null;
+        }
+
         try
         {
             var uri = new Uri(schemaUrl);
@@ -285,18 +306,47 @@ public static void ValidateSchemaVersion(string schemaUrl, ILogger logger)
                 if (CompareSemVer(currentVersion, schemaVersion) != 0)
                 {
                     var currentSchemaUrl = uri.ToString().Replace($"/v{schemaVersion}/", $"/v{currentVersion}/", StringComparison.OrdinalIgnoreCase);
-                    logger.LogWarning("The version of schema does not match the installed Dev Proxy version, the expected schema is {Schema}", currentSchemaUrl);
+                    return $"The version of schema does not match the installed Dev Proxy version, the expected schema is {currentSchemaUrl}";
                 }
             }
-            else
-            {
-                logger.LogDebug("Invalid schema {SchemaUrl}, skipping schema version validation.", schemaUrl);
-            }
         }
-        catch (Exception ex)
+        catch
         {
-            logger.LogWarning("Invalid schema {SchemaUrl}, skipping schema version validation. Error: {Error}", schemaUrl, ex.Message);
+            return $"The $schema value '{schemaUrl}' is not a valid URL. Schema version could not be validated.";
         }
+
+        return null;
+    }
+
+    /// <summary>
+    /// Returns the ordered list of config file paths to search.
+    /// The first existing file in the list should be used.
+    /// </summary>
+    public static IEnumerable<string?> GetConfigFileCandidates(string? userConfigFile)
+    {
+        return [
+            // config file specified by the user takes precedence
+            // null if not specified
+            userConfigFile,
+            // current directory - JSON/JSONC files
+            "devproxyrc.jsonc",
+            "devproxyrc.json",
+            // current directory - YAML files
+            "devproxyrc.yaml",
+            "devproxyrc.yml",
+            // .devproxy subdirectory - JSON/JSONC files
+            Path.Combine(".devproxy", "devproxyrc.jsonc"),
+            Path.Combine(".devproxy", "devproxyrc.json"),
+            // .devproxy subdirectory - YAML files
+            Path.Combine(".devproxy", "devproxyrc.yaml"),
+            Path.Combine(".devproxy", "devproxyrc.yml"),
+            // app folder - JSON/JSONC files
+            Path.Combine(AppFolder ?? "", "devproxyrc.jsonc"),
+            Path.Combine(AppFolder ?? "", "devproxyrc.json"),
+            // app folder - YAML files
+            Path.Combine(AppFolder ?? "", "devproxyrc.yaml"),
+            Path.Combine(AppFolder ?? "", "devproxyrc.yml")
+        ];
     }
 
     /// <summary>

DevProxy.Plugins/Generation/HarGeneratorPlugin.cs

@@ -9,7 +9,9 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
 using System.Diagnostics;
+using System.Globalization;
 using System.Text.Json;
+using System.Text.RegularExpressions;
 using System.Web;
 
 namespace DevProxy.Plugins.Generation;
@@ -33,6 +35,8 @@ public sealed class HarGeneratorPlugin(
         proxyConfiguration,
         pluginConfigurationSection)
 {
+    private static readonly Regex surrogatePairRegex = new(@"\\u([dD][89aAbB][0-9a-fA-F]{2})\\u([dD][cCdDeEfF][0-9a-fA-F]{2})");
+
     public override string Name => nameof(HarGeneratorPlugin);
 
     public override async Task AfterRecordingStopAsync(RecordingArgs e, CancellationToken cancellationToken)
@@ -69,6 +73,7 @@ r.Context.Session is not null &&
 
         Logger.LogDebug("Serializing HAR file...");
         var harFileJson = JsonSerializer.Serialize(harFile, ProxyUtils.JsonSerializerOptions);
+        harFileJson = UnescapeSurrogatePairs(harFileJson);
         var fileName = $"devproxy-{DateTime.Now:yyyyMMddHHmmss}.har";
 
         Logger.LogDebug("Writing HAR file to {FileName}...", fileName);
@@ -159,4 +164,15 @@ private HarEntry CreateHarEntry(RequestLog log)
 
         return entry;
     }
+
+    private static string UnescapeSurrogatePairs(string json)
+    {
+        return surrogatePairRegex.Replace(json, match =>
+        {
+            var high = int.Parse(match.Groups[1].Value, NumberStyles.HexNumber, CultureInfo.InvariantCulture);
+            var low = int.Parse(match.Groups[2].Value, NumberStyles.HexNumber, CultureInfo.InvariantCulture);
+            var codePoint = 0x10000 + ((high - 0xD800) << 10) + (low - 0xDC00);
+            return char.ConvertFromUtf32(codePoint);
+        });
+    }
 }

DevProxy/Commands/ApiCommand.cs

@@ -0,0 +1,93 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using DevProxy.Abstractions.Proxy;
+using DevProxy.Abstractions.Utils;
+using Microsoft.Extensions.Logging;
+using System.CommandLine;
+using System.CommandLine.Parsing;
+using System.Text.Json;
+
+namespace DevProxy.Commands;
+
+sealed class ApiCommand : Command
+{
+    private readonly IProxyConfiguration _proxyConfiguration;
+    private readonly ILogger _logger;
+
+    public ApiCommand(IProxyConfiguration proxyConfiguration, ILogger<ApiCommand> logger) :
+        base("api", "Manage Dev Proxy API information")
+    {
+        _proxyConfiguration = proxyConfiguration;
+        _logger = logger;
+        ConfigureCommand();
+    }
+
+    private void ConfigureCommand()
+    {
+        var apiShowCommand = new Command("show", "Display Dev Proxy API information for runtime management");
+        apiShowCommand.SetAction(parseResult =>
+        {
+            var outputFormat = parseResult.GetValueOrDefault<OutputFormat?>(DevProxyCommand.OutputOptionName) ?? OutputFormat.Text;
+            PrintApiInfo(outputFormat);
+        });
+
+        this.AddCommands(new List<Command>
+        {
+            apiShowCommand
+        }.OrderByName());
+    }
+
+    private void PrintApiInfo(OutputFormat outputFormat)
+    {
+        var ipAddress = _proxyConfiguration.IPAddress;
+        var apiPort = _proxyConfiguration.ApiPort;
+        var baseUrl = $"http://{ipAddress}:{apiPort}";
+
+        var endpoints = new[]
+        {
+            new ApiEndpointInfo { Method = "GET", Path = "/proxy", Description = "Get proxy status" },
+            new ApiEndpointInfo { Method = "POST", Path = "/proxy", Description = "Update proxy status (e.g. start/stop recording)" },
+            new ApiEndpointInfo { Method = "POST", Path = "/proxy/mockRequest", Description = "Issue a mock request" },
+            new ApiEndpointInfo { Method = "POST", Path = "/proxy/stopProxy", Description = "Stop the proxy" },
+            new ApiEndpointInfo { Method = "POST", Path = "/proxy/jwtToken", Description = "Create a JWT token" },
+            new ApiEndpointInfo { Method = "GET", Path = "/proxy/rootCertificate", Description = "Get the root certificate" },
+            new ApiEndpointInfo { Method = "GET", Path = "/proxy/logs", Description = "Get proxy logs (for detached mode access)" }
+        };
+
+        if (outputFormat == OutputFormat.Json)
+        {
+            var json = JsonSerializer.Serialize(new
+            {
+                baseUrl,
+                swaggerUrl = $"{baseUrl}/swagger/v1/swagger.json",
+                endpoints = endpoints.Select(e => new
+                {
+                    method = e.Method,
+                    path = e.Path,
+                    description = e.Description
+                })
+            }, ProxyUtils.JsonSerializerOptions);
+            _logger.LogStructuredOutput(json);
+        }
+        else
+        {
+            _logger.LogInformation("Base URL: {BaseUrl}", baseUrl);
+            _logger.LogInformation("OpenAPI spec: {SwaggerUrl}", $"{baseUrl}/swagger/v1/swagger.json");
+            _logger.LogInformation("");
+            _logger.LogInformation("Endpoints:");
+            foreach (var endpoint in endpoints)
+            {
+                _logger.LogInformation("  {Method,-6} {Path,-30} {Description}", endpoint.Method, endpoint.Path, endpoint.Description);
+            }
+        }
+    }
+}
+
+sealed class ApiEndpointInfo
+{
+    public string Method { get; set; } = string.Empty;
+    public string Path { get; set; } = string.Empty;
+    public string Description { get; set; } = string.Empty;
+}

DevProxy/Commands/CertCommand.cs

@@ -15,7 +15,7 @@ sealed class CertCommand : Command
     private readonly ILoggerFactory _loggerFactory;
     private readonly Option<bool> _forceOption = new("--force", "-f")
     {
-        Description = "Don't prompt for confirmation when removing the certificate"
+        Description = "Don't prompt for confirmation when removing the certificate. Required for non-interactive use (CI, piped stdin, automation)."
     };
 
     public CertCommand(ILogger<CertCommand> logger, ILoggerFactory loggerFactory) :
@@ -41,6 +41,11 @@ private void ConfigureCommand()
             certEnsureCommand,
             certRemoveCommand,
         }.OrderByName());
+
+        HelpExamples.Add(this, [
+            "devproxy cert ensure                                Install and trust certificate",
+            "devproxy cert remove --force                        Remove certificate (no prompt)",
+        ]);
     }
 
     private async Task EnsureCertAsync()
@@ -74,7 +79,7 @@ private async Task EnsureCertAsync()
         _logger.LogTrace("EnsureCertAsync() finished");
     }
 
-    public void RemoveCert(ParseResult parseResult)
+    public int RemoveCert(ParseResult parseResult)
     {
         _logger.LogTrace("RemoveCert() called");
 
@@ -83,10 +88,17 @@ public void RemoveCert(ParseResult parseResult)
             var isForced = parseResult.GetValue(_forceOption);
             if (!isForced)
             {
+                if (Console.IsInputRedirected ||
+                    Environment.GetEnvironmentVariable("CI") is not null)
+                {
+                    _logger.LogError("Confirmation required but running in non-interactive mode. Use --force to skip confirmation.");
+                    return 1;
+                }
+
                 var isConfirmed = PromptConfirmation("Do you want to remove the root certificate", acceptByDefault: false);
                 if (!isConfirmed)
                 {
-                    return;
+                    return 0;
                 }
             }
 
@@ -111,10 +123,12 @@ public void RemoveCert(ParseResult parseResult)
             }
 
             _logger.LogInformation("DONE");
+            return 0;
         }
         catch (Exception ex)
         {
             _logger.LogError(ex, "Error removing certificate");
+            return 1;
         }
         finally
         {