Add support for SignalR emulator #6793

cqnguy23 · 2024-11-25T15:57:02Z

Description

This PR adds support for SignalR Emulator https://learn.microsoft.com/en-us/azure/azure-signalr/signalr-howto-emulator

Fixes #6676

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Is this introducing a breaking change?
    - Yes
      - Link to aspire-docs issue (please use this breaking-change template):
    - No
      - Link to aspire-docs issue (please use this doc-idea template):
- No

Microsoft Reviewers: Open in CodeFlow

Addresses issue #6676

src/Aspire.Hosting.Azure.SignalR/Aspire.Hosting.Azure.SignalR.csproj

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRResource.cs

src/Aspire.Hosting.Azure.SignalR/Aspire.Hosting.Azure.SignalR.csproj

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRResource.cs

tests/Aspire.Hosting.Azure.Tests/AzureSignalREmulatorFunctionalTest.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

tests/Aspire.Hosting.Azure.Tests/AzureSignalREmulatorFunctionalTest.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

cqnguy23 · 2024-12-02T09:01:59Z

@dotnet-policy-service agree company="Microsoft"

src/Aspire.Hosting.Azure.SignalR/Aspire.Hosting.Azure.SignalR.csproj

src/Aspire.Hosting.Azure.SignalR/AzureSignalRHealthCheck.cs

playground/signalr/serverless/SignalRServerless.AppHost/README.md

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

playground/signalr/serverless/SignalRServerless.AppHost/Program.cs

Co-authored-by: Liangying.Wei <[email protected]>

…/cqnguy23/aspire into add-support-for-signalr-emulator

vicancy · 2024-12-11T08:15:49Z

Hi @eerhardt @davidfowl Azure Function requires an app key code to invoke the SignalR trigger, e.g. <endpoint>/runtime/webhooks/signalr/?code=xxx, https://learn.microsoft.com/en-us/azure/azure-functions/function-keys-how-to?tabs=azure-portal#use-access-keys. Is this code value something that aspire supports/or planned to help get this app key out?

eerhardt · 2024-12-11T16:30:24Z

Hi @eerhardt @davidfowl Azure Function requires an app key code to invoke the SignalR trigger, e.g. <endpoint>/runtime/webhooks/signalr/?code=xxx, https://learn.microsoft.com/en-us/azure/azure-functions/function-keys-how-to?tabs=azure-portal#use-access-keys. Is this code value something that aspire supports/or planned to help get this app key out?

We were just talking with @fabiocav yesterday about a similar scenario for HttpTriggers. .NET Aspire doesn't have support inbox today, but are discussing how it can be supported.

cc @captainsafia @DamianEdwards

cqnguy23 · 2024-12-12T07:24:34Z

Hi @eerhardt, could you help add this package Microsoft.Azure.Functions.Worker.Extensions.SignalRService to the package source? Getting this error when building the playground sample: Unable to find package Microsoft.Azure.Functions.Worker.Extensions.SignalRService. No packages exist with this id in source(s): dotnet-eng, dotnet-public, dotnet9, dotnet9-transport.

captainsafia · 2024-12-12T17:19:34Z

playground/signalr/serverless/SignalRServerless.AppHost/Program.cs

Can we move this to the existing Azure Functions playground sample instead of creating a new one?

Or collapse it into the existing SignalR playground app? I'm not sure we need 2 in the repo.

Also, is the "Functions" part of this superfluous? This PR is for the SignalR emulator. It might be overkill trying to define/decide how Functions and Azure SignalR work together in this PR. It will probably distract/delay getting the emulator support in.

Maybe in one SignalR playground but creating 2 SignalR resources, one for serverless one for default mode. For Azure SignalR emulator, it works for serverless scenarios only, which mostly works together with Azure Function. I think it would be a great serverless sample if Function works. But yeah if Function SignalRTrigger is not yet ready, surely we could have a simpler sample for the serverless scenario to let the emulator support ready first.

But yeah if Function SignalRTrigger is not yet ready, surely we could have a simpler sample for the serverless scenario to let the emulator support ready first.

I'm inclined to pull out the Functions-specific changes from this PR and just leave the SignalR support. Supporting triggers for Functions in Aspire requires some additional work (see #6414). It would make review easier to scope this to just the SignalR-emulator specific changes and move the Functions changes to a separate PR.

Is there a way to validate the emulator locally without implementing a Functions app?

@captainsafia Sure. I can just spin up a simple web app to invoke API from emulator without using Functions

@captainsafia removed the Functions out of the scope and used a web application to validate the emulator instead. Could you check again?

