Dev (#13)

* - while handling minimal endpoints invalid requests, prioritize ProblemHttpResult type responses first since it utilizes customized problem details defined by IServiceCollection.AddProblemDetails

* - add DoNotRegister attribute, to prevent targeted route group (including its children), endpoint or service endpoint request to be registered during application startup.
- fix DeleteCustomer endpoint class name

* - add DoNotRegister attribute information to README, also add a sample endpoint disabled with DoNotRegister attribute

* - bump version

Author: modabas

Directory.Build.props

@@ -18,6 +18,6 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>0.6.3</Version>
+    <Version>0.6.4</Version>
   </PropertyGroup>
 </Project>

README.md

@@ -308,6 +308,33 @@ internal class CreateBook(ServiceDbContext db, ILocationStore location)
 }
 ```
 
+### Disabling components
+
+DoNotRegister attribute can be used to prevent targeted route group (including its children) or endpoint to be registered during server application startup.
+
+Also prevents targeted service endpoint request to be registered during service endpoint client application startup.
+
+```csharp
+[MapToGroup<CustomersV1RouteGroup>()]
+[DoNotRegister]
+internal class DisabledCustomerFeature
+  : MinimalEndpoint<IResult>
+{
+  protected override void Configure(
+    IServiceProvider serviceProvider,
+    IRouteGroupConfigurator? parentRouteGroup)
+  {
+    MapGet("/disabled/");
+  }
+
+  protected override Task<IResult> HandleAsync(
+    CancellationToken ct)
+  {
+    throw new NotImplementedException();
+  }
+}
+```
+
 ## Samples
 
 [ShowcaseWebApi](https://github.com/modabas/ModEndpoints/tree/main/samples/ShowcaseWebApi) project demonstrates various kinds of endpoint implementations and configurations:

samples/ShowcaseWebApi/Features/Customers/CreateCustomer.cs

@@ -24,7 +24,7 @@ public CreateCustomerRequestValidator()
 
 [MapToGroup<CustomersV1RouteGroup>()]
 internal class CreateCustomer(ServiceDbContext db)
-  : MinimalEndpoint<CreateCustomerRequest, Results<CreatedAtRoute<CreateCustomerResponse>, ValidationProblem>>
+  : MinimalEndpoint<CreateCustomerRequest, Results<CreatedAtRoute<CreateCustomerResponse>, ValidationProblem, ProblemHttpResult>>
 {
   protected override void Configure(
     IServiceProvider serviceProvider,
@@ -33,7 +33,7 @@ protected override void Configure(
     MapPost("/");
   }
 
-  protected override async Task<Results<CreatedAtRoute<CreateCustomerResponse>, ValidationProblem>> HandleAsync(
+  protected override async Task<Results<CreatedAtRoute<CreateCustomerResponse>, ValidationProblem, ProblemHttpResult>> HandleAsync(
     CreateCustomerRequest req,
     CancellationToken ct)
   {

samples/ShowcaseWebApi/Features/Customers/DeleteBook.cs renamed to samples/ShowcaseWebApi/Features/Customers/DeleteCustomer.cs

@@ -0,0 +1,24 @@
+using ModEndpoints.Core;
+using ModEndpoints.RemoteServices.Core;
+using ShowcaseWebApi.Features.Customers.Configuration;
+
+namespace ShowcaseWebApi.Features.Customers;
+
+[MapToGroup<CustomersV1RouteGroup>()]
+[DoNotRegister]
+internal class DisabledCustomerFeature
+  : MinimalEndpoint<IResult>
+{
+  protected override void Configure(
+    IServiceProvider serviceProvider,
+    IRouteGroupConfigurator? parentRouteGroup)
+  {
+    MapGet("/disabled/");
+  }
+
+  protected override Task<IResult> HandleAsync(
+    CancellationToken ct)
+  {
+    throw new NotImplementedException();
+  }
+}

samples/ShowcaseWebApi/Features/Customers/DisabledCustomerFeature.cs

@@ -21,7 +21,7 @@ public GetCustomerByIdRequestValidator()
 
 [MapToGroup<CustomersV1RouteGroup>()]
 internal class GetCustomerById(ServiceDbContext db)
-  : MinimalEndpoint<GetCustomerByIdRequest, Results<Ok<GetCustomerByIdResponse>, NotFound, ValidationProblem>>
+  : MinimalEndpoint<GetCustomerByIdRequest, Results<Ok<GetCustomerByIdResponse>, NotFound, ValidationProblem, ProblemHttpResult>>
 {
   protected override void Configure(
     IServiceProvider serviceProvider,
@@ -30,7 +30,7 @@ protected override void Configure(
     MapGet("/{Id}");
   }
 
-  protected override async Task<Results<Ok<GetCustomerByIdResponse>, NotFound, ValidationProblem>> HandleAsync(
+  protected override async Task<Results<Ok<GetCustomerByIdResponse>, NotFound, ValidationProblem, ProblemHttpResult>> HandleAsync(
     GetCustomerByIdRequest req,
     CancellationToken ct)
   {

samples/ShowcaseWebApi/Features/Customers/GetCustomerById.cs

@@ -38,7 +38,8 @@ private static IServiceCollection AddRouteGroupsCoreFromAssembly(
         .DefinedTypes
         .Where(type => type is { IsAbstract: false, IsInterface: false } &&
                        type.IsAssignableTo(typeof(IRouteGroupConfigurator)) &&
-                       type != typeof(RootRouteGroup))
+                       type != typeof(RootRouteGroup) &&
+                       !type.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any())
         .Select(type => ServiceDescriptor.DescribeKeyed(typeof(IRouteGroupConfigurator), type, type, lifetime))
         .ToArray();
 
@@ -55,7 +56,8 @@ public static IServiceCollection AddEndpointsCoreFromAssembly(
     var endpointTypes = assembly
       .DefinedTypes
       .Where(type => type is { IsAbstract: false, IsInterface: false } &&
-                     type.IsAssignableTo(typeof(IEndpointConfigurator)));
+                     type.IsAssignableTo(typeof(IEndpointConfigurator)) &&
+                     !type.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any());
 
     CheckServiceEndpointRegistrations(endpointTypes);
 

src/ModEndpoints.Core/DependencyInjectionExtensions.cs

@@ -70,6 +70,14 @@ protected virtual ValueTask<TResponse> HandleInvalidValidationResultAsync(
       responseType.Name.StartsWith("Results`") &&
       (responseType.Namespace?.Equals("Microsoft.AspNetCore.Http.HttpResults") ?? false))
     {
+      if (TryUseImplicitOperatorFor<ProblemHttpResult>(
+        responseType,
+        validationResult,
+        vr => vr.ToTypedProblem(),
+        out var problem))
+      {
+        return new ValueTask<TResponse>(problem);
+      }
       if (TryUseImplicitOperatorFor<ValidationProblem>(
         responseType,
         validationResult,
@@ -82,25 +90,17 @@ protected virtual ValueTask<TResponse> HandleInvalidValidationResultAsync(
         responseType,
         validationResult,
         vr => vr.ToTypedBadRequestWithValidationProblem(),
-        out var badRequestWithValidationProblems))
+        out var badRequestWithValidationProblem))
       {
-        return new ValueTask<TResponse>(badRequestWithValidationProblems);
+        return new ValueTask<TResponse>(badRequestWithValidationProblem);
       }
       if (TryUseImplicitOperatorFor<BadRequest<ProblemDetails>>(
         responseType,
         validationResult,
         vr => vr.ToTypedBadRequestWithProblem(),
-        out var badRequestWithProblems))
+        out var badRequestWithProblem))
       {
-        return new ValueTask<TResponse>(badRequestWithProblems);
-      }
-      if (TryUseImplicitOperatorFor<ProblemHttpResult>(
-        responseType,
-        validationResult,
-        vr => vr.ToTypedProblem(),
-        out var problem))
-      {
-        return new ValueTask<TResponse>(problem);
+        return new ValueTask<TResponse>(badRequestWithProblem);
       }
       if (TryUseImplicitOperatorFor<BadRequest>(
         responseType,

src/ModEndpoints.Core/[Endpoints]/MinimalEndpoint.cs

@@ -0,0 +1,10 @@
+namespace ModEndpoints.RemoteServices.Core;
+
+/// <summary>
+/// Attribute to prevent targeted route group (including its children) or endpoint to be registered during server application startup.
+/// Also prevents targeted service endpoint request to be registered during service endpoint client application startup.
+/// </summary>
+[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
+public class DoNotRegisterAttribute : Attribute
+{
+}

src/ModEndpoints.RemoteServices.Core/DoNotRegisterAttribute.cs

@@ -10,6 +10,7 @@ public static class DependencyInjectionExtensions
   private const string ClientDoesNotExist = "A client with name {0} does not exist.";
   private const string ChannelAlreadyRegistered = "A channel for request type {0} is already registered.";
   private const string ChannelCannotBeRegistered = "Channel couldn't be registered for request type {0} and client name {1}.";
+  private const string RequestTypeFlaggedAsDoNotRegister = "Request type {0} is flagged as 'DoNotRegister'.";
 
   /// <summary>
   /// Adds and configures a new client for specified ServiceEndpoint request.
@@ -163,7 +164,8 @@ public static IServiceCollection AddRemoteServicesWithNewClient(
     var requestTypes = fromAssembly
         .DefinedTypes
         .Where(type => type is { IsAbstract: false, IsInterface: false } &&
-                       type.IsAssignableTo(typeof(IServiceRequestMarker)));
+                       type.IsAssignableTo(typeof(IServiceRequestMarker)) &&
+                       !type.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any());
 
     if (requestFilterPredicate is not null)
     {
@@ -206,7 +208,8 @@ public static IServiceCollection AddRemoteServicesToExistingClient(
     var requestTypes = fromAssembly
         .DefinedTypes
         .Where(type => type is { IsAbstract: false, IsInterface: false } &&
-                       type.IsAssignableTo(typeof(IServiceRequestMarker)));
+                       type.IsAssignableTo(typeof(IServiceRequestMarker)) &&
+                       !type.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any());
 
     if (requestFilterPredicate is not null)
     {
@@ -229,6 +232,10 @@ private static IServiceCollection AddRemoteServiceWithNewClientInternal(
     Action<IServiceProvider, HttpClient> configureClient,
     Action<IHttpClientBuilder>? configureClientBuilder)
   {
+    if (requestType.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any())
+    {
+      throw new InvalidOperationException(string.Format(RequestTypeFlaggedAsDoNotRegister, requestType));
+    }
     if (ServiceChannelRegistry.Instance.IsRequestRegistered(requestType))
     {
       throw new InvalidOperationException(string.Format(ChannelAlreadyRegistered, requestType));
@@ -250,6 +257,10 @@ private static IServiceCollection AddRemoteServiceToExistingClientInternal(
     Type requestType,
     string clientName)
   {
+    if (requestType.GetCustomAttributes(typeof(DoNotRegisterAttribute)).Any())
+    {
+      throw new InvalidOperationException(string.Format(RequestTypeFlaggedAsDoNotRegister, requestType));
+    }
     if (ServiceChannelRegistry.Instance.IsRequestRegistered(requestType))
     {
       throw new InvalidOperationException(string.Format(ChannelAlreadyRegistered, requestType));