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

Update azure azure-sdk-for-net monorepo #939

Merged
merged 3 commits into from
Apr 17, 2024
Merged

Update azure azure-sdk-for-net monorepo #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a7dca7
Update azure azure-sdk-for-net monorepo
renovate[bot] Apr 16, 2024
fdc209b
Fix tests and mark obsolete
wsugarman Apr 17, 2024
3ae9e85
Remove usage of obsolete function
wsugarman Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

<ItemGroup>
<PackageVersion Include="Azure.Core" Version="1.38.0" />
<PackageVersion Include="Azure.Identity" Version="1.10.4" />
<PackageVersion Include="Azure.Messaging.EventGrid" Version="4.23.0" />
<PackageVersion Include="Azure.Identity" Version="1.11.1" />
<PackageVersion Include="Azure.Messaging.EventGrid" Version="4.24.0" />
<PackageVersion Include="Azure.Security.KeyVault.Keys" Version="4.6.0" />
<PackageVersion Include="Azure.Storage.Blobs" Version="12.19.1" />
<PackageVersion Include="Azure.Storage.Common" Version="12.18.1" />
Expand Down Expand Up @@ -31,7 +31,7 @@
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.9.2" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.9.2" />
<PackageVersion Include="Microsoft.Data.SqlClient" Version="5.2.0" />
<PackageVersion Include="Microsoft.Extensions.Azure" Version="1.7.2" />
<PackageVersion Include="Microsoft.Extensions.Azure" Version="1.7.3" />
<PackageVersion Include="Microsoft.Extensions.Configuration" Version="$(SdkPackageVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Abstractions" Version="$(SdkPackageVersion)" />
<PackageVersion Include="Microsoft.Extensions.Configuration.CommandLine" Version="$(SdkPackageVersion)" />
Expand Down
8 changes: 2 additions & 6 deletions src/Microsoft.Health.Blob/Registration/BlobClientRegistrationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
using Microsoft.Health.Blob.Configs;
using Microsoft.Health.Blob.Features.Storage;
using Microsoft.Health.Blob.Registration;
using Microsoft.Health.Core.Extensions;
using Microsoft.IO;

namespace Microsoft.Extensions.DependencyInjection;
Expand Down Expand Up @@ -125,8 +124,7 @@ public static IServiceCollection AddBlobServiceClient(
IAzureClientBuilder<BlobServiceClient, BlobClientOptions> clientBuilder;
if (string.IsNullOrWhiteSpace(options.ConnectionString) && options.ServiceUri == null)
{
clientBuilder = builder
.AddBlobServiceClient(BlobLocalEmulator.ConnectionString);
clientBuilder = builder.AddBlobServiceClient(BlobLocalEmulator.ConnectionString);
}
else if (string.Equals(options.Credential, "managedidentity", StringComparison.OrdinalIgnoreCase))
{
Expand All @@ -138,9 +136,7 @@ public static IServiceCollection AddBlobServiceClient(
}
else
{
clientBuilder = builder
.AddBlobServiceClient(configuration)
.WithRetryableCredential(configuration);
clientBuilder = builder.AddBlobServiceClient(configuration);
}

// Add optional BlobClientOptions
Expand Down
43 changes: 24 additions & 19 deletions src/Microsoft.Health.Core.UnitTests/Extensions/IAzureClientBuilderExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Reflection;
using Azure.Core;
Expand All @@ -20,6 +19,7 @@

namespace Microsoft.Health.Core.UnitTests.Extensions;

[Obsolete("The retry behavior for IMDS has been improved in Azure.Identity and prevents overriding MaxRetries.")]
public class IAzureClientBuilderExtensionsTests
{
private static readonly Assembly AzureCoreAssembly = typeof(TokenCredential).Assembly;
Expand All @@ -29,15 +29,15 @@ public class IAzureClientBuilderExtensionsTests
public void GivenNoConfiguration_WhenConfiguringManagedIdentity_ThenUseDefaults()
{
string clientId = Guid.NewGuid().ToString();
RetryOptions expectedOptions = CreateRetryOptions();
RetryOptions expectedOptions = CreateRetryOptions(isManagedIdentity: true);

IConfiguration config = new ConfigurationBuilder()
.AddInMemoryCollection(new KeyValuePair<string, string>[]
{
.AddInMemoryCollection(
[
new KeyValuePair<string, string>("serviceUri", "https://127.0.0.1:10000/devstoreaccount1"),
new KeyValuePair<string, string>("clientId", clientId),
new KeyValuePair<string, string>("credential", "managedidentity"),
})
])
.Build();

ManagedIdentityCredential actualCredential = AssertTokenCredential<ManagedIdentityCredential>(config);
Expand All @@ -52,21 +52,22 @@ public void GivenConfiguration_WhenConfiguringManagedIdentity_ThenUseRetrySettin
RetryOptions expectedOptions = CreateRetryOptions(
delay: TimeSpan.FromSeconds(2),
maxDelay: TimeSpan.FromMinutes(1),
maxRetries: 12,
networkTimeout: TimeSpan.FromMinutes(5));
maxRetries: null, // This value is overridden by Azure.Identity for ManagedIdentityCredential to 5
networkTimeout: TimeSpan.FromMinutes(5),
isManagedIdentity: true);

IConfiguration config = new ConfigurationBuilder()
.AddInMemoryCollection(new KeyValuePair<string, string>[]
{
.AddInMemoryCollection(
[
new KeyValuePair<string, string>("serviceUri", "https://127.0.0.1:10000/devstoreaccount1"),
new KeyValuePair<string, string>("clientId", clientId),
new KeyValuePair<string, string>("credential", "managedidentity"),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.Delay)}", expectedOptions.Delay.ToString()),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.MaxDelay)}", expectedOptions.MaxDelay.ToString()),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.MaxRetries)}", expectedOptions.MaxRetries.ToString(CultureInfo.InvariantCulture)),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.MaxRetries)}", "12"),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.Mode)}", expectedOptions.Mode.ToString()),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.NetworkTimeout)}", expectedOptions.NetworkTimeout.ToString()),
})
])
.Build();