playground/signalr/serverless/SignalRServerless.Functions/Program.cs

playground/signalr/serverless/SignalRServerless.Functions/Function.cs

captainsafia · 2024-12-12T17:24:06Z

playground/signalr/serverless/SignalRServerless.Functions/Function.cs

+        _logger.LogInformation($"{invocationContext.ConnectionId} has disconnected");
+    }
+
+    public class NewConnection


Nit: Consider using a record type here.

src/Aspire.Hosting.Azure.SignalR/SignalREmulatorContainerImageTags.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalREmulatorResource.cs

eerhardt · 2024-12-12T22:30:38Z

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

+    /// Configures an Azure SignalR resource to be emulated. This resource requires an <see cref="AzureSignalRResource"/> to be added to the application model. Please note that the resource will be emulated in <b>Serverless mode</b>.
+    /// </summary>
+    /// <remarks>
+    /// This version of the package defaults to the <inheritdoc cref="SignalREmulatorContainerImageTags.Tag"/> tag of the <inheritdoc cref="SignalREmulatorContainerImageTags.Registry"/>/<inheritdoc cref="SignalREmulatorContainerImageTags.Image"/> container image.


FYI - @sebastienros - this will need to be fixed with #6747

could I just fix it in this PR?

@sebastienros do we know what the right fix is?

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

eerhardt · 2024-12-12T22:35:53Z

src/Aspire.Hosting.Azure.SignalR/AzureSignalRHealthCheck.cs

+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Aspire.Hosting.Azure.SignalR;
+internal sealed class AzureSignalRHealthCheck : IHealthCheck


Any thoughts on contributing this health check to https://github.com/xabaril/AspNetCore.Diagnostics.HealthChecks/? It doesn't need to block this PR, but the idea is that having a rich library of health checks (outside of Aspire) helps the whole community.

Since Azure SignalR has it's own SDK with HealthCheck embeded, this class might be only useful for this emulator scenario.

src/Aspire.Hosting.Azure.SignalR/AzureSignalRHealthCheck.cs

eerhardt

This is looking pretty good. I pulled it locally, and it all worked for me.

Thanks for the contribution!

src/Aspire.Hosting.Azure.SignalR/AzureSignalRHealthCheck.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRResource.cs

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs

playground/signalr/SignalR.AppHost/Program.cs

playground/signalr/SignalRServerlessWeb/Properties/launchSettings.json

eerhardt

LGTM. Thanks @cqnguy23!

eerhardt · 2025-01-06T22:21:29Z

However, it looks like the new test is failing:

Microsoft.Azure.SignalR.Common.AzureSignalRException : An error happened when making request to http://localhost:46185/api/health?api-version=2022-06-01
---- System.Net.Http.HttpRequestException : An error occurred while sending the request.
-------- System.IO.IOException : Unable to read data from the transport connection: Connection reset by peer.
------------ System.Net.Sockets.SocketException : Connection reset by peer



Stack trace
   at Microsoft.Azure.SignalR.RestClient.SendAsyncCore(String httpClientName, RestApiEndpoint api, HttpMethod httpMethod, String methodName, Object[] args, Func`2 handleExpectedResponseAsync, CancellationToken cancellationToken)
   at Microsoft.Azure.SignalR.Management.ServiceManagerImpl.IsServiceHealthy(CancellationToken cancellationToken)
   at Aspire.Hosting.Azure.Tests.AzureSignalREmulatorFunctionalTest.VerifyAzureSignalREmulatorResource() in /_/tests/Aspire.Hosting.Azure.Tests/AzureSignalREmulatorFunctionalTest.cs:line 91
--- End of stack trace from previous location ---
----- Inner Stack Trace -----
   at System.Net.Http.HttpConnection.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
   at System.Net.Http.HttpConnectionPool.SendWithVersionDetectionAndRetryAsync(HttpRequestMessage request, Boolean async, Boolean doRequestAuth, CancellationToken cancellationToken)
   at System.Net.Http.RedirectHandler.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
   at Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.<SendCoreAsync>g__Core|5_0(HttpRequestMessage request, Boolean useAsync, CancellationToken cancellationToken)
   at Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.<SendCoreAsync>g__Core|5_0(HttpRequestMessage request, Boolean useAsync, CancellationToken cancellationToken)
   at System.Net.Http.HttpClient.<SendAsync>g__Core|83_0(HttpRequestMessage request, HttpCompletionOption completionOption, CancellationTokenSource cts, Boolean disposeCts, CancellationTokenSource pendingRequestsCts, CancellationToken originalCancellationToken)
   at Microsoft.Azure.SignalR.RestClient.SendAsyncCore(String httpClientName, RestApiEndpoint api, HttpMethod httpMethod, String methodName, Object[] args, Func`2 handleExpectedResponseAsync, CancellationToken cancellationToken)
