Improve Minimal APIs support for request media types #35082 by rafikiassumani-msft · Pull Request #35230 · dotnet/aspnetcore

rafikiassumani-msft · 2021-08-10T17:55:54Z

Improve Minimal APIs support for request media types

PR Description
Refactoring code to prepare for changes that are needed to enable accepts media types for Minimal APIs

Fixes #35082

pranavkm

Speaking to @halter73, the plan was for RequestDelegateFactory to return an IReadOnlyList<object> which will get added as endpoint metadata by the caller. Here's what I propose the API would look like:

public static RequestDelegateResult Create(MethodInfo methodInfo, Func<HttpContext, object>? targetFactory = null, RequestDelegateFactoryOptions? options = null)

where

public sealed class RequestDelegateResult
{
   public RequestDelegate RequestDelegate { get; }

   public IReadOnlyList<object> EndpointMetadata { get; }
}

halter73 · 2021-08-20T21:03:57Z

-                context.Results.SelectMany(r => r.SupportedRequestFormats),
-                requestType =>
-                {
-                    Assert.Equal("application/json", requestType.MediaType);


What's the behavior now? Is the MediaType just "" or something? Or is the collection empty? Let's just add a regression test for whatever we think the behavior should be in this case rather than delete the test.

rafikiassumani-msft · 2021-08-20T23:22:33Z

/backport to release/6.0-rc1

github-actions · 2021-08-20T23:22:48Z

Started backporting to release/6.0-rc1: https://github.com/dotnet/aspnetcore/actions/runs/1152357480

github-actions · 2021-08-20T23:23:19Z

@rafikiassumanimsft backporting to release/6.0-rc1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: add support for request media types
Applying: change namespace for acceptsmatcher policy
Applying: additional changes
Using index info to reconstruct a base tree...
M	src/Http/Http.Extensions/src/RequestDelegateFactory.cs
M	src/Http/Routing/src/Builder/MinimalActionEndpointRouteBuilderExtensions.cs
Falling back to patching base and 3-way merge...
Auto-merging src/Http/Routing/src/Builder/MinimalActionEndpointRouteBuilderExtensions.cs
Auto-merging src/Http/Http.Extensions/src/RequestDelegateFactory.cs
CONFLICT (content): Merge conflict in src/Http/Http.Extensions/src/RequestDelegateFactory.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0003 additional changes
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

…tnet#35230) * add support for request media types * change namespace for acceptsmatcher policy * additional changes * enable 415 when unsupported content type is provide * add accepts extension method on minimalActions endpoint * add IAcceptsMetadata to API description * add empty content type test * feat: add types for iacceptmetadata * change requestdelegate factory to return metatdata * clean RequestDelegateFactoryOptions.cs * change request delegate to return requestdelegateresult type * make apis property init only * adding constructor to requestdelegatefactoryResult * Fixups * fix merge errors * address pr comment * fix test error * remove options from params * implements iacceptsMetadata * fix test failures * fix test failures * move iacceptmetadata to shared source * add acceptsmetadata shared code to mvc * fix tests * address pr comments * address another comment * nit * fix duplicate media types * fix test failures Co-authored-by: Pranav K <prkrishn@hotmail.com>

…35579) * add support for request media types

