Fix Azure ServiceBus persistent container support #7136

sebastienros · 2025-01-17T01:41:04Z

Description

Fixes #7071

Issues identified:

the lifetime is not forwarded to the dependent container (sqledge)
the password was new on every start, invalidating reusability
the volume was using a new folder on every start, invalidating reusability

Now the password and the folder are stored in user secrets and reused.

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

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

davidfowl · 2025-01-17T05:49:41Z

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

        var configHostFile = Path.Combine(Directory.CreateTempSubdirectory("AspireServiceBusEmulator").FullName, "Config.json");

+        if (lifetime == ContainerLifetime.Persistent && builder.ApplicationBuilder.ExecutionContext.IsRunMode && builder.ApplicationBuilder.AppHostAssembly is not null)


I wonder if we can centralize this logic.

davidfowl · 2025-01-18T16:32:29Z

/azp run

azure-pipelines · 2025-01-18T16:32:42Z

Azure Pipelines successfully started running 1 pipeline(s).

davidfowl · 2025-01-18T19:01:26Z

AddAzureServiceBusWithEmulatorGetsExpectedPort - actual failing test

davidfowl · 2025-01-23T05:09:05Z

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

+        var lifetime = ContainerLifetime.Session;
+
+        // Create a default file mount. This could be replaced by a user-provided file mount.
+        var configHostFile = Path.Combine(Directory.CreateTempSubdirectory("AspireServiceBusEmulator").FullName, "Config.json");


Do we always want to create the directory up front? In the case where the lifetime of is persistent, we may not want this right?

eerhardt · 2025-01-23T14:28:02Z

src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs

+    /// </remarks>
+    /// <param name="builder">Distributed application builder</param>
+    /// <param name="name">Name of the parameter</param>
+    /// <param name="value"></param>


The value parameter is a bit odd since it is only used on the first run. After the value is persisted once, calling AddPersistentParameter again with a different value is ignored, since it reads it from user secrets.

Maybe calling this initialValue or similar may help.

eerhardt · 2025-01-23T14:29:17Z

src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs

+    /// <param name="name">Name of the parameter</param>
+    /// <param name="value"></param>
+    /// <returns>The created <see cref="ParameterResource"/>.</returns>
+    public static ParameterResource AddPersistentParameter(this IDistributedApplicationBuilder builder, string name, string value)


What's the difference between this API and AddParameter(..., persist: true)?

In the end it does the same thing, but you need to use a ParameterDefault in the existing one and the one we need is private. So it's either making ConstantParameterDefault public or create a new helper method that uses it (which is what I implemented).

Can this one be built on top of the other one to show that it is the same thing only with different inputs?

Given your current build errors, it kind of shows why this API isn't working very well. You want to pass a ParameterDefault that will generate a temp file when the parameter value isn't already persisted. Basically a callback func that produces the default value when the value isn't already there.

eerhardt · 2025-01-23T14:30:56Z

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

@@ -14,6 +14,7 @@

  <ItemGroup>
    <Compile Include="$(RepoRoot)src\Aspire.Hosting\Utils\PasswordGenerator.cs" Link="Utils\PasswordGenerator.cs" />
+    <Compile Include="$(SharedDir)SecretsStore.cs" Link="Utils\SecretsStore.cs" />


Is this still needed?

eerhardt · 2025-01-23T14:33:30Z

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

        // Add emulator container

-        var password = PasswordGenerator.Generate(16, true, true, true, true, 0, 0, 0, 0);
+        // The password must be at least 8 characters long and contain characters from three of the following four sets: Uppercase letters, Lowercase letters, Base 10 digits, and Symbols
+        var passwordParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder.ApplicationBuilder, $"{builder.Resource.Name}-sqledge-pwd", minLower: 1, minUpper: 1, minNumeric: 1);


Suggested change

var passwordParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder.ApplicationBuilder, $"{builder.Resource.Name}-sqledge-pwd", minLower: 1, minUpper: 1, minNumeric: 1);

var passwordParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder.ApplicationBuilder, $"{builder.Resource.Name}-sql-pwd", minLower: 1, minUpper: 1, minNumeric: 1);

Do we need to explicitly call this "sqledge"? What if we changed it in the future?

What if it's not even sql in the future ;) Will update.

But the resource is named $"{builder.Resource.Name}-sqledge", that's why it's named $"{builder.Resource.Name}-sqledge-pwd" with the extra -pwd. If we were to change the type of resource, and the name, we could also use a different one for the password.

Or we can name everything without sqledge at all.

I think let's drop the edge in all for sure. I think sql is fine, but if you want to call it something more generic like -data I wouldn't object.

eerhardt · 2025-01-23T14:35:08Z

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

+                ContainerMountType.BindMount,
+                isReadOnly: true);
+
+        var hasCustomConfigJson = builder.Resource.Annotations.OfType<ContainerMountAnnotation>().Any(v => v.Target == AzureServiceBusEmulatorResource.EmulatorConfigJsonPath);


Why are we checking this now? We weren't before.

