Adding empty remote message check in the SystemLogger (#11473)

* Adding empty string check.

Author: RohitRanjanMS

release_notes.md

@@ -5,3 +5,4 @@
 -->
 - Adding a "web app" configuration profile (#11447)
 - Add JitTrace Files for v4.1045
+- Adding empty remote message check in the SystemLogger (#11473)

src/WebJobs.Script.WebHost/Extensions/ExceptionExtensions.cs

@@ -63,15 +63,17 @@ public static (string InnerExceptionType, string InnerExceptionMessage, string D
             var formattedDetails = exception.ToFormattedString();
 
             if (exception is FunctionInvocationException && baseException is RpcException { RemoteMessage: var remoteMsg }
-                && remoteMsg is not null)
+                && !string.IsNullOrWhiteSpace(remoteMsg))
             {
                 var redacted = GetRedactedExceptionMessage(remoteMsg);
 
-                var innerExceptionMessage = Sanitizer.Sanitize(
-                    originalMessage.Replace(remoteMsg, redacted, StringComparison.Ordinal));
+                var innerExceptionMessage = string.IsNullOrWhiteSpace(originalMessage)
+                    ? string.Empty
+                    : Sanitizer.Sanitize(originalMessage.Replace(remoteMsg, redacted, StringComparison.Ordinal));
 
-                var detailsSanitized = Sanitizer.Sanitize(
-                    formattedDetails.Replace(remoteMsg, redacted, StringComparison.Ordinal));
+                var detailsSanitized = string.IsNullOrWhiteSpace(formattedDetails)
+                    ? string.Empty
+                    : Sanitizer.Sanitize(formattedDetails.Replace(remoteMsg, redacted, StringComparison.Ordinal));
 
                 return (innerType, innerExceptionMessage, detailsSanitized, formattedMessage);
             }

test/WebJobs.Script.Tests/Extensions/ExceptionExtensionsTests.cs

@@ -1,7 +1,9 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// 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 Microsoft.Azure.WebJobs.Host;
+using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
 using Xunit;
 
 namespace Microsoft.Azure.WebJobs.Script.Tests.Extensions
@@ -31,7 +33,55 @@ public void GetExceptionDetails_ReturnsExpectedResult()
             Assert.Contains("System.Exception : some outer exception ---> System.InvalidOperationException : Some inner exception", exceptionDetails);
             Assert.Contains("End of inner exception", exceptionDetails);
             Assert.Contains("at Microsoft.Azure.WebJobs.Script.Tests.Extensions.ExceptionExtensionsTests.GetExceptionDetails_ReturnsExpectedResult()", exceptionDetails);
-            Assert.Contains("ExceptionExtensionsTests.cs : 20", exceptionDetails);
+            Assert.Contains("ExceptionExtensionsTests.cs", exceptionDetails);
+        }
+
+        [Fact]
+        public void GetExceptionDetails_Rpc()
+        {
+            string rpcMessage = "rpcMessage";
+            Exception innerException = new RpcException("result", rpcMessage, "stack");
+            Exception outerException = new FunctionInvocationException("message", innerException);
+            Exception fullException;
+
+            try
+            {
+                throw outerException;
+            }
+            catch (Exception e)
+            {
+                fullException = e;
+            }
+
+            (string exceptionType, string exceptionMessage, string exceptionDetails, string formattedText) = fullException.GetSanitizedExceptionDetails("safe text");
+
+            Assert.Equal("Microsoft.Azure.WebJobs.Script.Workers.Rpc.RpcException", exceptionType);
+            Assert.DoesNotContain(rpcMessage, exceptionMessage);
+            Assert.DoesNotContain(rpcMessage, exceptionDetails);
+            Assert.Contains("safe text", formattedText);
+        }
+
+        [Fact]
+        public void GetExceptionDetails_Rpc_Empty()
+        {
+            Exception innerException = new RpcException(string.Empty, string.Empty, string.Empty);
+            Exception outerException = new FunctionInvocationException(string.Empty, innerException);
+            Exception fullException;
+
+            try
+            {
+                throw outerException;
+            }
+            catch (Exception e)
+            {
+                fullException = e;
+            }
+
+            (string exceptionType, string exceptionMessage, _, string formattedText) = fullException.GetSanitizedExceptionDetails("safe text");
+
+            Assert.Equal("Microsoft.Azure.WebJobs.Script.Workers.Rpc.RpcException", exceptionType);
+            Assert.Equal("Result: \nType: \nException: \nStack: ", exceptionMessage);
+            Assert.Contains("safe text", formattedText);
         }
     }
 }