Azure Web PubSub service: MapWebPubSubHub extension with custom hub name (Azure#47022)

karpikpl · web-flow · commit 0636f606af3d · 2024-11-14T11:56:22.000+08:00
* MapWebPubSubHub extension with hub name

* updates to Readme

* adding mising api file from Export-API.ps1

* more tests

* cleaned up code duplication

* fixed assert
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/README.md b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/README.md
@@ -61,6 +61,8 @@ public void ConfigureServices(IServiceCollection services)
 
 ### Map `WebPubSubHub` to endpoint routing
 
+The name of the hub has to match the class name e.g. `SampleHub`.
+
 ```C# Snippet:WebPubSubMapHub
 public void Configure(IApplicationBuilder app)
 {
@@ -71,6 +73,18 @@ public void Configure(IApplicationBuilder app)
 }
 ```
 
+Hub name can be overriden by using extension method.
+
+```C# Snippet:WebPubSubMapHubCustom
+public void Configure(IApplicationBuilder app)
+{
+    app.UseEndpoints(endpoint =>
+    {
+        endpoint.MapWebPubSubHub<SampleHub>("/eventhandler", "customHub");
+    });
+}
+```
+
 ## Key concepts
 
 For information about general Web PubSub concepts [Concepts in Azure Web PubSub](https://docs.microsoft.com/azure/azure-web-pubsub/key-concepts)
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/api/Microsoft.Azure.WebPubSub.AspNetCore.netcoreapp3.1.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/api/Microsoft.Azure.WebPubSub.AspNetCore.netcoreapp3.1.cs
@@ -3,6 +3,7 @@ namespace Microsoft.AspNetCore.Builder
     public static partial class WebPubSubEndpointRouteBuilderExtensions
     {
         public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapWebPubSubHub<THub>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string path) where THub : Microsoft.Azure.WebPubSub.AspNetCore.WebPubSubHub { throw null; }
+        public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapWebPubSubHub<THub>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string path, string hubName) where THub : Microsoft.Azure.WebPubSub.AspNetCore.WebPubSubHub { throw null; }
     }
 }
 namespace Microsoft.Azure.WebPubSub.AspNetCore
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/src/Extensions/WebPubSubEndpointRouteBuilderExtensions.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/src/Extensions/WebPubSubEndpointRouteBuilderExtensions.cs
@@ -16,25 +16,43 @@ public static class WebPubSubEndpointRouteBuilderExtensions
         /// <summary>
         /// Maps the <see cref="WebPubSubHub"/> to the path <paramref name="path"/>.
         /// </summary>
-        /// <typeparam name="THub">User implemented <see cref="WebPubSubHub"/>.</typeparam>
+        /// <typeparam name="THub">User implemented <see cref="WebPubSubHub"/>.
+        /// Name of the class has to match the name of the hub in the Azure portal.</typeparam>
         /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/>.</param>
         /// <param name="path">The path to map the <see cref="WebPubSubHub"/>.</param>
         /// <returns>The <see cref="IEndpointConventionBuilder"/>.</returns>
         public static IEndpointConventionBuilder MapWebPubSubHub<THub>(
             this IEndpointRouteBuilder endpoints,
             string path) where THub: WebPubSubHub
+            => MapWebPubSubHub<THub>(endpoints, path, typeof(THub).Name);
+
+        /// <summary>
+        /// Maps the <see cref="WebPubSubHub"/> to the path "/client" with the specified hub name.
+        /// </summary>
+        /// <typeparam name="THub">User implemented <see cref="WebPubSubHub"/>.</typeparam>
+        /// <param name="endpoints">The <see cref="IEndpointRouteBuilder"/>.</param>
+        /// <param name="path">The path to map the <see cref="WebPubSubHub"/>.</param>
+        /// <param name="hubName">The name of the hub to connect to.</param>
+        /// <returns>The <see cref="IEndpointConventionBuilder"/>.</returns>
+        public static IEndpointConventionBuilder MapWebPubSubHub<THub>(
+            this IEndpointRouteBuilder endpoints, string path,
+            string hubName) where THub : WebPubSubHub
         {
             if (endpoints == null)
             {
                 throw new ArgumentNullException(nameof(endpoints));
             }
+            if (string.IsNullOrEmpty(hubName))
+            {
+                throw new ArgumentNullException(nameof(hubName));
+            }
 
             var marker = endpoints.ServiceProvider.GetService<WebPubSubMarkerService>() ?? throw new InvalidOperationException(
                     "Unable to find the required services. Please add all the required services by calling " +
                     "'IServiceCollection.AddWebPubSub' inside the call to 'ConfigureServices(...)' in the application startup code.");
 
             var adaptor = endpoints.ServiceProvider.GetService<ServiceRequestHandlerAdapter>();
-            adaptor.RegisterHub<THub>();
+            adaptor.RegisterHub<THub>(hubName);
 
             var app = endpoints.CreateApplicationBuilder();
             app.UseMiddleware<WebPubSubMiddleware>();
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/src/Internal/ServiceRequestHandlerAdapter.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/src/Internal/ServiceRequestHandlerAdapter.cs
@@ -36,6 +36,12 @@ public void RegisterHub<THub>() where THub : WebPubSubHub
             RegisterHub(hub.GetType().Name, hub);
         }
 
