Skip to content

Commit

Permalink
fix: set feature.enabled to false when all strategies are deactivated (
Browse files Browse the repository at this point in the history
…#3655)

<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->
set feature.enabled to false when all strategies are deactivated
## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->

---------

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: Prabodh Meshram <prabodh.meshram7@gmail.com>
  • Loading branch information
andreas-unleash and prabodhmeshram committed May 2, 2023
1 parent bba9b9a commit d45f81a
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 20 deletions.
18 changes: 11 additions & 7 deletions src/lib/db/feature-strategy-store.ts
Expand Up @@ -378,8 +378,12 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
e.strategies = e.strategies.sort(
(a, b) => a.sortOrder - b.sortOrder,
);
if (e.strategies && e.strategies.length === 0) {
e.enabled = false;
}
return e;
});

featureToggle.archived = archived;
return featureToggle;
}
Expand All @@ -389,10 +393,10 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
}

private addSegmentIdsToStrategy(
feature: PartialDeep<IFeatureToggleClient>,
featureToggle: PartialDeep<IFeatureToggleClient>,
row: Record<string, any>,
) {
const strategy = feature.strategies?.find(
const strategy = featureToggle.strategies?.find(
(s) => s?.id === row.strategy_id,
);
if (!strategy) {
Expand All @@ -415,22 +419,22 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
}

private addTag(
feature: Record<string, any>,
featureToggle: Record<string, any>,
row: Record<string, any>,
): void {
const tags = feature.tags || [];
const tags = featureToggle.tags || [];
const newTag = FeatureStrategiesStore.rowToTag(row);
feature.tags = [...tags, newTag];
featureToggle.tags = [...tags, newTag];
}

private isNewTag(
feature: Record<string, any>,
featureToggle: Record<string, any>,
row: Record<string, any>,
): boolean {
return (
row.tag_type &&
row.tag_value &&
!feature.tags?.some(
!featureToggle.tags?.some(
(tag) =>
tag.type === row.tag_type && tag.value === row.tag_value,
)
Expand Down
10 changes: 9 additions & 1 deletion src/lib/db/feature-toggle-client-store.ts
Expand Up @@ -251,10 +251,18 @@ export default class FeatureToggleClientStore
): IFeatureToggleClient[] {
const filtered: IFeatureToggleClient[] = [];
features.forEach((feature) => {
let { enabled } = feature;
const filteredStrategies = feature.strategies.filter(
(strategy) => !strategy.disabled,
);
filtered.push({ ...feature, strategies: filteredStrategies });
if (!filteredStrategies.length) {
enabled = false;
}
filtered.push({
...feature,
enabled,
strategies: filteredStrategies,
});
});
return filtered;
}
Expand Down
2 changes: 1 addition & 1 deletion src/lib/services/playground-service.ts
Expand Up @@ -41,7 +41,7 @@ export class PlaygroundService {
environment,
},
true,
true,
false,
),
this.segmentService.getActive(),
]);
Expand Down
11 changes: 3 additions & 8 deletions src/test/e2e/api/proxy/proxy.e2e.test.ts
Expand Up @@ -1108,6 +1108,7 @@ test('should not return all features', async () => {

test('should NOT evaluate disabled strategies when returning toggles', async () => {
const frontendToken = await createApiToken(ApiTokenType.FRONTEND);

await createFeatureToggle({
name: 'enabledFeature',
enabled: true,
Expand Down Expand Up @@ -1140,7 +1141,7 @@ test('should NOT evaluate disabled strategies when returning toggles', async ()
],
});
await createFeatureToggle({
name: 'disabledFeature3',
name: 'disabledFeature2',
enabled: true,
strategies: [
{
Expand All @@ -1166,7 +1167,7 @@ test('should NOT evaluate disabled strategies when returning toggles', async ()
],
});
await createFeatureToggle({
name: 'enabledFeature2',
name: 'disabledFeature3',
enabled: true,
strategies: [
{
Expand Down Expand Up @@ -1196,12 +1197,6 @@ test('should NOT evaluate disabled strategies when returning toggles', async ()
impressionData: false,
variant: { enabled: false, name: 'disabled' },
},
{
name: 'enabledFeature2',
enabled: true,
impressionData: false,
variant: { enabled: false, name: 'disabled' },
},
],
});
});
Expand Down
5 changes: 2 additions & 3 deletions src/test/e2e/services/playground-service.test.ts
Expand Up @@ -260,7 +260,7 @@ describe('the playground service (e2e)', () => {
);

// the playground differs from a normal SDK in that
// it _must_ evaluate all srategies and features
// it _must_ evaluate all strategies and features
// regardless of whether they're supposed to be
// enabled in the current environment or not.
const expectedSDKState = feature.isEnabled;
Expand All @@ -269,8 +269,6 @@ describe('the playground service (e2e)', () => {
expectedSDKState ===
client.isEnabled(feature.name, clientContext);

expect(enabledStateMatches).toBe(true);

ctx.log(
`feature.isEnabled, feature.isEnabledInCurrentEnvironment, presumedSDKState: ${feature.isEnabled}, ${feature.isEnabledInCurrentEnvironment}, ${expectedSDKState}`,
);
Expand All @@ -280,6 +278,7 @@ describe('the playground service (e2e)', () => {
clientContext,
)}`,
);
expect(enabledStateMatches).toBe(true);

// if x is disabled, then the variant will be the
// disabled variant.
Expand Down

0 comments on commit d45f81a

Please sign in to comment.