----- Inner Stack Trace -----
   at System.Net.Sockets.Socket.AwaitableSocketAsyncEventArgs.System.Threading.Tasks.Sources.IValueTaskSource<System.Int32>.GetResult(Int16 token)
   at System.Net.Http.HttpConnection.InitialFillAsync(Boolean async)
   at System.Net.Http.HttpConnection.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
----- Inner Stack Trace ----

Can you take a look?

cqnguy23 · 2025-01-07T09:52:21Z

However, it looks like the new test is failing:

Microsoft.Azure.SignalR.Common.AzureSignalRException : An error happened when making request to http://localhost:46185/api/health?api-version=2022-06-01
---- System.Net.Http.HttpRequestException : An error occurred while sending the request.
-------- System.IO.IOException : Unable to read data from the transport connection: Connection reset by peer.
------------ System.Net.Sockets.SocketException : Connection reset by peer



Stack trace
   at Microsoft.Azure.SignalR.RestClient.SendAsyncCore(String httpClientName, RestApiEndpoint api, HttpMethod httpMethod, String methodName, Object[] args, Func`2 handleExpectedResponseAsync, CancellationToken cancellationToken)
   at Microsoft.Azure.SignalR.Management.ServiceManagerImpl.IsServiceHealthy(CancellationToken cancellationToken)
   at Aspire.Hosting.Azure.Tests.AzureSignalREmulatorFunctionalTest.VerifyAzureSignalREmulatorResource() in /_/tests/Aspire.Hosting.Azure.Tests/AzureSignalREmulatorFunctionalTest.cs:line 91
--- End of stack trace from previous location ---
----- Inner Stack Trace -----
   at System.Net.Http.HttpConnection.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
   at System.Net.Http.HttpConnectionPool.SendWithVersionDetectionAndRetryAsync(HttpRequestMessage request, Boolean async, Boolean doRequestAuth, CancellationToken cancellationToken)
   at System.Net.Http.RedirectHandler.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
   at Microsoft.Extensions.Http.Logging.LoggingHttpMessageHandler.<SendCoreAsync>g__Core|5_0(HttpRequestMessage request, Boolean useAsync, CancellationToken cancellationToken)
   at Microsoft.Extensions.Http.Logging.LoggingScopeHttpMessageHandler.<SendCoreAsync>g__Core|5_0(HttpRequestMessage request, Boolean useAsync, CancellationToken cancellationToken)
   at System.Net.Http.HttpClient.<SendAsync>g__Core|83_0(HttpRequestMessage request, HttpCompletionOption completionOption, CancellationTokenSource cts, Boolean disposeCts, CancellationTokenSource pendingRequestsCts, CancellationToken originalCancellationToken)
   at Microsoft.Azure.SignalR.RestClient.SendAsyncCore(String httpClientName, RestApiEndpoint api, HttpMethod httpMethod, String methodName, Object[] args, Func`2 handleExpectedResponseAsync, CancellationToken cancellationToken)
----- Inner Stack Trace -----
   at System.Net.Sockets.Socket.AwaitableSocketAsyncEventArgs.System.Threading.Tasks.Sources.IValueTaskSource<System.Int32>.GetResult(Int16 token)
   at System.Net.Http.HttpConnection.InitialFillAsync(Boolean async)
   at System.Net.Http.HttpConnection.SendAsync(HttpRequestMessage request, Boolean async, CancellationToken cancellationToken)
----- Inner Stack Trace ----

Can you take a look?

Can you help me re-run the tests? I encountered this error a few times and found that re-running the tests would solve it.

eerhardt · 2025-01-07T15:31:54Z

I encountered this error a few times and found that re-running the tests would solve it.

We need our tests to be consistent and stable. If there is a problem, we should add retries/waits to the test code.

cqnguy23 added 2 commits November 25, 2024 14:47

add support for signalr emulator

a002b7f

add tests for signalr emulator

6a1068d

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Nov 25, 2024

remove unnecessary packge

3c50f3d

davidfowl requested a review from vicancy November 25, 2024 16:13

vicancy reviewed Nov 26, 2024

View reviewed changes

src/Aspire.Hosting.Azure.SignalR/Aspire.Hosting.Azure.SignalR.csproj Outdated Show resolved Hide resolved

