Add Service Bus emulator support #6737

sebastienros · 2024-11-20T00:26:03Z

Description

Add support for the Service Bus emulator https://techcommunity.microsoft.com/blog/messagingonazureblog/introducing-local-emulator-for-azure-service-bus/4304457

This PR introduces a custom model to configure the emulator and the cloud service. There is another branch that was based on the CDK directly (and use it for the emulator JSON too) but some discussions led to create a custom, simplified one (not really simplified here for the sake of understanding limits), that is then converted to JSON for the emulator, and to CDK resources for provisioning. If the model is not sufficient (can be on purpose to limit it to what users use in most cases) then the emulator configuration can be defined in JSON directly via WithConfigJson(path), customized with RunAsEmulator(c => c.ConfigJson(JsonNode)), and the CDK resources can be enhanced with the existing ConfigureInfrastructure().

Fixes #6605

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

# Conflicts: # Aspire.sln # src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusExtensions.cs

playground/AzureServiceBus/ServiceBus.AppHost/ServiceBus.AppHost.csproj

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/OptionalValue.cs

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/ServiceBusClientAffineProperties.cs

…alue.cs Co-authored-by: David Pine <david.pine@microsoft.com>

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/OptionalValue.cs

src/Aspire.Hosting.Azure.EventHubs/EventHubsEmulatorContainerImageTags.cs

src/Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.ServiceBus.csproj

src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusEmulatorResource.cs

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/ServiceBusClientAffineProperties.cs

eerhardt · 2024-11-20T17:32:39Z

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/ServiceBusTopic.cs

+    /// Converts the current instance to a provisioning entity.
+    /// </summary>
+    /// <returns>A <see cref="global::Azure.Provisioning.ServiceBus.ServiceBusTopic"/> instance.</returns>
+    public global::Azure.Provisioning.ServiceBus.ServiceBusTopic ToProvisioningEntity()


It's unfortunate that we have conflicting type names with Azure.Provisioning. I imagine we will have a lot of users who will reference both and need to disambiguate.

we can add a suffix to these types. However looking at the app host we shouldn't need to add usings at all, unless we call ConfigureInfrastructure to get the CDK types.

playground/AzureServiceBus/ServiceBusWorker/ServiceBusWorker.csproj

playground/AzureServiceBus/ServiceBus.AppHost/ServiceBus.AppHost.csproj

eerhardt · 2024-11-20T17:36:17Z

playground/AzureServiceBus/ServiceBus.AppHost/Program.cs

