feat: support flag metadata #1476

aasifkhan7 · 2024-12-16T21:42:59Z

This PR

Adds functionality to return flag metadata as part of the response.

Related Issues

Fixes #1464

Notes

This PR ensures that flag metadata is included and handled correctly in responses.

netlify · 2024-12-16T21:43:16Z

✅ Deploy Preview for polite-licorice-3db33c canceled.

Name	Link
🔨 Latest commit	`534e07e`
🔍 Latest deploy log	https://app.netlify.com/sites/polite-licorice-3db33c/deploys/67875e4446a4f90008f3e18f

Signed-off-by: Aasif Khan <[email protected]>

beeme1mr · 2024-12-17T20:11:45Z

Hey @aasifkhan7, I tested this locally and wasn't able to see flag metadata returned as a response.

Here's the flag configuration I was using:

{
  "flags": {
    "myBoolFlag": {
      "state": "ENABLED",
      "variants": {
        "on": true,
        "off": false
      },
      "defaultVariant": "on"
    }
  },
  "metadata": {
    "id": "test",
    "version": "1"
  }
}

Here are the test evaluations I tried:

curl -X POST "localhost:8013/flagd.evaluation.v1.Service/ResolveBoolean" -d '{"flagKey":"myBoolFlag","context":{}}' -H "Content-Type: application/json"

and

curl -X POST 'http://localhost:8016/ofrep/v1/evaluate/flags'

Please map the id and version to flagSetId and flagSetVersion respectively in the flag metadata. That will set us up nicely once this spec PR is merged. Thanks!

Signed-off-by: Aasif Khan <[email protected]>

aasifkhan7 · 2024-12-18T11:36:47Z

Hi @beeme1mr,

I've updated the commit to include the setting of flagSetId and flagSetVersion in the flag metadata as well. Could you please re-review the changes?

toddbaert

@aasifkhan7 nice job so far!

OFREP works as expected:

curl -X POST 'http://localhost:8016/ofrep/v1/evaluate/flags' | jq

{
  "flags": [
    {
      "value": 1,
      "key": "myIntFlag",
      "reason": "STATIC",
      "variant": "one",
      "metadata": {
        "flagSetId": "test",
        "flagSetVersion": "1"
      },
    ...
    }
  ]
}

curl -X POST "localhost:8013/flagd.evaluation.v1.Service/ResolveBoolean" -d '{"flagKey":"myBoolFlag","context":{}}' -H "Content-Type: application/json" | jq


{
  "value": true,
  "reason": "STATIC",
  "variant": "on",
  "metadata": {
    "flagSetId": "test",
    "flagSetVersion": "1"
  }
}

I left some comments - I also think we need some basic test coverage for this, but nice job!

core/pkg/evaluator/json.go

core/pkg/store/flags.go

Signed-off-by: Aasif Khan <[email protected]>

apodgorbunschih · 2025-01-07T11:59:19Z

👋 Hello folks,
@aasifkhan7 I had a question regarding the following MR.
Accordingly to that spec https://github.com/open-feature/flagd-schemas/pull/173/files the Metadata can be "Any additional key/value pair with value of type boolean, string, or number.". However in this MR the Metadata have a defined structure. Or this is something else and I am confusing 2 things ? 🤔 🙏
Thanks in advance!

Signed-off-by: Aasif Khan <[email protected]>

aasifkhan7 · 2025-01-07T13:17:12Z

👋 Hello folks, @aasifkhan7 I had a question regarding the following MR. Accordingly to that spec https://github.com/open-feature/flagd-schemas/pull/173/files the Metadata can be "Any additional key/value pair with value of type boolean, string, or number.". However in this MR the Metadata have a defined structure. Or this is something else and I am confusing 2 things ? 🤔 🙏 Thanks in advance!

@apodgorbunschih I've updated the PR to handle any fields that come in metadata.

Please re-review @beeme1mr @toddbaert

beeme1mr

Thanks, I'll manually test this. Could you please also ensure there are tests in the PR. Thanks!

core/pkg/evaluator/json_model.go

core/pkg/model/flag.go

core/pkg/store/flags.go

beeme1mr · 2025-01-07T13:28:29Z

