Skip to content

Fix bug with endpoint failover #686

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

Merged
merged 8 commits into from
Aug 5, 2025
Merged

Fix bug with endpoint failover #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bba05b0
update endpoint in do while
amerjusupovic Jun 24, 2025
4d4be49
add test
amerjusupovic Jun 24, 2025
d38fe14
in progress
amerjusupovic Jun 26, 2025
82edede
update test, update logic to backoff using correct endpoint
amerjusupovic Jun 26, 2025
0103c1d
make test more specific
amerjusupovic Jun 26, 2025
559a1dc
Merge branch 'main' into ajusupovic/backoffallclients-bug
amerjusupovic Jun 26, 2025
4e78969
Merge branch 'main' into ajusupovic/backoffallclients-bug
amerjusupovic Jun 30, 2025
93d5791
Merge branch 'main' into ajusupovic/backoffallclients-bug
zhiyuanliang-ms Jul 31, 2025
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
2 changes: 1 addition & 1 deletion ...Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1214,7 +1214,7 @@ private async Task<T> ExecuteWithFailOverPolicyAsync<T>(

do
{
UpdateClientBackoffStatus(previousEndpoint, success);
UpdateClientBackoffStatus(_configClientManager.GetEndpointForClient(currentClient), success);

clientEnumerator.MoveNext();

Expand Down
84 changes: 84 additions & 0 deletions tests/Tests.AzureAppConfiguration/Unit/FailoverTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,5 +415,89 @@ ae.InnerException is AggregateException ae2 &&
ae2.InnerExceptions.All(ex => ex is TaskCanceledException) &&
ae2.InnerException is TaskCanceledException tce);
}

[Fact]
public async Task FailOverTests_AllClientsBackedOffAfterNonFailoverableException()
{
IConfigurationRefresher refresher = null;
var mockResponse = new Mock<Response>();

// Setup first client - succeeds on startup, fails with 404 (non-failoverable) on first refresh
var mockClient1 = new Mock<ConfigurationClient>();
mockClient1.SetupSequence(c => c.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()))
.Returns(new MockAsyncPageable(Enumerable.Empty<ConfigurationSetting>().ToList()))
.Throws(new RequestFailedException(412, "Request failed."))
.Throws(new RequestFailedException(412, "Request failed."));
mockClient1.SetupSequence(c => c.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()))
.Returns(Task.FromResult(Response.FromValue<ConfigurationSetting>(kv, mockResponse.Object)))
.Throws(new RequestFailedException(412, "Request failed."))
.Throws(new RequestFailedException(412, "Request failed."));
mockClient1.SetupSequence(c => c.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()))
.Throws(new RequestFailedException(412, "Request failed."))
.Throws(new RequestFailedException(412, "Request failed."));
mockClient1.Setup(c => c.Equals(mockClient1)).Returns(true);

// Setup second client - succeeds on startup, should not be called during refresh
var mockClient2 = new Mock<ConfigurationClient>();
mockClient2.Setup(c => c.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()))
.Returns(new MockAsyncPageable(Enumerable.Empty<ConfigurationSetting>().ToList()));
mockClient2.Setup(c => c.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()))
.Returns(Task.FromResult(Response.FromValue<ConfigurationSetting>(kv, mockResponse.Object)));
mockClient2.Setup(c => c.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()))
.Returns(Task.FromResult(Response.FromValue<ConfigurationSetting>(kv, mockResponse.Object)));
mockClient2.Setup(c => c.Equals(mockClient2)).Returns(true);

ConfigurationClientWrapper cw1 = new ConfigurationClientWrapper(TestHelpers.PrimaryConfigStoreEndpoint, mockClient1.Object);
ConfigurationClientWrapper cw2 = new ConfigurationClientWrapper(TestHelpers.SecondaryConfigStoreEndpoint, mockClient2.Object);

var clientList = new List<ConfigurationClientWrapper>() { cw1, cw2 };
var configClientManager = new ConfigurationClientManager(clientList);

// Verify 2 clients are available
Assert.Equal(2, configClientManager.GetClients().Count());

// Act & Assert - Build configuration successfully with both clients
var config = new ConfigurationBuilder()
.AddAzureAppConfiguration(options =>
{
options.ClientManager = configClientManager;
options.Select("TestKey*");
options.ConfigureRefresh(refreshOptions =>
{
refreshOptions.Register("TestKey1", "label")
.SetRefreshInterval(TimeSpan.FromSeconds(1));
});

options.ReplicaDiscoveryEnabled = false;
refresher = options.GetRefresher();
}).Build();

// First refresh - should call client 1 and fail with non-failoverable exception
// This should cause all clients to be backed off
await Task.Delay(1500);
await refresher.TryRefreshAsync();

// Verify that client 1 was called during the first refresh
mockClient1.Verify(mc => mc.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()), Times.Exactly(1));
mockClient1.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Exactly(1));
mockClient1.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()), Times.Exactly(1));

// Verify that client 2 was not called during the first refresh
mockClient2.Verify(mc => mc.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()), Times.Never);
mockClient2.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Never);
mockClient2.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()), Times.Never);

// Second refresh - no clients should be called as all are backed off
await Task.Delay(1500);
await refresher.TryRefreshAsync();

// Verify that no additional calls were made to any client during the second refresh
mockClient1.Verify(mc => mc.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()), Times.Exactly(1));
mockClient1.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Exactly(1));
mockClient1.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()), Times.Exactly(1));
mockClient2.Verify(mc => mc.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()), Times.Never);
mockClient2.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Never);
mockClient2.Verify(mc => mc.GetConfigurationSettingAsync(It.IsAny<ConfigurationSetting>(), It.IsAny<bool>(), It.IsAny<CancellationToken>()), Times.Never);
}
}
}
Loading