Skip to content

Fix MediaTypeApiVersionReaderBuilder.AddParameters #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net45;net472</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net45;net472</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net45;net472</TargetFrameworks>
<AssemblyTitle>ASP.NET Web API Versioning API Explorer</AssemblyTitle>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,11 @@ protected virtual void UpdateUrlSegment()
/// <param name="name">The name of the media type parameter.</param>
protected virtual void AddMediaTypeParameter( string name )
{
if ( string.IsNullOrEmpty( name ) )
{
return;
}

var parameter = new NameValueHeaderValue( name, ApiVersion.ToString() );

CloneFormattersAndAddMediaTypeParameter( parameter, ApiDescription.SupportedRequestBodyFormatters );
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
namespace Asp.Versioning;

using System.Net.Http.Headers;
using System.Web.Http;
using System.Web.Http.Filters;
using static Asp.Versioning.ApiVersionParameterLocation;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net45;net472</TargetFrameworks>
<AssemblyTitle>ASP.NET Web API Versioning</AssemblyTitle>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace System.Web.Http;
using Asp.Versioning.Dispatcher;
using System.Web.Http.Controllers;
using System.Web.Http.Dispatcher;
using static Asp.Versioning.ApiVersionParameterLocation;

/// <summary>
/// Provides extension methods for the <see cref="HttpConfiguration"/> class.
Expand Down Expand Up @@ -79,9 +80,16 @@ private static void AddApiVersioning( this HttpConfiguration configuration, ApiV
configuration.Filters.Add( new ReportApiVersionsAttribute() );
}

if ( options.ApiVersionReader.VersionsByMediaType() )
var reader = options.ApiVersionReader;

if ( reader.VersionsByMediaType() )
{
configuration.Filters.Add( new ApplyContentTypeVersionActionFilter( options.ApiVersionReader ) );
var parameterName = reader.GetParameterName( MediaTypeParameter );

if ( !string.IsNullOrEmpty( parameterName ) )
{
configuration.Filters.Add( new ApplyContentTypeVersionActionFilter( reader ) );
}
}

configuration.Properties.AddOrUpdate( ApiVersioningOptionsKey, options, ( key, oldValue ) => options );
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net6.0;netcoreapp3.1</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net6.0;netcoreapp3.1</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net6.0;netcoreapp3.1</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ namespace Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using System.Globalization;
using System.Runtime.CompilerServices;
using static Asp.Versioning.ApiVersionParameterLocation;

/// <summary>
Expand Down Expand Up @@ -100,12 +101,17 @@ private static void Apply(
if ( parameterSource.VersionsByMediaType() )
{
var parameterName = parameterSource.GetParameterName( MediaTypeParameter );
requestDelegate = EnsureRequestDelegate( requestDelegate, endpointBuilder.RequestDelegate );
requestDelegate = new ContentTypeApiVersionDecorator( requestDelegate, parameterName );
endpointBuilder.RequestDelegate = requestDelegate;

if ( !string.IsNullOrEmpty( parameterName ) )
{
requestDelegate = EnsureRequestDelegate( requestDelegate, endpointBuilder.RequestDelegate );
requestDelegate = new ContentTypeApiVersionDecorator( requestDelegate, parameterName );
endpointBuilder.RequestDelegate = requestDelegate;
}
}
}

[MethodImpl( MethodImplOptions.AggressiveInlining )]
private static RequestDelegate EnsureRequestDelegate( RequestDelegate? current, RequestDelegate? original ) =>
( current ?? original ) ??
throw new InvalidOperationException(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,11 @@ protected virtual void UpdateUrlSegment()
/// <param name="name">The name of the media type parameter.</param>
protected virtual void AddMediaTypeParameter( string name )
{
if ( string.IsNullOrEmpty( name ) )
{
return;
}

var requestFormats = ApiDescription.SupportedRequestFormats.ToArray();
var responseTypes = ApiDescription.SupportedResponseTypes.ToArray();
var parameter = $"{name}={ApiVersion}";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net6.0;netcoreapp3.1</TargetFrameworks>
<RootNamespace>Asp.Versioning.ApiExplorer</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace Asp.Versioning;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
using Microsoft.Extensions.Options;
using static Asp.Versioning.ApiVersionParameterLocation;

/// <summary>
/// Represents the API versioning configuration for ASP.NET Core <see cref="MvcOptions">MVC options</see>.
Expand Down Expand Up @@ -36,9 +37,16 @@ public virtual void PostConfigure( string name, MvcOptions options )
options.Filters.AddService<ReportApiVersionsAttribute>();
}

if ( value.ApiVersionReader.VersionsByMediaType() )
var reader = value.ApiVersionReader;

if ( reader.VersionsByMediaType() )
{
options.Filters.AddService<ApplyContentTypeVersionActionFilter>();
var parameterName = reader.GetParameterName( MediaTypeParameter );

if ( !string.IsNullOrEmpty( parameterName ) )
{
options.Filters.AddService<ApplyContentTypeVersionActionFilter>();
}
}

var modelMetadataDetailsProviders = options.ModelMetadataDetailsProviders;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>6.2.0</VersionPrefix>
<VersionPrefix>6.2.1</VersionPrefix>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<TargetFrameworks>net6.0;netcoreapp3.1</TargetFrameworks>
<RootNamespace>Asp.Versioning</RootNamespace>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@

Fix MediaTypeApiVersionReaderBuilder.AddParameters (#904)
17 changes: 17 additions & 0 deletions src/Client/test/Asp.Versioning.Http.Client.Tests/TestServer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,28 @@ namespace Asp.Versioning.Http;
internal sealed class TestServer : HttpMessageHandler
{
private readonly HttpResponseMessage response;
private bool disposed;

public TestServer() => response = new( HttpStatusCode.OK );

public TestServer( HttpResponseMessage response ) => this.response = response;

protected override Task<HttpResponseMessage> SendAsync( HttpRequestMessage request, CancellationToken cancellationToken ) =>
Task.FromResult( response );

protected override void Dispose( bool disposing )
{
if ( disposed )
{
return;
}

base.Dispose( disposing );
disposed = true;

if ( disposing )
{
response.Dispose();
}
}
}
13 changes: 10 additions & 3 deletions src/Common/src/Common/MediaTypeApiVersionReaderBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,16 @@ public void AddParameters( IApiVersionParameterDescriptionContext context )
throw new ArgumentNullException( nameof( context ) );
}

for ( var i = 0; i < parameters.Count; i++ )
if ( parameters.Count == 0 )
{
context.AddParameter( parameters[i], MediaTypeParameter );
context.AddParameter( name: string.Empty, MediaTypeParameter );
}
else
{
for ( var i = 0; i < parameters.Count; i++ )
{
context.AddParameter( parameters[i], MediaTypeParameter );
}
}
}

Expand Down Expand Up @@ -427,7 +434,7 @@ private void Read(
versions.Add( result[j] );
}
}
}
}
}
}
}