I've also addressed the unrelated license compliance issue.

Signed-off-by: Aasif Khan <[email protected]>

beeme1mr

I manually tested it it nearly works. Please adjust the merge priority logic and add some tests. We should be good to go after that. Thanks!

core/pkg/evaluator/json.go

toddbaert · 2025-01-13T20:49:39Z

Hey @aasifkhan7 ! This seems very close to done, with the exception of some tests. Are you able to finish any time soon? If not, I can add the tests onto your existing work (you will still appear as a committer).

Let me know!

aasifkhan7 · 2025-01-14T01:43:05Z

@toddbaert , sorry for the delay, I got busy the last few weeks.

I'll add the tests. Thanks.

Signed-off-by: Aasif Khan <[email protected]>

aasifkhan7 · 2025-01-15T07:06:00Z

I've added a few test cases @beeme1mr @toddbaert . Please take a look.

toddbaert

Manually tested both the gRPC and HTTP endpoints, looks good. Tests also look good.

Thanks so much for helping with this @aasifkhan7 and working through it with us! This will be extremely helpful for adding more powerful telemetry for flagd users.

🤖 I have created a release *beep* *boop* --- <details><summary>flagd: 0.11.6</summary> ## [0.11.6](flagd/v0.11.5...flagd/v0.11.6) (2025-01-15) ### 🐛 Bug Fixes * **deps:** update module buf.build/gen/go/open-feature/flagd/connectrpc/go to v1.17.0-20241220192239-696330adaff0.1 ([#1488](#1488)) ([8e09457](8e09457)) * **deps:** update module buf.build/gen/go/open-feature/flagd/connectrpc/go to v1.18.1-20241220192239-696330adaff0.1 ([#1506](#1506)) ([b868194](b868194)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.1 ([#1489](#1489)) ([53add83](53add83)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.2 ([#1492](#1492)) ([9f1d94a](9f1d94a)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.36.0-20241220192239-696330adaff0.1 ([#1490](#1490)) ([6edce72](6edce72)) * **deps:** update module github.com/mattn/go-colorable to v0.1.14 ([#1508](#1508)) ([87727f7](87727f7)) * **deps:** update module github.com/open-feature/flagd/core to v0.10.5 ([#1482](#1482)) ([ce48cb7](ce48cb7)) * **deps:** update module golang.org/x/net to v0.33.0 [security] ([#1486](#1486)) ([4764077](4764077)) * **deps:** update module golang.org/x/net to v0.34.0 ([#1498](#1498)) ([7584f95](7584f95)) * **deps:** update module google.golang.org/grpc to v1.69.2 ([#1484](#1484)) ([6b40ad3](6b40ad3)) * **deps:** update module google.golang.org/grpc to v1.69.4 ([#1510](#1510)) ([76d6353](76d6353)) * **deps:** update module google.golang.org/protobuf to v1.36.1 ([#1491](#1491)) ([2c729a7](2c729a7)) * **deps:** update opentelemetry-go monorepo ([#1470](#1470)) ([26b0b1a](26b0b1a)) ### ✨ New Features * add ssl support to sync service ([#1479](#1479)) ([#1501](#1501)) ([d50fcc8](d50fcc8)) </details> <details><summary>flagd-proxy: 0.6.9</summary> ## [0.6.9](flagd-proxy/v0.6.8...flagd-proxy/v0.6.9) (2025-01-15) ### 🐛 Bug Fixes * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.1 ([#1489](#1489)) ([53add83](53add83)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.2 ([#1492](#1492)) ([9f1d94a](9f1d94a)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.36.0-20241220192239-696330adaff0.1 ([#1490](#1490)) ([6edce72](6edce72)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.36.2-20241220192239-696330adaff0.1 ([#1502](#1502)) ([426c36e](426c36e)) * **deps:** update module github.com/mattn/go-colorable to v0.1.14 ([#1508](#1508)) ([87727f7](87727f7)) * **deps:** update module github.com/open-feature/flagd/core to v0.10.5 ([#1482](#1482)) ([ce48cb7](ce48cb7)) * **deps:** update module golang.org/x/net to v0.33.0 [security] ([#1486](#1486)) ([4764077](4764077)) * **deps:** update module golang.org/x/net to v0.34.0 ([#1498](#1498)) ([7584f95](7584f95)) * **deps:** update module google.golang.org/grpc to v1.69.2 ([#1484](#1484)) ([6b40ad3](6b40ad3)) * **deps:** update module google.golang.org/grpc to v1.69.4 ([#1510](#1510)) ([76d6353](76d6353)) * **deps:** update opentelemetry-go monorepo ([#1470](#1470)) ([26b0b1a](26b0b1a)) </details> <details><summary>core: 0.10.6</summary> ## [0.10.6](core/v0.10.5...core/v0.10.6) (2025-01-15) ### 🐛 Bug Fixes * **deps:** update github.com/open-feature/flagd-schemas digest to 37baa2c ([#1499](#1499)) ([1a853f7](1a853f7)) * **deps:** update github.com/open-feature/flagd-schemas digest to b81a56e ([#1391](#1391)) ([6a3d8ac](6a3d8ac)) * **deps:** update golang.org/x/exp digest to 7588d65 ([#1495](#1495)) ([242e594](242e594)) * **deps:** update golang.org/x/exp digest to b2144cd ([#1320](#1320)) ([a692b00](a692b00)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.1 ([#1489](#1489)) ([53add83](53add83)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.5.1-20241220192239-696330adaff0.2 ([#1492](#1492)) ([9f1d94a](9f1d94a)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.36.0-20241220192239-696330adaff0.1 ([#1490](#1490)) ([6edce72](6edce72)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.36.2-20241220192239-696330adaff0.1 ([#1502](#1502)) ([426c36e](426c36e)) * **deps:** update module connectrpc.com/connect to v1.18.1 ([#1507](#1507)) ([89d3259](89d3259)) * **deps:** update module github.com/diegoholiveira/jsonlogic/v3 to v3.7.0 ([#1496](#1496)) ([e1fe149](e1fe149)) * **deps:** update module github.com/diegoholiveira/jsonlogic/v3 to v3.7.1 ([#1509](#1509)) ([9d06812](9d06812)) * **deps:** update module golang.org/x/crypto to v0.32.0 ([#1497](#1497)) ([63a34d2](63a34d2)) * **deps:** update module google.golang.org/grpc to v1.69.2 ([#1484](#1484)) ([6b40ad3](6b40ad3)) * **deps:** update module google.golang.org/grpc to v1.69.4 ([#1510](#1510)) ([76d6353](76d6353)) * **deps:** update opentelemetry-go monorepo ([#1470](#1470)) ([26b0b1a](26b0b1a)) ### ✨ New Features * add ssl support to sync service ([#1479](#1479)) ([#1501](#1501)) ([d50fcc8](d50fcc8)) * support flag metadata ([#1476](#1476)) ([13fbbad](13fbbad)) </details> --- 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: OpenFeature Bot <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

