Avoid using HttpRequest from log scope (#9979) (#9980)

Author: jviau

src/WebJobs.Script.WebHost/Diagnostics/SystemLogger.cs

@@ -146,10 +146,9 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
 
                 // For Http function invocations we want to stamp invocation logs with
                 // the request ID for easy correlation with incoming Http request logs.
-                if (scopeProps.TryGetValue(ScriptConstants.LoggerHttpRequest, out scopeValue))
+                if (scopeProps.TryGetValue(ScriptConstants.AzureFunctionsRequestIdKey, out scopeValue))
                 {
-                    var httpRequest = (HttpRequest)scopeValue;
-                    scopeActivityId = httpRequest.GetRequestId();
+                    scopeActivityId = scopeValue as string;
                 }
             }
 

src/WebJobs.Script.WebHost/Middleware/FunctionInvocationMiddleware.cs

@@ -136,6 +136,7 @@ private async Task<IActionResult> GetResultAsync(HttpContext context, IFunctionE
                 var scopeState = new Dictionary<string, object>()
                 {
                     [ScriptConstants.LoggerHttpRequest] = context.Request,
+                    [ScriptConstants.AzureFunctionsRequestIdKey] = context.Request.GetRequestId(),
                 };
 
                 using (logger.BeginScope(scopeState))

src/WebJobs.Script/ScriptConstants.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+using System;
 using System.Collections.Immutable;
 using NuGet.Versioning;
 
@@ -46,6 +47,10 @@ public static class ScriptConstants
         public const string TraceSourceHttpHandler = "HttpRequestTraceHandler";
         public const string TraceSourceHttpThrottleMiddleware = "HttpThrottleMiddleware";
 
+        // We have been using this to insert the full HttpRequest into the logger scope. This is not a good practice
+        // as it will worsen any execution context leaks. If logger scope is leaked, now HTTP request will be leaked as well.
+        // We will not remove it from the logger scope just yet, but we will remove all of our own usage of it.
+        [Obsolete("Do not access the HTTP request from the logger scope, this will be removed in a future version.")]
         public const string LoggerHttpRequest = "MS_HttpRequest";
 
         public const string LogCategoryHostController = "Host.Controllers.Host";