Fixes onboard APIs with OpenAPI specs. Closes dotnet#786 (dotnet#788)

Adds tracing to ApiCenterClient. Closes dotnet#785 Fixes generating OpenAPI specs. Closes dotnet#787
waldekmastykarz · Jun 14, 2024 · 8f689bb · 8f689bb
1 parent 16c89a6
commit 8f689bb
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 11 deletions.
diff --git a/dev-proxy-abstractions/ProxyUtils.cs b/dev-proxy-abstractions/ProxyUtils.cs
@@ -39,6 +39,12 @@ public static class ProxyUtils
 
     public static readonly string ReportsKey = "Reports";
 
+    static ProxyUtils()
+    {
+        // convert enum values to camelCase
+        jsonSerializerOptions.Converters.Add(new JsonStringEnumConverter(JsonNamingPolicy.CamelCase));
+    }
+
     public static bool IsGraphRequest(Request request) => IsGraphUrl(request.RequestUri);
 
     public static bool IsGraphUrl(Uri uri) =>

diff --git a/dev-proxy-plugins/ApiCenter/ApiCenterClient.cs b/dev-proxy-plugins/ApiCenter/ApiCenterClient.cs
@@ -82,7 +82,9 @@ internal ApiCenterClient(ApiCenterClientConfiguration configuration, ILogger log
 
         _authenticationHandler = new AuthenticationDelegatingHandler(_credential, _scopes)
         {
-            InnerHandler = new HttpClientHandler()
+            InnerHandler = new TracingDelegatingHandler(logger) {
+                InnerHandler = new HttpClientHandler()
+            }
         };
         _httpClient = new HttpClient(_authenticationHandler);
 
@@ -232,6 +234,6 @@ internal async Task<HttpResponseMessage> PostImportSpecification(ApiSpecImport a
     internal async Task<ApiSpecExportResult?> PostExportSpecification(string definitionId)
     {
         var definitionRes = await _httpClient.PostAsync($"https://management.azure.com{definitionId}/exportSpecification?api-version=2024-03-01", null);
-        return await definitionRes.Content.ReadFromJsonAsync<ApiSpecExportResult>();
+        return await definitionRes.Content.ReadFromJsonAsync<ApiSpecExportResult>(ProxyUtils.JsonSerializerOptions);
     }
 }
diff --git a/dev-proxy-plugins/ApiCenter/Models.cs b/dev-proxy-plugins/ApiCenter/Models.cs
@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using System.Text.Json.Serialization;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.DevProxy.Plugins.RequestLogs.ApiCenter;
@@ -25,9 +24,7 @@ internal class ApiProperties
     public ApiContact[] Contacts { get; set; } = [];
     public dynamic CustomProperties { get; set; } = new object();
     public string? Description { get; set; }
-    [JsonConverter(typeof(JsonStringEnumConverter))]
     public ApiKind? Kind { get; set; }
-    [JsonConverter(typeof(JsonStringEnumConverter))]
     public ApiLifecycleStage? LifecycleStage { get; set; }
     public string? Title { get; set; }
     public string? Summary { get; set; }
@@ -79,7 +76,6 @@ internal class ApiDefinitionPropertiesSpecification
 
 internal class ApiSpecImport
 {
-    [JsonConverter(typeof(JsonStringEnumConverter))]
     public ApiSpecImportResultFormat Format { get; set; }
     public ApiSpecImportRequestSpecification? Specification { get; set; }
     public string? Value { get; set; }
@@ -93,7 +89,6 @@ internal class ApiSpecImportRequestSpecification
 
 internal class ApiSpecExportResult
 {
-    [JsonConverter(typeof(JsonStringEnumConverter))]
     public ApiSpecExportResultFormat? Format { get; set; }
     public string? Value { get; set; }
 }
@@ -108,7 +103,6 @@ internal class ApiVersion
 
 internal class ApiVersionProperties
 {
-    [JsonConverter(typeof(JsonStringEnumConverter))]
     public ApiLifecycleStage LifecycleStage { get; set; }
     public string? Title { get; set; }
 }

diff --git a/dev-proxy-plugins/Reporters/PlainTextReporter.cs b/dev-proxy-plugins/Reporters/PlainTextReporter.cs
@@ -41,7 +41,7 @@ public PlainTextReporter(IPluginEvents pluginEvents, IProxyContext context, ILog
 
         if (_transformers.TryGetValue(reportType, out var transform))
         {
-            Logger.LogDebug("Transforming {reportType} using {transform}...", reportType.Name, transform.Method);
+            Logger.LogDebug("Transforming {reportType} using {transform}...", reportType.Name, transform.Method.Name);
 
             return transform(report.Value);
         }

diff --git a/dev-proxy-plugins/RequestLogs/ApiCenterOnboardingPlugin.cs b/dev-proxy-plugins/RequestLogs/ApiCenterOnboardingPlugin.cs
@@ -384,7 +384,16 @@ async Task ImportApiDefinition(string apiDefinitionId, string openApiSpecFilePat
         }
         else
         {
-            Logger.LogError("Failed to import API definition for {apiDefinition}. Status: {status}, reason: {reason}", apiDefinitionId, res.StatusCode, res.ReasonPhrase);
+            var resContent = res.ReasonPhrase;
+            try
+            {
+                resContent = await res.Content.ReadAsStringAsync();
+            }
+            catch
+            {
+            }
+
+            Logger.LogError("Failed to import API definition for {apiDefinition}. Status: {status}, reason: {reason}", apiDefinitionId, res.StatusCode, resContent);
         }
     }
 }
diff --git a/dev-proxy-plugins/RequestLogs/OpenApiSpecGeneratorPlugin.cs b/dev-proxy-plugins/RequestLogs/OpenApiSpecGeneratorPlugin.cs
@@ -404,7 +404,7 @@ private string ParametrizePath(OpenApiPathItem pathItem, Uri requestUri)
             if (IsParametrizable(segment))
             {
                 var parameterName = $"{previousSegment}-id";
-                segments[i] = "{" + parameterName + "}/";
+                segments[i] = $"{{{parameterName}}}{(requestUri.Segments[i].EndsWith('/') ? "/" : "")}";
 
                 pathItem.Parameters.Add(new OpenApiParameter
                 {

diff --git a/dev-proxy-plugins/TracingDelegatingHandler.cs b/dev-proxy-plugins/TracingDelegatingHandler.cs
@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.DevProxy.Plugins;
+
+internal class TracingDelegatingHandler(ILogger logger) : DelegatingHandler
+{
+    private readonly ILogger _logger = logger;
+
+    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    {
+        using var scope = _logger.BeginScope(request.GetHashCode().ToString());
+
+        _logger.LogTrace("Request: {method} {uri}", request.Method, request.RequestUri);
+        foreach (var (header, value) in request.Headers)
+        {
+            _logger.LogTrace("{header}: {value}", header, string.Join(", ", value));
+        }
+        if (request.Content is not null)
+        {
+            var body = await request.Content.ReadAsStringAsync();
+            _logger.LogTrace("Body: {body}", body);
+        }
+
+        var response = await base.SendAsync(request, cancellationToken);
+
+        _logger.LogTrace("Response");
+        foreach (var (header, value) in response.Headers)
+        {
+            _logger.LogTrace("{header}: {value}", header, string.Join(", ", value));
+        }
+        if (response.Content is not null)
+        {
+            var body = await response.Content.ReadAsStringAsync();
+            _logger.LogTrace("Body: {body}", body);
+        }
+
+        return response;
+    }
+}
diff --git a/dev-proxy/Logging/ProxyConsoleFormatter.cs b/dev-proxy/Logging/ProxyConsoleFormatter.cs
@@ -129,11 +129,21 @@ private void WriteMessageBoxedWithInvertedLabels(string? message, LogLevel logLe
         {
             scopeProvider.ForEachScope((scope, state) =>
             {
+                if (scope is null)
+                {
+                    return;
+                }
+
                 if (scope is string scopeString)
                 {
                     textWriter.Write(scopeString);
                     textWriter.Write(": ");
                 }
+                else if (scope.GetType().Name == "FormattedLogValues")
+                {
+                    textWriter.Write(scope.ToString());
+                    textWriter.Write(": ");
+                }
             }, textWriter);
         }