Merge pull request #23 from cloudfy/22-various-bugs

Enhance ProblemDetails and update project files
cloudfy · Nov 11, 2024 · c0e9014 · c0e9014
2 parents 8475a54 + 31bd6bb
commit c0e9014
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 17 deletions.
diff --git a/src/Arcturus.Extensions.ResultObjects.AspNetCore/ActionResults/ProblemDetailsActionResult.cs b/src/Arcturus.Extensions.ResultObjects.AspNetCore/ActionResults/ProblemDetailsActionResult.cs
@@ -17,15 +17,12 @@ public Task ExecuteResultAsync(ActionContext context)
     {
         HttpStatusCode defaultStatusCode = _result.HttpStatusCode ?? HttpStatusCode.BadRequest;
 
-        //var cts = new ProblemDetailsContext()
-        //{
-        //    HttpContext = context.HttpContext
-        //};
         var factory = context.HttpContext.RequestServices.GetService<ProblemDetailsFactory>();
         var problemDetails = factory!.CreateProblemDetails(context.HttpContext, (int)defaultStatusCode);
         problemDetails.Type ??= "https://schemas/2022/fault/#" + defaultStatusCode.ToString().ToLower();
         problemDetails.Title ??= _result.Fault?.Code;
         problemDetails.Detail = _result.Fault?.Message;
+        problemDetails.Instance = $"{context.HttpContext.Request.Method} {context.HttpContext.Request.Path}";
         //if (_properties?.Length > 0)
         //{
         //    prbml.Extensions.Add("fields", _properties.ToKeyValueList(_ => _.Code, _ => _.Message));

diff --git a/...s.Extensions.ResultObjects.AspNetCore/Arcturus.Extensions.ResultObjects.AspNetCore.csproj b/...s.Extensions.ResultObjects.AspNetCore/Arcturus.Extensions.ResultObjects.AspNetCore.csproj
@@ -4,6 +4,12 @@
 		<PackageId>Arcturus.Extensions.ResultObjects.AspNetCore</PackageId>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageTags>result,resultobject,aspnetcore,arcturus</PackageTags>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+		<NoWarn>$(NoWarn);1591</NoWarn>
+	</PropertyGroup>
+
+	<PropertyGroup>
+		<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

diff --git a/src/Arcturus.Extensions.ResultObjects.AspNetCore/Internals/JsonSerializerExtensions.cs b/src/Arcturus.Extensions.ResultObjects.AspNetCore/Internals/JsonSerializerExtensions.cs
@@ -7,18 +7,18 @@ namespace Arcturus.Extensions.ResultObjects.AspNetCore.Internals;
 
 internal static class JsonSerializerExtensions
 {
-    public static bool HasKnownPolymorphism(this JsonTypeInfo jsonTypeInfo)
+    internal static bool HasKnownPolymorphism(this JsonTypeInfo jsonTypeInfo)
      => jsonTypeInfo.Type.IsSealed || jsonTypeInfo.Type.IsValueType || jsonTypeInfo.PolymorphismOptions is not null;
 
-    public static bool ShouldUseWith(this JsonTypeInfo jsonTypeInfo, [NotNullWhen(false)] Type? runtimeType)
+    internal static bool ShouldUseWith(this JsonTypeInfo jsonTypeInfo, [NotNullWhen(false)] Type? runtimeType)
      => runtimeType is null || jsonTypeInfo.Type == runtimeType || jsonTypeInfo.HasKnownPolymorphism();
 
-    public static JsonTypeInfo GetReadOnlyTypeInfo(this JsonSerializerOptions options, Type type)
+    internal static JsonTypeInfo GetReadOnlyTypeInfo(this JsonSerializerOptions options, Type type)
     {
         options.MakeReadOnly();
         return options.GetTypeInfo(type);
     }
 
-    public static JsonTypeInfo GetRequiredTypeInfo(this JsonSerializerContext context, Type type)
+    internal static JsonTypeInfo GetRequiredTypeInfo(this JsonSerializerContext context, Type type)
         => context.GetTypeInfo(type) ?? throw new InvalidOperationException($"Unable to obtain the JsonTypeInfo for type '{type.FullName}' from the context '{context.GetType().FullName}'.");
 }
diff --git a/src/Arcturus.Extensions.ResultObjects.AspNetCore/ResultExtensions.cs b/src/Arcturus.Extensions.ResultObjects.AspNetCore/ResultExtensions.cs
@@ -31,10 +31,10 @@ public static IActionResult ToActionResult<T>(this Result<T> result)
             result.WithHttpStatusCode(_defaultStatusCode));
     }
     /// <summary>