ManagedIdentityCredential actualCredential = AssertTokenCredential<ManagedIdentityCredential>(config);
Expand All @@ -77,16 +78,16 @@ public void GivenConfiguration_WhenConfiguringManagedIdentity_ThenUseRetrySettin
[Fact]
public void GivenOtherCredentialType_WhenConfiguringCredential_ThenSkipAndUseDefaults()
{
RetryOptions expectedOptions = CreateRetryOptions();
RetryOptions expectedOptions = CreateRetryOptions(isManagedIdentity: false);

IConfiguration config = new ConfigurationBuilder()
.AddInMemoryCollection(new KeyValuePair<string, string>[]
{
.AddInMemoryCollection(
[
new KeyValuePair<string, string>("serviceUri", "https://127.0.0.1:10000/devstoreaccount1"),
new KeyValuePair<string, string>("clientId", Guid.NewGuid().ToString()),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.Delay)}", "00:52:00"),
new KeyValuePair<string, string>($"credentialRetry:{nameof(RetryOptions.MaxRetries)}", "17"),
})
])
.Build();

DefaultAzureCredential actualCredential = AssertTokenCredential<DefaultAzureCredential>(config);
Expand All @@ -96,14 +97,18 @@ public void GivenOtherCredentialType_WhenConfiguringCredential_ThenSkipAndUseDef
private static RetryOptions CreateRetryOptions(
TimeSpan? delay = null,
TimeSpan? maxDelay = null,
int maxRetries = 3,
int? maxRetries = null,
RetryMode mode = RetryMode.Exponential,
TimeSpan? networkTimeout = null)
TimeSpan? networkTimeout = null,
bool isManagedIdentity = false)
{
// Note: By default, the Azure.Identity library uses 5 retries for IMDS
int defaultRetries = isManagedIdentity ? 5 : 3;

var options = Activator.CreateInstance(typeof(RetryOptions), nonPublic: true) as RetryOptions;
options.Delay = delay ?? TimeSpan.FromSeconds(0.8);
options.MaxDelay = maxDelay ?? TimeSpan.FromMinutes(1);
options.MaxRetries = maxRetries;
options.MaxRetries = maxRetries.HasValue ? maxRetries.GetValueOrDefault() : defaultRetries;
options.Mode = mode;
options.NetworkTimeout = networkTimeout ?? TimeSpan.FromSeconds(100);

Expand Down Expand Up @@ -155,7 +160,7 @@ private static void AssertRetryOptions<T>(RetryOptions expected, T actualCredent
.GetValue(httpPipeline);

// Validate RetryPolicy
var actualRetryPolicy = policies.ToArray().Single(x => x.GetType() == typeof(RetryPolicy)) as RetryPolicy;
var actualRetryPolicy = policies.ToArray().Single(x => x.GetType().IsAssignableTo(typeof(RetryPolicy))) as RetryPolicy;
var delayStrategy = typeof(RetryPolicy)
.GetField("_delayStrategy", BindingFlags.NonPublic | BindingFlags.Instance)
.GetValue(actualRetryPolicy) as DelayStrategy;
Expand Down
1 change: 1 addition & 0 deletions src/Microsoft.Health.Core/Extensions/IAzureClientBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ public static class IAzureClientBuilderExtensions
/// <exception cref="ArgumentNullException">
/// <paramref name="builder"/> or <paramref name="configuration"/> is <see langword="null"/>.
/// </exception>
[Obsolete("The retry behavior for IMDS has been improved in Azure.Identity and prevents overriding MaxRetries.")]
public static IAzureClientBuilder<TClient, TOptions> WithRetryableCredential<TClient, TOptions>(
this IAzureClientBuilder<TClient, TOptions> builder,
IConfiguration configuration)
Expand Down