Throw exception if feature management schemas are mixed to avoid unintentionally hiding feature flags. #187
Conversation
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
…tentionally hiding feature flags.
avanigupta
approved these changes
Jun 8, 2022
jimmyca15
added a commit
that referenced
this pull request
Jun 10, 2022
* Add support for feature variants. * Renaming and assorted fixes. * Remove unnecessary field. * * Added additional argument validation. * Added additional dynamic feature configuration validation. * Fixed bug in audience accumulation for variant targeting * Added test for variant targeting audience accumulation. * Since filter aliases are case insensitive, update filter cache to reflect this. * * Fixed issue with filter + assigner suffix references. * Clarified error types. * Updated/added tests * Share suffix matching logic. Corrected variable name. * Removed unnecessary helper methods. Updated error codes for consistency. * Clarify filter selection logic in feature evaluation and add checks for impossible contextual evaluations. * Updated argument validation messages. Updated exception used for null child property. * Update to dynamic features. (#157) * Update to dynamic features. * Update types to respect dynamic feature name. E.g. IFeatureManager -> IDynamicFeatureManager. * Updated property/method summaries to distinguish dynamic features and feature flags. * Added IDynamicFeatureManagerSnapshot * Separate feature flags and dynamic features in configuration schema * Backward compatability support for old configuration schema. * Breaking: Update custom feature definition provider to return feature flags and dynamic features. * Added DynamicFeatureDefinition class * renamed FeatureDefinition to FeatureFlagDefinition. * Breaking: IFeatureManager.GetFeatureNamesAsync renamed to IFeatureManager.GetFeatureFlagNamesAsync * Corrected namespace for built-in feature variant assigners. * Microsoft.FeatureManagement -> Microsoft.FeatureManagement.Assigners * Added test for custom feature definition provider. * Added test for backcompat support for v1 configuration schema. * * Separated feature flag implementation from dynamic feature impelementation in FeatureManager, ConfigurationFeatureDefinitionProvider, and FeatureManagerSnapshot.. * Separated IConfigurationDefinitionProvider into IFeatureFlagDefinitionProvider and IDynamicFeatureDefinitionProvider * Added missing default cancellation tokens. * Use shared helper for filter/assigner reference matching. * Add copyright header. * Added dynamic feature documentation. (#159) * Added dynamic feature documentation. * Readme fixes. * * Added index. * Moved around sections * Removed enum usage. * Fixed mistyped interfaces. * Clarified variant resolution. * Fix links with '.' character. * Updates. * Updated index. * Default -> Name * Remove `MyFeatureFlags` references. * Updated missed "feature name" occurrences. * feature definition -> feature flag * SuggestedReadmeChanges * Updated comments from readme * Fixed targeting assignment precedence. * Remove unused variable. Update method signature. Added missing declaration in test. * Add null/empty check for feature evaluation. * Added .NET 6 as a target framework and removed .NET 5 * Update Azure App Configuration provider reference in example project to pull features using v2 schema. * Build with .NET 6 (#186) * Build with .NET 6 * Update build step name. * Add link to v2 readme. (#184) * Throw exception if feature management schemas are mixed to avoid unintentionally hiding feature flags. (#187) Co-authored-by: mrm9084 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The v3 library adds a new schema for defining feature flags. The feature manager only reads feature flags using a single schema. If different feature flag sources such as multiple appsettings files, or a file and a feature flag provider are mixed and using different schemas it could cause feature flags to be hidden.
In order to prevent a hard to troubleshoot situation where feature flags are not being found due to mixed schemas, this PR updates the feature management system to throw an exception if feature management schemas are mixed.