aasifkhan7 requested a review from a team as a code owner December 16, 2024 21:43

dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Dec 16, 2024

aasifkhan7 changed the title ~~return flag metadata as well~~ feat: return flag metadata as well Dec 17, 2024

aasifkhan7 force-pushed the feat/flag-metadata branch 3 times, most recently from 3b6e501 to c55537f Compare December 17, 2024 05:20

return flag metadata as well

931c120

Signed-off-by: Aasif Khan <[email protected]>

aasifkhan7 force-pushed the feat/flag-metadata branch from c55537f to 931c120 Compare December 17, 2024 05:22

aasifkhan7 added 2 commits December 17, 2024 10:54

Merge branch 'main' into feat/flag-metadata

29bd3f7

added a json name for flagsetmetadata

5d8173e

Signed-off-by: Aasif Khan <[email protected]>

fix: start returning flagSetId, flagSetVersion as well in flag metadata

dd48ee3

Signed-off-by: Aasif Khan <[email protected]>

aasifkhan7 force-pushed the feat/flag-metadata branch from f75d5b5 to dd48ee3 Compare December 18, 2024 11:33

toddbaert reviewed Dec 18, 2024

View reviewed changes

core/pkg/evaluator/json.go Outdated Show resolved Hide resolved

toddbaert reviewed Dec 18, 2024

View reviewed changes

