Rename EnableStackTrace to SendStackTraceToClients

abpframework · Nov 11, 2021 · 3ce989e · 3ce989e
1 parent f75747e
commit 3ce989e
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 31 deletions.
diff --git a/docs/en/Exception-Handling.md b/docs/en/Exception-Handling.md
@@ -329,12 +329,12 @@ You can also throw these type of exceptions in your code (although it's rarely n
 Configure<AbpExceptionHandlingOptions>(options =>
 {
     options.SendExceptionsDetailsToClients = true;
-    options.EnableStackTrace = false;
+    options.SendStackTraceToClients = false;
 });
 ````
 
 Here, a list of the options you can configure:
 
 * `SendExceptionsDetailsToClients` (default: `false`): You can enable or disable sending exception details to the client.
-* `EnableStackTrace` (default: `false`): You can enable or disable sending the `StackTrace` of exception to the client. When you set `EnableStackTrace` to true, it is set to `true` even if `SendExceptionsDetailsToClients` is `false` because it contains the exception details.
+* `SendStackTraceToClients` (default: `true`): You can enable or disable sending the stack trace of exception to the client. If you want to send the stack trace to the client, you must set both `SendStackTraceToClients` and `SendExceptionsDetailsToClients` options to `true` otherwise, the stack trace will not be sent to the client.
 
diff --git a/...ponents.Web/Volo/Abp/AspNetCore/Components/Web/ExceptionHandling/UserExceptionInformer.cs b/...ponents.Web/Volo/Abp/AspNetCore/Components/Web/ExceptionHandling/UserExceptionInformer.cs
@@ -66,7 +66,7 @@ protected virtual RemoteServiceErrorInfo GetErrorInfo(UserExceptionInformerConte
             return ExceptionToErrorInfoConverter.Convert(context.Exception, options =>
             {
                 options.SendExceptionsDetailsToClients = Options.SendExceptionsDetailsToClients;
-                options.EnableStackTrace = Options.EnableStackTrace;
+                options.SendStackTraceToClients = Options.SendStackTraceToClients;
             });
         }
     }

diff --git a/framework/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Shared/Controllers/ErrorController.cs b/framework/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Shared/Controllers/ErrorController.cs
@@ -50,7 +50,7 @@ public async Task<IActionResult> Index(int httpStatusCode)
             var errorInfo = _errorInfoConverter.Convert(exception, options =>
             {
                 options.SendExceptionsDetailsToClients = _exceptionHandlingOptions.SendExceptionsDetailsToClients;
-                options.EnableStackTrace = _exceptionHandlingOptions.EnableStackTrace;
+                options.SendStackTraceToClients = _exceptionHandlingOptions.SendStackTraceToClients;
             });
 
             if (httpStatusCode == 0)

diff --git a/...c/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/ExceptionHandling/AbpExceptionFilter.cs b/...c/Volo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/ExceptionHandling/AbpExceptionFilter.cs
@@ -62,7 +62,7 @@ protected virtual async Task HandleAndWrapException(ExceptionContext context)
             var remoteServiceErrorInfo  = exceptionToErrorInfoConverter.Convert(context.Exception, options =>
             {
                 options.SendExceptionsDetailsToClients = exceptionHandlingOptions.SendExceptionsDetailsToClients;
-                options.EnableStackTrace = exceptionHandlingOptions.EnableStackTrace;
+                options.SendStackTraceToClients = exceptionHandlingOptions.SendStackTraceToClients;
             });
 
             var logLevel = context.Exception.GetLogLevel();

diff --git a/...lo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/ExceptionHandling/AbpExceptionPageFilter.cs b/...lo.Abp.AspNetCore.Mvc/Volo/Abp/AspNetCore/Mvc/ExceptionHandling/AbpExceptionPageFilter.cs
@@ -74,7 +74,7 @@ protected virtual async Task HandleAndWrapException(PageHandlerExecutedContext c
             var remoteServiceErrorInfo  = exceptionToErrorInfoConverter.Convert(context.Exception, options =>
             {
                 options.SendExceptionsDetailsToClients = exceptionHandlingOptions.SendExceptionsDetailsToClients;
-                options.EnableStackTrace = exceptionHandlingOptions.EnableStackTrace;
+                options.SendStackTraceToClients = exceptionHandlingOptions.SendStackTraceToClients;
             });
 
             var logLevel = context.Exception.GetLogLevel();

diff --git a/...lo.Abp.AspNetCore/Volo/Abp/AspNetCore/ExceptionHandling/AbpExceptionHandlingMiddleware.cs b/...lo.Abp.AspNetCore/Volo/Abp/AspNetCore/ExceptionHandling/AbpExceptionHandlingMiddleware.cs
@@ -89,7 +89,7 @@ await httpContext.RequestServices.GetRequiredService<IAbpAuthorizationExceptionH
                             errorInfoConverter.Convert(exception, options =>
                             {
                                 options.SendExceptionsDetailsToClients = exceptionHandlingOptions.SendExceptionsDetailsToClients;
-                                options.EnableStackTrace = exceptionHandlingOptions.EnableStackTrace;
+                                options.SendStackTraceToClients = exceptionHandlingOptions.SendStackTraceToClients;
                             })
                         )
                     )

