Azure cosmosdb support in aspire #359
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.ApplicationModel; | ||
| using Aspire.Hosting.Azure.Data.Cosmos; | ||
| using System.Text.Json; | ||
|
|
||
| namespace Aspire.Hosting; | ||
|
|
||
| /// <summary> | ||
| /// Provides extension methods for adding Azure Cosmos DB resources to an <see cref="IDistributedApplicationBuilder"/>. | ||
| /// </summary> | ||
| public static class AzureCosmosDBCloudApplicationBuilderExtensions | ||
| { | ||
| /// <summary> | ||
| /// Adds an Azure Cosmos DB connection to the application model. | ||
| /// </summary> | ||
| /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param> | ||
| /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param> | ||
| /// <param name="connectionString">The connection string.</param> | ||
| /// <returns>A reference to the <see cref="IResourceBuilder{AzureCosmosDatabaseResource}"/>.</returns> | ||
| public static IResourceBuilder<AzureCosmosDBConnectionResource> AddAzureCosmosDB( | ||
| this IDistributedApplicationBuilder builder, | ||
| string name, | ||
| string? connectionString = null) | ||
| { | ||
| var connection = new AzureCosmosDBConnectionResource(name, connectionString); | ||
| return builder.AddResource(connection) | ||
| .WithAnnotation(new ManifestPublishingCallbackAnnotation(jsonWriter => WriteCosmosDBConnectionToManifest(jsonWriter, connection))); | ||
| } | ||
|
|
||
| private static void WriteCosmosDBConnectionToManifest(Utf8JsonWriter jsonWriter, AzureCosmosDBConnectionResource cosmosDbConnection) | ||
| { | ||
| jsonWriter.WriteString("type", "azure.cosmosdb.connection.v0"); | ||
| jsonWriter.WriteString("connectionString", cosmosDbConnection.GetConnectionString()); | ||
| } | ||
|
|
||
| private static void WriteCosmosDBDatabaseToManifest(Utf8JsonWriter jsonWriter, AzureCosmosDatabaseResource cosmosDatabase) | ||
| { | ||
| jsonWriter.WriteString("type", "azure.cosmosdb.database.v0"); | ||
| jsonWriter.WriteString("parent", cosmosDatabase.Parent.Name); | ||
| jsonWriter.WriteString("databaseName", cosmosDatabase.Name); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Adds an Azure Cosmos DB database to a <see cref="IResourceBuilder{AzureCosmosDatabaseResource}"/>. | ||
| /// </summary> | ||
| /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param> | ||
| /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param> | ||
| /// <returns>A reference to the <see cref="IResourceBuilder{AzureCosmosDatabaseResource}"/>.</returns> | ||
| public static IResourceBuilder<AzureCosmosDatabaseResource> AddDatabase(this IResourceBuilder<AzureCosmosDBConnectionResource> builder, string name) | ||
| { | ||
| var cosmosDatabase = new AzureCosmosDatabaseResource(name, builder.Resource); | ||
| return builder | ||
| .ApplicationBuilder | ||
| .AddResource(cosmosDatabase) | ||
| .WithAnnotation(new ManifestPublishingCallbackAnnotation( | ||
| (json) => WriteCosmosDBDatabaseToManifest(json, cosmosDatabase))); | ||
| } | ||
| } |
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,21 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.ApplicationModel; | ||
|
|
||
| namespace Aspire.Hosting.Azure.Data.Cosmos; | ||
|
|
||
| /// <summary> | ||
| /// Represents a connection to an Azure Cosmos DB account. | ||
| /// </summary> | ||
| /// <param name="name">The resource name.</param> | ||
| /// <param name="connectionString">The connection string to use to connect.</param> | ||
| public class AzureCosmosDBConnectionResource(string name, string? connectionString) | ||
| : Resource(name), IResourceWithConnectionString | ||
| { | ||
| /// <summary> | ||
| /// Gets the connection string to use for this database. | ||
| /// </summary> | ||
| /// <returns>The connection string to use for this database.</returns> | ||
| public string? GetConnectionString() => connectionString; | ||
| } |
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,29 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Hosting.ApplicationModel; | ||
|
|
||
| namespace Aspire.Hosting.Azure.Data.Cosmos; | ||
|
|
||
| /// <summary> | ||
| /// Represents an Azure Cosmos DB database. | ||
| /// </summary> | ||
| /// <param name="name">The database name.</param> | ||
| /// <param name="parent">The parent <see cref="AzureCosmosDBConnectionResource"/>.</param> | ||
| public class AzureCosmosDatabaseResource(string name, AzureCosmosDBConnectionResource parent) | ||
| : Resource(name), IResourceWithParent<AzureCosmosDBConnectionResource>, IResourceWithConnectionString | ||
| { | ||
| /// <summary> | ||
| /// Gets the parent <see cref="AzureCosmosDBConnectionResource"/>. | ||
| /// </summary> | ||
| public AzureCosmosDBConnectionResource Parent { get; } = parent; | ||
|
|
||
| /// <summary> | ||
| /// Gets the connection string to use for this database. | ||
| /// </summary> | ||
| /// <returns>The connection string to use for this database.</returns> | ||
| public string? GetConnectionString() | ||
| { | ||
| return Parent.GetConnectionString(); | ||
| } | ||
| } |
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,20 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>$(NetCurrent)</TargetFramework> | ||
| <IsPackable>true</IsPackable> | ||
| <EnableConfigurationBindingGenerator>false</EnableConfigurationBindingGenerator> | ||
| <IsAotCompatible>false</IsAotCompatible> | ||
|
Pilchie marked this conversation as resolved.
|
||
| <PackageTags>$(ComponentAzurePackageTags) cosmos cosmosdb data database db</PackageTags> | ||
| <Description>A client for Azure Cosmos DB that integrates with Aspire, including logging and telemetry.</Description> | ||
| <PackageIconFullPath>$(SharedDir)AzureCosmosDB_256x.png</PackageIconFullPath> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Azure.Identity" /> | ||
| <PackageReference Include="Microsoft.Azure.Cosmos" /> | ||
| <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" /> | ||
| <PackageReference Include="OpenTelemetry.Extensions.Hosting" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
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,126 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Aspire.Microsoft.Azure.Cosmos; | ||
| using Azure.Identity; | ||
| using Microsoft.Azure.Cosmos; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
|
|
||
| namespace Microsoft.Extensions.Hosting; | ||
|
|
||
| /// <summary> | ||
| /// Azure CosmosDB extension | ||
| /// </summary> | ||
| public static class AspireAzureCosmosDBExtensions | ||
| { | ||
| private const string DefaultConfigSectionName = "Aspire:Microsoft:Azure:Cosmos"; | ||
|
|
||
| /// <summary> | ||
| /// Registers <see cref="CosmosClient" /> as a singleton in the services provided by the <paramref name="builder"/>. | ||
| /// Configures logging and telemetry for the <see cref="CosmosClient" />. | ||
| /// </summary> | ||
| /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param> | ||
| /// <param name="connectionName">The connection name to use to find a connection string.</param> | ||
| /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="AzureCosmosDBSettings"/>. It's invoked after the settings are read from the configuration.</param> | ||
| /// <param name="configureClientOptions">An optional method that can be used for customizing the <see cref="CosmosClientOptions"/>.</param> | ||
| /// <remarks>Reads the configuration from "Aspire:Microsoft:Azure:Cosmos" section.</remarks> | ||
| /// <exception cref="InvalidOperationException">If required ConnectionString is not provided in configuration section</exception> | ||
| public static void AddAzureCosmosDB( | ||
| this IHostApplicationBuilder builder, | ||
| string connectionName, | ||
| Action<AzureCosmosDBSettings>? configureSettings = null, | ||
| Action<CosmosClientOptions>? configureClientOptions = null) | ||
| { | ||
| AddAzureCosmosDB(builder, DefaultConfigSectionName, configureSettings, configureClientOptions, connectionName, serviceKey: null); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Registers <see cref="CosmosClient" /> as a singleton for given <paramref name="name" /> in the services provided by the <paramref name="builder"/>. | ||
| /// Configures logging and telemetry for the <see cref="CosmosClient" />. | ||
| /// </summary> | ||
| /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param> | ||
| /// <param name="name">The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve the connection string from the ConnectionStrings configuration section.</param> | ||
| /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="AzureCosmosDBSettings"/>. It's invoked after the settings are read from the configuration.</param> | ||
| /// <param name="configureClientOptions">An optional method that can be used for customizing the <see cref="CosmosClientOptions"/>.</param> | ||
| /// <remarks>Reads the configuration from "Aspire:Microsoft:Azure:Cosmos:{name}" section.</remarks> | ||
| /// <exception cref="InvalidOperationException">If required ConnectionString is not provided in configuration section</exception> | ||
| public static void AddKeyedAzureCosmosDB( | ||
| this IHostApplicationBuilder builder, | ||
| string name, | ||
| Action<AzureCosmosDBSettings>? configureSettings = null, | ||
| Action<CosmosClientOptions>? configureClientOptions = null) | ||
| { | ||
| AddAzureCosmosDB(builder, $"{DefaultConfigSectionName}:{name}", configureSettings, configureClientOptions, connectionName: name, serviceKey: name); | ||
| } | ||
|
|
||
| private static void AddAzureCosmosDB( | ||
| this IHostApplicationBuilder builder, | ||
| string configurationSectionName, | ||
| Action<AzureCosmosDBSettings>? configureSettings, | ||
| Action<CosmosClientOptions>? configureClientOptions, | ||
| string connectionName, | ||
| string? serviceKey) | ||
| { | ||
| ArgumentNullException.ThrowIfNull(builder); | ||
|
|
||
| var settings = new AzureCosmosDBSettings(); | ||
| builder.Configuration.GetSection(configurationSectionName).Bind(settings); | ||
|
|
||
| if (builder.Configuration.GetConnectionString(connectionName) is string connectionString) | ||
| { | ||
| if (Uri.TryCreate(connectionString, UriKind.Absolute, out var uri)) | ||
| { | ||
| settings.AccountEndpoint = uri; | ||
| } | ||
| else | ||
| { | ||
| settings.ConnectionString = connectionString; | ||
| } | ||
| } | ||
|
|
||
| configureSettings?.Invoke(settings); | ||
|
|
||
| var clientOptions = new CosmosClientOptions(); | ||
| // Needs to be enabled for either logging or tracing to work. | ||
| clientOptions.CosmosClientTelemetryOptions.DisableDistributedTracing = false; | ||
| if (settings.Tracing) | ||
| { | ||
| builder.Services.AddOpenTelemetry().WithTracing(tracerProviderBuilder => | ||
| { | ||
| tracerProviderBuilder.AddSource("Azure.Cosmos.Operation"); | ||
| }); | ||
| } | ||
|
|
||
| configureClientOptions?.Invoke(clientOptions); | ||
|
Member
There was a problem hiding this comment. The
Member
Author
There was a problem hiding this comment. That's on my todolist, but it's not easy, since I don't think many parts of the
Member
There was a problem hiding this comment. What I've been doing is walking through the type and looking for simple properties. You can see all of them in the other Azure components schema, or in the RabbitMQ schema I just did a few days ago: And then add a test for it like so:
Member
Author
There was a problem hiding this comment. Can we consider merging this and I'll expand on that in a separate PR? |
||
|
|
||
| if (serviceKey is null) | ||
| { | ||
| builder.Services.AddSingleton(_ => ConfigureDb()); | ||
| } | ||
| else | ||
| { | ||
| builder.Services.AddKeyedSingleton(serviceKey, (sp, key) => ConfigureDb()); | ||
| } | ||
|
|
||
| CosmosClient ConfigureDb() | ||
| { | ||
| if (!string.IsNullOrEmpty(settings.ConnectionString)) | ||
| { | ||
| return new CosmosClient(settings.ConnectionString, clientOptions); | ||
| } | ||
| else if (settings.AccountEndpoint is not null) | ||
| { | ||
| var credential = settings.Credential ?? new DefaultAzureCredential(); | ||
| return new CosmosClient(settings.AccountEndpoint.OriginalString, credential, clientOptions); | ||
| } | ||
| else | ||
| { | ||
| throw new InvalidOperationException( | ||
| $"A CosmosClient could not be configured. Ensure valid connection information was provided in 'ConnectionStrings:{connectionName}' or either " + | ||
| $"{nameof(settings.ConnectionString)} or {nameof(settings.AccountEndpoint)} must be provided " + | ||
| $"in the '{configurationSectionName}' configuration section."); | ||
| } | ||
| } | ||
| } | ||
| } | ||
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,39 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Azure.Core; | ||
|
|
||
| namespace Aspire.Microsoft.Azure.Cosmos; | ||
|
|
||
| /// <summary> | ||
| /// The settings relevant to accessing Azure Cosmos DB. | ||
| /// </summary> | ||
| public sealed class AzureCosmosDBSettings | ||
| { | ||
| /// <summary> | ||
| /// Gets or sets the connection string of the Azure Cosmos database to connect to. | ||
| /// </summary> | ||
| public string? ConnectionString { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// <para>Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is enabled or not.</para> | ||
| /// <para>Enabled by default.</para> | ||
| /// </summary> | ||
| public bool Tracing { get; set; } = true; | ||
|
|
||
| /// <summary> | ||
| /// A <see cref="Uri"/> referencing the Azure Cosmos DB Endpoint. | ||
| /// This is likely to be similar to "https://{account_name}.queue.core.windows.net". | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Must not contain shared access signature. | ||
| /// Used along with <see cref="Credential"/> to establish the connection. | ||
| /// </remarks> | ||
| public Uri? AccountEndpoint { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the credential used to authenticate to the Azure Cosmos DB endpoint. | ||
| /// </summary> | ||
| public TokenCredential? Credential { get; set; } | ||
| } | ||
|
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like 3.36.0 is out now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CosmosDB does versioning wrong right now :(. 3.36.0-preview is actually 3.36.0 + preview stuff. In this case it's the difference between distributed tracing being on or off by default, so I'm happy to change if you want.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is some messed up versioning for sure. Definitely not how the rest of the ecosystem does it.