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.

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

[wip] fix: variant fallback usage #169

Closed
wants to merge 7 commits into from
Closed
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
36 changes: 23 additions & 13 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -415,8 +415,27 @@ func (uc *Client) getVariantWithoutMetrics(feature string, options ...VariantOpt
strategyResult = uc.isEnabled(feature, WithContext(*ctx))
}

if !strategyResult.Enabled {
getFallbackWithFeatureEnabled := func(featureEnabled bool) *api.Variant {
if opts.variantFallbackFunc != nil {
variant := opts.variantFallbackFunc(feature, ctx)
if variant != nil {
variant.FeatureEnabled = featureEnabled
}
return variant
} else if opts.variantFallback != nil {
opts.variantFallback.FeatureEnabled = featureEnabled
return opts.variantFallback
}

if featureEnabled {
return disabledVariantFeatureEnabled
}
return defaultVariant

}

if !strategyResult.Enabled {
return getFallbackWithFeatureEnabled(false)
}

var f *api.Feature
Expand All @@ -426,25 +445,16 @@ func (uc *Client) getVariantWithoutMetrics(feature string, options ...VariantOpt
f = uc.repository.getToggle(feature)
}

if f == nil {
if opts.variantFallbackFunc != nil {
return opts.variantFallbackFunc(feature, ctx)
} else if opts.variantFallback != nil {
return opts.variantFallback
}
return defaultVariant
}

if !f.Enabled {
return defaultVariant
if f == nil || !f.Enabled {
return getFallbackWithFeatureEnabled(false)
}

if strategyResult.Variant != nil {
return strategyResult.Variant
}

if len(f.Variants) == 0 {
return disabledVariantFeatureEnabled
return getFallbackWithFeatureEnabled(true)
}

return api.VariantCollection{
Expand Down
213 changes: 213 additions & 0 deletions client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1144,3 +1144,216 @@ func TestClient_VariantFromEnabledFeatureWithNoVariants(t *testing.T) {

assert.True(gock.IsDone(), "there should be no more mocks")
}

func TestGetVariantWithFallbackVariantWhenFeatureDisabled(t *testing.T) {
assert := assert.New(t)
defer gock.OffAll()

gock.New(mockerServer).
Post("/client/register").
MatchHeader("UNLEASH-APPNAME", mockAppName).
MatchHeader("UNLEASH-INSTANCEID", mockInstanceId).
Reply(200)

feature := "feature-disabled"
features := []api.Feature{
{
Name: feature,
Description: "feature-desc",
Enabled: false,
CreatedAt: time.Date(1974, time.May, 19, 1, 2, 3, 4, time.UTC),
Strategy: "default-strategy",
Strategies: []api.Strategy{
{
Id: 1,
Name: "default",
},
},
},
}

gock.New(mockerServer).
Get("/client/features").
Reply(200).
JSON(api.FeatureResponse{
Features: features,
Segments: []api.Segment{},
})

mockListener := &MockedListener{}
mockListener.On("OnReady").Return()
mockListener.On("OnRegistered", mock.AnythingOfType("ClientData"))
mockListener.On("OnCount", feature, false).Return()
mockListener.On("OnError").Return()

client, err := NewClient(
WithUrl(mockerServer),
WithAppName(mockAppName),
WithInstanceId(mockInstanceId),
WithListener(mockListener),
)

assert.NoError(err)
client.WaitForReady()

fallbackVariant := api.Variant{
Name: "fallback-variant",
FeatureEnabled: true,
}

variant := client.GetVariant(feature, WithVariantFallback(&fallbackVariant))

assert.False(variant.Enabled)

assert.False(variant.FeatureEnabled)

assert.Equal(fallbackVariant, *variant)

fallbackFunc := func(feature string, ctx *context.Context) *api.Variant {
return &fallbackVariant
}

variantWithFallbackFunc := client.GetVariant(feature, WithVariantFallbackFunc(fallbackFunc))

assert.Equal(fallbackVariant, *variantWithFallbackFunc)

assert.True(gock.IsDone(), "there should be no more mocks")
}

func TestGetVariantWithFallbackVariantWhenFeatureEnabledButNoVariants(t *testing.T) {
assert := assert.New(t)
defer gock.OffAll()

gock.New(mockerServer).
Post("/client/register").
MatchHeader("UNLEASH-APPNAME", mockAppName).
MatchHeader("UNLEASH-INSTANCEID", mockInstanceId).
Reply(200)

feature := "feature-no-variants"
features := []api.Feature{
{
Name: feature,
Description: "feature-desc",
Enabled: true,
CreatedAt: time.Date(1974, time.May, 19, 1, 2, 3, 4, time.UTC),
Strategy: "default-strategy",
Strategies: []api.Strategy{
{
Id: 1,
Name: "default",
},
},
},
}

gock.New(mockerServer).
Get("/client/features").
Reply(200).
JSON(api.FeatureResponse{
Features: features,
Segments: []api.Segment{},
})

mockListener := &MockedListener{}
mockListener.On("OnReady").Return()
mockListener.On("OnRegistered", mock.AnythingOfType("ClientData"))
mockListener.On("OnCount", feature, true).Return()
mockListener.On("OnError").Return()

client, err := NewClient(
WithUrl(mockerServer),
WithAppName(mockAppName),
WithInstanceId(mockInstanceId),
WithListener(mockListener),
)

assert.NoError(err)
client.WaitForReady()

fallbackVariant := api.Variant{
Name: "fallback-variant",
FeatureEnabled: false,
}

variant := client.GetVariant(feature, WithVariantFallback(&fallbackVariant))

assert.False(variant.Enabled)

assert.True(variant.FeatureEnabled)

assert.Equal(fallbackVariant, *variant)

fallbackFunc := func(feature string, ctx *context.Context) *api.Variant {
return &fallbackVariant
}

variantWithFallbackFunc := client.GetVariant(feature, WithVariantFallbackFunc(fallbackFunc))

assert.Equal(fallbackVariant, *variantWithFallbackFunc)

assert.True(gock.IsDone(), "there should be no more mocks")
}

func TestGetVariantWithFallbackVariantWhenFeatureDoesntExist(t *testing.T) {
assert := assert.New(t)
defer gock.OffAll()

gock.New(mockerServer).
Post("/client/register").
MatchHeader("UNLEASH-APPNAME", mockAppName).
MatchHeader("UNLEASH-INSTANCEID", mockInstanceId).
Reply(200)

feature := "feature-no-variants"
features := []api.Feature{
{},
}

gock.New(mockerServer).
Get("/client/features").
Reply(200).
JSON(api.FeatureResponse{
Features: features,
Segments: []api.Segment{},
})

mockListener := &MockedListener{}
mockListener.On("OnReady").Return()
mockListener.On("OnRegistered", mock.AnythingOfType("ClientData"))
mockListener.On("OnCount", feature, false).Return()
mockListener.On("OnError").Return()

client, err := NewClient(
WithUrl(mockerServer),
WithAppName(mockAppName),
WithInstanceId(mockInstanceId),
WithListener(mockListener),
)

assert.NoError(err)
client.WaitForReady()

fallbackVariant := api.Variant{
Name: "fallback-variant",
FeatureEnabled: true,
}

variant := client.GetVariant(feature, WithVariantFallback(&fallbackVariant))

assert.False(variant.Enabled)

assert.False(variant.FeatureEnabled)

assert.Equal(fallbackVariant, *variant)

fallbackFunc := func(feature string, ctx *context.Context) *api.Variant {
return &fallbackVariant
}

variantWithFallbackFunc := client.GetVariant(feature, WithVariantFallbackFunc(fallbackFunc))

assert.Equal(fallbackVariant, *variantWithFallbackFunc)

assert.True(gock.IsDone(), "there should be no more mocks")
}