Dev (#17)

modabas · web-flow · commit af10bbdbffdd · 2025-04-14T11:53:42.000+03:00
* - code refactoring: make some internal class and interfaces public to make overriding them via DI easier, rename some classes and variables

* - code cleanup and sync namespaces

* - add summary info

* - add tests for web result endpoints with failed result

* - bump version
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -18,6 +18,6 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>0.6.6</Version>
+    <Version>0.6.7</Version>
   </PropertyGroup>
 </Project>
diff --git a/samples/BenchmarkWebApi/Features/MinimalApis/BasicTest.cs b/samples/BenchmarkWebApi/Features/MinimalApis/BasicTest.cs
@@ -1,4 +1,4 @@
-﻿namespace BenchmarkWebApi.Features.RegularEndpoints;
+﻿namespace BenchmarkWebApi.Features.MinimalApis;
 
 internal static class BasicTest
 {
diff --git a/samples/BenchmarkWebApi/Features/MinimalApis/InProcessTest.cs b/samples/BenchmarkWebApi/Features/MinimalApis/InProcessTest.cs
@@ -5,7 +5,7 @@
 using ModResults;
 using ModResults.MinimalApis;
 
-namespace BenchmarkWebApi.Features.RegularEndpoints;
+namespace BenchmarkWebApi.Features.MinimalApis;
 
 public record InProcessTestRequest(Guid Id, [FromBody] InProcessTestRequestBody Body);
 
diff --git a/samples/BenchmarkWebApi/Program.cs b/samples/BenchmarkWebApi/Program.cs
@@ -1,5 +1,5 @@
 ﻿using BenchmarkWebApi.Extensions;
-using BenchmarkWebApi.Features.RegularEndpoints;
+using BenchmarkWebApi.Features.MinimalApis;
 using ModEndpoints;
 
 var builder = WebApplication.CreateBuilder(args);
diff --git a/src/ModEndpoints/DependencyInjectionExtensions.cs b/src/ModEndpoints/DependencyInjectionExtensions.cs
@@ -23,10 +23,10 @@ public static IServiceCollection AddModEndpointsFromAssembly(
     //WebResultEndpoint components
     services.TryAddKeyedSingleton<IResultToResponseMapper, DefaultResultToResponseMapper>(
       WebResultEndpointDefinitions.DefaultResultToResponseMapperName);
-    services.TryAddKeyedSingleton<IPreferredSuccessStatusCodeCache, PreferredSuccessStatusCodeCacheForResult>(
-      WebResultEndpointDefinitions.PreferredSuccessStatusCodeCacheNameForResult);
-    services.TryAddKeyedSingleton<IPreferredSuccessStatusCodeCache, PreferredSuccessStatusCodeCacheForResultOfT>(
-      WebResultEndpointDefinitions.PreferredSuccessStatusCodeCacheNameForResultOfT);
+    services.TryAddKeyedSingleton<IPreferredSuccessStatusCodeCache, DefaultPreferredSuccessStatusCodeCacheForResult>(
+      WebResultEndpointDefinitions.DefaultPreferredSuccessStatusCodeCacheNameForResult);
+    services.TryAddKeyedSingleton<IPreferredSuccessStatusCodeCache, DefaultPreferredSuccessStatusCodeCacheForResultOfT>(
+      WebResultEndpointDefinitions.DefaultPreferredSuccessStatusCodeCacheNameForResultOfT);
     services.TryAddScoped<ILocationStore, DefaultLocationStore>();
     services.TryAddSingleton<IResultToResponseMapProvider, DefaultResultToResponseMapProvider>();
 
diff --git a/src/ModEndpoints/[WebResultEndpoint]/DefaultPreferredSuccessStatusCodeCacheForResult.cs b/src/ModEndpoints/[WebResultEndpoint]/DefaultPreferredSuccessStatusCodeCacheForResult.cs
@@ -4,7 +4,10 @@
 
 namespace ModEndpoints;
 
-internal class PreferredSuccessStatusCodeCacheForResult : IPreferredSuccessStatusCodeCache
+/// <summary>
+/// Used to store and retrieve preferred success status codes for Web Result Endpoints without a response model.
+/// </summary>
+public class DefaultPreferredSuccessStatusCodeCacheForResult : IPreferredSuccessStatusCodeCache
 {
   private readonly int?[] _successStatusCodePriorityList =
   [
diff --git a/src/ModEndpoints/[WebResultEndpoint]/DefaultPreferredSuccessStatusCodeCacheForResultOfT.cs b/src/ModEndpoints/[WebResultEndpoint]/DefaultPreferredSuccessStatusCodeCacheForResultOfT.cs
@@ -4,7 +4,10 @@
 
 namespace ModEndpoints;
 
-internal class PreferredSuccessStatusCodeCacheForResultOfT : IPreferredSuccessStatusCodeCache
+/// <summary>
+/// Used to store and retrieve preferred success status codes for Web Result Endpoints with a response model.
+/// </summary>
+public class DefaultPreferredSuccessStatusCodeCacheForResultOfT : IPreferredSuccessStatusCodeCache
 {
   private readonly int?[] _successStatusCodePriorityList =
   [
diff --git a/src/ModEndpoints/[WebResultEndpoint]/DefaultResultToResponseMapper.cs b/src/ModEndpoints/[WebResultEndpoint]/DefaultResultToResponseMapper.cs
@@ -1,5 +1,4 @@
 ﻿using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Http.Metadata;
 using Microsoft.Extensions.DependencyInjection;
 using ModResults;
 using ModResults.MinimalApis;
@@ -23,11 +22,11 @@ public async ValueTask<IResult> ToResponseAsync(
 
     var preferredSuccessStatusCodeCache = context.RequestServices
       .GetRequiredKeyedService<IPreferredSuccessStatusCodeCache>(
-      WebResultEndpointDefinitions.PreferredSuccessStatusCodeCacheNameForResult);
-    var preferredCode = preferredSuccessStatusCodeCache
+      WebResultEndpointDefinitions.DefaultPreferredSuccessStatusCodeCacheNameForResult);
+    var preferredSuccessCode = preferredSuccessStatusCodeCache
       .GetStatusCode(context);
 
-    switch (preferredCode)
+    switch (preferredSuccessCode)
     {
       case StatusCodes.Status204NoContent:
         return result.ToResponse();
@@ -73,11 +72,11 @@ public async ValueTask<IResult> ToResponseAsync<TValue>(
 
     var preferredSuccessStatusCodeCache = context.RequestServices
       .GetRequiredKeyedService<IPreferredSuccessStatusCodeCache>(
-      WebResultEndpointDefinitions.PreferredSuccessStatusCodeCacheNameForResultOfT);
-    var preferredCode = preferredSuccessStatusCodeCache
+      WebResultEndpointDefinitions.DefaultPreferredSuccessStatusCodeCacheNameForResultOfT);
+    var preferredSuccessCode = preferredSuccessStatusCodeCache
       .GetStatusCode(context);
 
-    switch (preferredCode)
+    switch (preferredSuccessCode)
     {
       case StatusCodes.Status200OK:
         return result.ToResponse();
diff --git a/src/ModEndpoints/[WebResultEndpoint]/IPreferredSuccessStatusCodeCache.cs b/src/ModEndpoints/[WebResultEndpoint]/IPreferredSuccessStatusCodeCache.cs
@@ -2,7 +2,7 @@
 
 namespace ModEndpoints;
 
-internal interface IPreferredSuccessStatusCodeCache
+public interface IPreferredSuccessStatusCodeCache
 {
   int? GetStatusCode(HttpContext context);
 }
diff --git a/src/ModEndpoints/[WebResultEndpoint]/WebResultEndpointDefinitions.cs b/src/ModEndpoints/[WebResultEndpoint]/WebResultEndpointDefinitions.cs
@@ -2,9 +2,9 @@
 public static class WebResultEndpointDefinitions
 {
   public const string DefaultResultToResponseMapperName = "DefaultResultToResponseMapper";
+  public const string DefaultPreferredSuccessStatusCodeCacheNameForResult = "DefaultPreferredSuccessStatusCodeCacheForResult";
+  public const string DefaultPreferredSuccessStatusCodeCacheNameForResultOfT = "DefaultPreferredSuccessStatusCodeCacheForResultOfT";
+
   public const string InvalidRouteMessage = "No route matches the supplied values.";
   public const string HttpContextIsInvalidMessage = "Http context resolved from dependency injection is invalid.";
-
-  internal const string PreferredSuccessStatusCodeCacheNameForResult = "PreferredSuccessStatusCodeCacheForResult";
-  internal const string PreferredSuccessStatusCodeCacheNameForResultOfT = "PreferredSuccessStatusCodeCacheForResultOfT";
 }
diff --git a/tests/ModEndpoints.TestServer/Features/Books/FailureEndpointWithResponseModel.cs b/tests/ModEndpoints.TestServer/Features/Books/FailureEndpointWithResponseModel.cs
@@ -0,0 +1,20 @@
+﻿using ModEndpoints.Core;
+using ModResults;
+
+namespace ModEndpoints.TestServer.Features.Books;
+
+public record FailureEndpointWithoutResponseModelResponse(Guid Id);
+
+internal class FailureEndpointWithResponseModel
+  : WebResultEndpointWithEmptyRequest<FailureEndpointWithoutResponseModelResponse>
+{
+  protected override void Configure(IServiceProvider serviceProvider, IRouteGroupConfigurator? parentRouteGroup)
+  {
+    MapPost("/failure/withResponseModel");
+  }
+
+  protected override Task<Result<FailureEndpointWithoutResponseModelResponse>> HandleAsync(CancellationToken ct)
+  {
+    return Task.FromResult(Result<FailureEndpointWithoutResponseModelResponse>.NotFound("Item not found."));
+  }
+}
diff --git a/tests/ModEndpoints.TestServer/Features/Books/FailureEndpointWithoutResponseModel.cs b/tests/ModEndpoints.TestServer/Features/Books/FailureEndpointWithoutResponseModel.cs
@@ -0,0 +1,18 @@
+﻿using ModEndpoints.Core;
+using ModResults;
+
+namespace ModEndpoints.TestServer.Features.Books;
+
+internal class FailureEndpointWithoutResponseModel
+  : WebResultEndpointWithEmptyRequest
+{
+  protected override void Configure(IServiceProvider serviceProvider, IRouteGroupConfigurator? parentRouteGroup)
+  {
+    MapPost("/failure/withoutResponseModel");
+  }
+
+  protected override Task<Result> HandleAsync(CancellationToken ct)
+  {
+    return Task.FromResult(Result.NotFound("Item not found."));
+  }
+}
diff --git a/tests/ModEndpoints.Tests/WebResultEndpoints/HandlerTests.cs b/tests/ModEndpoints.Tests/WebResultEndpoints/HandlerTests.cs
@@ -45,6 +45,40 @@ await httpResponse.Content.ReadAsStreamAsync(),
     Assert.Equal(19.99m, response.Price);
   }
 
+  [Fact]
+  public async Task FailureEndpointWithEmptyRequestOfTResponse_Returns_ErrorAsync()
+  {
+    var httpRequest = new HttpRequestMessage(HttpMethod.Post, "/api/books/failure/withResponseModel");
+    var httpResponse = await _testClient.SendAsync(httpRequest);
+
+    Assert.False(httpResponse.IsSuccessStatusCode);
+    Assert.Equal(StatusCodes.Status404NotFound, (int)httpResponse.StatusCode);
+  }
+
+  [Fact]
+  public async Task FailureEndpointWithEmptyRequest_Returns_ErrorAsync()
+  {
+    var httpRequest = new HttpRequestMessage(HttpMethod.Post, "/api/books/failure/withoutResponseModel");
+
+    var httpResponse = await _testClient.SendAsync(httpRequest);
+    Assert.False(httpResponse.IsSuccessStatusCode);
+    Assert.Equal(StatusCodes.Status404NotFound, (int)httpResponse.StatusCode);
+  }
+
+  [Fact]
+  public async Task EndpointOfTRequest_Returns_SuccessAsync()
+  {
+    var bookId = Guid.NewGuid();
+    var httpRequest = new HttpRequestMessage(HttpMethod.Put, $"/api/books/{bookId}")
+    {
+      Content = JsonContent.Create(new UpdateBookRequestBody("Title 1", "Author 1", 19.99m))
+    };
+
+    var httpResponse = await _testClient.SendAsync(httpRequest);
+    Assert.True(httpResponse.IsSuccessStatusCode);
+    Assert.Equal(StatusCodes.Status204NoContent, (int)httpResponse.StatusCode);
+  }
+
   [Fact]
   public async Task EndpointWithEmptyRequestOfTResponse_Returns_SuccessAsync()
   {
@@ -78,18 +112,4 @@ public async Task EndpointWithEmptyRequest_Returns_SuccessAsync()
     Assert.True(httpResponse.IsSuccessStatusCode);
     Assert.Equal(StatusCodes.Status204NoContent, (int)httpResponse.StatusCode);
   }
-
-  [Fact]
-  public async Task EndpointOfTRequest_Returns_SuccessAsync()
-  {
-    var bookId = Guid.NewGuid();
-    var httpRequest = new HttpRequestMessage(HttpMethod.Put, $"/api/books/{bookId}")
-    {
-      Content = JsonContent.Create(new UpdateBookRequestBody("Title 1", "Author 1", 19.99m))
-    };
-
-    var httpResponse = await _testClient.SendAsync(httpRequest);
-    Assert.True(httpResponse.IsSuccessStatusCode);
-    Assert.Equal(StatusCodes.Status204NoContent, (int)httpResponse.StatusCode);
-  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace BenchmarkWebApi.Features.RegularEndpoints;`
	`1`	`+namespace BenchmarkWebApi.Features.MinimalApis;`
`2`	`2`
`3`	`3`	`internal static class BasicTest`
`4`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,10 @@`
`4`	`4`
`5`	`5`	`namespace ModEndpoints;`
`6`	`6`
`7`		`-internal class PreferredSuccessStatusCodeCacheForResult : IPreferredSuccessStatusCodeCache`
	`7`	`+/// <summary>`
	`8`	`+/// Used to store and retrieve preferred success status codes for Web Result Endpoints without a response model.`
	`9`	`+/// </summary>`
	`10`	`+public class DefaultPreferredSuccessStatusCodeCacheForResult : IPreferredSuccessStatusCodeCache`
`8`	`11`	`{`
`9`	`12`	`private readonly int?[] _successStatusCodePriorityList =`
`10`	`13`	`[`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace ModEndpoints;`
`4`	`4`
`5`		`-internal interface IPreferredSuccessStatusCodeCache`
	`5`	`+public interface IPreferredSuccessStatusCodeCache`
`6`	`6`	`{`
`7`	`7`	`int? GetStatusCode(HttpContext context);`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`	`public static class WebResultEndpointDefinitions`
`3`	`3`	`{`
`4`	`4`	`public const string DefaultResultToResponseMapperName = "DefaultResultToResponseMapper";`
	`5`	`+ public const string DefaultPreferredSuccessStatusCodeCacheNameForResult = "DefaultPreferredSuccessStatusCodeCacheForResult";`
	`6`	`+ public const string DefaultPreferredSuccessStatusCodeCacheNameForResultOfT = "DefaultPreferredSuccessStatusCodeCacheForResultOfT";`
	`7`	`+`
`5`	`8`	`public const string InvalidRouteMessage = "No route matches the supplied values.";`
`6`	`9`	`public const string HttpContextIsInvalidMessage = "Http context resolved from dependency injection is invalid.";`
`7`		`-`
`8`		`- internal const string PreferredSuccessStatusCodeCacheNameForResult = "PreferredSuccessStatusCodeCacheForResult";`
`9`		`- internal const string PreferredSuccessStatusCodeCacheNameForResultOfT = "PreferredSuccessStatusCodeCacheForResultOfT";`
`10`	`10`	`}`