Skip to content

fix: correctly reset api state on shutdown - #589

Merged
gruebel merged 3 commits into
mainfrom
fix-shutdown
Apr 17, 2026
Merged

fix: correctly reset api state on shutdown#589
gruebel merged 3 commits into
mainfrom
fix-shutdown

Conversation

@gruebel

@gruebelgruebel commented Apr 12, 2026

Copy link
Copy Markdown
Member

This PR

  • added extra clear functions for easier reuse

Related Issues

Fixes#585

Notes

@toddbaert should we handle this as "breaking" change?

@gruebel
correctly reset api state on shutdown
0d11a1b
Signed-off-by: gruebel <anton.gruebel@gmail.com>
@gruebel
gruebel requested review from a team as code ownersApril 12, 2026 15:30
@gruebel
gruebel requested a review from toddbaertApril 12, 2026 15:30
gemini-code-assist[bot]
gemini-code-assistBot reviewed Apr 12, 2026
View reviewed changes

@gemini-code-assistgemini-code-assistBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces clear_evaluation_context and clear_transaction_context_propagator functions to reset the global state and updates the shutdown function to ensure all providers, hooks, and contexts are properly cleared. A new test case was added to validate the API state reset. The reviewer recommended adding the new clear functions to the all list in openfeature/api.py to make them part of the public API.

Comment threadopenfeature/api.py
Comment threadopenfeature/api.py
@codecov

codecovBot commented Apr 12, 2026•
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.35%. Comparing base (17d62c4) to head (a2dab75).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #589 +/- ##
==========================================
+ Coverage 98.33% 98.35% +0.01% 
==========================================
Files 45 45 Lines 2157 2183 +26 ==========================================
+ Hits 2121 2147 +26 
Misses 36 36
FlagCoverage Δ
unittests98.35% <100.00%> (+0.01%)⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gruebelgruebel mentioned this pull request Apr 14, 2026
Merged
toddbaert
toddbaert approved these changes Apr 17, 2026
View reviewed changes

@toddbaerttoddbaert left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I would consider this breaking. It's only behaviorally different, and in a way I think is quite unlikely to negatively impact anyone.

Will merge next week unless I hear objections.

@gruebel
gruebel merged commit eaa195b into mainApr 17, 2026
15 checks passed
@gruebel
gruebel deleted the fix-shutdown branch April 17, 2026 21:55
gruebel added a commit to balgaly/python-sdk that referenced this pull request Jun 6, 2026
@gruebel
fix: correctly reset api state on shutdown (open-feature#589)
9d47ab7
correctly reset api state on shutdown
Signed-off-by: gruebel <anton.gruebel@gmail.com>
gruebel added a commit that referenced this pull request Jun 7, 2026
@balgaly@jonathannorris
@gruebel@openfeaturebot@renovate@toddbaert@Lucas-FManager
test(e2e): add Behave step definitions for context merging (#593)
79bb01b
* test(e2e): add Behave step definitions for context merging
Add the missing E2E step definitions so the contextMerging.feature
scenarios from the OpenFeature spec run against python-sdk.
Fixes#500
Changes:
- Bump spec submodule to 130df3eb so contextMerging.feature is copied in
during the `poe e2e` task.
- Add tests/features/environment.py with a before_scenario hook that
resets provider/hook/API-context/transaction-context state, so
scenarios cannot leak state between features.
- Add tests/features/steps/context_merging_steps.py:
- RetrievableContextProvider captures the merged EvaluationContext
it receives, so assertions can inspect what the SDK merged.
- Step definitions for all scenarios in contextMerging.feature:
single-level insert, multi-level insert, and per-key overwrite
precedence across API / Transaction / Client / Invocation /
Before Hooks.
- Client-level context is set via direct attribute assignment on
OpenFeatureClient.context (no new setter), since merging already
honors client.context (openfeature/client.py:422-429).
Runs clean: 4 features / 50 scenarios / 233 steps.
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* docs: fix inaccuracies in README code examples (#592)
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* fix: correctly reset api state on shutdown (#589)
correctly reset api state on shutdown
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(main): release 0.9.0 (#555)
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update pre-commit hook tox-dev/pyproject-fmt to v2.21.2 (#601)
* chore(deps): update pre-commit hook tox-dev/pyproject-fmt to v2.21.2
* upper bound toml-fmt-common till fixed
Signed-off-by: gruebel <anton.gruebel@gmail.com>
---------
Signed-off-by: gruebel <anton.gruebel@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: gruebel <anton.gruebel@gmail.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update astral-sh/setup-uv action to v8 (#603)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update codecov/codecov-action action to v6 (#604)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update googleapis/release-please-action action to v5 (#605)
* chore(deps): update googleapis/release-please-action action to v5
* fix config
Signed-off-by: gruebel <anton.gruebel@gmail.com>
---------
Signed-off-by: gruebel <anton.gruebel@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: gruebel <anton.gruebel@gmail.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v2 (#606)
* chore(deps): update pre-commit hook pre-commit/mirrors-mypy to v2
* update config
Signed-off-by: gruebel <anton.gruebel@gmail.com>
---------
Signed-off-by: gruebel <anton.gruebel@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: gruebel <anton.gruebel@gmail.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update dependency prek to >=0.4.3,<0.5.0 (#607)
* chore(deps): update dependency prek to >=0.4.3,<0.5.0
* adjust CI
Signed-off-by: gruebel <anton.gruebel@gmail.com>
---------
Signed-off-by: gruebel <anton.gruebel@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: gruebel <anton.gruebel@gmail.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* feat!: make set_provider non-blocking, add set_provider_and_wait (#595)
* feat!: make set_provider non-blocking, add set_provider_and_wait
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
* fix: ruff format signature collapse in api.py
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
* fix: use threading.Event in error event test to avoid flaky busy-wait
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
* fixup: pr feedback and additional checks
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
* fix: check active registration in stale-init guard, not _provider_status
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
* fixup: edge shutdown race
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
---------
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* fix: isolate provider event handler dispatch (#599)
* Isolate provider event handlers
Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
* Address event handler review feedback
Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
* test: cover event dispatch noop path
Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
* fixup: drain executor at exit and relax non-blocking test timing margin
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
---------
Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* test: fix flaky event handler test (#609)
fix flaky event handler test
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(deps): update pre-commit hook astral-sh/ruff-pre-commit to v0.15.15 (#608)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* chore(main): release 0.10.0 (#602)
* chore(main): release 0.10.0
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
* docs: clarify non-blocking set_provider behavior in changelog
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
---------
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* fix CR comments
Signed-off-by: gruebel <anton.gruebel@gmail.com>
* cleanup
Signed-off-by: gruebel <anton.gruebel@gmail.com>
---------
Signed-off-by: gruebel <anton.gruebel@gmail.com>
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
Co-authored-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Co-authored-by: Anton Grübel <anton.gruebel@gmail.com>
Co-authored-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Nguyen Cat Luong <pkiphone.anhluong@gmail.com>
Co-authored-by: Lucas-FManager <265058144+Lucas-FManager@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@federicobondfedericobondfedericobond approved these changes
@beeme1mrbeeme1mrbeeme1mr approved these changes
@toddbaerttoddbaerttoddbaert approved these changes
+1 more reviewer
@gemini-code-assistgemini-code-assist[bot]gemini-code-assist[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

shutdown() doesn't fully reset state

4 participants

@gruebel@federicobond@beeme1mr@toddbaert