Skip to content

fix(core): context value for feature flag should be parsed for boolean #34616

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

Closed
wants to merge 4 commits into from
Closed

fix(core): context value for feature flag should be parsed for boolean #34616

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57b4aa7
fix(core): context value for feature flag should be parsed for boolean
kumsmrit Jun 3, 2025
ce35077
Merge branch 'main' into feature-flag-fix
kumsmrit Jun 3, 2025
db05616
Merge branch 'main' into feature-flag-fix
kumsmrit Jul 7, 2025
c0ee35a
Merge branch 'main' into feature-flag-fix
kumsmrit Jul 29, 2025
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
14 changes: 13 additions & 1 deletion packages/aws-cdk-lib/core/lib/feature-flags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,18 @@ export class FeatureFlags {
}
return true;
}
return context !== undefined ? Boolean(context) : cxapi.futureFlagDefault(featureFlag);
if (context === undefined) {
return cxapi.futureFlagDefault(featureFlag);
}
if (typeof context === 'string') {
let parsedContext;
try {
parsedContext = JSON.parse(context.trim().toLowerCase());
} catch (e) {
throw new Error(`Feature flag '${featureFlag}' expected boolean context, but instead got '${context}'`);
Copy link
Contributor

@rix0rrr rix0rrr Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe log a warning to stderr and return true instead?

Copy link
Contributor

@mrgrain mrgrain Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer an Annotation over a log statement.

}
return Boolean(parsedContext);
}
return Boolean(context);
}
}
8 changes: 8 additions & 0 deletions packages/aws-cdk-lib/core/test/feature-flags.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,13 @@ describe('feature flags', () => {
const actual = FeatureFlags.of(stack).isEnabled(cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT);
expect(actual).toEqual(true);
});

test('strings are evaluated as boolean', () => {
const stack = new Stack();
stack.node.setContext(cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT, 'false');

const actual = FeatureFlags.of(stack).isEnabled(cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT);
expect(actual).toEqual(false);
});
});
});
Loading