core/pkg/store/flags.go Outdated Show resolved Hide resolved

toddbaert requested review from hairyhenderson, Kavindu-Dodan, aepfli, toddbaert, warber, craigpastro, gruebel and thisthat December 18, 2024 14:22

aasifkhan7 added 3 commits December 20, 2024 13:28

fetching flag metadata with a single lock

5cb824c

Signed-off-by: Aasif Khan <[email protected]>

change id of flagSet -> id

bb2ca43

Signed-off-by: Aasif Khan <[email protected]>

Merge branch 'open-feature:main' into feat/flag-metadata

9480943

metadata can be any generic value

c1770b1

Signed-off-by: Aasif Khan <[email protected]>

beeme1mr reviewed Jan 7, 2025

View reviewed changes

core/pkg/evaluator/json_model.go Outdated Show resolved Hide resolved

core/pkg/model/flag.go Outdated Show resolved Hide resolved

core/pkg/store/flags.go Outdated Show resolved Hide resolved

aasifkhan7 added 2 commits January 8, 2025 12:57

changed MetaData -> Metadata

9907dd4

Signed-off-by: Aasif Khan <[email protected]>

Merge branch 'open-feature:main' into feat/flag-metadata

fddcc3c

beeme1mr reviewed Jan 8, 2025

View reviewed changes

core/pkg/evaluator/json.go Outdated Show resolved Hide resolved

beeme1mr changed the title ~~feat: return flag metadata as well~~ feat: support flag metadata Jan 9, 2025

beeme1mr mentioned this pull request Jan 13, 2025

feat: add support for flag metadata, add loading screens open-feature/toggle-shop#21

Open

aasifkhan7 added 3 commits January 15, 2025 06:06

added omitifempty on sourceMetadata, metadata

bb2dab1

Signed-off-by: Aasif Khan <[email protected]>

Merge branch 'open-feature:main' into feat/flag-metadata

aa16441

added tests

534e07e

Signed-off-by: Aasif Khan <[email protected]>

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Jan 15, 2025

toddbaert requested a review from beeme1mr January 15, 2025 18:35

toddbaert approved these changes Jan 15, 2025

View reviewed changes

beeme1mr approved these changes Jan 15, 2025

View reviewed changes

toddbaert merged commit 13fbbad into open-feature:main Jan 15, 2025
14 checks passed

github-actions bot mentioned this pull request Jan 15, 2025

chore: release main #1483

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support flag metadata #1476

feat: support flag metadata #1476

aasifkhan7 commented Dec 16, 2024 •

edited

Loading

netlify bot commented Dec 16, 2024 •

edited

Loading

beeme1mr commented Dec 17, 2024

aasifkhan7 commented Dec 18, 2024

toddbaert left a comment

apodgorbunschih commented Jan 7, 2025

aasifkhan7 commented Jan 7, 2025

beeme1mr left a comment

beeme1mr commented Jan 7, 2025

beeme1mr left a comment

toddbaert commented Jan 13, 2025

aasifkhan7 commented Jan 14, 2025

aasifkhan7 commented Jan 15, 2025

toddbaert left a comment

feat: support flag metadata #1476

feat: support flag metadata #1476

Conversation

aasifkhan7 commented Dec 16, 2024 • edited Loading

This PR

Related Issues

Notes

netlify bot commented Dec 16, 2024 • edited Loading

✅ Deploy Preview for polite-licorice-3db33c canceled.

beeme1mr commented Dec 17, 2024

aasifkhan7 commented Dec 18, 2024

toddbaert left a comment

Choose a reason for hiding this comment

apodgorbunschih commented Jan 7, 2025

aasifkhan7 commented Jan 7, 2025

beeme1mr left a comment

Choose a reason for hiding this comment

beeme1mr commented Jan 7, 2025

beeme1mr left a comment

Choose a reason for hiding this comment

toddbaert commented Jan 13, 2025

aasifkhan7 commented Jan 14, 2025

aasifkhan7 commented Jan 15, 2025

toddbaert left a comment

Choose a reason for hiding this comment

aasifkhan7 commented Dec 16, 2024 •

edited

Loading

netlify bot commented Dec 16, 2024 •

edited

Loading