+        public void RegisterHub<THub>(string hubName) where THub : WebPubSubHub
+        {
+            var hub = Create<THub>();
+            RegisterHub(hubName, hub);
+        }
+
         // For test only
         internal void RegisterHub(string hubName, WebPubSubHub hub)
         {
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/AddWebPubSubTests.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/AddWebPubSubTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 #if NETCOREAPP
+using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using NUnit.Framework;
@@ -59,6 +60,64 @@ public void TestWebPubSubConfigureEmptyOptionsAndAddHubThrows()
             Assert.Throws<ArgumentException>(() => clientFactory.Create<TestHub>());
         }
 
+        [Test]
+        public void TestMapWebPubSubHubConfigureNormal()
+        {
+            var testHost = "webpubsub.azure.net";
+            WebApplicationBuilder builder = WebApplication.CreateBuilder();
+            builder.Services
+             .AddWebPubSub(o => o.ServiceEndpoint = new WebPubSubServiceEndpoint($"Endpoint=https://{testHost};AccessKey=7aab239577fd4f24bc919802fb629f5f;Version=1.0;"));
+
+            using var app = builder.Build();
+            app.MapWebPubSubHub<TestHub>("/testhub");
+
+            var validator = app.Services.GetRequiredService<RequestValidator>();
+
+            Assert.NotNull(validator);
+            Assert.True(validator.IsValidOrigin(new List<string> { testHost }));
+        }
+
+        [Test]
+        public void TestMapWebPubSubHubConfigureCustomHub()
+        {
+            var testHost = "webpubsub.azure.net";
+            var customHub = "customhub";
+            WebApplicationBuilder builder = WebApplication.CreateBuilder();
+            builder.Services
+             .AddWebPubSub(o => o.ServiceEndpoint = new WebPubSubServiceEndpoint($"Endpoint=https://{testHost};AccessKey=7aab239577fd4f24bc919802fb629f5f;Version=1.0;"));
+
+            using var app = builder.Build();
+            app.MapWebPubSubHub<TestHub>("/testhub", customHub);
+
+            var validator = app.Services.GetRequiredService<RequestValidator>();
+            var adaptor = app.Services.GetRequiredService<ServiceRequestHandlerAdapter>();
+
+            Assert.NotNull(validator);
+            Assert.NotNull(adaptor);
+            Assert.True(validator.IsValidOrigin(new List<string> { testHost }));
+            Assert.NotNull(adaptor.GetHub(customHub), "Custom hub should be registered");
+        }
+
+        [Test]
+        public void TestMapWebPubSubHubConfigureHubByTypeName()
+        {
+            var testHost = "webpubsub.azure.net";
+            WebApplicationBuilder builder = WebApplication.CreateBuilder();
+            builder.Services
+             .AddWebPubSub(o => o.ServiceEndpoint = new WebPubSubServiceEndpoint($"Endpoint=https://{testHost};AccessKey=7aab239577fd4f24bc919802fb629f5f;Version=1.0;"));
+
+            using var app = builder.Build();
+            app.MapWebPubSubHub<TestHub>("/testhub");
+
+            var validator = app.Services.GetRequiredService<RequestValidator>();
+            var adaptor = app.Services.GetRequiredService<ServiceRequestHandlerAdapter>();
+
+            Assert.NotNull(validator);
+            Assert.NotNull(adaptor);
+            Assert.True(validator.IsValidOrigin(new List<string> { testHost }));
+            Assert.NotNull(adaptor.GetHub(nameof(TestHub)), "Hub with the name that matches the class name should be registered");
+        }
+
         private sealed class TestHub : WebPubSubHub
         { }
 
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/Microsoft.Azure.WebPubSub.AspNetCore.Tests.csproj b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/Microsoft.Azure.WebPubSub.AspNetCore.Tests.csproj
@@ -18,7 +18,7 @@
   </ItemGroup>
 
   <ItemGroup>
-		<PackageReference Include="Azure.Identity"/>
+		<PackageReference Include="Azure.Identity" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
 		<PackageReference Include="Moq" />
 		<PackageReference Include="NUnit" />
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/Samples/WebPubSubSampleCreateWithAzureIdentity.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/Samples/WebPubSubSampleCreateWithAzureIdentity.cs
@@ -26,13 +26,15 @@ public void ConfigureServices(IServiceCollection services)
         }
 #endregion
 
