feat: add support for all retrievers in cli #4025

DeamonDev · 2025-10-06T07:19:27Z

Description

I added new flags related to other kind of retrievers. Based on them the new retriever is being spawned (but see #4024).
There is also new --check-mode flag which when present would only dump the configuration of retriever being used to perform evaluate call. It also served me while testing some multi-flags (like http's --header) because there is some kind of parsing logic at evaluate_cmd layer.

The redis retriever is not supported because of #4023. We may of course hack it and provide empty output when -kind=redis but I think the refactor of RetrieverConf struct would benefit more.

Closes issue(s)

Resolve #3876

Checklist

I have tested this code
I have added unit test to cover this code
I have updated the documentation (README.md and /website/docs)
I have followed the contributing guide

Signed-off-by: deamondev <[email protected]>

netlify · 2025-10-06T07:19:32Z

✅ Deploy Preview for go-feature-flag-doc-preview canceled.

Name	Link
🔨 Latest commit	`f650bcc`
🔍 Latest deploy log	https://app.netlify.com/projects/go-feature-flag-doc-preview/deploys/68fe18d0b2503f000881223b

codecov · 2025-10-06T07:23:50Z

Codecov Report

❌ Patch coverage is 90.53254% with 16 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.06%. Comparing base (a28007f) to head (f650bcc).

Files with missing lines	Patch %	Lines
cmd/cli/evaluate/evaluate_cmd.go	92.68%	6 Missing and 6 partials ⚠️
retriever/gcstorageretriever/retriever.go	0.00%	2 Missing ⚠️
retriever/s3retrieverv2/retriever.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4025      +/-   ##
==========================================
+ Coverage   84.93%   85.06%   +0.13%     
==========================================
  Files         138      138              
  Lines        5643     5806     +163     
==========================================
+ Hits         4793     4939     +146     
- Misses        644      654      +10     
- Partials      206      213       +7

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

thomaspoignant · 2025-10-13T18:42:36Z

retriever/s3retrieverv2/retriever.go

+
+func (s *Retriever) SetDownloader(downloader DownloaderAPI) {
+	s.downloader = downloader
+}


Just to be sure, why do you need this function?
You can probably set the downloader directly in the struct?

It is used indeed in test

r, err := retrieverInit.InitRetriever( &retrieverconf.RetrieverConf{ Kind: "s3", Bucket: "Bucket", Item: "valid", }) if err != nil { return evaluate{}, err } s3Retriever, _ := r.(*s3retrieverv2.Retriever) s3Retriever.SetDownloader(downloader)

And downloader is not (and should not be) a member of RetrieverConf (here I used, of course mocked downloader)

thomaspoignant · 2025-10-13T19:30:49Z

/gemini review

gemini-code-assist

Code Review

This pull request significantly enhances the CLI by adding support for all retrievers, which is a great feature. The implementation introduces a --check-mode for inspecting retriever configurations, which is very useful for debugging.

My review focuses on improving documentation clarity, fixing a parsing bug, and some minor code cleanup. I've identified a few issues in the README.md that could confuse users, a bug in the HTTP header parsing logic, and some opportunities for code refinement in the tests and command implementation.

Overall, this is a solid contribution. Addressing the feedback will make the new CLI features more robust and easier to use.

cmd/cli/evaluate/evaluate_cmd.go

cmd/cli/README.md

cmd/cli/evaluate/evaluate_cmd.go

cmd/cli/evaluate/evaluate_cmd_test.go

cmd/cli/evaluate/evaluate_test.go

Signed-off-by: deamondev <[email protected]>

sonarqubecloud · 2025-10-26T12:50:20Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

thomaspoignant

Hey @DeamonDev sorry if I am a bit late to review.

I've tested the changes and we are close to be good.
Can you address the last changes if you don't mind?

thomaspoignant · 2025-10-20T20:15:17Z

cmd/cli/README.md

+- `postgresql`
+
+**Caution**: We do not support `redis` retriever as for now due
+to: https://github.com/thomaspoignant/go-feature-flag/issues/4023.


Do you want to add the serializable layer on this PR or do you prefer to open another pull request for this?

thomaspoignant · 2025-10-20T20:16:05Z

cmd/cli/README.md

+
+| Flag     | Description                               | Default |
+|----------|-------------------------------------------|---------|
+| `--path` | Path to the local flag configuration file | ""      |


Can we have a default value to file to be similar to the old behavior as much as possible?

thomaspoignant · 2025-10-20T20:17:01Z

cmd/cli/README.md

+As mentioned above the `--config` flag is deprecated and we encourage you to use the `--path` flag instead. For example
+the following command:
+
 ```shell
 go-feature-flag-cli evaluate --config="<location_of_your_flag_configuration_file>" --flag="<name_of_your_flag_to_evaluate>" --ctx='<evaluation_ctx_as_json_string>'
 ```

+may be replaced by:
+
+```shell
+go-feature-flag-cli evaluate --kind="file" --path="<location_of_your_flag_configuration_file>" --flag="<name_of_your_flag_to_evaluate>" --ctx='<evaluation_ctx_as_json_string>'


👏 praise: ‏This is great to have an example here.

thomaspoignant · 2025-10-20T20:19:05Z

cmdhelpers/retrieverconf/retriever_conf.go

+	Kind           RetrieverKind `mapstructure:"kind"             koanf:"kind" json:"Kind"`
+	RepositorySlug string        `mapstructure:"repositorySlug"   koanf:"repositoryslug" json:"RepositorySlug"`
+	Branch         string        `mapstructure:"branch"           koanf:"branch" json:"Branch"`
+	Path           string        `mapstructure:"path"             koanf:"path" json:"Path"`
 	// Deprecated: Please use AuthToken instead
-	GithubToken string              `mapstructure:"githubToken"    koanf:"githubtoken"`
-	URL         string              `mapstructure:"url"            koanf:"url"`
-	Timeout     int64               `mapstructure:"timeout"        koanf:"timeout"`
-	HTTPMethod  string              `mapstructure:"method"         koanf:"method"`
-	HTTPBody    string              `mapstructure:"body"           koanf:"body"`
-	HTTPHeaders map[string][]string `mapstructure:"headers"        koanf:"headers"`
-	Bucket      string              `mapstructure:"bucket"         koanf:"bucket"`
-	Object      string              `mapstructure:"object"         koanf:"object"`
-	Item        string              `mapstructure:"item"           koanf:"item"`
-	Namespace   string              `mapstructure:"namespace"      koanf:"namespace"`
-	ConfigMap   string              `mapstructure:"configmap"      koanf:"configmap"`
-	Key         string              `mapstructure:"key"            koanf:"key"`
-	BaseURL     string              `mapstructure:"baseUrl"        koanf:"baseurl"`
-	AuthToken   string              `mapstructure:"token"          koanf:"token"`
+	GithubToken string              `mapstructure:"githubToken"   koanf:"githubtoken" json:"GithubToken"`
+	URL         string              `mapstructure:"url"           koanf:"url" json:"URL"`
+	Timeout     int64               `mapstructure:"timeout"       koanf:"timeout" json:"Timeout"`
+	HTTPMethod  string              `mapstructure:"method"        koanf:"method" json:"HTTPMethod"`
+	HTTPBody    string              `mapstructure:"body"          koanf:"body" json:"HTTPBody"`
+	HTTPHeaders map[string][]string `mapstructure:"headers"       koanf:"headers" json:"HTTPHeaders"`
+	Bucket      string              `mapstructure:"bucket"        koanf:"bucket" json:"Bucket"`
+	Object      string              `mapstructure:"object"        koanf:"object" json:"Object"`
+	Item        string              `mapstructure:"item"          koanf:"item" json:"Item"`
+	Namespace   string              `mapstructure:"namespace"     koanf:"namespace" json:"Namespace"`
+	ConfigMap   string              `mapstructure:"configmap"     koanf:"configmap" json:"ConfigMap"`
+	Key         string              `mapstructure:"key"           koanf:"key" json:"Key"`
+	BaseURL     string              `mapstructure:"baseUrl"       koanf:"baseurl" json:"BaseURL"`
+	AuthToken   string              `mapstructure:"token"         koanf:"token" json:"AuthToken"`


Do you really need to add the json tag in the struct?
What is the reason do you need it?

thomaspoignant · 2025-10-26T16:59:39Z

cmd/cli/evaluate/evaluate_cmd.go

+
+			err := retrieverConf.IsValid()
+			if err != nil {
+				return err


🔨 issue: ‏ With the current cli flags names there is an issue when the cli is in error, the error message is not consistent.

For example if I run

cli evaluate --kind=github --ctx='{"targetingKey": "123"}'

I will have the following error:

ERROR error executing command: invalid retriever: no "repositorySlug" property found for kind "github"

But your cli flags are waiting for repository-slug and not repositorySlug.

DeamonDev added 21 commits October 4, 2025 21:17

add support for github retriever

2f2665d

Signed-off-by: deamondev <[email protected]>

refactor evaluate struct

812c65d

Signed-off-by: deamondev <[email protected]>

add gitlab retriever support

9bb98da

Signed-off-by: deamondev <[email protected]>

fix formatting

a89ab25

Signed-off-by: deamondev <[email protected]>

add support for bitbucket retriever

09d5f1e

Signed-off-by: deamondev <[email protected]>

add support for s3 retriever

448aa69

Signed-off-by: deamondev <[email protected]>

start adding support for http retriever

1c05e87

Signed-off-by: deamondev <[email protected]>

add test for http retriever

8d62a36

Signed-off-by: deamondev <[email protected]>

add check flag

1163fa1

Signed-off-by: deamondev <[email protected]>

add test for evaluate cmd http retriever

15052c2

Signed-off-by: deamondev <[email protected]>

add more tests

86ffc80

Signed-off-by: deamondev <[email protected]>

add more tests for s3 and bitbucket

f551f0d

Signed-off-by: deamondev <[email protected]>

add support for gcs

6e54164

Signed-off-by: deamondev <[email protected]>

little refactor

2d97760

Signed-off-by: deamondev <[email protected]>

add support for mongodb

fc3678b

Signed-off-by: deamondev <[email protected]>

add support for azure and postgres

fadeb12

Signed-off-by: deamondev <[email protected]>

start writing docs

8230bce

Signed-off-by: deamondev <[email protected]>

add readme

d09c14f

Signed-off-by: deamondev <[email protected]>

add timeout in docs

58acc14

Signed-off-by: deamondev <[email protected]>

link redis options issue

e0fb0ca

Signed-off-by: deamondev <[email protected]>

add todo comment

fcf358d

Signed-off-by: deamondev <[email protected]>

github-actions bot assigned thomaspoignant Oct 6, 2025

github-actions bot requested a review from thomaspoignant October 6, 2025 07:19

DeamonDev changed the title ~~Feature add support for all retrievers in cli~~ feature: add support for all retrievers in cli Oct 6, 2025

DeamonDev changed the title ~~feature: add support for all retrievers in cli~~ feat: add support for all retrievers in cli Oct 6, 2025

DeamonDev mentioned this pull request Oct 6, 2025

(change) Add serializable configuration layer for redis options in struct describing configuration of retriever #4023

Open

thomaspoignant reviewed Oct 13, 2025

View reviewed changes

gemini-code-assist bot reviewed Oct 13, 2025

View reviewed changes

thomaspoignant and others added 4 commits October 16, 2025 09:24

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

c462a7e

little refactor

8e94cb1

Signed-off-by: deamondev <[email protected]>

trailing space

76f0a13

Signed-off-by: deamondev <[email protected]>

make lint happy

51a412b

Signed-off-by: deamondev <[email protected]>

DeamonDev force-pushed the feature-add-support-for-all-retrievers-in-cli branch from 72150d2 to 51a412b Compare October 17, 2025 13:12

DeamonDev added 6 commits October 17, 2025 15:15

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

19032d8

correct readme for cli

37303f9

Signed-off-by: deamondev <[email protected]>

correct initialization of retrievers

eb47d9a

Signed-off-by: deamondev <[email protected]>

correct tests after adding init calls

a2e0d93

Signed-off-by: deamondev <[email protected]>

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

451998d

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

e92a641

DeamonDev mentioned this pull request Oct 21, 2025

(change) Initialization of retrievers should also eventually call their specific initialization methods #4024

Open

DeamonDev added 3 commits October 23, 2025 10:00

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

9b34545

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

b88bdbe

Merge branch 'main' into feature-add-support-for-all-retrievers-in-cli

f650bcc

DeamonDev requested a review from thomaspoignant October 26, 2025 12:49

thomaspoignant requested changes Oct 26, 2025

View reviewed changes

Uh oh!

feat: add support for all retrievers in cli #4025

Are you sure you want to change the base?

feat: add support for all retrievers in cli #4025

Conversation

DeamonDev commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Closes issue(s)

Checklist

Uh oh!

netlify bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for go-feature-flag-doc-preview canceled.

Uh oh!

codecov bot commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thomaspoignant Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

DeamonDev Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thomaspoignant commented Oct 13, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 26, 2025

Quality Gate passed

Uh oh!

thomaspoignant left a comment

Choose a reason for hiding this comment

Uh oh!

thomaspoignant Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

thomaspoignant Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

thomaspoignant Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

thomaspoignant Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

thomaspoignant Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DeamonDev commented Oct 6, 2025 •

edited

Loading

netlify bot commented Oct 6, 2025 •

edited

Loading

codecov bot commented Oct 6, 2025 •

edited

Loading

DeamonDev Oct 17, 2025 •

edited

Loading