Adds cancellationtoken to the FeatureEvaluationContext- and respects … #532
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
…CancellationToken throughout evaluation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a cancellation mechanism to the feature evaluation process in the Microsoft.FeatureManagement library, allowing for early termination during long-running feature evaluations.
- Added a CancellationToken property to FeatureFilterEvaluationContext.
- Integrated cancellation checks into the IsEnabledAsync and AssignVariantAsync methods to handle cancellation requests efficiently.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Microsoft.FeatureManagement/FeatureManager.cs | Added cancellation checks in evaluation loops for feature enabled and variant assignment methods. |
| src/Microsoft.FeatureManagement/FeatureFilterEvaluationContext.cs | Added a CancellationToken property to support cancellation in feature filters. |
jimmyca15
reviewed
Mar 28, 2025
| @@ -472,6 +472,11 @@ private async ValueTask<bool> IsEnabledAsync<TContext>(FeatureDefinition feature | |||
| // For all enabling filters listed in the feature's state, evaluate them according to requirement type | |||
| foreach (FeatureFilterConfiguration featureFilterConfiguration in featureDefinition.EnabledFor) | |||
| { | |||
| if (cancellationToken.IsCancellationRequested) | |||
| { | |||
| cancellationToken.ThrowIfCancellationRequested(); | |||
There was a problem hiding this comment.
The surrounding if statement isn't needed. Note the If in the method name.
jimmyca15
reviewed
Mar 28, 2025
| /// <summary> | ||
| /// A cancellation token that can be used to request cancellation of the feature evaluation operation. | ||
| /// </summary> | ||
| public CancellationToken CancellationToken { get; set; } = CancellationToken.None; |
There was a problem hiding this comment.
It's a struct, no need for an initializer.
jimmyca15
approved these changes
Mar 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces a cancellation mechanism to the feature evaluation process in the
Microsoft.FeatureManagementlibrary. The changes ensure that long-running feature evaluations can be cancelled if needed, improving the responsiveness and control over feature management operations.Key changes include:
Cancellation Token Integration:
src/Microsoft.FeatureManagement/FeatureFilterEvaluationContext.cs: Added aCancellationTokenproperty to theFeatureFilterEvaluationContextclass to support cancellation of feature evaluation operations.Cancellation Checks:
src/Microsoft.FeatureManagement/FeatureManager.cs: Added checks forcancellationToken.IsCancellationRequestedin theIsEnabledAsyncmethod to allow for early termination of the evaluation loop if cancellation is requested.src/Microsoft.FeatureManagement/FeatureManager.cs: Updated theFeatureFilterEvaluationContextinstantiation to include theCancellationTokenin theIsEnabledAsyncmethod.src/Microsoft.FeatureManagement/FeatureManager.cs: Added checks forcancellationToken.IsCancellationRequestedin theAssignVariantAsyncmethod to handle cancellation during user, group, and percentile allocations. [1] [2] [3]These updates enhance the robustness of the feature management system by allowing operations to be cancelled gracefully, which can be particularly useful in scenarios where feature evaluations are time-sensitive or resource-intensive.
Addresses #531