-
Notifications
You must be signed in to change notification settings - Fork 237
fix(flags): handle plain array and object forms in overrideFeatureFlags
#3245
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
Merged
+68
−5
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,6 +61,15 @@ const PERSISTENCE_FEATURE_FLAG_PAYLOADS = '$feature_flag_payloads' | |
| const PERSISTENCE_OVERRIDE_FEATURE_FLAG_PAYLOADS = '$override_feature_flag_payloads' | ||
| const PERSISTENCE_FEATURE_FLAG_REQUEST_ID = '$feature_flag_request_id' | ||
|
|
||
| /** Converts an array of flag names to a Record where each flag is set to true. */ | ||
| const arrayToFlagsRecord = (flags: string[]): Record<string, string | boolean> => { | ||
| const flagsObj: Record<string, string | boolean> = {} | ||
| for (let i = 0; i < flags.length; i++) { | ||
| flagsObj[flags[i]] = true | ||
| } | ||
| return flagsObj | ||
| } | ||
|
|
||
| export const filterActiveFeatureFlags = (featureFlags?: Record<string, string | boolean>) => { | ||
| const activeFeatureFlags: Record<string, string | boolean> = {} | ||
| for (const [key, value] of entries(featureFlags || {})) { | ||
|
|
@@ -946,6 +955,8 @@ export class PostHogFeatureFlags implements Extension { | |
| * - posthog.featureFlags.overrideFeatureFlags(false) // clear all overrides | ||
| * - posthog.featureFlags.overrideFeatureFlags(['beta-feature']) // enable flags | ||
| * - posthog.featureFlags.overrideFeatureFlags({'beta-feature': 'variant'}) // set variants | ||
| * - posthog.featureFlags.overrideFeatureFlags({ flags: ['beta-feature'] }) // enable flags | ||
| * - posthog.featureFlags.overrideFeatureFlags({ flags: {'beta-feature': 'variant'} }) // set variants | ||
| * - posthog.featureFlags.overrideFeatureFlags({ // set both flags and payloads | ||
| * flags: {'beta-feature': 'variant'}, | ||
| * payloads: { 'beta-feature': { someData: true } } | ||
|
|
@@ -968,6 +979,15 @@ export class PostHogFeatureFlags implements Extension { | |
| return forceDebugLogger.info('All overrides cleared') | ||
| } | ||
|
|
||
| // Array syntax: ['flag-a', 'flag-b'] -> { 'flag-a': true, 'flag-b': true } | ||
| if (isArray(overrideOptions)) { | ||
| const flagsObj = arrayToFlagsRecord(overrideOptions) | ||
| this._instance.persistence.register({ [PERSISTENCE_OVERRIDE_FEATURE_FLAGS]: flagsObj }) | ||
| this._fireFeatureFlagsCallbacks() | ||
|
|
||
| return forceDebugLogger.info('Flag overrides set', { flags: overrideOptions }) | ||
| } | ||
|
|
||
| if ( | ||
| overrideOptions && | ||
| typeof overrideOptions === 'object' && | ||
|
|
@@ -983,10 +1003,7 @@ export class PostHogFeatureFlags implements Extension { | |
| forceDebugLogger.info('Flag overrides cleared') | ||
| } else if (options.flags) { | ||
| if (isArray(options.flags)) { | ||
| const flagsObj: Record<string, string | boolean> = {} | ||
| for (let i = 0; i < options.flags.length; i++) { | ||
| flagsObj[options.flags[i]] = true | ||
| } | ||
| const flagsObj = arrayToFlagsRecord(options.flags) | ||
| this._instance.persistence.register({ [PERSISTENCE_OVERRIDE_FEATURE_FLAGS]: flagsObj }) | ||
| } else { | ||
| this._instance.persistence.register({ [PERSISTENCE_OVERRIDE_FEATURE_FLAGS]: options.flags }) | ||
|
|
@@ -1013,6 +1030,16 @@ export class PostHogFeatureFlags implements Extension { | |
| return | ||
| } | ||
|
|
||
| // Fallback: treat as Record<string, string | boolean>, e.g. {'beta-feature': 'variant'} | ||
| if (overrideOptions && typeof overrideOptions === 'object') { | ||
| this._instance.persistence.register({ | ||
| [PERSISTENCE_OVERRIDE_FEATURE_FLAGS]: overrideOptions as Record<string, string | boolean>, | ||
| }) | ||
| this._fireFeatureFlagsCallbacks() | ||
|
|
||
| return forceDebugLogger.info('Flag overrides set', { flags: overrideOptions }) | ||
| } | ||
|
|
||
| this._fireFeatureFlagsCallbacks() | ||
|
||
| } | ||
|
|
||
|
|
||
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
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.
The return type always has true in the values of the object, so
string | booleanis actually broader than it could be.