-
Notifications
You must be signed in to change notification settings - Fork 650
Fix Azure ServiceBus persistent container support #7136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
3be1e3d
Fix Azure ServiceBus persistent container support
sebastienros 86513bf
Refactor state persistence
sebastienros 1e9de41
Fix tests
sebastienros 97ce49c
PR feedback
sebastienros ac1e1f5
Fix build
sebastienros 3ebd0da
Merge remote-tracking branch 'origin/main' into sebros/sbpersist
sebastienros 4ffcda7
Test AspireStore
sebastienros 650e3df
Refactor KeyValueStore
sebastienros d929346
Add tests
sebastienros fcb23e7
Update src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusExtensions.cs
sebastienros d031cd2
Use /obj folder to store files
sebastienros 376fcca
Create ResourcesPreparingEvent
sebastienros 5620c61
Merge remote-tracking branch 'origin/main' into sebros/sbpersist
sebastienros b8a1025
Remove unused AddPersistentParameter
sebastienros 727f0f0
Only fallback folder on ENV
sebastienros 417c0ff
Fix method documentation
sebastienros 663ee7a
Remove newly added event
sebastienros 33868bc
Merge remote-tracking branch 'origin/main' into sebros/sbpersist
sebastienros ec769ed
Fix tests
sebastienros e691cb9
Use temp path for store in functional tests
sebastienros 21808c5
PR feedback
sebastienros ad785ef
Moving things
sebastienros 1bd23ae
Merge remote-tracking branch 'origin/main' into sebros/sbpersist
sebastienros File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using System.Buffers; | ||
using System.Security.Cryptography; | ||
using IdentityModel; | ||
using Microsoft.Extensions.SecretManager.Tools.Internal; | ||
|
||
namespace Aspire.Hosting.Utils; | ||
|
||
internal sealed class AspireStore : KeyValueStore | ||
sebastienros marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
private readonly string _storeBasePath; | ||
private const string StoreFileName = "aspire.json"; | ||
private static readonly SearchValues<char> s_invalidChars = SearchValues.Create(['/', '\\', '?', '%', '*', ':', '|', '"', '<', '>', '.', ' ']); | ||
|
||
private AspireStore(string basePath) | ||
: base(Path.Combine(basePath, StoreFileName)) | ||
{ | ||
ArgumentNullException.ThrowIfNull(basePath); | ||
|
||
_storeBasePath = basePath; | ||
} | ||
|
||
/// <summary> | ||
/// Creates a new instance of <see cref="AspireStore"/> using the provided <paramref name="builder"/>. | ||
/// </summary> | ||
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param> | ||
/// <returns>A new instance of <see cref="AspireStore"/>.</returns> | ||
/// <remarks> | ||
/// The store is created in the following locations: | ||
/// - On Windows: %APPDATA%\Aspire\{applicationHash}\aspire.json | ||
/// - On Mac/Linux: ~/.aspire/{applicationHash}\aspire.json | ||
/// - If none of the above locations are available, the store is created in the directory specified by the ASPIRE_STORE_FALLBACK_DIR environment variable. | ||
/// - If the ASPIRE_STORE_FALLBACK_DIR environment variable is not set, an <see cref="InvalidOperationException"/> is thrown. | ||
/// | ||
/// The directory has the permissions set to 700 on Unix systems. | ||
/// </remarks> | ||
public static AspireStore Create(IDistributedApplicationBuilder builder) | ||
{ | ||
ArgumentNullException.ThrowIfNull(builder); | ||
|
||
const string aspireStoreFallbackDir = "ASPIRE_STORE_FALLBACK_DIR"; | ||
|
||
var appData = Environment.GetEnvironmentVariable("APPDATA"); | ||
var root = appData // On Windows it goes to %APPDATA%\Microsoft\UserSecrets\ | ||
?? Environment.GetEnvironmentVariable("HOME") // On Mac/Linux it goes to ~/.microsoft/usersecrets/ | ||
?? Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData) | ||
?? Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) | ||
?? Environment.GetEnvironmentVariable(aspireStoreFallbackDir); // this fallback is an escape hatch if everything else fails | ||
|
||
if (string.IsNullOrEmpty(root)) | ||
{ | ||
throw new InvalidOperationException($"Could not determine an appropriate location for storing user secrets. Set the {aspireStoreFallbackDir} environment variable to a folder where Aspire content should be stored."); | ||
} | ||
|
||
var appName = Sanitize(builder.Environment.ApplicationName).ToLowerInvariant(); | ||
var appNameHash = builder.Configuration["AppHost:Sha256"]![..10].ToLowerInvariant(); | ||
|
||
var directoryPath = !string.IsNullOrEmpty(appData) | ||
? Path.Combine(root, "Aspire", $"{appName}.{appNameHash}") | ||
: Path.Combine(root, ".aspire", $"{appName}.{appNameHash}"); | ||
|
||
return new AspireStore(directoryPath); | ||
} | ||
|
||
protected override void EnsureDirectory() | ||
{ | ||
var directoryName = Path.GetDirectoryName(FilePath); | ||
if (!string.IsNullOrEmpty(directoryName) && !Directory.Exists(directoryName)) | ||
{ | ||
if (!OperatingSystem.IsWindows()) | ||
{ | ||
var tempDir = Directory.CreateTempSubdirectory(); | ||
tempDir.MoveTo(directoryName); | ||
} | ||
else | ||
{ | ||
Directory.CreateDirectory(directoryName); | ||
} | ||
} | ||
} | ||
|
||
public string GetOrCreateFileWithContent(string filename, Stream contentStream) | ||
{ | ||
// THIS HASN'T BEEN TESTED YET. FOR DISCUSSIONS ONLY. | ||
|
||
ArgumentNullException.ThrowIfNullOrWhiteSpace(filename); | ||
ArgumentNullException.ThrowIfNull(contentStream); | ||
|
||
EnsureDirectory(); | ||
|
||
// Strip any folder information from the filename. | ||
filename = Path.GetFileName(filename); | ||
|
||
// Delete existing file versions with the same name. | ||
var allFiles = Directory.EnumerateFiles(_storeBasePath, filename + ".*"); | ||
|
||
foreach (var file in allFiles) | ||
{ | ||
try | ||
{ | ||
File.Delete(file); | ||
} | ||
catch | ||
{ | ||
} | ||
} | ||
|
||
// Create a temporary file to write the content to. | ||
var tempFileName = Path.GetTempFileName(); | ||
|
||
// Write the content to the temporary file. | ||
using (var fileStream = File.OpenWrite(tempFileName)) | ||
{ | ||
contentStream.CopyTo(fileStream); | ||
} | ||
|
||
// Compute the hash of the content. | ||
var hash = SHA256.HashData(File.ReadAllBytes(tempFileName)); | ||
|
||
// Move the temporary file to the final location. | ||
// TODO: Use System.Buffers.Text implementation when targeting .NET 9.0 or greater | ||
var finalFilePath = Path.Combine(_storeBasePath, filename, ".", Base64Url.Encode(hash).ToLowerInvariant()); | ||
File.Move(tempFileName, finalFilePath, overwrite: false); | ||
|
||
// If the file already exists, delete the temporary file. | ||
if (File.Exists(tempFileName)) | ||
{ | ||
File.Delete(tempFileName); | ||
} | ||
|
||
return finalFilePath; | ||
} | ||
|
||
/// <summary> | ||
/// Creates a file with the provided <paramref name="filename"/> if it does not exist. | ||
/// </summary> | ||
/// <param name="filename"></param> | ||
/// <returns></returns> | ||
public string GetOrCreateFile(string filename) | ||
{ | ||
EnsureDirectory(); | ||
|
||
// Strip any folder information from the filename. | ||
filename = Path.GetFileName(filename); | ||
|
||
var finalFilePath = Path.Combine(_storeBasePath, filename); | ||
|
||
if (!File.Exists(finalFilePath)) | ||
{ | ||
var tempFileName = Path.GetTempFileName(); | ||
File.Move(tempFileName, finalFilePath, overwrite: false); | ||
} | ||
|
||
return finalFilePath; | ||
} | ||
|
||
/// <summary> | ||
/// Removes any unwanted characters from the <paramref name="filename"/>. | ||
/// </summary> | ||
internal static string Sanitize(string filename) | ||
{ | ||
return string.Create(filename.Length, filename, static (s, name) => | ||
{ | ||
var nameSpan = name.AsSpan(); | ||
|
||
for (var i = 0; i < nameSpan.Length; i++) | ||
{ | ||
var c = nameSpan[i]; | ||
|
||
s[i] = s_invalidChars.Contains(c) ? '_' : c; | ||
} | ||
}); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.