Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add evalution reason #1099

Merged
merged 6 commits into from
Oct 28, 2022
Merged

feat: add evalution reason #1099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
93a732e
feat(wip): add evalution reason
markphelps Oct 27, 2022
be2fee1
chore: move reason to all error paths
markphelps Oct 27, 2022
d0f84ed
chore: add missing test coverage
markphelps Oct 27, 2022
bb12a99
chore: add API test for match reason
markphelps Oct 27, 2022
0813312
Merge branch 'main' into evaluation-reason
markphelps Oct 28, 2022
ba31aae
chore: update changelog
markphelps Oct 28, 2022
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

### Added

- `reason` field in `EvaluationResponse` payload detailing why the request evaluated to the given result [#1099](https://github.com/flipt-io/flipt/pull/1099)

### Deprecated

- Deprecated both `db.migrations.path` and `db.migrations_path` [#1096](https://github.com/flipt-io/flipt/pull/1096)
Expand Down
15 changes: 15 additions & 0 deletions internal/server/evaluator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,25 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli

flag, err := s.store.GetFlag(ctx, r.FlagKey)
if err != nil {
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON

var errnf errs.ErrNotFound
if errors.As(err, &errnf) {
resp.Reason = flipt.EvaluationReason_FLAG_NOT_FOUND_EVALUATION_REASON
}

return resp, err
}

if !flag.Enabled {
resp.Match = false
resp.Reason = flipt.EvaluationReason_FLAG_DISABLED_EVALUATION_REASON
return resp, nil
}

rules, err := s.store.GetEvaluationRules(ctx, r.FlagKey)
if err != nil {
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON
return resp, err
}

Expand All @@ -95,6 +104,7 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli
// rule loop
for _, rule := range rules {
if rule.Rank < lastRank {
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON
return resp, errs.ErrInvalidf("rule rank: %d detected out of order", rule.Rank)
}

Expand All @@ -119,10 +129,12 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli
case flipt.ComparisonType_BOOLEAN_COMPARISON_TYPE:
match, err = matchesBool(c, v)
default:
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON
return resp, errs.ErrInvalid("unknown constraint type")
}

if err != nil {
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON
return resp, err
}

Expand Down Expand Up @@ -180,6 +192,7 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli

distributions, err := s.store.GetEvaluationDistributions(ctx, rule.ID)
if err != nil {
resp.Reason = flipt.EvaluationReason_ERROR_EVALUATION_REASON
return resp, err
}

Expand Down Expand Up @@ -207,6 +220,7 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli
if len(validDistributions) == 0 {
s.logger.Info("no distributions for rule")
resp.Match = true
resp.Reason = flipt.EvaluationReason_MATCH_EVALUATION_REASON
return resp, nil
}

Expand All @@ -231,6 +245,7 @@ func (s *Server) evaluate(ctx context.Context, r *flipt.EvaluationRequest) (*fli
resp.Match = true
resp.Value = d.VariantKey
resp.Attachment = d.VariantAttachment
resp.Reason = flipt.EvaluationReason_MATCH_EVALUATION_REASON
return resp, nil
} // end rule loop

Expand Down
91 changes: 91 additions & 0 deletions internal/server/evaluator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package server

import (
"context"
"errors"
"testing"

"github.com/gofrs/uuid"
Expand Down Expand Up @@ -184,6 +185,7 @@ func TestEvaluate_FlagNotFound(t *testing.T) {
require.Error(t, err)
assert.EqualError(t, err, "flag \"foo\" not found")
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_FLAG_NOT_FOUND_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_FlagDisabled(t *testing.T) {
Expand All @@ -208,6 +210,7 @@ func TestEvaluate_FlagDisabled(t *testing.T) {

require.NoError(t, err)
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_FLAG_DISABLED_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_FlagNoRules(t *testing.T) {
Expand All @@ -234,6 +237,34 @@ func TestEvaluate_FlagNoRules(t *testing.T) {

require.NoError(t, err)
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_UNKNOWN_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_ErrorGettingRules(t *testing.T) {
var (
store = &storeMock{}
logger = zaptest.NewLogger(t)
s = &Server{
logger: logger,
store: store,
}
)

store.On("GetFlag", mock.Anything, "foo").Return(enabledFlag, nil)

store.On("GetEvaluationRules", mock.Anything, "foo").Return([]*storage.EvaluationRule{}, errors.New("error getting rules!"))

resp, err := s.Evaluate(context.TODO(), &flipt.EvaluationRequest{
EntityId: "1",
FlagKey: "foo",
Context: map[string]string{
"bar": "boz",
},
})

require.Error(t, err)
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_ERROR_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_RulesOutOfOrder(t *testing.T) {
Expand Down Expand Up @@ -295,6 +326,54 @@ func TestEvaluate_RulesOutOfOrder(t *testing.T) {
require.Error(t, err)
assert.EqualError(t, err, "rule rank: 0 detected out of order")
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_ERROR_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_ErrorGettingDistributions(t *testing.T) {
var (
store = &storeMock{}
logger = zaptest.NewLogger(t)
s = &Server{
logger: logger,
store: store,
}
)

store.On("GetFlag", mock.Anything, "foo").Return(enabledFlag, nil)

store.On("GetEvaluationRules", mock.Anything, "foo").Return(
[]*storage.EvaluationRule{
{
ID: "1",
FlagKey: "foo",
SegmentKey: "bar",
SegmentMatchType: flipt.MatchType_ALL_MATCH_TYPE,
Rank: 0,
Constraints: []storage.EvaluationConstraint{
{
ID: "2",
Type: flipt.ComparisonType_STRING_COMPARISON_TYPE,
Property: "bar",
Operator: flipt.OpEQ,
Value: "baz",
},
},
},
}, nil)

store.On("GetEvaluationDistributions", mock.Anything, "1").Return([]*storage.EvaluationDistribution{}, errors.New("error getting distributions!"))

resp, err := s.Evaluate(context.TODO(), &flipt.EvaluationRequest{
EntityId: "1",
FlagKey: "foo",
Context: map[string]string{
"bar": "baz",
},
})

require.Error(t, err)
assert.False(t, resp.Match)
assert.Equal(t, flipt.EvaluationReason_ERROR_EVALUATION_REASON, resp.Reason)
}

// Match ALL constraints
Expand Down Expand Up @@ -382,6 +461,7 @@ func TestEvaluate_MatchAll_NoVariants_NoDistributions(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Empty(t, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -511,6 +591,7 @@ func TestEvaluate_MatchAll_SingleVariantDistribution(t *testing.T) {
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, "boz", resp.Value)
assert.Equal(t, `{"key":"value"}`, resp.Attachment)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -631,6 +712,7 @@ func TestEvaluate_MatchAll_RolloutDistribution(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -707,6 +789,7 @@ func TestEvaluate_MatchAll_RolloutDistribution_MultiRule(t *testing.T) {
assert.Equal(t, "subscribers", resp.SegmentKey)
assert.Equal(t, "foo", resp.FlagKey)
assert.NotEmpty(t, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_MatchAll_NoConstraints(t *testing.T) {
Expand Down Expand Up @@ -813,6 +896,7 @@ func TestEvaluate_MatchAll_NoConstraints(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -903,6 +987,7 @@ func TestEvaluate_MatchAny_NoVariants_NoDistributions(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Empty(t, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -1064,6 +1149,7 @@ func TestEvaluate_MatchAny_SingleVariantDistribution(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, "boz", resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -1184,6 +1270,7 @@ func TestEvaluate_MatchAny_RolloutDistribution(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -1260,6 +1347,7 @@ func TestEvaluate_MatchAny_RolloutDistribution_MultiRule(t *testing.T) {
assert.Equal(t, "subscribers", resp.SegmentKey)
assert.Equal(t, "foo", resp.FlagKey)
assert.NotEmpty(t, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
}

func TestEvaluate_MatchAny_NoConstraints(t *testing.T) {
Expand Down Expand Up @@ -1366,6 +1454,7 @@ func TestEvaluate_MatchAny_NoConstraints(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -1466,6 +1555,7 @@ func TestEvaluate_FirstRolloutRuleIsZero(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down Expand Up @@ -1593,6 +1683,7 @@ func TestEvaluate_MultipleZeroRolloutDistributions(t *testing.T) {
assert.True(t, resp.Match)
assert.Equal(t, "bar", resp.SegmentKey)
assert.Equal(t, matchesVariantKey, resp.Value)
assert.Equal(t, flipt.EvaluationReason_MATCH_EVALUATION_REASON, resp.Reason)
})
}
}
Expand Down
Loading