Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ public AzureAppConfigurationProvider(IConfigurationClientManager configClientMan
string requestTracingDisabled = null;
try
{
requestTracingDisabled = Environment.GetEnvironmentVariable(RequestTracingConstants.RequestTracingDisabledEnvironmentVariable);
requestTracingDisabled = Environment.GetEnvironmentVariable(EnvironmentVariables.DisableRequestTracing);
}
catch (SecurityException) { }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ namespace Microsoft.Extensions.Configuration.AzureAppConfiguration
{
internal class RequestTracingConstants
{
public const string RequestTracingDisabledEnvironmentVariable = "AZURE_APP_CONFIGURATION_TRACING_DISABLED";
public const string AzureFunctionEnvironmentVariable = "FUNCTIONS_EXTENSION_VERSION";
public const string AzureWebAppEnvironmentVariable = "WEBSITE_SITE_NAME";
public const string ContainerAppEnvironmentVariable = "CONTAINER_APP_NAME";
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
//
namespace Microsoft.Extensions.Configuration.AzureAppConfiguration
{
/// <summary>
/// Environment variables used to configure Azure App Configuration provider behavior.
/// </summary>
internal static class EnvironmentVariables
{
/// <summary>
/// Environment variable to disable Feature Management schema compatibility.
/// The value of this variable is a boolean string, e.g. "true" or "false".
/// When set to "true", schema compatibility checks for feature flags are disabled,
/// and all feature flags will be interpreted using the Microsoft Feature Flags schema.
/// </summary>
public const string DisableFmSchemaCompatibility = "AZURE_APP_CONFIGURATION_FM_SCHEMA_COMPATIBILITY_DISABLED";

/// <summary>
/// Environment variable to disable request tracing.
/// The value of this variable is a boolean string, e.g. "true" or "false".
/// </summary>
public const string DisableRequestTracing = "AZURE_APP_CONFIGURATION_TRACING_DISABLED";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Linq;
using System.Net.Mime;
using System.Security.Cryptography;
using System.Security;
using System.Text;
using System.Text.Json;
using System.Threading;
Expand All @@ -20,10 +21,21 @@ internal class FeatureManagementKeyValueAdapter : IKeyValueAdapter
{
private FeatureFlagTracing _featureFlagTracing;
private int _featureFlagIndex = 0;
private bool _fmSchemaCompatibilityDisabled = false;

public FeatureManagementKeyValueAdapter(FeatureFlagTracing featureFlagTracing)
{
_featureFlagTracing = featureFlagTracing ?? throw new ArgumentNullException(nameof(featureFlagTracing));

string fmSchemaCompatibilityDisabled = null;

try
{
fmSchemaCompatibilityDisabled = Environment.GetEnvironmentVariable(EnvironmentVariables.DisableFmSchemaCompatibility);
}
catch (SecurityException) { }

_fmSchemaCompatibilityDisabled = bool.TryParse(fmSchemaCompatibilityDisabled, out bool disabled) ? disabled : false;
}

public Task<IEnumerable<KeyValuePair<string, string>>> ProcessKeyValue(ConfigurationSetting setting, Uri endpoint, Logger logger, CancellationToken cancellationToken)
Expand All @@ -33,7 +45,10 @@ public Task<IEnumerable<KeyValuePair<string, string>>> ProcessKeyValue(Configura
var keyValues = new List<KeyValuePair<string, string>>();

// Check if we need to process the feature flag using the microsoft schema
if ((featureFlag.Variants != null && featureFlag.Variants.Any()) || featureFlag.Allocation != null || featureFlag.Telemetry != null)
if (_fmSchemaCompatibilityDisabled ||
(featureFlag.Variants != null && featureFlag.Variants.Any()) ||
featureFlag.Allocation != null ||
featureFlag.Telemetry != null)
{
keyValues = ProcessMicrosoftSchemaFeatureFlag(featureFlag, setting, endpoint);
}
Expand Down
69 changes: 69 additions & 0 deletions tests/Tests.AzureAppConfiguration/Unit/FeatureManagementTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2291,6 +2291,75 @@ public void ThrowsOnIncorrectJsonTypes()
}
}

[Fact]
public void EnvironmentVariableForcesMicrosoftSchemaForAllFlags()
{
var mixedSchemaFlags = new List<ConfigurationSetting>
{
_kv,
_variantFeatureFlagCollection[0]
};

var mockResponse = new Mock<Response>();
var mockClient = new Mock<ConfigurationClient>(MockBehavior.Strict);

mockClient.Setup(c => c.GetConfigurationSettingsAsync(It.IsAny<SettingSelector>(), It.IsAny<CancellationToken>()))
.Returns(new MockAsyncPageable(mixedSchemaFlags));

try
{
// Act - Set environment variable to force Microsoft schema
Environment.SetEnvironmentVariable(EnvironmentVariables.DisableFmSchemaCompatibility, "true");

var config = new ConfigurationBuilder()
.AddAzureAppConfiguration(options =>
{
options.ClientManager = TestHelpers.CreateMockedConfigurationClientManager(mockClient.Object);
options.UseFeatureFlags();
})
.Build();

// Assert - Both flags should be in Microsoft schema format
// First flag (would be in .NET schema without environment variable) should now be in Microsoft schema
Assert.Equal("Beta", config["feature_management:feature_flags:0:id"]);
Assert.Equal("True", config["feature_management:feature_flags:0:enabled"]);
Assert.Equal("Browser", config["feature_management:feature_flags:0:conditions:client_filters:0:name"]);
Assert.Equal("Firefox", config["feature_management:feature_flags:0:conditions:client_filters:0:parameters:AllowedBrowsers:0"]);

// Second flag (always Microsoft schema) should still be in Microsoft schema
Assert.Equal("VariantsFeature1", config["feature_management:feature_flags:1:id"]);
Assert.Equal("True", config["feature_management:feature_flags:1:enabled"]);
Assert.Equal("Big", config["feature_management:feature_flags:1:variants:0:name"]);
Assert.Equal("600px", config["feature_management:feature_flags:1:variants:0:configuration_value"]);

// Verify .NET schema paths are NOT present
Assert.Null(config["FeatureManagement:myFeature:EnabledFor:0:Name"]);
Assert.Null(config["FeatureManagement:VariantsFeature1:EnabledFor:0:Name"]);
}
finally
{
// Cleanup - Reset environment variable
Environment.SetEnvironmentVariable("AZURE_APP_CONFIGURATION_FM_SCHEMA_COMPATIBILITY_DISABLED", null);
}

// Act - Verify normal behavior when environment variable is not set
var configWithoutEnvVar = new ConfigurationBuilder()
.AddAzureAppConfiguration(options =>
{
options.ClientManager = TestHelpers.CreateMockedConfigurationClientManager(mockClient.Object);
options.UseFeatureFlags();
})
.Build();

// First flag (no variants) should be in .NET schema
Assert.Equal("Browser", configWithoutEnvVar["FeatureManagement:Beta:EnabledFor:0:Name"]);
Assert.Equal("Firefox", configWithoutEnvVar["FeatureManagement:Beta:EnabledFor:0:Parameters:AllowedBrowsers:0"]);

// Second flag (has variants) should be in Microsoft schema
Assert.Equal("VariantsFeature1", configWithoutEnvVar["feature_management:feature_flags:0:id"]);
Assert.Equal("Big", configWithoutEnvVar["feature_management:feature_flags:0:variants:0:name"]);
}

Response<ConfigurationSetting> GetIfChanged(ConfigurationSetting setting, bool onlyIfChanged, CancellationToken cancellationToken)
{
return Response.FromValue(FirstKeyValue, new MockResponse(200));
Expand Down
4 changes: 2 additions & 2 deletions tests/Tests.AzureAppConfiguration/Unit/Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ public void TestTurnOffRequestTracing()
var options = new AzureAppConfigurationOptions();
options.ClientOptions.Transport = mockTransport;

Environment.SetEnvironmentVariable(RequestTracingConstants.RequestTracingDisabledEnvironmentVariable, "True");
Environment.SetEnvironmentVariable(EnvironmentVariables.DisableRequestTracing, "True");

var clientManager = TestHelpers.CreateMockedConfigurationClientManager(options);
var config = new ConfigurationBuilder()
Expand All @@ -296,7 +296,7 @@ public void TestTurnOffRequestTracing()
options.ClientOptions.Transport = mockTransport;

// Delete the request tracing environment variable
Environment.SetEnvironmentVariable(RequestTracingConstants.RequestTracingDisabledEnvironmentVariable, null);
Environment.SetEnvironmentVariable(EnvironmentVariables.DisableRequestTracing, null);
Environment.SetEnvironmentVariable(RequestTracingConstants.AzureFunctionEnvironmentVariable, "v1.0");

var clientManager1 = TestHelpers.CreateMockedConfigurationClientManager(options);
Expand Down