WithConfigurationFile is removing an existing one. Before this PR the call back would be executed before WithConfigurationFile so it would keep only one. Now the callback is called after WithConfigurationFile so it won't have the same effect.

There is a test ensuring a single mount is defined.

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

eerhardt · 2025-01-29T20:38:07Z

src/Shared/AspireStore.cs

+
+namespace Aspire.Hosting.Utils;
+
+internal sealed class AspireStore : KeyValueStore


I think we will want to make this API public because any integration (including outside of dotnet/aspire) will want to write to this folder.

eerhardt · 2025-01-29T20:39:27Z

src/Shared/SecretsStore.cs

@@ -12,83 +11,92 @@ namespace Microsoft.Extensions.SecretManager.Tools.Internal;
 /// <summary>
 /// Adapted from dotnet user-secrets at https://github.com/dotnet/aspnetcore/blob/482730a4c773ee4b3ae9525186d10999c89b556d/src/Tools/dotnet-user-secrets/src/Internal/SecretsStore.cs
 /// </summary>
-internal sealed class SecretsStore
+internal abstract class KeyValueStore


I'm not sure we need this abstraction. SecretsStore is just about reading/writing the secrets.json file. The new Store should be about reading/writing files to the app directory (wherever it is that we decide).

Co-authored-by: Eric Erhardt <[email protected]>

Fix Azure ServiceBus persistent container support

3be1e3d

sebastienros requested a review from davidfowl January 17, 2025 01:41

davidfowl reviewed Jan 17, 2025

View reviewed changes

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

davidfowl reviewed Jan 17, 2025

View reviewed changes

Refactor state persistence

86513bf

This was referenced Jan 18, 2025

The active test run was aborted. Reason: Test host process crashed dotnet/dnceng#451

Open

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

Fix tests

1e9de41

sebastienros marked this pull request as ready for review January 22, 2025 20:43

sebastienros requested a review from eerhardt January 23, 2025 00:12

davidfowl reviewed Jan 23, 2025

View reviewed changes

eerhardt reviewed Jan 23, 2025

View reviewed changes

sebastienros added 2 commits January 23, 2025 15:33

PR feedback

97ce49c

Fix build

ac1e1f5

danmoseley requested a review from Copilot January 27, 2025 19:23

sebastienros added 3 commits January 28, 2025 09:33

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

3ebd0da

Test AspireStore

4ffcda7

Refactor KeyValueStore

650e3df

eerhardt reviewed Jan 29, 2025

View reviewed changes

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

eerhardt reviewed Jan 29, 2025

View reviewed changes

sebastienros requested a review from mitchdenny as a code owner January 29, 2025 20:42

sebastienros and others added 4 commits January 29, 2025 12:42

Add tests

d929346

Update src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusExtensions.cs

fcb23e7

Co-authored-by: Eric Erhardt <[email protected]>

Use /obj folder to store files

d031cd2

Create ResourcesPreparingEvent

376fcca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Azure ServiceBus persistent container support #7136

Fix Azure ServiceBus persistent container support #7136

sebastienros commented Jan 17, 2025 •

edited

Loading

davidfowl Jan 17, 2025

davidfowl commented Jan 18, 2025

azure-pipelines bot commented Jan 18, 2025

davidfowl commented Jan 18, 2025

davidfowl Jan 23, 2025

eerhardt Jan 23, 2025

eerhardt Jan 23, 2025

sebastienros Jan 23, 2025

eerhardt Jan 24, 2025

eerhardt Jan 24, 2025

eerhardt Jan 23, 2025

eerhardt Jan 23, 2025

sebastienros Jan 23, 2025

sebastienros Jan 23, 2025

eerhardt Jan 24, 2025

eerhardt Jan 23, 2025

sebastienros Jan 23, 2025

eerhardt Jan 29, 2025

eerhardt Jan 29, 2025

		var configHostFile = Path.Combine(Directory.CreateTempSubdirectory("AspireServiceBusEmulator").FullName, "Config.json");

		if (lifetime == ContainerLifetime.Persistent && builder.ApplicationBuilder.ExecutionContext.IsRunMode && builder.ApplicationBuilder.AppHostAssembly is not null)

	var passwordParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder.ApplicationBuilder, $"{builder.Resource.Name}-sqledge-pwd", minLower: 1, minUpper: 1, minNumeric: 1);
	var passwordParameter = ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder.ApplicationBuilder, $"{builder.Resource.Name}-sql-pwd", minLower: 1, minUpper: 1, minNumeric: 1);


		namespace Aspire.Hosting.Utils;

		internal sealed class AspireStore : KeyValueStore

Fix Azure ServiceBus persistent container support #7136

Are you sure you want to change the base?

Fix Azure ServiceBus persistent container support #7136

Conversation

sebastienros commented Jan 17, 2025 • edited Loading

Description

Checklist

Choose a reason for hiding this comment

davidfowl commented Jan 18, 2025

azure-pipelines bot commented Jan 18, 2025

davidfowl commented Jan 18, 2025

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebastienros commented Jan 17, 2025 •

edited

Loading