-    /// 
+    /// Converts a <see cref="Result"/> object to an <see cref="IActionResult"/> object.
     /// </summary>
-    /// <param name="result"></param>
-    /// <returns></returns>
+    /// <param name="result">The <see cref="Result"/> object to convert.</param>
+    /// <returns>An <see cref="IActionResult"/> object representing the result.</returns>
     public static IActionResult ToActionResult(this Result result)
     {
         if (result.IsSuccess && result.HttpStatusCode is null)
@@ -52,10 +52,10 @@ public static IActionResult ToActionResult(this Result result)
 
     }
     /// <summary>
-    /// 
+    /// Converts a Task of <see cref="Result"/> object to an <see cref="IActionResult"/> object.
     /// </summary>
-    /// <param name="result"></param>
-    /// <returns></returns>
+    /// <param name="result">The <see cref="Result"/> object to convert.</param>
+    /// <returns>An <see cref="IActionResult"/> object representing the result.</returns>
     public async static Task<IActionResult> ToActionResult(this Task<Result> result)
         => (await result).ToActionResult();
     /// <summary>

diff --git a/src/Arcturus.Extensions.ResultObjects.AspNetCore/Results/ProblemDetailsResult.cs b/src/Arcturus.Extensions.ResultObjects.AspNetCore/Results/ProblemDetailsResult.cs
@@ -17,14 +17,13 @@ public Task ExecuteAsync(HttpContext httpContext)
     {
         HttpStatusCode defaultStatusCode = _result.HttpStatusCode ?? HttpStatusCode.BadRequest;
 
-        //var factory1 = httpContext.RequestServices.GetService<IProblemDetailsService>();
         var factory = httpContext.RequestServices.GetService<ProblemDetailsFactory>();
         var problemDetails = factory!.CreateProblemDetails(httpContext, (int)defaultStatusCode);
 
         problemDetails.Title ??= _result.Fault?.Code;
         problemDetails.Detail = _result.Fault?.Message;
         problemDetails.Type ??= "https://schemas/2022/fault/#" + defaultStatusCode.ToString().ToLower();
-
+        problemDetails.Instance = $"{httpContext.Request.Method} {httpContext.Request.Path}";
         //var cts = new ProblemDetailsContext()
         //{
         //    HttpContext = httpContext

diff --git a/src/Arcturus.ResultObjects/Arcturus.ResultObjects.csproj b/src/Arcturus.ResultObjects/Arcturus.ResultObjects.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
 	  <PackageId>Arcturus.ResultObjects</PackageId>
 	  <PackageTags>result,resultobject,arcturus</PackageTags>
+	  <PackageLicenseExpression>MIT</PackageLicenseExpression>
 	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
 	  <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>

diff --git a/src/Arcturus.ResultObjects/ResultExtensions.cs b/src/Arcturus.ResultObjects/ResultExtensions.cs
@@ -73,7 +73,6 @@ public static Result<T> WithHelpLink<T>(this Result<T> result, string uri)
     /// <summary>
     /// Assigns a helplink to the result.
     /// </summary>
-    /// <typeparam name="T">Type of result object.</typeparam>
     /// <param name="result">Required.</param>
     /// <param name="uri">Url of the help link.</param>
     /// <returns><see cref="Result"/></returns>