feat: FlagD Provider #19

erenatas · 2025-02-17T17:39:51Z

This PR

Implements FlagD provider, including support for RPC evaluation, In-Process, OFREP and Offline modes.

Configuration and relevant feature set should be 100% compliant with testbed. Includes E2E testing done with testcontainers-rs and flagd and envoy containers.

Notes

My main intention with OFREP support was to generate client from OpenAPI specification, however as of working on this implementation, there is no suitable client generator for OpenAPI 3.1.0.
I haven't been able to test 2 features in an automated manner, which are E2E testing of selector, and Socket implementation for In-Process implementation.
I spent several evenings in trying to have 100% pass for cucumber tests for config.feature, however I have given up as I could not find a straightforward way to pass all of them at once.

Linked issues

Should resolve #5

How to test

Follow instructions on README.md.

This work is in progress and in internal review, - Envoy nameresolver, testcontainer impl does not work yet Signed-off-by: Eren Atas <[email protected]>

Signed-off-by: Eren Atas <[email protected]>

beeme1mr

Wow, this is very impressive. Nice job @erenatas!

Honestly, a lot of this is beyond my Rust skills, so I mainly focused on the configurations, documentation, and general structure.

beeme1mr · 2025-02-18T19:14:45Z

crates/flagd/Cargo.toml

@@ -1,9 +1,45 @@
 [package]
 name = "open-feature-flagd"
-version = "0.1.0"
+version = "0.0.1"


As a follow up, we'll want to wire up Release Please so this version can be automatically managed.

I can add something like

name: Release Please on: push: branches: - main jobs: release: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Generate Release Pull Request uses: googleapis/release-please-action@v2 with: token: ${{ secrets.GITHUB_TOKEN }} release-type: cargo

If that sounds good?

I can handle this in a follow-up pr. I have an embarrassing amount of experience with release please at this point.

I also update rust build yaml to install protoc however I believe I need approval to test.

crates/flagd/README.md

crates/flagd/src/resolver/rpc.rs

crates/flagd/tests/README.md

crates/flagd/tests/common/mod.rs

beeme1mr · 2025-02-18T19:55:50Z

crates/flagd/tests/in_process_test.rs

+    assert_eq!(struct_result.value.fields["number"], Value::Int(42));
+}
+
+// TODO: MAKE THIS WORK


Is this relevant in this PR or is it something to follow up on?

I want to get this to work, but I couldn't. I would like to have 2 flagd containers where I would like to pass one of them to the other as a source with a selector so that I can E2E test selector functionality but I couldn't get this to work as much as I tried. I tried to replicate what is written in flagd documentation, I couldn't get it to work. I either get something like: "timeout while waiting for all sync sources to complete their initial sync. continuing sync service", or "sync server stopped". I tried doing:

$ echo '{ "$schema": "https://flagd.dev/schema/v0/flags.json", "flags": { "scoped-flag": { "state": "ENABLED", "variants": { "on": true, "off": false }, "defaultVariant": "on", "source": "test-scope" } } }' > config.json $ docker run --network flagd-net -v $(pwd)/config.json:/etc/flagd/config.json ghcr.io/open-feature/flagd start --port 8013 --sources='[{"uri":"/etc/flagd/config.json","provider":"file"},{"uri":"flagd-source:8013","provider":"grpc","selector":"test-scope"}]' $ docker run --network flagd-net -v $(pwd)/config.json:/etc/flagd/config.json -p 8018:8013 -p 8020:8015 -p 8021:8016 ghcr.io/open-feature/flagd start --port 8013 --sources='[{"uri":"/etc/flagd/config.json","provider":"file"},{"uri":"flagd-source:8016/flags.json","provider":"http","selector":"test-scope"}]'

It didn't work unfortunately. If you have any tips I would be very happy to hear.

crates/flagd/tests/targeting_test.rs

Signed-off-by: Eren Atas <[email protected]>

erenatas

Not done yet

erenatas · 2025-02-18T22:46:10Z

crates/flagd/Cargo.toml

@@ -1,9 +1,45 @@
 [package]
 name = "open-feature-flagd"
-version = "0.1.0"
+version = "0.0.1"


I can add something like

name: Release Please on: push: branches: - main jobs: release: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Generate Release Pull Request uses: googleapis/release-please-action@v2 with: token: ${{ secrets.GITHUB_TOKEN }} release-type: cargo

If that sounds good?

crates/flagd/README.md

erenatas · 2025-02-18T23:27:25Z

crates/flagd/src/resolver/rest.rs

Once I understand what's difference of an "OFREP" provider exactly I doubt it would be that difficult, however is it ok if we do this separately? I would be happy to work on it and abstract this part away from this crate.

Another thing is as I stated over the PR description I originally intended to generate the client over openapi yaml however I could not find a suitable client generator that supports 3.1.0 yet. From what I have seenprogenitor is most used client generator and support is not there yet.

crates/flagd/tests/README.md

crates/flagd/tests/common/mod.rs

erenatas · 2025-02-18T23:47:43Z

crates/flagd/tests/in_process_test.rs

+    assert_eq!(struct_result.value.fields["number"], Value::Int(42));
+}
+
+// TODO: MAKE THIS WORK


I want to get this to work, but I couldn't. I would like to have 2 flagd containers where I would like to pass one of them to the other as a source with a selector so that I can E2E test selector functionality but I couldn't get this to work as much as I tried. I tried to replicate what is written in flagd documentation, I couldn't get it to work. I either get something like: "timeout while waiting for all sync sources to complete their initial sync. continuing sync service", or "sync server stopped". I tried doing:

