Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve CosmosClient initialization ergonomics #4405

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+37 −19
Open

Improve CosmosClient initialization ergonomics #4405

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6efa8a7
Make `InitializeContainersAsync` public
onionhammer Apr 11, 2024
adfeaf2
Added missing doccomment
onionhammer Apr 12, 2024
f282d6b
Only the async factory method should dispose on exception
onionhammer Apr 12, 2024
dde8fc3
Pre-allocate enough room in tasks list, allow cancellationtoken to be…
onionhammer Apr 12, 2024
d7f73da
Added additional doccomment to describe behavior of internal vs non-i…
onionhammer Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 37 additions & 19 deletions Microsoft.Azure.Cosmos/src/CosmosClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ protected CosmosClient()
authKeyOrResourceToken,
cosmosClientOptions);

await cosmosClient.InitializeContainersAsync(containers, cancellationToken);
await cosmosClient.InitializeContainersInternalAsync(containers, cancellationToken);
return cosmosClient;
}

Expand Down Expand Up @@ -463,7 +463,7 @@ protected CosmosClient()
authKeyOrResourceTokenCredential,
cosmosClientOptions);

await cosmosClient.InitializeContainersAsync(containers, cancellationToken);
await cosmosClient.InitializeContainersInternalAsync(containers, cancellationToken);
return cosmosClient;
}

Expand Down Expand Up @@ -516,7 +516,7 @@ protected CosmosClient()
CosmosClient cosmosClient = new CosmosClient(connectionString,
cosmosClientOptions);

await cosmosClient.InitializeContainersAsync(containers, cancellationToken);
await cosmosClient.InitializeContainersInternalAsync(containers, cancellationToken);
return cosmosClient;
}

Expand Down Expand Up @@ -551,7 +551,7 @@ protected CosmosClient()
tokenCredential,
cosmosClientOptions);

await cosmosClient.InitializeContainersAsync(containers, cancellationToken);
await cosmosClient.InitializeContainersInternalAsync(containers, cancellationToken);
return cosmosClient;
}

Expand Down Expand Up @@ -1391,26 +1391,44 @@ internal DatabaseProperties PrepareDatabaseProperties(string id)
/// <param name="containers">A read-only list containing the database id
/// and their respective container id.</param>
/// <param name="cancellationToken">An instance of <see cref="CancellationToken"/>.</param>
internal async Task InitializeContainersAsync(
/// <returns>A task to await on.</returns>
public async Task InitializeContainersAsync(
IReadOnlyList<(string databaseId, string containerId)> containers,
CancellationToken cancellationToken = default)
{
List<Task> tasks = new (containers.Count);
foreach ((string databaseId, string containerId) in containers)
{
ContainerInternal container = (ContainerInternal)this.GetContainer(
databaseId,
containerId);

tasks.Add(this.ClientContext.InitializeContainerUsingRntbdAsync(
databaseId: databaseId,
containerLinkUri: container.LinkUri,
cancellationToken: cancellationToken));
}

await Task.WhenAll(tasks);
}

/// <summary>
/// Initializes the container by creating the Rntbd
/// connection to all of the backend replica nodes.
///
/// Disposes the client if the initialization fails.
/// </summary>
/// <param name="containers">A read-only list containing the database id
/// and their respective container id.</param>
/// <param name="cancellationToken">An instance of <see cref="CancellationToken"/>.</param>
/// <returns>A task to await on.</returns>
internal async Task InitializeContainersInternalAsync(
IReadOnlyList<(string databaseId, string containerId)> containers,
CancellationToken cancellationToken)
{
try
{
List<Task> tasks = new ();
foreach ((string databaseId, string containerId) in containers)
{
ContainerInternal container = (ContainerInternal)this.GetContainer(
databaseId,
containerId);

tasks.Add(this.ClientContext.InitializeContainerUsingRntbdAsync(
databaseId: databaseId,
containerLinkUri: container.LinkUri,
cancellationToken: cancellationToken));
}

await Task.WhenAll(tasks);
await InitializeContainersAsync(containers, cancellationToken);
}
catch
{
Expand Down