feat: Implement transaction context #312
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #312 +/- ##
==========================================
+ Coverage 85.13% 85.49% +0.36%
==========================================
Files 36 38 +2
Lines 1480 1517 +37
Branches 151 154 +3
==========================================
+ Hits 1260 1297 +37
Misses 188 188
Partials 32 32 ☔ View full report in Codecov by Sentry. |
Thanks for the review @lukas-reining. I based the implementation on the JS client. I'll look into more detail on the Java version instead. |
askpt
force-pushed
the
askpt/243-feature-implement-transaction-context
branch
from
35b90bf to
9158a92
Compare
askpt
force-pushed
the
askpt/243-feature-implement-transaction-context
branch
from
a0a7f36 to
c471c06
Compare
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
toddbaert
reviewed
Dec 31, 2024
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
|
This looks right to me, though unless there's a good reason, I think we should remove this. Besides that I'm ready to approve. I also pushed a small change to add docs to the README. @askpt please check them and make sure they make sense to you (it's a similar example to other SDKs). |
toddbaert
requested review from
arttonoyan,
kinyoklion,
beeme1mr and
chrfwow
toddbaert
approved these changes
Dec 31, 2024
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
chrfwow
reviewed
Jan 2, 2025
test/OpenFeature.Tests/AsyncLocalTransactionContextPropagatorTests.cs
Outdated
Show resolved
Hide resolved
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
beeme1mr
approved these changes
Jan 6, 2025
kylejuliandev
pushed a commit
to kylejuliandev/dotnet-sdk
that referenced
this pull request
Jan 9, 2025
<!-- Please use this template for your pull request. --> <!-- Please use the sections that you need and delete other sections --> ## Transaction Context <!-- add the description of the PR here --> This pull request introduces transaction context propagation to the OpenFeature library. The changes include adding a new interface for transaction context propagation, implementing a no-op and an AsyncLocal-based propagator, and updating the API to support these propagators. ### Related Issues <!-- add here the GitHub issue that this PR resolves if applicable --> Fixes open-feature#243 ### Notes <!-- any additional notes for this PR --> #### Transaction Context Propagation: * [`src/OpenFeature/Api.cs`](diffhunk://#diff-dc150fbd3b7be797470374ee7e38c7ab8a31eb9b6b7a52345e05114c2d32a15eR25-R26): Added a private field `_transactionContextPropagator` and a lock for thread safety. Introduced methods to get and set the transaction context propagator, and to manage the transaction context using the propagator. [[1]](diffhunk://#diff-dc150fbd3b7be797470374ee7e38c7ab8a31eb9b6b7a52345e05114c2d32a15eR25-R26) [[2]](diffhunk://#diff-dc150fbd3b7be797470374ee7e38c7ab8a31eb9b6b7a52345e05114c2d32a15eR222-R274) * [`src/OpenFeature/AsyncLocalTransactionContextPropagator.cs`](diffhunk://#diff-d9ca58e32d696079f875c51837dfc6ded087b06eb3aef3513f5ea15ebc22c700R1-R25): Implemented the `AsyncLocalTransactionContextPropagator` class that uses `AsyncLocal<T>` to store the transaction context. * [`src/OpenFeature/NoOpTransactionContextPropagator.cs`](diffhunk://#diff-09ab422ed267155042b791de4d1c88f1bd82cb68d5f541a92c6af4318ceacd6aR1-R15): Implemented a no-op version of the `ITransactionContextPropagator` interface. * [`src/OpenFeature/Model/ITransactionContextPropagator.cs`](diffhunk://#diff-614f5b3e42871f4057f04d5fd27bf56157315e1c822ff0c83403255a8bf163ecR1-R26): Defined the `ITransactionContextPropagator` interface responsible for persisting transaction contexts. #### API Enhancements: * [`src/OpenFeature/Api.cs`](diffhunk://#diff-dc150fbd3b7be797470374ee7e38c7ab8a31eb9b6b7a52345e05114c2d32a15eR291): Updated the `ShutdownAsync` method to reset the transaction context propagator. * [`src/OpenFeature/OpenFeatureClient.cs`](diffhunk://#diff-c23c8a3ea4538fbdcf6b1cf93ea3de456906e4d267fc4b2ba3f8b1cb186a7907R224): Modified the `EvaluateFlagAsync` method to merge the transaction context with the evaluation context. --------- Signed-off-by: André Silva <2493377+askpt@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: Kyle Julian <38759683+kylejuliandev@users.noreply.github.com>
toddbaert
added a commit
that referenced
this pull request
Jan 31, 2025
🤖 I have created a release *beep* *boop* --- ## [2.3.0](v2.2.0...v2.3.0) (2025-01-31) ### ⚠ BREAKING CHANGES #### Hook Changes The signature of the `finally` hook stage has been changed. The signature now includes the `evaluation details`, as per the [OpenFeature specification](https://openfeature.dev/specification/sections/hooks#requirement-438). Note that since hooks are still `experimental,` this does not constitute a change requiring a new major version. To migrate, update any hook that implements the `finally` stage to accept `evaluation details` as the second argument. * Add evaluation details to finally hook stage ([#335](#335)) ([2ef9955](2ef9955)) #### .NET 6 Removed support for .NET 6. * add dotnet 9 support, rm dotnet 6 ([#317](#317)) ([2774b0d](2774b0d)) ### 🐛 Bug Fixes * Adding Async Lifetime method to fix flaky unit tests ([#333](#333)) ([e14ab39](e14ab39)) * Fix issue with DI documentation ([#350](#350)) ([728ae47](728ae47)) ### ✨ New Features * add dotnet 9 support, rm dotnet 6 ([#317](#317)) ([2774b0d](2774b0d)) * Add evaluation details to finally hook stage ([#335](#335)) ([2ef9955](2ef9955)) * Implement Default Logging Hook ([#308](#308)) ([7013e95](7013e95)) * Implement transaction context ([#312](#312)) ([1b5a0a9](1b5a0a9)) ### 🧹 Chore * **deps:** update actions/upload-artifact action to v4.5.0 ([#332](#332)) ([fd68cb0](fd68cb0)) * **deps:** update codecov/codecov-action action to v5 ([#316](#316)) ([6c4cd02](6c4cd02)) * **deps:** update codecov/codecov-action action to v5.1.2 ([#334](#334)) ([b9ebddf](b9ebddf)) * **deps:** update codecov/codecov-action action to v5.3.1 ([#355](#355)) ([1e8ebc4](1e8ebc4)) * **deps:** update dependency coverlet.collector to 6.0.3 ([#336](#336)) ([8527b03](8527b03)) * **deps:** update dependency coverlet.msbuild to 6.0.3 ([#337](#337)) ([26fd235](26fd235)) * **deps:** update dependency dotnet-sdk to v9.0.101 ([#339](#339)) ([dd26ad6](dd26ad6)) * **deps:** update dependency fluentassertions to 7.1.0 ([#346](#346)) ([dd1c8e4](dd1c8e4)) * **deps:** update dependency microsoft.net.test.sdk to 17.12.0 ([#322](#322)) ([6f5b049](6f5b049)) ### 📚 Documentation * disable space in link text lint rule ([#329](#329)) ([583b2a9](583b2a9)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Signed-off-by: Todd Baert <todd.baert@dynatrace.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
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.
Transaction Context
This pull request introduces transaction context propagation to the OpenFeature library. The changes include adding a new interface for transaction context propagation, implementing a no-op and an AsyncLocal-based propagator, and updating the API to support these propagators.
Related Issues
Fixes #243
Notes
Transaction Context Propagation:
src/OpenFeature/Api.cs: Added a private field_transactionContextPropagatorand a lock for thread safety. Introduced methods to get and set the transaction context propagator, and to manage the transaction context using the propagator. [1] [2]src/OpenFeature/AsyncLocalTransactionContextPropagator.cs: Implemented theAsyncLocalTransactionContextPropagatorclass that usesAsyncLocal<T>to store the transaction context.src/OpenFeature/NoOpTransactionContextPropagator.cs: Implemented a no-op version of theITransactionContextPropagatorinterface.src/OpenFeature/Model/ITransactionContextPropagator.cs: Defined theITransactionContextPropagatorinterface responsible for persisting transaction contexts.API Enhancements:
src/OpenFeature/Api.cs: Updated theShutdownAsyncmethod to reset the transaction context propagator.src/OpenFeature/OpenFeatureClient.cs: Modified theEvaluateFlagAsyncmethod to merge the transaction context with the evaluation context.