src/Aspire.Hosting.Azure.SignalR/AzureSignalRExtensions.cs Outdated Show resolved Hide resolved

vicancy reviewed Nov 26, 2024

View reviewed changes

src/Aspire.Hosting.Azure.SignalR/AzureSignalRResource.cs Outdated Show resolved Hide resolved

BrennanConroy reviewed Nov 26, 2024

View reviewed changes

src/Aspire.Hosting.Azure.SignalR/Aspire.Hosting.Azure.SignalR.csproj Outdated Show resolved Hide resolved

eerhardt requested a review from sebastienros November 26, 2024 23:14

vicancy reviewed Nov 28, 2024

View reviewed changes

refactor code

a65d687

cqnguy23 added 5 commits December 5, 2024 00:19

add playground samples

eb9b674

remove unnecessary package ref

7ed0565

improve documentation

23b2d81

use http request for health check instead

929235f

use bidirectional sample for playground instead

80e73eb

vicancy reviewed Dec 10, 2024

View reviewed changes

cqnguy23 and others added 5 commits December 10, 2024 16:34

refactor code as reviewed

75770f0

revert unnecessary change

5710c14

Update playground/signalr/serverless/SignalRServerless.AppHost/README.md

11dc033

Co-authored-by: Liangying.Wei <[email protected]>

add EOL

303aaab

Merge branch 'add-support-for-signalr-emulator' of https://github.com…

e1084e5

…/cqnguy23/aspire into add-support-for-signalr-emulator

cqnguy23 added 3 commits December 12, 2024 11:07

upgrade playground dependencies

731180a

Merge branch 'main' into add-support-for-signalr-emulator

8d87001

revert upgrade dependencies

f3ce730

captainsafia reviewed Dec 12, 2024

View reviewed changes

playground/signalr/serverless/SignalRServerless.Functions/Program.cs Outdated Show resolved Hide resolved

captainsafia reviewed Dec 12, 2024

View reviewed changes

playground/signalr/serverless/SignalRServerless.Functions/Function.cs Outdated Show resolved Hide resolved

captainsafia reviewed Dec 12, 2024

View reviewed changes

eerhardt reviewed Dec 12, 2024

View reviewed changes

cqnguy23 added 5 commits December 13, 2024 18:16

combine signalr playgrounds and refactor code

09575bf

use a web application instead of functions for serverless sample

a63b994

remove unnescessary package

b188b62

refactor code

2b4088e

add rest api role assignment for sample and update manifest

8f2ed7d

eerhardt reviewed Jan 2, 2025

View reviewed changes

cqnguy23 and others added 2 commits January 4, 2025 22:19

refactor code as reviewed

5477ff5

Fix test

301235d

cqnguy23 requested a review from eerhardt January 6, 2025 04:52

Merge branch 'main' into add-support-for-signalr-emulator

3ba4d8b

eerhardt approved these changes Jan 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for SignalR emulator #6793

Add support for SignalR emulator #6793

cqnguy23 commented Nov 25, 2024 •

edited

Loading

cqnguy23 commented Dec 2, 2024

vicancy commented Dec 11, 2024

eerhardt commented Dec 11, 2024

cqnguy23 commented Dec 12, 2024

captainsafia Dec 12, 2024

eerhardt Dec 12, 2024

vicancy Dec 13, 2024

captainsafia Dec 13, 2024

cqnguy23 Dec 16, 2024

cqnguy23 Dec 31, 2024

captainsafia Dec 12, 2024

eerhardt Dec 12, 2024

cqnguy23 Dec 13, 2024

eerhardt Dec 13, 2024

eerhardt Dec 12, 2024

vicancy Dec 13, 2024

eerhardt left a comment

eerhardt left a comment

eerhardt commented Jan 6, 2025

cqnguy23 commented Jan 7, 2025

eerhardt commented Jan 7, 2025

Add support for SignalR emulator #6793

Are you sure you want to change the base?

Add support for SignalR emulator #6793

Conversation

cqnguy23 commented Nov 25, 2024 • edited Loading

Description

Checklist

Microsoft Reviewers: Open in CodeFlow

cqnguy23 commented Dec 2, 2024

vicancy commented Dec 11, 2024

eerhardt commented Dec 11, 2024

cqnguy23 commented Dec 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eerhardt left a comment

Choose a reason for hiding this comment

eerhardt left a comment

Choose a reason for hiding this comment

eerhardt commented Jan 6, 2025

cqnguy23 commented Jan 7, 2025

eerhardt commented Jan 7, 2025

cqnguy23 commented Nov 25, 2024 •

edited

Loading