feat: Flag metadata #223

askpt · 2024-01-30T16:36:08Z

Flag Metadata

Adds support for flag metadata

Related Issues

Fixes #192

Notes

Currently, an invalid flag evaluation (cast) will throw an exception. I was thinking of returning null and logging it as a warning. For that effort, I need a log source (chore: Use logging source generators #189).

Follow-up Tasks

Change EventMetadata type #234

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

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

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

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

Co-authored-by: renovate[bot] <29139614+renovate[bot]@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>

The linter on the docs page complains that this should be a header instead of an emphasis. This PR changes the key to use a blockquote, which works better anyway. Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

See: #202 Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

This commit refactors the FlagMetadata class in the OpenFeature.Model namespace to use ImmutableDictionary instead of Dictionary for the _metadata field. This change ensures that the metadata dictionary is immutable, providing better thread safety and preventing unintended modifications. The GetString method is also moved to the bottom of the class for better organization. Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

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

codecov · 2024-01-30T16:39:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d792b32) 94.28% compared to head (03db18a) 94.47%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #223      +/-   ##
==========================================
+ Coverage   94.28%   94.47%   +0.19%     
==========================================
  Files          25       27       +2     
  Lines        1067     1104      +37     
  Branches      115      119       +4     
==========================================
+ Hits         1006     1043      +37     
  Misses         37       37              
  Partials       24       24

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

src/OpenFeature/Model/FlagMetadata.cs

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

toddbaert · 2024-01-31T19:08:14Z

@askpt FlagMetadata and EventMetadata are shaped the same in the SDK:

https://openfeature.dev/specification/types#event-metadata
https://openfeature.dev/specification/types#flag-metadata

I think for consistency, that means we should use the same type for these, which I guess would mean it should be a Dictionary<string, object>(), unless there's some way we can bring them in line with your new implementation in a non-breaking way... maybe with extension methods?

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

askpt · 2024-02-02T14:29:32Z

@askpt FlagMetadata and EventMetadata are shaped the same in the SDK:

https://openfeature.dev/specification/types#event-metadata https://openfeature.dev/specification/types#flag-metadata

I think for consistency, that means we should use the same type for these, which I guess would mean it should be a Dictionary<string, object>(), unless there's some way we can bring them in line with your new implementation in a non-breaking way... maybe with extension methods?

@toddbaert I added a TODO to change the dictionary to use the BaseMetadata type. This would be a breaking change. See 5a2dcc9

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

toddbaert · 2024-02-05T18:08:14Z

I think the e2e tests are failing because of the change in the resolvers to include a new optional metadata param - I think the change in the signature is somehow causing an issue due to the circular dependency on flagd.

We've had an issue to remove this cycle for a while, as we have in other SDKs by adding the in-memory provider (which the spec requires anyway).

toddbaert · 2024-02-10T19:57:11Z

@askpt merged the recent changes to remove the flagd dep and now e2e looks good!

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

src/OpenFeature/Model/ProviderEvents.cs

🤖 I have created a release *beep* *boop* --- ## [1.5.0](v1.4.1...v1.5.0) (2024-03-12) ### 🐛 Bug Fixes * Add targeting key ([#231](#231)) ([d792b32](d792b32)) * Fix NU1009 reference assembly warning ([#222](#222)) ([7eebcdd](7eebcdd)) * invalid editorconfig ([#244](#244)) ([3c00757](3c00757)) ### ✨ New Features * Flag metadata ([#223](#223)) ([fd0a541](fd0a541)) * implement in-memory provider ([#232](#232)) ([1082094](1082094)) ### 🧹 Chore * bump spec version badge ([#246](#246)) ([ebf5552](ebf5552)) * cleanup unused usings 🧹 ([#240](#240)) ([cdc1bee](cdc1bee)) * **deps:** update actions/upload-artifact action to v4.3.0 ([#203](#203)) ([0a7e98d](0a7e98d)) * **deps:** update actions/upload-artifact action to v4.3.1 ([#233](#233)) ([cfaf1c8](cfaf1c8)) * **deps:** update codecov/codecov-action action to v3.1.5 ([#209](#209)) ([a509b1f](a509b1f)) * **deps:** update codecov/codecov-action action to v3.1.6 ([#226](#226)) ([a577a80](a577a80)) * **deps:** update dependency coverlet.collector to v6.0.1 ([#238](#238)) ([f2cb67b](f2cb67b)) * **deps:** update dependency fluentassertions to v6.12.0 ([#215](#215)) ([2c237df](2c237df)) * **deps:** update dependency microsoft.net.test.sdk to v17.8.0 ([#216](#216)) ([4cb3ae0](4cb3ae0)) * **deps:** update dependency nsubstitute to v5.1.0 ([#217](#217)) ([3be76cd](3be76cd)) * **deps:** update dependency openfeature.contrib.providers.flagd to v0.1.8 ([#211](#211)) ([c1aece3](c1aece3)) * **deps:** update xunit-dotnet monorepo ([#236](#236)) ([fa25ece](fa25ece)) * Enable Central Package Management (CPM) ([#178](#178)) ([249a0a8](249a0a8)) * Enforce coding styles on build ([#242](#242)) ([64699c8](64699c8)) * More sln cleanup ([#206](#206)) ([bac3d94](bac3d94)) * SourceLink is built-in for .NET SDK 8.0.100+ ([#198](#198)) ([45e2c86](45e2c86)) * Sync ci.yml with contrib repo ([#196](#196)) ([130654b](130654b)) * Sync release.yml with ci.yml following [#173](#173) ([#195](#195)) ([eba8848](eba8848)) ### 📚 Documentation * fix hook ecosystem link ([#229](#229)) ([cc6c404](cc6c404)) * update the feature table key ([f8724cd](f8724cd)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

