feat: Implement transaction context by askpt · Pull Request #312 · open-feature/dotnet-sdk

askpt · 2024-11-11T10:42:48Z

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 _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] [2]
src/OpenFeature/AsyncLocalTransactionContextPropagator.cs: Implemented the AsyncLocalTransactionContextPropagator class that uses AsyncLocal<T> to store the transaction context.
src/OpenFeature/NoOpTransactionContextPropagator.cs: Implemented a no-op version of the ITransactionContextPropagator interface.
src/OpenFeature/Model/ITransactionContextPropagator.cs: Defined the ITransactionContextPropagator interface responsible for persisting transaction contexts.

API Enhancements:

src/OpenFeature/Api.cs: Updated the ShutdownAsync method to reset the transaction context propagator.
src/OpenFeature/OpenFeatureClient.cs: Modified the EvaluateFlagAsync method to merge the transaction context with the evaluation context.

codecov · 2024-11-15T08:19:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.49%. Comparing base (2ef9955) to head (95c1fb7).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

lukas-reining

Nice start! Left some thoughts and references to how we are doing it in the other languages.

src/OpenFeature/Model/TransactionContext.cs

src/OpenFeature/Model/ContextBuilder.cs

src/OpenFeature/Api.cs

askpt · 2024-11-26T18:40:08Z

Nice start! Left some thoughts and references to how we are doing it in the other languages.

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.

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

src/OpenFeature/AsyncLocalTransactionContextPropagator.cs

src/OpenFeature/OpenFeatureClient.cs

test/OpenFeature.Tests/AsyncLocalTransactionContextPropagatorTests.cs

test/OpenFeature.Tests/OpenFeatureTests.cs

README.md

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

chrfwow

Looks good

## 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 open-feature#243 ### Notes  #### 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>

🤖 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>

askpt linked an issue Nov 11, 2024 that may be closed by this pull request

[FEATURE] Implement transaction context #243

Closed

toddbaert requested review from benjiro and lukas-reining November 26, 2024 15:22

lukas-reining reviewed Nov 26, 2024

View reviewed changes

src/OpenFeature/Model/TransactionContext.cs Outdated Show resolved Hide resolved

src/OpenFeature/Model/ContextBuilder.cs Outdated Show resolved Hide resolved

src/OpenFeature/Api.cs Outdated Show resolved Hide resolved

src/OpenFeature/Api.cs Outdated Show resolved Hide resolved

askpt force-pushed the askpt/243-feature-implement-transaction-context branch from 35b90bf to 9158a92 Compare December 4, 2024 17:05

askpt closed this Dec 10, 2024

askpt force-pushed the askpt/243-feature-implement-transaction-context branch from a0a7f36 to c471c06 Compare December 10, 2024 08:34

Changing API client and added Context Propagator.

264d8c9

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

askpt reopened this Dec 10, 2024

askpt added 16 commits December 12, 2024 08:18

Merge branch 'main' into askpt/243-feature-implement-transaction-context

c15192a

Merge branch 'main' into askpt/243-feature-implement-transaction-context

3539674

Merge branch 'main' into askpt/243-feature-implement-transaction-context

63c3f62

Adding NoOpTransactionContextPropagator.

6a870ff

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Making field readonly.

8bcfc99

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Added an empty context return.

50613fe

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding unit tests.

b67b659

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Merge branch 'main' into askpt/243-feature-implement-transaction-context

b0a20d7

Fix unit test.

02f93dd

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding clear transaction context to shutdown.

8d45264

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Merge branch 'main' into askpt/243-feature-implement-transaction-context

8e3789b

Merging transaction context at evaluation.

d9ed730

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding an AsyncLocalTransactionContextPropagator.

9f75a44

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Merge branch 'main' into askpt/243-feature-implement-transaction-context

e473ccc

Adding unit tests.

4146f0e

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding missing tests.

64f5c68

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

askpt requested a review from lukas-reining December 20, 2024 08:52

askpt marked this pull request as ready for review December 20, 2024 08:52

askpt requested a review from a team as a code owner December 20, 2024 08:52

askpt added 2 commits December 31, 2024 14:32

Change visibility of GetPropagator.

bf4dbb4

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Merge branch 'main' into askpt/243-feature-implement-transaction-context

e480050

chrfwow reviewed Jan 2, 2025

View reviewed changes

askpt added 3 commits January 2, 2025 14:15

Fixed comment.

7a60997

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Replaced the context.

1769be8

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Fixing the context merging order. Updated unit test.

59ddca7

Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

askpt requested a review from chrfwow January 2, 2025 15:22

chrfwow approved these changes Jan 2, 2025

View reviewed changes

Merge branch 'main' into askpt/243-feature-implement-transaction-context

6d2d318

beeme1mr approved these changes Jan 6, 2025

View reviewed changes

Merge branch 'main' into askpt/243-feature-implement-transaction-context

95c1fb7

askpt merged commit 1b5a0a9 into main Jan 7, 2025

askpt deleted the askpt/243-feature-implement-transaction-context branch January 7, 2025 08:40

dependabot bot mentioned this pull request Jul 30, 2025

Bump Grpc.AspNetCore and 9 others maheshkonda/observe-OTel-demo#140

Closed

This was referenced Nov 27, 2025

Bump Grpc.AspNetCore and 8 others Jineshkumar1/opentelemetry-demo#165

Closed

Bump Grpc.AspNetCore and 8 others Jineshkumar1/opentelemetry-demo#167

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement transaction context#312

feat: Implement transaction context#312
askpt merged 25 commits intomainfrom
askpt/243-feature-implement-transaction-context

askpt commented Nov 11, 2024 •

edited

Loading

Uh oh!

codecov bot commented Nov 15, 2024 •

edited

Loading

Uh oh!

lukas-reining left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

askpt commented Nov 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrfwow left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

askpt commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Transaction Context

Related Issues

Notes

Transaction Context Propagation:

API Enhancements:

Uh oh!

codecov bot commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

lukas-reining left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

askpt commented Nov 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrfwow left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

askpt commented Nov 11, 2024 •

edited

Loading

codecov bot commented Nov 15, 2024 •

edited

Loading