+        #region Snippet:WebPubSubMapHubCustom
         public void Configure(IApplicationBuilder app)
         {
             app.UseEndpoints(endpoint =>
             {
-                endpoint.MapWebPubSubHub<SampleHub>("/eventhandler");
+                endpoint.MapWebPubSubHub<SampleHub>("/eventhandler", "customHub");
             });
         }
+        #endregion
 
         private sealed class SampleHub : WebPubSubHub
         {
diff --git a/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/ServiceRequestHandlerTests.cs b/sdk/webpubsub/Microsoft.Azure.WebPubSub.AspNetCore/tests/ServiceRequestHandlerTests.cs
@@ -7,7 +7,6 @@
 using System.IO;
 using System.Linq;
 using System.Net;
-using System.Security.Authentication;
 using System.Text;
 using System.Text.Json;
 using System.Threading;
@@ -311,6 +310,20 @@ public async Task TestWrongTypeReturns()
             Assert.AreEqual("Invalid user", response);
         }
 
+        [Test]
+        public async Task TestHubBaseReturnsWhenCustomHubName()
+        {
+            var hubName = "customHub";
+            _adaptor.RegisterHub<TestDefaultHub>(hubName);
+            var connectBody = "{\"claims\":{\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\":[\"ddd\"],\"nbf\":[\"1629183374\"],\"exp\":[\"1629186974\"],\"iat\":[\"1629183374\"],\"aud\":[\"http://localhost:8080/client/hubs/chat\"],\"sub\":[\"ddd\"]},\"query\":{\"access_token\":[\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkZGQiLCJuYmYiOjE2MjkxODMzNzQsImV4cCI6MTYyOTE4Njk3NCwiaWF0IjoxNjI5MTgzMzc0LCJhdWQiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvY2xpZW50L2h1YnMvY2hhdCJ9.tqD8ykjv5NmYw6gzLKglUAv-c-AVWu-KNZOptRKkgMM\"]},\"subprotocols\":[\"protocol1\", \"protocol2\"],\"clientCertificates\":[],\"headers\":{}}";
+            var context = PrepareHttpContext(httpMethod: HttpMethods.Post, eventName: "connect", body: connectBody, hub: hubName);
+
+            await _adaptor.HandleRequest(context);
+
+            Assert.AreEqual(StatusCodes.Status200OK, context.Response.StatusCode);
+            Assert.Null(context.Response.ContentLength);
+        }
+
         private static HttpContext PrepareHttpContext(
             WebPubSubEventType type = WebPubSubEventType.System,
             string eventName = "connect",

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ namespace Microsoft.AspNetCore.Builder`
`3`	`3`	`public static partial class WebPubSubEndpointRouteBuilderExtensions`
`4`	`4`	`{`
`5`	`5`	`public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapWebPubSubHub<THub>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string path) where THub : Microsoft.Azure.WebPubSub.AspNetCore.WebPubSubHub { throw null; }`
	`6`	`+ public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapWebPubSubHub<THub>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, string path, string hubName) where THub : Microsoft.Azure.WebPubSub.AspNetCore.WebPubSubHub { throw null; }`
`6`	`7`	`}`
`7`	`8`	`}`
`8`	`9`	`namespace Microsoft.Azure.WebPubSub.AspNetCore`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,12 @@ public void RegisterHub<THub>() where THub : WebPubSubHub`
`36`	`36`	`RegisterHub(hub.GetType().Name, hub);`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ public void RegisterHub<THub>(string hubName) where THub : WebPubSubHub`
	`40`	`+ {`
	`41`	`+ var hub = Create<THub>();`
	`42`	`+ RegisterHub(hubName, hub);`
	`43`	`+ }`
	`44`	`+`
`39`	`45`	`// For test only`
`40`	`46`	`internal void RegisterHub(string hubName, WebPubSubHub hub)`
`41`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,13 +26,15 @@ public void ConfigureServices(IServiceCollection services)`
`26`	`26`	`}`
`27`	`27`	`#endregion`
`28`	`28`
	`29`	`+ #region Snippet:WebPubSubMapHubCustom`
`29`	`30`	`public void Configure(IApplicationBuilder app)`
`30`	`31`	`{`
`31`	`32`	`app.UseEndpoints(endpoint =>`
`32`	`33`	`{`
`33`		`- endpoint.MapWebPubSubHub<SampleHub>("/eventhandler");`
	`34`	`+ endpoint.MapWebPubSubHub<SampleHub>("/eventhandler", "customHub");`
`34`	`35`	`});`
`35`	`36`	`}`
	`37`	`+ #endregion`
`36`	`38`
`37`	`39`	`private sealed class SampleHub : WebPubSubHub`
`38`	`40`	`{`