Dev (#42)

modabas · web-flow · commit 1b9508f6f75a · 2026-01-28T19:11:08.000+03:00
* - don't inject http context accessor, not needed

* - add server sent events support to web result endpoints for .net 10 and greater

* - add sample list books as streaming response

* - remove default implicit conversion between WebResult&lt;TValue&gt; and WebResult
- remove ToWebResult extension method from WebResult&lt;TValue&gt;
- Add WebResultWithStreamingResponse as a simpler form of ServerSentEventsWebResult. WebResultEndpoints using this form has simpler HandleAsync method signature.
- Add sample endpoint utilizing WebResultWithStreamingResponse

* - add tests for web result endpoint sse and streaming response cases

* - WebResultWithStreamingResponse  for WebResultEndpoints has been changed to function similar to a Minimal API with IAsyncEnumerable&lt;&gt; response
- notnull contraint has been lifted for TValue parameter in WebResultWithStreamingResponse and ServerSentEventsWebResult

* - update deps to latest

* - bump version
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -19,6 +19,6 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>2.0.1</Version>
+    <Version>2.0.2</Version>
   </PropertyGroup>
 </Project>
diff --git a/samples/ServiceEndpointClient/ServiceEndpointClient.csproj b/samples/ServiceEndpointClient/ServiceEndpointClient.csproj
@@ -6,8 +6,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.1" />
-    <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="10.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="10.0.2" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/samples/ShowcaseWebApi/Extensions/WebApplicationBuilderExtensions.cs b/samples/ShowcaseWebApi/Extensions/WebApplicationBuilderExtensions.cs
@@ -43,7 +43,6 @@ public static WebApplicationBuilder AddSwagger(this WebApplicationBuilder builde
 
   public static WebApplicationBuilder AddWebServices(this WebApplicationBuilder builder)
   {
-    //builder.Services.AddHttpContextAccessor();
     builder.Services.AddProblemDetails(options =>
     {
       options.CustomizeProblemDetails = context =>
diff --git a/samples/ShowcaseWebApi/Features/Books/ListBooksSse.cs b/samples/ShowcaseWebApi/Features/Books/ListBooksSse.cs
@@ -0,0 +1,45 @@
+﻿using System.Net.ServerSentEvents;
+using System.Runtime.CompilerServices;
+using Microsoft.EntityFrameworkCore;
+using ModEndpoints;
+using ModEndpoints.Core;
+using ShowcaseWebApi.Data;
+using ShowcaseWebApi.Features.Books.Configuration;
+
+namespace ShowcaseWebApi.Features.Books;
+
+[MapToGroup<BooksV1RouteGroup>()]
+internal class ListBooksSse(ServiceDbContext db)
+  : WebResultEndpointWithEmptyRequest<IAsyncEnumerable<SseItem<ListBooksResponseItem>>>
+{
+  protected override void Configure(
+    EndpointConfigurationBuilder builder,
+    EndpointConfigurationContext configurationContext)
+  {
+    builder.MapGet("/listSse/")
+      .Produces<SseItem<ListBooksResponseItem>>(contentType: "text/event-stream");
+  }
+
+  protected override async Task<WebResult<IAsyncEnumerable<SseItem<ListBooksResponseItem>>>> HandleAsync(
+    CancellationToken ct)
+  {
+    return WebResults.ServerSentEvents(GetBooks(ct));
+
+    async IAsyncEnumerable<ListBooksResponseItem> GetBooks(
+      [EnumeratorCancellation] CancellationToken ct)
+    {
+      await foreach (var book in db.Books
+        .Select(b => new ListBooksResponseItem(
+          b.Id,
+          b.Title,
+          b.Author,
+          b.Price))
+        .AsAsyncEnumerable()
+        .WithCancellation(ct))
+      {
+        await Task.Delay(1000, ct);
+        yield return book;
+      }
+    }
+  }
+}
diff --git a/samples/ShowcaseWebApi/Features/Books/ListBooksWithStreamingResponse.cs b/samples/ShowcaseWebApi/Features/Books/ListBooksWithStreamingResponse.cs
@@ -0,0 +1,43 @@
+﻿using System.Runtime.CompilerServices;
+using Microsoft.EntityFrameworkCore;
+using ModEndpoints;
+using ModEndpoints.Core;
+using ShowcaseWebApi.Data;
+using ShowcaseWebApi.Features.Books.Configuration;
+
+namespace ShowcaseWebApi.Features.Books;
+
+[MapToGroup<BooksV1RouteGroup>()]
+internal class ListBooksWithStreamingResponse(ServiceDbContext db)
+  : WebResultEndpointWithEmptyRequest<IAsyncEnumerable<ListBooksResponseItem>>
+{
+  protected override void Configure(
+    EndpointConfigurationBuilder builder,
+    EndpointConfigurationContext configurationContext)
+  {
+    builder.MapGet("/listWithStreamingResponse/");
+  }
+
+  protected override async Task<WebResult<IAsyncEnumerable<ListBooksResponseItem>>> HandleAsync(
+    CancellationToken ct)
+  {
+    return WebResults.WithStreamingResponse(GetBooks(ct));
+
+    async IAsyncEnumerable<ListBooksResponseItem> GetBooks(
+      [EnumeratorCancellation] CancellationToken ct)
+    {
+      await foreach (var book in db.Books
+        .Select(b => new ListBooksResponseItem(
+          b.Id,
+          b.Title,
+          b.Author,
+          b.Price))
+        .AsAsyncEnumerable()
+        .WithCancellation(ct))
+      {
+        await Task.Delay(1000, ct);
+        yield return book;
+      }
+    }
+  }
+}
diff --git a/samples/ShowcaseWebApi/ShowcaseWebApi.csproj b/samples/ShowcaseWebApi/ShowcaseWebApi.csproj
@@ -5,11 +5,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="10.0.1" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="10.0.2" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.0" />
     <PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.1" />
-    <PackageReference Include="Asp.Versioning.Http" Version="8.1.0" />
-    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0" />
+    <PackageReference Include="Asp.Versioning.Http" Version="8.1.1" />
+    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.1" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/samples/WeatherForecastWebApi/WeatherForecastWebApi.csproj b/samples/WeatherForecastWebApi/WeatherForecastWebApi.csproj
@@ -7,8 +7,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.1" />
-    <PackageReference Include="Scalar.AspNetCore" Version="2.11.10" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.2" />
+    <PackageReference Include="Scalar.AspNetCore" Version="2.12.20" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ModEndpoints.Core/ModEndpoints.Core.csproj b/src/ModEndpoints.Core/ModEndpoints.Core.csproj
@@ -14,7 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.102">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
diff --git a/src/ModEndpoints.RemoteServices.Contracts/ModEndpoints.RemoteServices.Contracts.csproj b/src/ModEndpoints.RemoteServices.Contracts/ModEndpoints.RemoteServices.Contracts.csproj
@@ -14,7 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.102">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
diff --git a/src/ModEndpoints.RemoteServices/ModEndpoints.RemoteServices.csproj b/src/ModEndpoints.RemoteServices/ModEndpoints.RemoteServices.csproj
@@ -19,15 +19,15 @@
   </ItemGroup>
   
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.102">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Http" Version="10.0.1" />
-    <PackageReference Include="ModResults" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Extensions.Http" Version="10.0.2" />
+    <PackageReference Include="ModResults" Version="1.2.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ModEndpoints/DependencyInjectionExtensions.cs b/src/ModEndpoints/DependencyInjectionExtensions.cs
@@ -57,7 +57,6 @@ public static IServiceCollection AddModEndpointsFromAssembly(
       RemoteServiceDefinitions.DefaultUriResolverName);
     services.TryAddSingleton<IUriResolverProvider, DefaultUriResolverProvider>();
 
-    services.AddHttpContextAccessor();
     return services.AddModEndpointsCoreFromAssembly(
       assembly,
       conf =>
diff --git a/src/ModEndpoints/ModEndpoints.csproj b/src/ModEndpoints/ModEndpoints.csproj
@@ -14,14 +14,14 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.102">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>
   
   <ItemGroup>
-    <PackageReference Include="ModResults.MinimalApis" Version="1.1.1" />
+    <PackageReference Include="ModResults.MinimalApis" Version="1.2.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/JsonSerializerExtensions.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/JsonSerializerExtensions.cs
@@ -0,0 +1,13 @@
+﻿using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization.Metadata;
+
+namespace ModEndpoints;
+
+internal static class JsonSerializerExtensions
+{
+  public 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)
+   => runtimeType is null || jsonTypeInfo.Type == runtimeType || jsonTypeInfo.HasKnownPolymorphism();
+}
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/ServerSentEventsWebResult.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/ServerSentEventsWebResult.cs
@@ -0,0 +1,53 @@
+﻿#if NET10_0_OR_GREATER
+using System.Net.ServerSentEvents;
+using Microsoft.AspNetCore.Http;
+using ModResults;
+using ModResults.MinimalApis;
+
+namespace ModEndpoints;
+
+/// <summary>
+/// Represents a web result that writes a stream of server-sent events to the response.
+/// </summary>
+/// <typeparam name="TValue">The underlying type of the events emitted.</typeparam>
+internal sealed class ServerSentEventsWebResult<TValue> : WebResult<IAsyncEnumerable<SseItem<TValue>>>
+{
+  private ServerSentEventsWebResult(Result<IAsyncEnumerable<SseItem<TValue>>> result) : base(result)
+  {
+  }
+
+  public static ServerSentEventsWebResult<TValue> Create(Result<IAsyncEnumerable<SseItem<TValue>>> result)
+  {
+    return new ServerSentEventsWebResult<TValue>(result);
+  }
+
+  public static ServerSentEventsWebResult<TValue> Create(Result<IAsyncEnumerable<TValue>> result, string? eventType)
+  {
+    return new ServerSentEventsWebResult<TValue>(WrapEvents(result, eventType));
+  }
+
+  private static Result<IAsyncEnumerable<SseItem<TValue>>> WrapEvents(Result<IAsyncEnumerable<TValue>> result, string? eventType)
+  {
+    return result.ToResult(
+      static (value, state) => WrapEventsAsync(value, state.eventType),
+      new { eventType });
+  }
+
+  private static async IAsyncEnumerable<SseItem<TValue>> WrapEventsAsync(IAsyncEnumerable<TValue> events, string? eventType)
+  {
+    await foreach (var item in events)
+    {
+      yield return new SseItem<TValue>(item, eventType);
+    }
+  }
+
+  public override ValueTask<IResult> ExecuteAsync(HttpContext context, CancellationToken ct)
+  {
+    if (Result.IsFailed)
+    {
+      return ValueTask.FromResult(Result.ToErrorResponse());
+    }
+    return ValueTask.FromResult(Results.ServerSentEvents(Result.Value));
+  }
+}
+#endif
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/StreamingResponseResult.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/StreamingResponseResult.cs
@@ -0,0 +1,80 @@
+﻿using System.Text.Json;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Features;
+using Microsoft.AspNetCore.Http.Json;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+
+namespace ModEndpoints;
+
+/// <summary>
+/// Represents a result that writes a stream of events to the response.
+/// </summary>
+/// <typeparam name="T">The underlying type of the events emitted.</typeparam>
+internal sealed class StreamingResponseResult<T> : IResult, IStatusCodeHttpResult, IValueHttpResult, IValueHttpResult<IAsyncEnumerable<T>>
+{
+  private static readonly byte[] _start = "["u8.ToArray();
+  private static readonly byte[] _end = "]"u8.ToArray();
+  private static readonly byte[] _seperator = ","u8.ToArray();
+  private readonly IAsyncEnumerable<T> _events;
+
+  public IAsyncEnumerable<T>? Value => _events;
+  object? IValueHttpResult.Value => Value;
+
+  public int StatusCode => StatusCodes.Status200OK;
+  int? IStatusCodeHttpResult.StatusCode => StatusCode;
+
+  public StreamingResponseResult(IAsyncEnumerable<T> events)
+  {
+    _events = events;
+  }
+
+  public async Task ExecuteAsync(HttpContext httpContext)
+  {
+    httpContext.Response.ContentType = "application/json; charset=utf-8";
+    httpContext.Response.Headers.CacheControl = "no-cache,no-store";
+    httpContext.Response.Headers.Pragma = "no-cache";
+
+    var bufferingFeature = httpContext.Features.GetRequiredFeature<IHttpResponseBodyFeature>();
+    bufferingFeature.DisableBuffering();
+
+    var jsonOptions = httpContext.RequestServices.GetService<IOptions<JsonOptions>>()?.Value ?? new JsonOptions();
+
+    bool isFirstItem = true;
+    var ct = httpContext.RequestAborted;
+
+    httpContext.Response.StatusCode = StatusCode;
+
+    await httpContext.Response.Body.WriteAsync(_start, ct);
+    await foreach (var @event in _events.WithCancellation(ct))
+    {
+      if (!isFirstItem)
+      {
+        await httpContext.Response.Body.WriteAsync(_seperator, ct);
+      }
+      await WriteAsJsonAsync(@event, httpContext.Response.Body, jsonOptions, ct);
+      isFirstItem = false;
+    }
+    await httpContext.Response.Body.WriteAsync(_end, ct);
+  }
+
+  private static async Task WriteAsJsonAsync(T item, Stream writer, JsonOptions jsonOptions, CancellationToken ct)
+  {
+    if (item is null)
+    {
+      var nullBytes = JsonSerializer.SerializeToUtf8Bytes<object?>(null, jsonOptions.SerializerOptions);
+      await writer.WriteAsync(nullBytes, ct);
+      return;
+    }
+
+    var runtimeType = item.GetType();
+    var jsonTypeInfo = jsonOptions.SerializerOptions.GetTypeInfo(typeof(T));
+
+    var typeInfo = jsonTypeInfo.ShouldUseWith(runtimeType)
+        ? jsonTypeInfo
+        : jsonOptions.SerializerOptions.GetTypeInfo(typeof(object));
+
+    var json = JsonSerializer.SerializeToUtf8Bytes(item, typeInfo);
+    await writer.WriteAsync(json, ct);
+  }
+}
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResult.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResult.cs
@@ -80,9 +80,4 @@ public static implicit operator WebResult<TValue>(Result<TValue> result)
   {
     return new DefaultWebResult<TValue>(result);
   }
-
-  public static implicit operator WebResult(WebResult<TValue> webResult)
-  {
-    return webResult.ToWebResult();
-  }
 }
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResultExtensions.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResultExtensions.cs
@@ -1,6 +1,5 @@
 ﻿using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
-using ModResults;
 using ModResults.MinimalApis;
 
 namespace ModEndpoints;
@@ -37,11 +36,6 @@ internal IResult ExecuteInternal(HttpContext context, string? location)
   extension<TValue>(WebResult<TValue> webResult)
     where TValue : notnull
   {
-    public WebResult ToWebResult()
-    {
-      return new DefaultWebResult(webResult.Result.ToResult());
-    }
-
     internal IResult ExecuteInternal(HttpContext context, string? location)
     {
       if (webResult.Result.IsFailed)
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResultWithStreamingResponse.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResultWithStreamingResponse.cs
diff --git a/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResults.cs b/src/ModEndpoints/[WebResultEndpoint]/[WebResults]/WebResults.cs
diff --git a/tests/ModEndpoints.TestServer/Features/Books/ListBooksSse.cs b/tests/ModEndpoints.TestServer/Features/Books/ListBooksSse.cs
diff --git a/tests/ModEndpoints.TestServer/Features/Books/ListBooksWithStreamingResponse.cs b/tests/ModEndpoints.TestServer/Features/Books/ListBooksWithStreamingResponse.cs
diff --git a/tests/ModEndpoints.Tests/ModEndpoints.Tests.csproj b/tests/ModEndpoints.Tests/ModEndpoints.Tests.csproj
diff --git a/tests/ModEndpoints.Tests/WebResultEndpoints/HandlerTests.cs b/tests/ModEndpoints.Tests/WebResultEndpoints/HandlerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ public static WebApplicationBuilder AddSwagger(this WebApplicationBuilder builde`
`43`	`43`
`44`	`44`	`public static WebApplicationBuilder AddWebServices(this WebApplicationBuilder builder)`
`45`	`45`	`{`
`46`		`- //builder.Services.AddHttpContextAccessor();`
`47`	`46`	`builder.Services.AddProblemDetails(options =>`
`48`	`47`	`{`
`49`	`48`	`options.CustomizeProblemDetails = context =>`