Skip to content

feat: Flagd metadata #241

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.

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

Merged
merged 4 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions flags/selector-flag-combined-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"flags": {
"metadata-flag": {
"state": "ENABLED",
"variants": {
"true": true,
"false": false
},
"defaultVariant": "false",
"targeting": {},
"metadata": {
"string": "a",
"integer": 1,
"float": 1.2,
"boolean": true
}
}
},
"metadata": {
"string": "b",
"integer": 2,
"float": 2.2,
"boolean": false,
"flag-set-string": "c",
"flag-set-integer": 3,
"flag-set-float": 3.2,
"flag-set-boolean": false
}
}
19 changes: 19 additions & 0 deletions flags/selector-flag-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"flags": {
"metadata-flag": {
"state": "ENABLED",
"variants": {
"true": true,
"false": false
},
"defaultVariant": "false",
"targeting": {},
"metadata": {
"string": "a",
"integer": 1,
"float": 1.2,
"boolean": true
}
}
}
}
19 changes: 19 additions & 0 deletions flags/selector-flag-set-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"flags": {
"metadata-flag": {
"state": "ENABLED",
"variants": {
"true": true,
"false": false
},
"defaultVariant": "false",
"targeting": {}
}
},
"metadata": {
"string": "a",
"integer": 1,
"float": 1.2,
"boolean": true
}
}
52 changes: 52 additions & 0 deletions gherkin/metadata.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
@in-process @metadata @file
Feature: flag and flag set metadata

# This test suite contains scenarios to test flagd providers.
# It's associated with the flags configured in flags.
# It should be used in conjunction with the suites supplied by the OpenFeature specification.

Scenario: Returns metadata
Given an option "selector" of type "String" with value "rawflags/selector-flag-metadata.json"
And a stable flagd provider
And a Boolean-flag with key "metadata-flag" and a default value "true"
When the flag was evaluated with details
Then the resolved metadata should contain
| key | metadata_type | value |
| string | String | a |
| integer | Integer | 1 |
| float | Float | 1.2 |
| boolean | Boolean | true |

Scenario: Returns flag set metadata
Given an option "selector" of type "String" with value "rawflags/selector-flag-set-metadata.json"
And a stable flagd provider
And a Boolean-flag with key "metadata-flag" and a default value "true"
When the flag was evaluated with details
Then the resolved metadata should contain
| key | metadata_type | value |
| string | String | a |
| integer | Integer | 1 |
| float | Float | 1.2 |
| boolean | Boolean | true |

Scenario: Flag metadata overwrites flag set metadata
Given an option "selector" of type "String" with value "rawflags/selector-flag-combined-metadata.json"
And a stable flagd provider
And a Boolean-flag with key "metadata-flag" and a default value "true"
When the flag was evaluated with details
Then the resolved metadata should contain
| key | metadata_type | value |
| string | String | a |
| integer | Integer | 1 |
| float | Float | 1.2 |
| boolean | Boolean | true |
| flag-set-string | String | c |
| flag-set-integer | Integer | 3 |
| flag-set-float | Float | 3.2 |
| flag-set-boolean | Boolean | false |

Scenario: Returns no metadata
Given a Boolean-flag with key "boolean-flag" and a default value "true"
And a stable flagd provider
When the flag was evaluated with details
Then the resolved metadata is empty
12 changes: 12 additions & 0 deletions launchpad/configs/default.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@
{
"uri": "rawflags/selector-flags.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-metadata.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-set-metadata.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-combined-metadata.json",
"provider": "file"
}
],
"context-value": {
Expand Down
12 changes: 12 additions & 0 deletions launchpad/configs/ssl.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@
{
"uri": "rawflags/selector-flags.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-metadata.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-set-metadata.json",
"provider": "file"
},
{
"uri": "rawflags/selector-flag-combined-metadata.json",
"provider": "file"
}
],
"context-value": {
Expand Down
3 changes: 2 additions & 1 deletion launchpad/pkg/json.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"io/ioutil"
"os"
"path/filepath"
"strings"
"sync"
)

Expand All @@ -28,7 +29,7 @@ func CombineJSONFiles(inputDir string) error {
combinedData := make(map[string]interface{})

for _, file := range files {
if filepath.Ext(file.Name()) == ".json" {
if filepath.Ext(file.Name()) == ".json" && !strings.HasPrefix(file.Name(), "selector-") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you it seems that this have been lost during the refactoring

filePath := filepath.Join(inputDir, file.Name())
content, err := ioutil.ReadFile(filePath)
if err != nil {
Expand Down