Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Flag metadata #223

Merged
merged 34 commits into from
Feb 12, 2024
Merged

feat: Flag metadata #223

merged 34 commits into from
Feb 12, 2024

Conversation

askpt
Copy link
Member

@askpt askpt commented Jan 30, 2024 •
edited
Loading

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

@askpt 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
@askpt
Add FlagMetadata class to OpenFeature.Model
5b5f9a3 
Signed-off-by: André Silva <[email protected]>
@askpt
Update FlagEvaluationDetails and ResolutionDetails classes with FlagM…
be07fd0 
…etadata property

Signed-off-by: André Silva <[email protected]>
@austindrenski @askpt
chore: SourceLink is built-in for .NET SDK 8.0.100+ (#198)
454a277 
Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@austindrenski @askpt
chore: Sync release.yml with ci.yml following #173 (#195)
fc817a6 
Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@askpt
build: Update OpenFeature.sln (#202)
ace936e 
Signed-off-by: André Silva <[email protected]>
@renovate @askpt
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 <[email protected]>
@askpt
Adding a GetValue.
adb57ab 
Signed-off-by: André Silva <[email protected]>
@askpt
Adding more Get methods.
0034d51 
Signed-off-by: André Silva <[email protected]>
@askpt
Adding empty constructor.
d8956cd 
Signed-off-by: André Silva <[email protected]>
@askpt
Adding top level namespace.
a8978a0 
Signed-off-by: André Silva <[email protected]>
@beeme1mr @askpt
docs: update the feature table key
f40ce57 
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 <[email protected]>
Signed-off-by: André Silva <[email protected]>
@austindrenski @askpt
chore: Enable Central Package Management (CPM) (#178)
824ffc2 
Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@renovate @askpt
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 <[email protected]>
@austindrenski @askpt
chore: More sln cleanup (#206)
58bd313 
See: #202

Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@austindrenski @askpt
chore: Sync ci.yml with contrib repo (#196)
48b9e6c 
Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@austindrenski @askpt
fix: Fix NU1009 reference assembly warning (#222)
0325083 
Signed-off-by: Austin Drenski <[email protected]>
Signed-off-by: André Silva <[email protected]>
@askpt
Refactor FlagMetadata class to use ImmutableDictionary
d7ba40f 
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 <[email protected]>
@askpt
Adding initial tests.
b04f01c 
Signed-off-by: André Silva <[email protected]>
@askpt
Moved code and fixed code smells.
0fb919c 
Signed-off-by: André Silva <[email protected]>
@askpt
Fix code. Added unit tests.
4ad9ca5 
Signed-off-by: André Silva <[email protected]>
@askpt
Change namespace scope. Added nullable check.
9813d3c 
Signed-off-by: André Silva <[email protected]>
@askpt askpt force-pushed the askpt/192-feature-implement-flag-metadata branch from b245d9b to 9813d3c Compare January 30, 2024 16:38
@codecov Codecov
Copy link

codecov bot commented Jan 30, 2024 •
edited
Loading

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.

@askpt askpt changed the title Implement flag metadata Feat: Flag metadata Jan 30, 2024
@askpt askpt changed the title Feat: Flag metadata feat: Flag metadata Jan 30, 2024
@askpt
Adding reference.
5a2dcc9 
Signed-off-by: André Silva <[email protected]>
@askpt
Copy link
Member Author

askpt commented Feb 2, 2024 •
edited
Loading

@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

@toddbaert
Copy link
Member

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).

This was referenced Feb 8, 2024
Merged
Merged
@toddbaert
Copy link
Member

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

@askpt askpt force-pushed the askpt/192-feature-implement-flag-metadata branch from a718ba5 to 2761bff Compare February 12, 2024 08:13
@askpt askpt mentioned this pull request Feb 12, 2024
Closed
@askpt askpt marked this pull request as ready for review February 12, 2024 17:00
@askpt askpt requested a review from a team as a code owner February 12, 2024 17:00
@askpt askpt requested a review from toddbaert February 12, 2024 17:00
@askpt askpt requested a review from kinyoklion February 12, 2024 17:33
@askpt askpt merged commit fd0a541 into main Feb 12, 2024
16 checks passed
@askpt askpt deleted the askpt/192-feature-implement-flag-metadata branch February 12, 2024 20:51
@github-actions github-actions bot mentioned this pull request Feb 12, 2024
Merged
beeme1mr pushed a commit that referenced this pull request Mar 12, 2024
@github-actions
chore(main): release 1.5.0 (#205)
b23334b 
🤖 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>
arttonoyan pushed a commit to arttonoyan/dotnet-sdk that referenced this pull request Nov 17, 2024
@askpt @arttonoyan
feat: Flag metadata (open-feature#223)
403c40f 
Signed-off-by: Artyom Tonoyan <[email protected]>
arttonoyan pushed a commit to arttonoyan/dotnet-sdk that referenced this pull request Nov 17, 2024
@github-actions @arttonoyan
chore(main): release 1.5.0 (open-feature#205)
454d20e 
🤖 I have created a release *beep* *boop*
---

##
[1.5.0](open-feature/dotnet-sdk@v1.4.1...v1.5.0)
(2024-03-12)

### 🐛 Bug Fixes

* Add targeting key
([open-feature#231](open-feature#231))
([d792b32](open-feature@d792b32))
* Fix NU1009 reference assembly warning
([open-feature#222](open-feature#222))
([7eebcdd](open-feature@7eebcdd))
* invalid editorconfig
([open-feature#244](open-feature#244))
([3c00757](open-feature@3c00757))

### ✨ New Features

* Flag metadata
([open-feature#223](open-feature#223))
([fd0a541](open-feature@fd0a541))
* implement in-memory provider
([open-feature#232](open-feature#232))
([1082094](open-feature@1082094))

### 🧹 Chore

* bump spec version badge
([open-feature#246](open-feature#246))
([ebf5552](open-feature@ebf5552))
* cleanup unused usings 🧹
([open-feature#240](open-feature#240))
([cdc1bee](open-feature@cdc1bee))
* **deps:** update actions/upload-artifact action to v4.3.0
([open-feature#203](open-feature#203))
([0a7e98d](open-feature@0a7e98d))
* **deps:** update actions/upload-artifact action to v4.3.1
([open-feature#233](open-feature#233))
([cfaf1c8](open-feature@cfaf1c8))
* **deps:** update codecov/codecov-action action to v3.1.5
([open-feature#209](open-feature#209))
([a509b1f](open-feature@a509b1f))
* **deps:** update codecov/codecov-action action to v3.1.6
([open-feature#226](open-feature#226))
([a577a80](open-feature@a577a80))
* **deps:** update dependency coverlet.collector to v6.0.1
([open-feature#238](open-feature#238))
([f2cb67b](open-feature@f2cb67b))
* **deps:** update dependency fluentassertions to v6.12.0
([open-feature#215](open-feature#215))
([2c237df](open-feature@2c237df))
* **deps:** update dependency microsoft.net.test.sdk to v17.8.0
([open-feature#216](open-feature#216))
([4cb3ae0](open-feature@4cb3ae0))
* **deps:** update dependency nsubstitute to v5.1.0
([open-feature#217](open-feature#217))
([3be76cd](open-feature@3be76cd))
* **deps:** update dependency openfeature.contrib.providers.flagd to
v0.1.8 ([open-feature#211](open-feature#211))
([c1aece3](open-feature@c1aece3))
* **deps:** update xunit-dotnet monorepo
([open-feature#236](open-feature#236))
([fa25ece](open-feature@fa25ece))
* Enable Central Package Management (CPM)
([open-feature#178](open-feature#178))
([249a0a8](open-feature@249a0a8))
* Enforce coding styles on build
([open-feature#242](open-feature#242))
([64699c8](open-feature@64699c8))
* More sln cleanup
([open-feature#206](open-feature#206))
([bac3d94](open-feature@bac3d94))
* SourceLink is built-in for .NET SDK 8.0.100+
([open-feature#198](open-feature#198))
([45e2c86](open-feature@45e2c86))
* Sync ci.yml with contrib repo
([open-feature#196](open-feature#196))
([130654b](open-feature@130654b))
* Sync release.yml with ci.yml following
[open-feature#173](open-feature#173)
([open-feature#195](open-feature#195))
([eba8848](open-feature@eba8848))

### 📚 Documentation

* fix hook ecosystem link
([open-feature#229](open-feature#229))
([cc6c404](open-feature@cc6c404))
* update the feature table key
([f8724cd](open-feature@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>
Signed-off-by: Artyom Tonoyan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@toddbaert toddbaert toddbaert approved these changes

@kinyoklion kinyoklion kinyoklion approved these changes

@beeme1mr beeme1mr Awaiting requested review from beeme1mr

@benjiro benjiro Awaiting requested review from benjiro

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEATURE] Implement flag metadata
5 participants
@askpt @toddbaert @kinyoklion @austindrenski @beeme1mr