+    ;
+
+serviceBus
+    .AddQueue("myQueue", queue =>


Do we need to use a callback API pattern here? Why doesn't .AddQueue return the Queue, and then you can modify it as you want?

@eerhardt In this case we would need to return an object that combines behavior of IResourceBuilder<AzureServiceBusResource> with what you are describing so that we could either modify the specified queue or start to specify a different queue or topic?

(full disclosure, I'm not a super fan of fluent APIs)

If you want to start to specify a different queue, you would start a new code line.

var serviceBus = builder.AddAzureServiceBus("sbemulator"); var queue1 = serviceBus.AddQueue("queue1"); // set properties on queue1 var queue2 = serviceBus.AddQueue("queue2"); // set properties on queue2

Why doesn't .AddQueue return the Queue, and then you can modify it as you want?

This would be a breaking change. Is that something we'd want? But we could then reference the resources when building the model, or do topic.AddSubscription("sub.1")

This would be a breaking change. Is that something we'd want?

Any way we could make it without a breaking change? A new method name? AddServiceBusQueue?

cc @mitchdenny @davidfowl - thoughts on using callbacks in the API this way?

timheuer · 2024-11-20T18:21:34Z

src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusEmulatorResource.cs

+public class AzureServiceBusEmulatorResource(AzureServiceBusResource innerResource) : ContainerResource(innerResource.Name), IResource
+{
+    // The path to the emulator configuration file in the container.
+    internal const string EmulatorConfigJsonPath = "/ServiceBus_Emulator/ConfigFiles/Config.json";


assume this is still WIP as would need a way to supply config.json based ont he docs as well?

This is the internal path for the emulator, this won't change. We do bind your own files to this internal path. Use the WithConfigJson(yourpath) for that. And internally it will bind to this path.

I will add another method to configure a JsonObject representing the document in case we want to alter either the generated one of the bound one.

This is the internal path for the emulator, this won't change. We do bind your own files to this internal path. Use the WithConfigJson(yourpath) for that. And internally it will bind to this path.

Oh, that would be nice to get in for Event Hubs emulator to unblock a few things while the API evolves to match this app model idea.

Done, added ConfigureJson in the RunEmulator's lambda.

sebastienros added 6 commits October 30, 2024 14:35

wip

f956d0d

It's alive

000b32f

Add healthchecks

c6fdaca

Merge remote-tracking branch 'origin/main' into sebros/sbemu

1561028

# Conflicts: # Aspire.sln # src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusExtensions.cs

React to breaking changes

8ecc4fd

Create common model for emulator and cdk

698faae

sebastienros changed the title ~~Sebros/sbemunewmodel~~ Add Service Bus emulator support Nov 20, 2024

Merge branch 'main' into sebros/sbemunewmodel

e22e309

ilmax mentioned this pull request Nov 20, 2024

Add Service Bus Emulator support to Aspire #6738

Closed

1 task

sebastienros requested a review from eerhardt November 20, 2024 16:32

IEvangelist reviewed Nov 20, 2024

View reviewed changes

playground/AzureServiceBus/ServiceBus.AppHost/ServiceBus.AppHost.csproj Show resolved Hide resolved

IEvangelist reviewed Nov 20, 2024

View reviewed changes

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/OptionalValue.cs Outdated Show resolved Hide resolved

IEvangelist reviewed Nov 20, 2024

View reviewed changes

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/ServiceBusClientAffineProperties.cs Outdated Show resolved Hide resolved

IEvangelist reviewed Nov 20, 2024

View reviewed changes

src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/ServiceBusClientAffineProperties.cs Outdated Show resolved Hide resolved

sebastienros and others added 2 commits November 20, 2024 09:04

Remove unnecessary !

63dae9e

Update src/Aspire.Hosting.Azure.ServiceBus/ApplicationModel/OptionalV…

9e3ae51

…alue.cs Co-authored-by: David Pine <david.pine@microsoft.com>

eerhardt reviewed Nov 20, 2024

View reviewed changes

timheuer reviewed Nov 20, 2024

View reviewed changes

sebastienros added 3 commits November 20, 2024 14:42

Remove OptionalValue<T>

0a971eb

PR feedback

8f8281d

Revert API breaking changes

fd1a4b2

tjementum mentioned this pull request Nov 21, 2024

Outbox pattern platformplatform/PlatformPlatform#117

Open

sebastienros added 2 commits November 21, 2024 17:24

Ad callback to update json configuration

12c6214

Add tests

af5ff57

sebastienros mentioned this pull request Nov 23, 2024

AddAzureServiceBusQueue relies on the knowledge queues and topics exist Xabaril/AspNetCore.Diagnostics.HealthChecks#2321

Open

sebastienros marked this pull request as ready for review November 23, 2024 02:29

Fix breaking changes

781c595

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Service Bus emulator support #6737

Add Service Bus emulator support #6737

sebastienros commented Nov 20, 2024 •

edited

Loading

eerhardt Nov 20, 2024

sebastienros Nov 20, 2024

eerhardt Nov 20, 2024

bbrandt Nov 20, 2024

eerhardt Nov 20, 2024

sebastienros Nov 21, 2024

eerhardt Nov 22, 2024

timheuer Nov 20, 2024

sebastienros Nov 20, 2024

sebastienros Nov 20, 2024

oising Nov 21, 2024

sebastienros Nov 22, 2024

Add Service Bus emulator support #6737

Are you sure you want to change the base?

Add Service Bus emulator support #6737

Conversation

sebastienros commented Nov 20, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebastienros commented Nov 20, 2024 •

edited

Loading