diff --git a/...bp.ExceptionHandling/Volo/Abp/AspNetCore/ExceptionHandling/AbpExceptionHandlingOptions.cs b/...bp.ExceptionHandling/Volo/Abp/AspNetCore/ExceptionHandling/AbpExceptionHandlingOptions.cs
@@ -2,21 +2,8 @@
 {
     public class AbpExceptionHandlingOptions
     {
-        public bool SendExceptionsDetailsToClients { get; set; }
-
-        private bool _enableStackTrace;
+        public bool SendExceptionsDetailsToClients { get; set; } = false;
 
-        public bool EnableStackTrace
-        {
-            get => _enableStackTrace;
-            set
-            {
-                _enableStackTrace = value;
-                if (_enableStackTrace)
-                {
-                    SendExceptionsDetailsToClients = true;
-                }
-            }
-        }
+        public bool SendStackTraceToClients { get; set; } = true;
     }
 }
diff --git a/...ionHandling/Volo/Abp/AspNetCore/ExceptionHandling/DefaultExceptionToErrorInfoConverter.cs b/...ionHandling/Volo/Abp/AspNetCore/ExceptionHandling/DefaultExceptionToErrorInfoConverter.cs
@@ -42,7 +42,7 @@ public RemoteServiceErrorInfo Convert(Exception exception, bool includeSensitive
         {
             var exceptionHandlingOptions = CreateDefaultOptions();
             exceptionHandlingOptions.SendExceptionsDetailsToClients = includeSensitiveDetails;
-            exceptionHandlingOptions.EnableStackTrace = includeSensitiveDetails;
+            exceptionHandlingOptions.SendStackTraceToClients = includeSensitiveDetails;
 
             var errorInfo = CreateErrorInfoWithoutCode(exception, exceptionHandlingOptions);
 
@@ -73,7 +73,7 @@ protected virtual RemoteServiceErrorInfo CreateErrorInfoWithoutCode(Exception ex
         {
             if (options.SendExceptionsDetailsToClients)
             {
-                return CreateDetailedErrorInfoFromException(exception, options.EnableStackTrace);
+                return CreateDetailedErrorInfoFromException(exception, options.SendStackTraceToClients);
             }
 
             exception = TryToGetActualException(exception);
@@ -213,11 +213,11 @@ protected virtual Exception TryToGetActualException(Exception exception)
             return exception;
         }
 
-        protected virtual RemoteServiceErrorInfo CreateDetailedErrorInfoFromException(Exception exception, bool enableStackTrace)
+        protected virtual RemoteServiceErrorInfo CreateDetailedErrorInfoFromException(Exception exception, bool sendStackTraceToClients)
         {
             var detailBuilder = new StringBuilder();
 
-            AddExceptionToDetails(exception, detailBuilder, enableStackTrace);
+            AddExceptionToDetails(exception, detailBuilder, sendStackTraceToClients);
 
             var errorInfo = new RemoteServiceErrorInfo(exception.Message, detailBuilder.ToString());
 
@@ -229,7 +229,7 @@ protected virtual RemoteServiceErrorInfo CreateDetailedErrorInfoFromException(Ex
             return errorInfo;
         }
 
-        protected virtual void AddExceptionToDetails(Exception exception, StringBuilder detailBuilder, bool enableStackTrace)
+        protected virtual void AddExceptionToDetails(Exception exception, StringBuilder detailBuilder, bool sendStackTraceToClients)
         {
             //Exception Message
             detailBuilder.AppendLine(exception.GetType().Name + ": " + exception.Message);
@@ -256,15 +256,15 @@ protected virtual void AddExceptionToDetails(Exception exception, StringBuilder
             }
 
             //Exception StackTrace
-            if (enableStackTrace && !string.IsNullOrEmpty(exception.StackTrace))
+            if (sendStackTraceToClients && !string.IsNullOrEmpty(exception.StackTrace))
             {
                 detailBuilder.AppendLine("STACK TRACE: " + exception.StackTrace);
             }
 
             //Inner exception
             if (exception.InnerException != null)
             {
-                AddExceptionToDetails(exception.InnerException, detailBuilder, enableStackTrace);
+                AddExceptionToDetails(exception.InnerException, detailBuilder, sendStackTraceToClients);
             }
 
             //Inner exceptions for AggregateException
@@ -278,7 +278,7 @@ protected virtual void AddExceptionToDetails(Exception exception, StringBuilder
 
                 foreach (var innerException in aggException.InnerExceptions)
                 {
-                    AddExceptionToDetails(innerException, detailBuilder, enableStackTrace);
+                    AddExceptionToDetails(innerException, detailBuilder, sendStackTraceToClients);
                 }
             }
         }
@@ -321,7 +321,7 @@ protected virtual AbpExceptionHandlingOptions CreateDefaultOptions()
             return new AbpExceptionHandlingOptions
             {
                 SendExceptionsDetailsToClients = false,
-                EnableStackTrace = false
+                SendStackTraceToClients = true
             };
         }
     }