Add CreateExceptionProblemDetails and make it virtual

khellang · Aug 8, 2022 · 0bc61a2 · 0bc61a2
1 parent 2528bba
commit 0bc61a2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 12 deletions.
diff --git a/src/ProblemDetails/Mvc/ProblemDetailsResultFilter.cs b/src/ProblemDetails/Mvc/ProblemDetailsResultFilter.cs
@@ -69,7 +69,7 @@ public void OnResultExecuting(ResultExecutingContext context)
                 // Set the response status code because it might be used for mapping inside the factory.
                 context.HttpContext.Response.StatusCode = result.StatusCode ?? StatusCodes.Status500InternalServerError;
 
-                var details = Factory.GetDetails(context.HttpContext, exception);
+                var details = Factory.CreateExceptionProblemDetails(context.HttpContext, exception);
 
                 // Devs can choose to ignore errors by returning null.
                 if (details is null)

diff --git a/src/ProblemDetails/ProblemDetailsFactory.cs b/src/ProblemDetails/ProblemDetailsFactory.cs
@@ -32,7 +32,10 @@ public ProblemDetailsFactory(
 
         private ExceptionDetailsProvider DetailsProvider { get; }
 
-        public MvcProblemDetails? GetDetails(HttpContext context, Exception error)
+        [Obsolete("Use " + nameof(CreateExceptionProblemDetails) + " instead.")]
+        public MvcProblemDetails? GetDetails(HttpContext context, Exception error) => CreateExceptionProblemDetails(context, error);
+
+        public virtual MvcProblemDetails? CreateExceptionProblemDetails(HttpContext context, Exception error)
         {
             MvcProblemDetails? result;
             if (error is ProblemDetailsException problem)
@@ -74,18 +77,18 @@ public ProblemDetailsFactory(
             }
 
             return result;
-        }
 
-        private MvcProblemDetails? MapToProblemDetails(HttpContext context, Exception error)
-        {
-            if (Options.TryMapProblemDetails(context, error, out var result))
+            MvcProblemDetails? MapToProblemDetails(HttpContext context, Exception error)
             {
-                // The user has set up a mapping for the specific exception type.
-                return result;
-            }
+                if (Options.TryMapProblemDetails(context, error, out var result))
+                {
+                    // The user has set up a mapping for the specific exception type.
+                    return result;
+                }
 
-            // Fall back to the generic status code problem details.
-            return Options.MapStatusCode(context);
+                // Fall back to the generic status code problem details.
+                return Options.MapStatusCode(context);
+            }
         }
 
         public override MvcProblemDetails CreateProblemDetails(

diff --git a/src/ProblemDetails/ProblemDetailsMiddleware.cs b/src/ProblemDetails/ProblemDetailsMiddleware.cs
@@ -112,7 +112,7 @@ private async Task HandleException(HttpContext context, ExceptionDispatchInfo ed
                 context.Features.Set<IExceptionHandlerPathFeature>(feature);
                 context.Features.Set<IExceptionHandlerFeature>(feature);
 
-                var details = Factory.GetDetails(context, error);
+                var details = Factory.CreateExceptionProblemDetails(context, error);
 
                 if (details != null) // Don't handle the exception if we can't or don't want to convert it to ProblemDetails
                 {