* [release/6.0-rc1] Update dependencies from dotnet/runtime dotnet/efcore (#35513) * Set HttpSys read error log levels to debug #35490 (#35542) Co-authored-by: Chris R <Tratcher@outlook.com> * [release/6.0-rc1] Treat reference type parameters in oblivious nullability context as optional (#35526) * Treat parameters in oblivious nullability context as optional * Only apply fix for reference types * Update optionality check in API descriptor * Update check in BindAsync and Mvc.ApiExplorer test * HTTP/3: Use new QuicStream.ReadsCompleted property in transport (#35483) Co-authored-by: James Newton-King <james@newtonking.com> * HTTP/3: Fix incorrectly pooling aborted streams (#35441) * [release/6.0-rc1] Binding support for 'bool' values with InputRadioGroup and InputSelect (#35523) * Binding support for 'bool' values with InputRadioGroup and InputSelect (#35318) * Update CodeCheck.ps1 Co-authored-by: Brennan <brecon@microsoft.com> * [release/6.0-rc1] Update dependencies from dotnet/efcore dotnet/runtime (#35558) * Update dependencies from https://github.com/dotnet/efcore build 20210820.19 Microsoft.EntityFrameworkCore.Tools , dotnet-ef , Microsoft.EntityFrameworkCore , Microsoft.EntityFrameworkCore.SqlServer , Microsoft.EntityFrameworkCore.InMemory , Microsoft.EntityFrameworkCore.Relational , Microsoft.EntityFrameworkCore.Sqlite , Microsoft.EntityFrameworkCore.Design From Version 6.0.0-rc.1.21420.8 -> To Version 6.0.0-rc.1.21420.19 * Update dependencies from https://github.com/dotnet/efcore build 20210820.22 Microsoft.EntityFrameworkCore.Tools , dotnet-ef , Microsoft.EntityFrameworkCore , Microsoft.EntityFrameworkCore.SqlServer , Microsoft.EntityFrameworkCore.InMemory , Microsoft.EntityFrameworkCore.Relational , Microsoft.EntityFrameworkCore.Sqlite , Microsoft.EntityFrameworkCore.Design From Version 6.0.0-rc.1.21420.8 -> To Version 6.0.0-rc.1.21420.22 * Update dependencies from https://github.com/dotnet/efcore build 20210820.30 Microsoft.EntityFrameworkCore.Tools , dotnet-ef , Microsoft.EntityFrameworkCore , Microsoft.EntityFrameworkCore.SqlServer , Microsoft.EntityFrameworkCore.InMemory , Microsoft.EntityFrameworkCore.Relational , Microsoft.EntityFrameworkCore.Sqlite , Microsoft.EntityFrameworkCore.Design From Version 6.0.0-rc.1.21420.8 -> To Version 6.0.0-rc.1.21420.30 * Update dependencies from https://github.com/dotnet/runtime build 20210820.15 Microsoft.NETCore.Platforms , Microsoft.NETCore.BrowserDebugHost.Transport , Microsoft.NETCore.App.Runtime.win-x64 , Microsoft.Win32.SystemEvents , Microsoft.NET.Runtime.MonoAOTCompiler.Task , Microsoft.Internal.Runtime.AspNetCore.Transport , Microsoft.Extensions.Primitives , Microsoft.Extensions.Options.DataAnnotations , Microsoft.Extensions.Options.ConfigurationExtensions , Microsoft.NET.Runtime.WebAssembly.Sdk , Microsoft.Extensions.Options , Microsoft.Extensions.Logging.TraceSource , Microsoft.Extensions.Logging.EventSource , Microsoft.Extensions.Configuration.UserSecrets , Microsoft.Extensions.Configuration.Json , Microsoft.Extensions.Configuration.Ini , Microsoft.Extensions.Configuration.FileExtensions , Microsoft.Extensions.Configuration.EnvironmentVariables , Microsoft.Extensions.Configuration.CommandLine , Microsoft.Extensions.Configuration.Binder , Microsoft.Extensions.Configuration.Xml , Microsoft.Extensions.Configuration.Abstractions , Microsoft.Extensions.Caching.Memory , Microsoft.Extensions.Caching.Abstractions , Microsoft.Extensions.Configuration , Microsoft.Extensions.DependencyInjection , Microsoft.Extensions.DependencyInjection.Abstractions , Microsoft.Extensions.Logging.EventLog , Microsoft.Extensions.Logging.Debug , Microsoft.Extensions.Logging.Console , Microsoft.Extensions.Logging.Configuration , Microsoft.Extensions.Logging.Abstractions , Microsoft.Extensions.Logging , Microsoft.Extensions.Http , Microsoft.Extensions.Hosting.Abstractions , Microsoft.Extensions.Hosting , Microsoft.Extensions.HostFactoryResolver.Sources , Microsoft.Extensions.FileSystemGlobbing , Microsoft.Extensions.FileProviders.Physical , Microsoft.Extensions.FileProviders.Composite , Microsoft.Extensions.FileProviders.Abstractions , Microsoft.Extensions.DependencyModel , Microsoft.NETCore.App.Runtime.AOT.win-x64.Cross.browser-wasm , Microsoft.NETCore.App.Ref , System.Windows.Extensions , System.Threading.Channels , System.Text.Json , System.Text.Encodings.Web , System.ServiceProcess.ServiceController , System.Drawing.Common , System.DirectoryServices.Protocols , System.Diagnostics.EventLog , System.Diagnostics.DiagnosticSource , System.IO.Pipelines , System.Security.Permissions , System.Security.Cryptography.Xml , System.Security.Cryptography.Pkcs , System.Runtime.CompilerServices.Unsafe , System.Resources.Extensions , System.Reflection.Metadata , System.Net.Http.WinHttpHandler , System.Net.Http.Json From Version 6.0.0-rc.1.21420.7 -> To Version 6.0.0-rc.1.21420.15 Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com> * Improve Minimal APIs support for request media types #35082 (#35230) (#35579) * add support for request media types * [release/6.0-rc1] Update dependencies from dotnet/efcore dotnet/runtime (#35573) Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Chris R <Tratcher@outlook.com> Co-authored-by: Safia Abdalla <safia@microsoft.com> Co-authored-by: James Newton-King <james@newtonking.com> Co-authored-by: Mackinnon Buck <mackinnon.buck@gmail.com> Co-authored-by: Brennan <brecon@microsoft.com> Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com> Co-authored-by: Rafiki Assumani <87031580+rafikiassumaniMSFT@users.noreply.github.com>

rachna-lad · 2022-09-07T05:58:32Z

@rafikiassumani-msft How does Accepts work when Content-Type in Header is null?
I have defined Accepts("application/json") as supported content type.

ghost · 2022-09-07T05:58:37Z

Hi @rachna-lad. It looks like you just commented on a closed PR. The team will most probably miss it. If you'd like to bring something important up to their attention, consider filing a new issue and add enough details to build context.

add support for request media types

f855193

rafikiassumani-msft requested review from BrennanConroy, Tratcher, javiercn and pranavkm as code owners August 10, 2021 17:55

rafikiassumani-msft marked this pull request as draft August 10, 2021 17:56

Pilchie added the old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels label Aug 10, 2021

change namespace for acceptsmatcher policy

8133bff

pranavkm reviewed Aug 11, 2021

View reviewed changes

rafikiassumani-msft added 2 commits August 11, 2021 11:31

additional changes

17853dd

enable 415 when unsupported content type is provide

a24a181

davidfowl reviewed Aug 11, 2021

View reviewed changes

Comment thread src/Http/Http.Extensions/src/RequestDelegateFactoryOptions.cs Outdated

rafikiassumani-msft added 4 commits August 11, 2021 16:09

add accepts extension method on minimalActions endpoint

2116e6d

add IAcceptsMetadata to API description

6700e93

add empty content type test

094ed22

feat: add types for iacceptmetadata

ab29717

pranavkm reviewed Aug 13, 2021

View reviewed changes

rafikiassumani-msft added 4 commits August 12, 2021 21:04

change requestdelegate factory to return metatdata

94fa1a7

clean RequestDelegateFactoryOptions.cs

8096fd3

change request delegate to return requestdelegateresult type

ce440cb

make apis property init only

74b234b

rafikiassumani-msft marked this pull request as ready for review August 13, 2021 05:34

pranavkm reviewed Aug 13, 2021

View reviewed changes

rafikiassumani-msft and others added 2 commits August 13, 2021 09:41

adding constructor to requestdelegatefactoryResult

990be74

Fixups

0097323

rafikiassumani-msft requested a review from Pilchie as a code owner August 16, 2021 19:33

rafikiassumani-msft added 4 commits August 16, 2021 13:30

resolve conflicts

6b108eb

fix merge errors

d4e85d5

address pr comment

3de78c6

fix test error

c3d2cd3

rafikiassumani-msft added 7 commits August 18, 2021 23:32

fix test failures

be64e8e

fix test failures

85b38ca

move iacceptmetadata to shared source

f6762c9

add acceptsmetadata shared code to mvc

d4daaa7

resolve conflicts

ad8ed0c

fix tests

f43d3c0

fix merge conflicts

7b664f8

pranavkm approved these changes Aug 20, 2021

View reviewed changes

javiercn reviewed Aug 20, 2021

View reviewed changes

Comment thread src/Http/Routing/src/Matching/AcceptsMatcherPolicy.cs

javiercn reviewed Aug 20, 2021

View reviewed changes

Comment thread src/Http/Routing/src/Microsoft.AspNetCore.Routing.csproj Outdated

rafikiassumani-msft added 3 commits August 20, 2021 11:37

address pr comments

2b638db

address another comment

14a7ff9

nit

38790ae

halter73 approved these changes Aug 20, 2021

View reviewed changes

fix duplicate media types

8a8348e

halter73 reviewed Aug 20, 2021

View reviewed changes

rafikiassumani-msft added 2 commits August 20, 2021 15:10

resolve merge conflicts

88f6c6c

fix test failures

b29ea2a

rafikiassumani-msft merged commit 4f5049a into dotnet:main Aug 21, 2021

ghost added this to the 7.0-preview1 milestone Aug 21, 2021

rafikiassumani-msft mentioned this pull request Aug 21, 2021

Improve Minimal APIs support for request media types #35082 (#35230) #35579

Merged

10 tasks

rafikiassumani-msft added a commit that referenced this pull request Aug 21, 2021

Improve Minimal APIs support for request media types #35082 (#35230) (#…

ac45a99

…35579) * add support for request media types

amcasey added the area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc label Jun 2, 2023

Conversation

rafikiassumani-msft commented Aug 10, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pranavkm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

halter73 Aug 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rafikiassumani-msft commented Aug 20, 2021

Uh oh!

github-actions Bot commented Aug 20, 2021

Uh oh!

github-actions Bot commented Aug 20, 2021

Uh oh!

rachna-lad commented Sep 7, 2022

Uh oh!

ghost commented Sep 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

pranavkm left a comment •

edited

Loading

halter73 Aug 20, 2021 •

edited

Loading