askpt linked an issue Jan 30, 2024 that may be closed by this pull request

[FEATURE] Implement flag metadata #192

Closed

askpt and others added 21 commits January 30, 2024 16:38

Add FlagMetadata class to OpenFeature.Model

5b5f9a3

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

Update FlagEvaluationDetails and ResolutionDetails classes with FlagM…

be07fd0

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

chore: SourceLink is built-in for .NET SDK 8.0.100+ (#198)

454a277

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

chore: Sync release.yml with ci.yml following #173 (#195)

fc817a6

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

build: Update OpenFeature.sln (#202)

ace936e

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

chore(deps): update actions/upload-artifact action to v4.3.0 (#203)

bd4a48a

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding a GetValue.

adb57ab

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

Adding more Get methods.

0034d51

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

Adding empty constructor.

d8956cd

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

Adding top level namespace.

a8978a0

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

chore: Enable Central Package Management (CPM) (#178)

824ffc2

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

chore(deps): update codecov/codecov-action action to v3.1.5 (#209)

f70fc61

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

chore: More sln cleanup (#206)

58bd313

See: #202 Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

chore: Sync ci.yml with contrib repo (#196)

48b9e6c

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

fix: Fix NU1009 reference assembly warning (#222)

0325083

Signed-off-by: Austin Drenski <austin@austindrenski.io> Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>

Adding initial tests.

b04f01c

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

Moved code and fixed code smells.

0fb919c

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

Fix code. Added unit tests.

4ad9ca5

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

Change namespace scope. Added nullable check.

9813d3c

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

askpt force-pushed the askpt/192-feature-implement-flag-metadata branch from b245d9b to 9813d3c Compare January 30, 2024 16:38

Merge branch 'main' into askpt/192-feature-implement-flag-metadata

a33db20

askpt changed the title ~~Implement flag metadata~~ Feat: Flag metadata Jan 30, 2024

askpt changed the title ~~Feat: Flag metadata~~ feat: Flag metadata Jan 30, 2024

toddbaert reviewed Jan 30, 2024

View reviewed changes

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

askpt added 2 commits January 31, 2024 16:06

Refactor FlagMetadata class to inherit from BaseMetadata

cc91037

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

Adding documentation.

8a6859e

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

toddbaert mentioned this pull request Jan 31, 2024

feat: Add custom dimensions for metrics open-feature/dotnet-sdk-contrib#122

Closed

Adding reference.

5a2dcc9

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

askpt added 6 commits February 2, 2024 14:30

Merge branch 'main' into askpt/192-feature-implement-flag-metadata

e4fbad0

Adding reference to the spec.

c59c30e

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

Small fix.

cdb8a86

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

Added some conditions.

c1ae332

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

Adding more specs.

c14361f

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

Fixing unit tests.

2b2a64f

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

This was referenced Feb 8, 2024

fix: Add targeting key #231

Merged

feat: implement in-memory provider #232

Merged

Merge branch 'main' into askpt/192-feature-implement-flag-metadata

adf885a

Remove default constructor from BaseMetadata class

2761bff

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

askpt force-pushed the askpt/192-feature-implement-flag-metadata branch from a718ba5 to 2761bff Compare February 12, 2024 08:13

Merge branch 'main' into askpt/192-feature-implement-flag-metadata

03db18a

askpt mentioned this pull request Feb 12, 2024

Change EventMetadata type #234

Closed

askpt marked this pull request as ready for review February 12, 2024 17:00

askpt requested a review from a team as a code owner February 12, 2024 17:00

askpt requested a review from toddbaert February 12, 2024 17:00

kinyoklion reviewed Feb 12, 2024

View reviewed changes

src/OpenFeature/Model/ProviderEvents.cs Show resolved Hide resolved

askpt requested a review from kinyoklion February 12, 2024 17:33

kinyoklion approved these changes Feb 12, 2024

View reviewed changes

toddbaert approved these changes Feb 12, 2024

View reviewed changes

askpt merged commit fd0a541 into main Feb 12, 2024
16 checks passed

askpt deleted the askpt/192-feature-implement-flag-metadata branch February 12, 2024 20:51

github-actions bot mentioned this pull request Feb 12, 2024

chore(main): release 1.5.0 #205

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Flag metadata #223

feat: Flag metadata #223

askpt commented Jan 30, 2024 •

edited

Loading

codecov bot commented Jan 30, 2024 •

edited

Loading

toddbaert commented Jan 31, 2024 •

edited

Loading

askpt commented Feb 2, 2024 •

edited

Loading

toddbaert commented Feb 5, 2024

toddbaert commented Feb 10, 2024

feat: Flag metadata #223

feat: Flag metadata #223

Conversation

askpt commented Jan 30, 2024 • edited Loading

Flag Metadata

Related Issues

Notes

Follow-up Tasks

codecov bot commented Jan 30, 2024 • edited Loading

Codecov Report

toddbaert commented Jan 31, 2024 • edited Loading

askpt commented Feb 2, 2024 • edited Loading

toddbaert commented Feb 5, 2024

toddbaert commented Feb 10, 2024

askpt commented Jan 30, 2024 •

edited

Loading

codecov bot commented Jan 30, 2024 •

edited

Loading

toddbaert commented Jan 31, 2024 •

edited

Loading

askpt commented Feb 2, 2024 •

edited

Loading