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

refactor: Feature flags getter #22015

Merged
merged 3 commits into from
Nov 3, 2022
Merged

refactor: Feature flags getter #22015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
347fff0
refactor: feature flag getter
zhaoyongjie Nov 3, 2022
febbdc6
error context
zhaoyongjie Nov 3, 2022
b7eb30f
update assertion
zhaoyongjie Nov 3, 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
9 changes: 3 additions & 6 deletions superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,11 @@ declare global {
}
}

export function isFeatureEnabled(feature: FeatureFlag) {
export function isFeatureEnabled(feature: FeatureFlag): boolean {
try {
return !!window.featureFlags[feature];
} catch (error) {
// eslint-disable-next-line no-console
console.error(`Failed to query feature flag ${feature} (see error below)`);
// eslint-disable-next-line no-console
console.error(error);
return false;
console.error(`Failed to query feature flag ${feature}`);
}
return false;
}
47 changes: 20 additions & 27 deletions superset-frontend/packages/superset-ui-core/test/utils/featureFlag.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,48 +16,41 @@
* specific language governing permissions and limitations
* under the License.
*/

import { FeatureFlag, isFeatureEnabled } from '@superset-ui/core';

const originalFeatureFlags = window.featureFlags;
// eslint-disable-next-line no-console
const originalConsoleError = console.error;
const reset = () => {
window.featureFlags = originalFeatureFlags;
// eslint-disable-next-line no-console
console.error = originalConsoleError;
};
import mockConsole from 'jest-mock-console';
import { isFeatureEnabled, FeatureFlag } from '@superset-ui/core';

it('returns false and raises console error if feature flags have not been initialized', () => {
// eslint-disable-next-line no-console
console.error = jest.fn();
delete (window as any).featureFlags;
mockConsole();
Object.defineProperty(window, 'featureFlags', {
value: undefined,
});

expect(isFeatureEnabled(FeatureFlag.ALLOW_DASHBOARD_DOMAIN_SHARDING)).toEqual(
false,
);

// eslint-disable-next-line no-console
expect(console.error).toHaveBeenNthCalledWith(
1,
'Failed to query feature flag ALLOW_DASHBOARD_DOMAIN_SHARDING (see error below)',
expect(console.error).toHaveBeenCalled();
// @ts-expect-error
expect(console.error.mock.calls[0][0]).toEqual(
'Failed to query feature flag ALLOW_DASHBOARD_DOMAIN_SHARDING',
);

reset();
});

it('returns false for unset feature flag', () => {
Object.defineProperty(window, 'featureFlags', {
value: {},
});

expect(isFeatureEnabled(FeatureFlag.ALLOW_DASHBOARD_DOMAIN_SHARDING)).toEqual(
false,
);

reset();
});

it('returns true for set feature flag', () => {
window.featureFlags = {
[FeatureFlag.CLIENT_CACHE]: true,
};
Object.defineProperty(window, 'featureFlags', {
value: {
CLIENT_CACHE: true,
},
});

expect(isFeatureEnabled(FeatureFlag.CLIENT_CACHE)).toEqual(true);
reset();
});