feat(openfeature/provider): Add ability to pass context into openfeature provider to support cancellation #4087
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
leoromanovsky
changed the title
leoromanovsky
changed the title
- Add ability to pass context into openfeature provider to support cancellation - Update to OpenFeature v1.17.0 from pinned pre-release version - Implement ContextAwareStateHandler with InitWithContext and ShutdownWithContext - Add comprehensive timeout tests for SetProviderWithContextAndWait and ShutdownWithContext - Simplify InitWithContext implementation using channels instead of sync.Cond - Replace complex mutex lock/unlock cycles with clean channel-based signaling - All tests passing with improved error handling for test scenarios
leoromanovsky
force-pushed
the
lr/of-context
branch
from
88d9117 to
ef3e3de
Compare
- Reduce initialization timeout from 30s to 5s for faster timeouts - Reduce shutdown timeout from 10s to 5s for consistency - Revert InitWithContext from channel approach back to sync.Cond - sync.Cond supports multiple broadcasts for ongoing config updates - All timeout tests passing with improved responsiveness
github-actions
bot
added
the
apm:ecosystem
eliottness
approved these changes
Nov 6, 2025
Comment on lines
+150
to
+152
| ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) | ||
| defer cancel() | ||
| _ = p.ShutdownWithContext(ctx) |
There was a problem hiding this comment.
Sadly I think we need to put at the very least 15sec or more because reomte config can be really really slow
There was a problem hiding this comment.
Suggested change
| ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) | |
| defer cancel() | |
| _ = p.ShutdownWithContext(ctx) | |
| ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second) | |
| defer cancel() | |
| _ = p.ShutdownWithContext(ctx) |
Comment on lines
+113
to
+141
| // Check if context was cancelled | ||
| select { | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| default: | ||
| } | ||
|
|
||
| // Use a condition variable with context support | ||
| // We need to handle the case where context gets cancelled while waiting | ||
| done := make(chan struct{}) | ||
| go func() { | ||
| defer close(done) | ||
| p.mu.Lock() | ||
| defer p.mu.Unlock() | ||
| p.configChange.Wait() | ||
| }() | ||
|
|
||
| // Temporarily unlock to allow the configuration update and context handling | ||
| p.mu.Unlock() | ||
|
|
||
| select { | ||
| case <-ctx.Done(): | ||
| // Relock before returning | ||
| p.mu.Lock() | ||
| return ctx.Err() | ||
| case <-done: | ||
| // Configuration might have been updated, relock and loop to check | ||
| p.mu.Lock() | ||
| } |
There was a problem hiding this comment.
I would prefer if we made the inside of the loop into it's own function so we can defer p.mu.Lock() instead of locking on each branch of the select statement. Do you agree ?
| func (p *DatadogProvider) Init(openfeature.EvaluationContext) error { | ||
| func (p *DatadogProvider) Init(evaluationContext openfeature.EvaluationContext) error { | ||
| // Use a background context with a reasonable timeout for backward compatibility | ||
| ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) |
There was a problem hiding this comment.
Suggested change
| ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) | |
| ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second) |
Sadly I think we need to put at the very least 15sec or more because remote config can be really really slow
| ) | ||
|
|
||
| var _ openfeature.FeatureProvider = (*DatadogProvider)(nil) | ||
| var _ openfeature.ContextAwareStateHandler = (*DatadogProvider)(nil) |
There was a problem hiding this comment.
Suggested change
| var _ openfeature.ContextAwareStateHandler = (*DatadogProvider)(nil) | |
| var _ openfeature.ContextAwareStateHandler = (*DatadogProvider)(nil) | |
| var _ openfeature.StateHandler = (*DatadogProvider)(nil) |
I guess 🤷
Comment on lines
+367
to
+376
| // Check if context was cancelled before starting evaluation | ||
| select { | ||
| case <-ctx.Done(): | ||
| return evaluationResult{ | ||
| Value: defaultValue, | ||
| Reason: openfeature.ErrorReason, | ||
| Error: ctx.Err(), | ||
| } | ||
| default: | ||
| } |
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.
Motivation
context.Contextand cancel or timeout if the service is down. The customer impact is that the server can hang which is an extremely negative customer experience.1.17.0What does this PR do?
1.17.0Reviewer's Checklist
./scripts/lint.shlocally.Unsure? Have a question? Request a review!