-
Notifications
You must be signed in to change notification settings - Fork 666
Fetch Feature Flag with call to Feature Flag Gateway Api #6398
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
Open
brew42
wants to merge
1
commit into
main
Choose a base branch
from
feature/CSENG-68_AddFFG
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| package featureflaggateway | ||
|
|
||
| // FeatureFlagRequest request body for feature flag request. | ||
| type FeatureFlagRequest struct { | ||
| Data FeatureFlagsData `json:"data"` | ||
| } | ||
|
|
||
| // FeatureFlagsData represents feature flags response data. | ||
| type FeatureFlagsData struct { | ||
| Type string `json:"type"` | ||
| Attributes FeatureFlagsRequestAttributes `json:"attributes"` | ||
| } | ||
|
|
||
| // FeatureFlagsRequestAttributes represents feature flags request attributes. | ||
| type FeatureFlagsRequestAttributes struct { | ||
| Flags []string `json:"flags"` | ||
| } | ||
|
|
||
| // FeatureFlagsResponse represents the updated response format. | ||
| type FeatureFlagsResponse struct { | ||
| Data FeatureFlagsDataItem `json:"data"` | ||
| } | ||
|
|
||
| // FeatureFlagsDataItem represents the "data" object (previously slice). | ||
| type FeatureFlagsDataItem struct { | ||
| ID string `json:"id"` | ||
| Type string `json:"type"` | ||
| Attributes FeatureFlagAttributesList `json:"attributes"` | ||
| } | ||
|
|
||
| // FeatureFlagAttributesList represents attributes containing evaluations + evaluated_at. | ||
| type FeatureFlagAttributesList struct { | ||
| Evaluations []FeatureFlagAttributes `json:"evaluations"` | ||
| EvaluatedAt string `json:"evaluatedAt"` | ||
| } | ||
|
|
||
| // FeatureFlagAttributes represent one evaluation result. | ||
| type FeatureFlagAttributes struct { | ||
| Key string `json:"key"` | ||
| Value bool `json:"value"` | ||
| Reason string `json:"reason"` | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| package featureflaggateway | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
| "path" | ||
| "strings" | ||
| "time" | ||
| ) | ||
|
|
||
| const ( | ||
| // ApplicationJSON is the content type for JSON. | ||
| ApplicationJSON = "application/json" | ||
| userAgent = "User-Agent" | ||
| contentType = "Content-Type" | ||
| accept = "Accept" | ||
| snykCli = "snyk-cli" | ||
| authorization = "Authorization" | ||
| defaultVersion = "2024-10-15" | ||
| ) | ||
|
|
||
| // Service is a service for interacting with Feature Flag Gateway. | ||
| type Service interface { | ||
| EvaluateFlags(ctx context.Context, flags []string, orgID string, version string, token string) (*FeatureFlagsResponse, error) | ||
| } | ||
|
|
||
| // Client is an HTTP client for the Feature Flag Gateway | ||
| // endpoint. | ||
| type Client struct { | ||
| baseURL *url.URL | ||
| client *http.Client | ||
| } | ||
|
|
||
| // NewService creates a new Feature Flag Gateway client. | ||
| func NewService(baseURL *url.URL, requestTimeout time.Duration) (*Client, error) { | ||
| if baseURL == nil { | ||
| return nil, fmt.Errorf("base URL is nil") | ||
| } | ||
|
|
||
| client := &http.Client{ | ||
| Timeout: requestTimeout, | ||
| } | ||
|
|
||
| return &Client{ | ||
| baseURL: baseURL, | ||
| client: client, | ||
| }, nil | ||
| } | ||
|
|
||
| // EvaluateFlags evaluates feature flags for a given organization. | ||
| func (c *Client) EvaluateFlags(ctx context.Context, flags []string, orgID string, version string, token string) (featureFlagsResponse *FeatureFlagsResponse, retErr error) { | ||
| orgID = strings.TrimSpace(orgID) | ||
| if orgID == "" { | ||
| return nil, fmt.Errorf("orgID is required") | ||
| } | ||
|
|
||
| token = strings.TrimSpace(token) | ||
| if token == "" { | ||
| return nil, fmt.Errorf("token is required") | ||
| } | ||
|
|
||
| if version == "" { | ||
| version = defaultVersion | ||
| } | ||
|
|
||
| reqBody := buildRequest(flags) | ||
| bodyBytes, err := json.Marshal(reqBody) | ||
| if err != nil { | ||
| return featureFlagsResponse, fmt.Errorf("marshal evaluate flags request: %w", err) | ||
| } | ||
|
|
||
| req, err := http.NewRequestWithContext(ctx, http.MethodPost, c.getBaseURL(orgID, version), bytes.NewReader(bodyBytes)) | ||
| if err != nil { | ||
| return featureFlagsResponse, fmt.Errorf("create evaluate flagsrequest: %w", err) | ||
| } | ||
|
|
||
| req.Header.Add(contentType, ApplicationJSON) | ||
| req.Header.Add(accept, ApplicationJSON) | ||
| req.Header.Add(userAgent, snykCli) | ||
| req.Header.Set(authorization, "token "+token) | ||
|
|
||
| resp, err := c.client.Do(req) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("making evaluate flags request: %w", err) | ||
| } | ||
| defer func() { | ||
| retErr = errors.Join(retErr, resp.Body.Close()) | ||
| }() | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| err = fmt.Errorf("evaluate flags failed: status=%d", resp.StatusCode) | ||
| return nil, err | ||
| } | ||
|
|
||
| if err := json.NewDecoder(resp.Body).Decode(&featureFlagsResponse); err != nil { | ||
| return nil, fmt.Errorf("decode evaluate flags response: %w", err) | ||
| } | ||
|
|
||
| return featureFlagsResponse, nil | ||
| } | ||
|
|
||
| func buildRequest(flags []string) FeatureFlagRequest { | ||
| return FeatureFlagRequest{ | ||
| Data: FeatureFlagsData{ | ||
| Type: "feature_flags_evaluation", | ||
| Attributes: FeatureFlagsRequestAttributes{ | ||
| Flags: flags, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (c *Client) getBaseURL(orgID, version string) string { | ||
| if version == "" { | ||
| version = defaultVersion | ||
| } | ||
|
|
||
| u := *c.baseURL | ||
| u.Path = path.Join( | ||
| u.Path, | ||
| "orgs", | ||
| url.PathEscape(orgID), | ||
| "feature_flags", | ||
| "evaluation", | ||
| ) | ||
|
|
||
| q := u.Query() | ||
| q.Set("version", version) | ||
| u.RawQuery = q.Encode() | ||
|
|
||
| return u.String() | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should consider moving these classes to the pkg folder in the feature-flag-gateway repo so they can be reused wherever this service is used.