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 # (issue)

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

vicancy · 2024-11-26T02:35:20Z

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

  <ItemGroup>
    <ProjectReference Include="..\Aspire.Hosting.Azure\Aspire.Hosting.Azure.csproj" />
    <PackageReference Include="Azure.Provisioning" />
    <PackageReference Include="Azure.Provisioning.SignalR" />
+    <PackageReference Include="Microsoft.Azure.SignalR.Management" />


this is a little bit heavy dependency, is it possible to not dependent on it?

I think the convention for other services is to use the Service SDK to init a client for healthcheck. In my opinion, it looks more clean that way as well. Also the tests use this SDK to get negotiate URL as well

Microsoft.Azure.SignalR.Management is a little bit different story, and it references Microsoft.Azure.SignalR which references aspnetcore SignalR. It sounds too much for a project doing the service provisioning

Okay makes sense, I'll just try using REST API for the health check in the main code, and maybe use this Management SDK to perform the tests since it's more complicated to test with using just REST API

vicancy · 2024-11-26T02:36:38Z

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

+            healthCheckKey,
+            sp => {
+                // Use SignalR Management SDK to init a client for health test
+                var client = new ServiceManagerBuilder()


does a simple http call work?

vicancy · 2024-11-26T03:16:12Z

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

@@ -23,5 +31,7 @@ public class AzureSignalRResource(string name, Action<AzureResourceInfrastructur
    /// Gets the connection string template for the manifest for Azure SignalR.
    /// </summary>
    public ReferenceExpression ConnectionStringExpression =>
-        ReferenceExpression.Create($"Endpoint=https://{HostName};AuthType=azure");
+        IsEmulator
+        ? ReferenceExpression.Create($"Endpoint={EmulatorEndpoint.Property(EndpointProperty.Scheme)}://{EmulatorEndpoint.Property(EndpointProperty.Host)}:{EmulatorEndpoint.Property(EndpointProperty.Port)};AccessKey=ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCDEFGH;Version=1.0;")


could we update the emulator to not dependent on "AccessKey" so that we don't need to have the AccessKey in code although it is fake

Revert the comment. Emulator could be working in an isolated environment, so Microsoft Entra ID should not be a dependency when using Emulator. AccessKey is a best choice for existing SDKs to work seamlessly.

BrennanConroy · 2024-11-26T19:46:02Z

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

  <ItemGroup>
    <ProjectReference Include="..\Aspire.Hosting.Azure\Aspire.Hosting.Azure.csproj" />
    <PackageReference Include="Azure.Provisioning" />
    <PackageReference Include="Azure.Provisioning.SignalR" />
+    <PackageReference Include="Microsoft.Azure.SignalR.Management" />
+    <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" />


Why do you need the signalr client reference? Looks like it's only used in a test, so shouldn't the reference be on the test project?

you're right, let me move it to test project

dotnet-policy-service · 2024-11-27T02:41:54Z

@cqnguy23 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

vicancy · 2024-11-28T01:47:04Z

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

@@ -59,4 +63,61 @@ public static IResourceBuilder<AzureSignalRResource> AddAzureSignalR(this IDistr
                      .WithParameter(AzureBicepResource.KnownParameters.PrincipalType)
                      .WithManifestPublishingCallback(resource.WriteToManifest);
    }
+
+    /// <summary>
+    /// Configures an Azure SignalR resource to be emulated. This resource requires an <see cref="AzureSignalRResource"/> to be added to the application model.


also emphasize in the comment that the emulator is for Serverless only

vicancy · 2024-11-28T02:05:07Z

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

{
+

remove extra line

vicancy · 2024-11-28T02:05:22Z

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

+namespace Aspire.Hosting.Azure.Tests;
+public class AzureSignalREmulatorFunctionalTest(ITestOutputHelper testOutputHelper)
+{
+


remove extra line

vicancy · 2024-11-28T02:07:11Z

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

+    /// <param name="builder">The Azure storage resource builder.</param>
+    /// <param name="configureContainer">Callback that exposes underlying container used for emulation to allow for customization.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
+    public static IResourceBuilder<AzureSignalRResource> RunAsEmulator(this IResourceBuilder<AzureSignalRResource> builder, Action<IResourceBuilder<AzureSignalREmulatorResource>>? configureContainer = null)


also showing how to use RunAsEmulator in the signalr playground project

vicancy · 2024-11-28T02:08:30Z

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

+using Xunit.Abstractions;
+
+namespace Aspire.Hosting.Azure.Tests;
+public class AzureSignalREmulatorFunctionalTest(ITestOutputHelper testOutputHelper)


also add test to check the if the connectionString is expected, similar test see AzureBicepResourceTests.AddAzureCosmosDBEmulator

vicancy · 2024-11-28T03:01:35Z

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

+        {
+            return builder;
+        }
+


shall we do some check here to make sure the SignalR service is in Serverless mode?

builder.ConfigureInfrastructure(i => { // Get the SignalRService set by AddAzureSignalR var resource = i.GetProvisionableResources().OfType<SignalRService>().First(s => s.BicepIdentifier == i.AspireResource.GetBicepIdentifier()); // check if the serviceMode is Serverless if (resource.Features.Any(feature => feature.Value != null && feature.Value.Flag.Value == SignalRFeatureFlag.ServiceMode && feature.Value.Value.Value != null && feature.Value.Value.Value.Equals("Serverless", StringComparison.OrdinalIgnoreCase))) { return; } else { throw new InvalidOperationException("Emulator works only for Azure SignalR Serverless mode"); } });

chuongnguyen 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

BrennanConroy reviewed Nov 26, 2024

View reviewed changes

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

vicancy reviewed Nov 28, 2024

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

vicancy Nov 26, 2024

cqnguy23 Nov 27, 2024

vicancy Nov 27, 2024

cqnguy23 Nov 29, 2024

vicancy Nov 26, 2024

vicancy Nov 26, 2024

vicancy Nov 27, 2024

BrennanConroy Nov 26, 2024

cqnguy23 Nov 27, 2024

dotnet-policy-service bot commented Nov 27, 2024

Contribution License Agreement

vicancy Nov 28, 2024

vicancy Nov 28, 2024

vicancy Nov 28, 2024

vicancy Nov 28, 2024

vicancy Nov 28, 2024

vicancy Nov 28, 2024

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

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

dotnet-policy-service bot commented Nov 27, 2024

Contribution License Agreement

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

cqnguy23 commented Nov 25, 2024 •

edited

Loading