Use endpoints instead of actions. Relates to #812

commonsensesoftware · commonsensesoftware · commit dfcfb5151f64 · 2022-04-08T20:10:05.000-07:00
diff --git a/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc.ApiExplorer/DefaultApiVersionDescriptionProvider.cs b/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc.ApiExplorer/DefaultApiVersionDescriptionProvider.cs
@@ -2,9 +2,10 @@
 
 namespace Asp.Versioning.ApiExplorer;
 
-using Microsoft.AspNetCore.Mvc.Abstractions;
-using Microsoft.AspNetCore.Mvc.Infrastructure;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Primitives;
 using static Asp.Versioning.ApiVersionMapping;
 using static System.Globalization.CultureInfo;
 
@@ -14,23 +15,22 @@ namespace Asp.Versioning.ApiExplorer;
 [CLSCompliant( false )]
 public class DefaultApiVersionDescriptionProvider : IApiVersionDescriptionProvider
 {
-    private readonly Lazy<IReadOnlyList<ApiVersionDescription>> apiVersionDescriptions;
+    private readonly ApiVersionDescriptionCollection collection;
     private readonly IOptions<ApiExplorerOptions> options;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DefaultApiVersionDescriptionProvider"/> class.
     /// </summary>
-    /// <param name="actionDescriptorCollectionProvider">The <see cref="IActionDescriptorCollectionProvider">provider</see>
-    /// used to enumerate the actions within an application.</param>
+    /// <param name="endpointDataSource">The <see cref="EndpointDataSource">data source</see> for <see cref="Endpoint">endpoints</see>.</param>
     /// <param name="sunsetPolicyManager">The <see cref="ISunsetPolicyManager">manager</see> used to resolve sunset policies.</param>
     /// <param name="apiExplorerOptions">The <see cref="IOptions{TOptions}">container</see> of configured
     /// <see cref="ApiExplorerOptions">API explorer options</see>.</param>
     public DefaultApiVersionDescriptionProvider(
-        IActionDescriptorCollectionProvider actionDescriptorCollectionProvider,
+        EndpointDataSource endpointDataSource,
         ISunsetPolicyManager sunsetPolicyManager,
         IOptions<ApiExplorerOptions> apiExplorerOptions )
     {
-        apiVersionDescriptions = LazyApiVersionDescriptions.Create( this, actionDescriptorCollectionProvider );
+        collection = new( this, endpointDataSource );
         SunsetPolicyManager = sunsetPolicyManager;
         options = apiExplorerOptions;
     }
@@ -48,41 +48,46 @@ public DefaultApiVersionDescriptionProvider(
     protected ApiExplorerOptions Options => options.Value;
 
     /// <inheritdoc />
-    public IReadOnlyList<ApiVersionDescription> ApiVersionDescriptions => apiVersionDescriptions.Value;
+    public IReadOnlyList<ApiVersionDescription> ApiVersionDescriptions => collection.Items;
 
     /// <summary>
     /// Enumerates all API versions within an application.
     /// </summary>
-    /// <param name="actionDescriptorCollectionProvider">The <see cref="IActionDescriptorCollectionProvider">provider</see> used to enumerate the actions within an application.</param>
+    /// <param name="endpointDataSource">The <see cref="EndpointDataSource">data source</see> used to enumerate the endpoints within an application.</param>
     /// <returns>A <see cref="IReadOnlyList{T}">read-only list</see> of <see cref="ApiVersionDescription">API version descriptions</see>.</returns>
-    protected virtual IReadOnlyList<ApiVersionDescription> EnumerateApiVersions( IActionDescriptorCollectionProvider actionDescriptorCollectionProvider )
+    protected virtual IReadOnlyList<ApiVersionDescription> EnumerateApiVersions( EndpointDataSource endpointDataSource )
     {
-        if ( actionDescriptorCollectionProvider == null )
+        if ( endpointDataSource == null )
         {
-            throw new ArgumentNullException( nameof( actionDescriptorCollectionProvider ) );
+            throw new ArgumentNullException( nameof( endpointDataSource ) );
         }
 
-        var actions = actionDescriptorCollectionProvider.ActionDescriptors.Items;
-        var descriptions = new List<ApiVersionDescription>( capacity: actions.Count );
+        var endpoints = endpointDataSource.Endpoints;
+        var descriptions = new List<ApiVersionDescription>( capacity: endpoints.Count );
         var supported = new HashSet<ApiVersion>();
         var deprecated = new HashSet<ApiVersion>();
 
-        BucketizeApiVersions( actions, supported, deprecated );
+        BucketizeApiVersions( endpoints, supported, deprecated );
         AppendDescriptions( descriptions, supported, deprecated: false );
         AppendDescriptions( descriptions, deprecated, deprecated: true );
 
         return descriptions.OrderBy( d => d.ApiVersion ).ToArray();
     }
 
-    private void BucketizeApiVersions( IReadOnlyList<ActionDescriptor> actions, ISet<ApiVersion> supported, ISet<ApiVersion> deprecated )
+    private void BucketizeApiVersions( IReadOnlyList<Endpoint> endpoints, ISet<ApiVersion> supported, ISet<ApiVersion> deprecated )
     {
         var declared = new HashSet<ApiVersion>();
         var advertisedSupported = new HashSet<ApiVersion>();
         var advertisedDeprecated = new HashSet<ApiVersion>();
 
-        for ( var i = 0; i < actions.Count; i++ )
+        for ( var i = 0; i < endpoints.Count; i++ )
         {
-            var model = actions[i].GetApiVersionMetadata().Map( Explicit | Implicit );
+            if ( endpoints[i].Metadata.GetMetadata<ApiVersionMetadata>() is not ApiVersionMetadata metadata )
+            {
+                continue;
+            }
+
+            var model = metadata.Map( Explicit | Implicit );
             var versions = model.DeclaredApiVersions;
 
             for ( var j = 0; j < versions.Count; j++ )
@@ -130,28 +135,51 @@ private void AppendDescriptions( ICollection<ApiVersionDescription> descriptions
         }
     }
 
-    private sealed class LazyApiVersionDescriptions : Lazy<IReadOnlyList<ApiVersionDescription>>
+    private sealed class ApiVersionDescriptionCollection
     {
+        private readonly object syncRoot = new();
+        private readonly EndpointDataSource endpointDataSource;
         private readonly DefaultApiVersionDescriptionProvider apiVersionDescriptionProvider;
-        private readonly IActionDescriptorCollectionProvider actionDescriptorCollectionProvider;
+        private IReadOnlyList<ApiVersionDescription>? items;
 
-        private LazyApiVersionDescriptions(
+        public ApiVersionDescriptionCollection(
             DefaultApiVersionDescriptionProvider apiVersionDescriptionProvider,
-            IActionDescriptorCollectionProvider actionDescriptorCollectionProvider )
+            EndpointDataSource endpointDataSource )
         {
             this.apiVersionDescriptionProvider = apiVersionDescriptionProvider;
-            this.actionDescriptorCollectionProvider = actionDescriptorCollectionProvider;
+            this.endpointDataSource = endpointDataSource ?? throw new ArgumentNullException( nameof( endpointDataSource ) );
+            ChangeToken.OnChange( endpointDataSource.GetChangeToken, UpdateItems );
         }
 
-        internal static Lazy<IReadOnlyList<ApiVersionDescription>> Create(
-            DefaultApiVersionDescriptionProvider apiVersionDescriptionProvider,
-            IActionDescriptorCollectionProvider actionDescriptorCollectionProvider )
+        public IReadOnlyList<ApiVersionDescription> Items
         {
-            var descriptions = new LazyApiVersionDescriptions( apiVersionDescriptionProvider, actionDescriptorCollectionProvider );
-            return new( descriptions.EnumerateApiVersions );
+            get
+            {
+                Initialize();
+                return items!;
+            }
         }
 
-        private IReadOnlyList<ApiVersionDescription> EnumerateApiVersions() =>
-            apiVersionDescriptionProvider.EnumerateApiVersions( actionDescriptorCollectionProvider );
+        private void Initialize()
+        {
+            if ( items == null )
+            {
+                lock ( syncRoot )
+                {
+                    if ( items == null )
+                    {
+                        UpdateItems();
+                    }
+                }
+            }
+        }
+
+        private void UpdateItems()
+        {
+            lock ( syncRoot )
+            {
+                items = apiVersionDescriptionProvider.EnumerateApiVersions( endpointDataSource );
+            }
+        }
     }
 }
diff --git a/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/DefaultApiVersionDescriptionProviderTest.cs b/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/DefaultApiVersionDescriptionProviderTest.cs
@@ -11,7 +11,7 @@ public void api_version_descriptions_should_collate_expected_versions()
     {
         // arrange
         var descriptionProvider = new DefaultApiVersionDescriptionProvider(
-            new TestActionDescriptorCollectionProvider(),
+            new TestEndpointDataSource(),
             Mock.Of<ISunsetPolicyManager>(),
             Options.Create( new ApiExplorerOptions() { GroupNameFormat = "'v'VVV" } ) );
 
@@ -40,7 +40,7 @@ public void api_version_descriptions_should_apply_sunset_policy()
         policyManager.Setup( pm => pm.TryGetPolicy( default, apiVersion, out expected ) ).Returns( true );
 
         var descriptionProvider = new DefaultApiVersionDescriptionProvider(
-            new TestActionDescriptorCollectionProvider(),
+            new TestEndpointDataSource(),
             policyManager.Object,
             Options.Create( new ApiExplorerOptions() { GroupNameFormat = "'v'VVV" } ) );
 
diff --git a/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/TestActionDescriptorCollectionProvider.cs b/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/TestActionDescriptorCollectionProvider.cs
@@ -5,7 +5,7 @@ namespace Asp.Versioning.ApiExplorer;
 using Microsoft.AspNetCore.Mvc.Abstractions;
 using Microsoft.AspNetCore.Mvc.Infrastructure;
 
-internal class TestActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider
+internal sealed class TestActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider
 {
     private readonly Lazy<ActionDescriptorCollection> collection = new( CreateActionDescriptors );
 
diff --git a/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/TestEndpointDataSource.cs b/src/AspNetCore/WebApi/test/Asp.Versioning.Mvc.ApiExplorer.Tests/TestEndpointDataSource.cs
@@ -0,0 +1,197 @@
+﻿// Copyright (c) .NET Foundation and contributors. All rights reserved.
+
+namespace Asp.Versioning.ApiExplorer;
+
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
+using Microsoft.AspNetCore.Routing.Patterns;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Primitives;
+
+internal class TestEndpointDataSource : EndpointDataSource
+{
+    public override IReadOnlyList<Endpoint> Endpoints { get; } = CreateEndpoints();
+
+    public override IChangeToken GetChangeToken() => NullChangeToken.Singleton;
+
+    private static IReadOnlyList<Endpoint> CreateEndpoints()
+    {
+        var endpoints = new List<Endpoint>();
+
+        AddOrderEndpoints( endpoints );
+        AddPeopleEndpoints( endpoints );
+
+        return endpoints;
+    }
+
+    private static void AddOrderEndpoints( ICollection<Endpoint> endpoints )
+    {
+        // api version 0.9 and 1.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-orders/{id}",
+                "orders/{id}",
+                declared: new ApiVersion[] { new( 0, 9 ), new( 1, 0 ) },
+                supported: new ApiVersion[] { new( 1, 0 ) },
+                deprecated: new ApiVersion[] { new( 0, 9 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-orders",
+                "orders",
+                declared: new ApiVersion[] { new( 1, 0 ) },
+                supported: new ApiVersion[] { new( 1, 0 ) } ) );
+
+        // api version 2.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-orders",
+                "orders",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "GET-orders/{id}",
+                "orders/{id}",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-orders",
+                "orders",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        // api version 3.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-orders",
+                "orders",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "GET-orders/{id}",
+                "orders/{id}",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-orders",
+                "orders",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "DELETE-orders/{id}",
+                "orders/{id}",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+    }
+
+    private static void AddPeopleEndpoints( ICollection<Endpoint> endpoints )
+    {
+        // api version 0.9 and 1.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-people/{id}",
+                "people/{id}",
+                declared: new ApiVersion[] { new( 0, 9 ), new( 1, 0 ) },
+                supported: new ApiVersion[] { new( 1, 0 ) },
+                deprecated: new ApiVersion[] { new( 0, 9 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-people",
+                "people",
+                declared: new ApiVersion[] { new( 1, 0 ) },
+                supported: new ApiVersion[] { new( 1, 0 ) } ) );
+
+        // api version 2.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-people",
+                "people",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "GET-people/{id}",
+                "people/{id}",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-people",
+                "people",
+                declared: new ApiVersion[] { new( 2, 0 ) },
+                supported: new ApiVersion[] { new( 2, 0 ) } ) );
+
+        // api version 3.0
+        endpoints.Add(
+            NewEndpoint(
+                "GET-people",
+                "people",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "GET-people/{id}",
+                "people/{id}",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+
+        endpoints.Add(
+            NewEndpoint(
+                "POST-people",
+                "people",
+                declared: new ApiVersion[] { new( 3, 0 ) },
+                supported: new ApiVersion[] { new( 3, 0 ) },
+                advertised: new ApiVersion[] { new( 4, 0 ) } ) );
+    }
+
+    private static Endpoint NewEndpoint(
+        string displayName,
+        string pattern,
+        IEnumerable<ApiVersion> declared,
+        IEnumerable<ApiVersion> supported,
+        IEnumerable<ApiVersion> deprecated = null,
+        IEnumerable<ApiVersion> advertised = null,
+        IEnumerable<ApiVersion> advertisedDeprecated = null )
+    {
+        var metadata = new ApiVersionMetadata(
+            ApiVersionModel.Empty,
+            new ApiVersionModel(
+                declared,
+                supported,
+                deprecated ?? Enumerable.Empty<ApiVersion>(),
+                advertised ?? Enumerable.Empty<ApiVersion>(),
+                advertisedDeprecated ?? Enumerable.Empty<ApiVersion>() ) );
+        var builder = new RouteEndpointBuilder(
+            Route404,
+            RoutePatternFactory.Parse( pattern ),
+            default )
+        {
+            DisplayName = displayName,
+            Metadata = { metadata },
+        };
+
+        return builder.Build();
+    }
+
+    private static Task Route404( HttpContext context ) => Task.CompletedTask;
+}

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace Asp.Versioning.ApiExplorer;`
`5`	`5`	`using Microsoft.AspNetCore.Mvc.Abstractions;`
`6`	`6`	`using Microsoft.AspNetCore.Mvc.Infrastructure;`
`7`	`7`
`8`		`-internal class TestActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider`
	`8`	`+internal sealed class TestActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider`
`9`	`9`	`{`
`10`	`10`	`private readonly Lazy<ActionDescriptorCollection> collection = new( CreateActionDescriptors );`
`11`	`11`