Improve HttpContextAccessor debugging (#49430)

Co-authored-by: Martin Costello <[email protected]>

Author: JamesNK

src/Http/Http/src/HttpContextAccessor.cs

@@ -1,11 +1,14 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics;
+
 namespace Microsoft.AspNetCore.Http;
 
 /// <summary>
 /// Provides an implementation of <see cref="IHttpContextAccessor" /> based on the current execution context.
 /// </summary>
+[DebuggerDisplay("HttpContext = {HttpContext}")]
 public class HttpContextAccessor : IHttpContextAccessor
 {
     private static readonly AsyncLocal<HttpContextHolder> _httpContextCurrent = new AsyncLocal<HttpContextHolder>();

src/Http/Http/test/Internal/DefaultHttpRequestTests.cs

@@ -4,6 +4,7 @@
 using System.Globalization;
 using Microsoft.AspNetCore.Http.Features;
 using Microsoft.AspNetCore.Routing;
+using Microsoft.AspNetCore.Shared;
 using Microsoft.Extensions.Primitives;
 
 namespace Microsoft.AspNetCore.Http;
@@ -246,6 +247,97 @@ public void BodyReader_CanGet()
         Assert.NotNull(bodyPipe);
     }
 
+    [Fact]
+    public void DebuggerToString_EmptyRequest()
+    {
+        var context = new DefaultHttpContext();
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("(unspecified)", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasMethod()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.Method = "GET";
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("GET (unspecified)", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasProtocol()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.Protocol = "HTTP/2";
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("(unspecified) HTTP/2", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasContentType()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.ContentType = "application/json";
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("(unspecified) application/json", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasQueryString()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.QueryString = new QueryString("?query=true");
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("(unspecified)://(unspecified)?query=true", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasCompleteRequestUri()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.Scheme = "http";
+        context.Request.Host = new HostString("localhost", 8080);
+        context.Request.Path = "/Path";
+        context.Request.PathBase = "/PathBase";
+        context.Request.QueryString = new QueryString("?test=true");
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("http://localhost:8080/PathBase/Path?test=true", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasPartialRequestUri()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.Scheme = "http";
+        context.Request.Host = new HostString("localhost");
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("http://localhost", debugText);
+    }
+
+    [Fact]
+    public void DebuggerToString_HasEverything()
+    {
+        var context = new DefaultHttpContext();
+        context.Request.Method = "GET";
+        context.Request.Protocol = "HTTP/2";
+        context.Request.ContentType = "application/json";
+        context.Request.Scheme = "http";
+        context.Request.Host = new HostString("localhost", 8080);
+        context.Request.Path = "/Path";
+        context.Request.PathBase = "/PathBase";
+        context.Request.QueryString = new QueryString("?test=true");
+
+        var debugText = HttpContextDebugFormatter.RequestToString(context.Request);
+        Assert.Equal("GET http://localhost:8080/PathBase/Path?test=true HTTP/2 application/json", debugText);
+    }
+
     private class CustomRouteValuesFeature : IRouteValuesFeature
     {
         public RouteValueDictionary RouteValues { get; set; }

src/Shared/Debugger/HttpContextDebugFormatter.cs

@@ -31,7 +31,15 @@ public static string ResponseToString(HttpResponse response, string? reasonPhras
 
     public static string RequestToString(HttpRequest request)
     {
-        var text = $"{request.Method} {GetRequestUrl(request, includeQueryString: true)} {request.Protocol}";
+        var text = GetRequestUrl(request, includeQueryString: true);
+        if (!string.IsNullOrEmpty(request.Method))
+        {
+            text = $"{request.Method} {text}";
+        }
+        if (!string.IsNullOrEmpty(request.Protocol))
+        {
+            text += $" {request.Protocol}";
+        }
         if (!string.IsNullOrEmpty(request.ContentType))
         {
             text += $" {request.ContentType}";
@@ -53,6 +61,28 @@ public static string ContextToString(HttpContext context, string? reasonPhrase)
 
     private static string GetRequestUrl(HttpRequest request, bool includeQueryString)
     {
-        return $"{request.Scheme}://{request.Host.Value}{request.PathBase.Value}{request.Path.Value}{(includeQueryString ? request.QueryString.Value : string.Empty)}";
+        // The URL might be missing because the context was manually created in a test, e.g. new DefaultHttpContext()
+        if (string.IsNullOrEmpty(request.Scheme) &&
+            !request.Host.HasValue &&
+            !request.PathBase.HasValue &&
+            !request.Path.HasValue &&
+            !request.QueryString.HasValue)
+        {
+            return "(unspecified)";
+        }
+
+        // If some parts of the URL are provided then default the significant parts to avoid a werid output.
+        var scheme = request.Scheme;
+        if (string.IsNullOrEmpty(scheme))
+        {
+            scheme = "(unspecified)";
+        }
+        var host = request.Host.Value;
+        if (string.IsNullOrEmpty(host))
+        {
+            host = "(unspecified)";
+        }
+
+        return $"{scheme}://{host}{request.PathBase.Value}{request.Path.Value}{(includeQueryString ? request.QueryString.Value : string.Empty)}";
     }
 }