$ echo '{ "$schema": "https://flagd.dev/schema/v0/flags.json", "flags": { "scoped-flag": { "state": "ENABLED", "variants": { "on": true, "off": false }, "defaultVariant": "on", "source": "test-scope" } } }' > config.json $ docker run --network flagd-net -v $(pwd)/config.json:/etc/flagd/config.json ghcr.io/open-feature/flagd start --port 8013 --sources='[{"uri":"/etc/flagd/config.json","provider":"file"},{"uri":"flagd-source:8013","provider":"grpc","selector":"test-scope"}]' $ docker run --network flagd-net -v $(pwd)/config.json:/etc/flagd/config.json -p 8018:8013 -p 8020:8015 -p 8021:8016 ghcr.io/open-feature/flagd start --port 8013 --sources='[{"uri":"/etc/flagd/config.json","provider":"file"},{"uri":"flagd-source:8016/flags.json","provider":"http","selector":"test-scope"}]'

It didn't work unfortunately. If you have any tips I would be very happy to hear.

crates/flagd/tests/targeting_test.rs

Signed-off-by: Eren Atas <[email protected]>

crates/flagd/build.rs

beeme1mr

Unless someone objects, I'm going to try and merge this tomorrow. It's still marked as experimental, so we can make changes as necessary but at least we can tackle them in small chunks.

erenatas · 2025-02-20T15:33:39Z

Before squash, I would appreacite if you add my colleagues' mails who helped review:

Reviewed-by: Alan dos Santos <[email protected]>
Reviewed-by: Kaan Karakaya <[email protected]>
Reviewed-by: Vinicius Gobbo <[email protected]>

I would like to note down here that I appreciate all of their help!

Signed-off-by: Eren Atas <[email protected]>

erenatas · 2025-02-20T16:05:15Z

@beeme1mr build+tests passed after recursive submodule pull, two notes:

config.feature tests:

 [Summary]
1 feature
83 scenarios (77 passed, 1 skipped, 5 failed)
254 steps (248 passed, 1 skipped, 5 failed)
test config_test ... ok

I really couldn't figure out how to pass all of them at once properly, I really tried
2. You will see chcon stderrs that doesn't affect the result, this is because on Linux machines if selinux is enabled you need to allow files to be used by containers with chcon, this was not an issue on my work mac and personal fedora but apparently it logs some stderr here, it doesn't break tests

Signed-off-by: Eren Atas <[email protected]>

erenatas added 2 commits February 12, 2025 23:09

Draft: Initial Commit,

111529a

This work is in progress and in internal review, - Envoy nameresolver, testcontainer impl does not work yet Signed-off-by: Eren Atas <[email protected]>

Fix envoy resolution, improvements

5671726

Signed-off-by: Eren Atas <[email protected]>

erenatas changed the title ~~FlagD Provider~~ feat: FlagD Provider Feb 17, 2025

beeme1mr reviewed Feb 18, 2025

View reviewed changes

beeme1mr requested review from toddbaert, sheepduke, gruebel, MaximFischuk, aepfli and chrfwow February 18, 2025 20:05

Update after comments

599b969

Signed-off-by: Eren Atas <[email protected]>

erenatas commented Feb 18, 2025

View reviewed changes

erenatas added 3 commits February 19, 2025 01:12

Update after comments, cargo fmt

af727fa

Signed-off-by: Eren Atas <[email protected]>

Add tokio sleep until there is a better way to fix flakiness

f9fe772

Signed-off-by: Eren Atas <[email protected]>

Proper fractal testing, fix flakiness of retry mechanism

84bfb81

Signed-off-by: Eren Atas <[email protected]>

erenatas requested a review from beeme1mr February 19, 2025 20:29

beeme1mr reviewed Feb 19, 2025

View reviewed changes

crates/flagd/build.rs Show resolved Hide resolved

beeme1mr reviewed Feb 19, 2025

View reviewed changes

erenatas added 2 commits February 20, 2025 16:49

rust.yml: pull submodules recursively

a83a214

Signed-off-by: Eren Atas <[email protected]>

Update testbed

9380339

Signed-off-by: Eren Atas <[email protected]>

Fix fractional, ensure to return variant and flag_metadata

4304e71

Signed-off-by: Eren Atas <[email protected]>

erenatas force-pushed the flagd-provider branch from 9457450 to 4304e71 Compare February 20, 2025 18:14

beeme1mr approved these changes Feb 20, 2025

View reviewed changes

beeme1mr merged commit a1a8573 into open-feature:main Feb 20, 2025
4 checks passed

beeme1mr mentioned this pull request Feb 20, 2025

chore: add erenatas open-feature/community#430

Merged

openfeaturebot mentioned this pull request Feb 20, 2025

chore(main): release open-feature-flagd 0.0.2 #21

Merged

erenatas deleted the flagd-provider branch February 23, 2025 14:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: FlagD Provider #19

feat: FlagD Provider #19

erenatas commented Feb 17, 2025 •

edited

Loading

beeme1mr left a comment

beeme1mr Feb 18, 2025

erenatas Feb 18, 2025

beeme1mr Feb 19, 2025

erenatas Feb 19, 2025

beeme1mr Feb 18, 2025

erenatas Feb 18, 2025

erenatas left a comment

erenatas Feb 18, 2025

erenatas Feb 18, 2025

erenatas Feb 18, 2025

beeme1mr left a comment

erenatas commented Feb 20, 2025

erenatas commented Feb 20, 2025

feat: FlagD Provider #19

feat: FlagD Provider #19

Conversation

erenatas commented Feb 17, 2025 • edited Loading

This PR

Notes

Linked issues

How to test

beeme1mr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erenatas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beeme1mr left a comment

Choose a reason for hiding this comment

erenatas commented Feb 20, 2025

erenatas commented Feb 20, 2025

erenatas commented Feb 17, 2025 •

edited

Loading