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

Jump to bottom

refactor: flag resolver should use stricter types #2571

Merged
merged 6 commits into from
Dec 20, 2022
Merged

refactor: flag resolver should use stricter types #2571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd70ad8
refactor: flag resolver should use stricter types
nunogois Nov 30, 2022
4f3f721
address PR comments
nunogois Dec 2, 2022
8c05aa7
fix import path
nunogois Dec 2, 2022
0186683
refactor: DRYer approach
nunogois Dec 12, 2022
ac90304
fix: update snap
nunogois Dec 16, 2022
4eed026
fix: update snap
nunogois Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/lib/__snapshots__/create-config.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ exports[`should create default config 1`] = `
"isEnabled": [Function],
},
"flags": {
"E": false,
"ENABLE_DARK_MODE_SUPPORT": false,
"anonymiseEventLog": false,
"batchMetrics": false,
Expand All @@ -83,6 +84,7 @@ exports[`should create default config 1`] = `
},
"flagResolver": FlagResolver {
"experiments": {
"E": false,
"ENABLE_DARK_MODE_SUPPORT": false,
"anonymiseEventLog": false,
"batchMetrics": false,
Expand Down
115 changes: 53 additions & 62 deletions src/lib/types/experimental.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,61 @@
import { parseEnvVarBoolean } from '../util';

export type IFlags = Partial<Record<string, boolean>>;
export type IFlags = Partial<typeof flags>;
export type IFlagKey = keyof IFlags;

export const defaultExperimentalOptions = {
flags: {
ENABLE_DARK_MODE_SUPPORT: false,
anonymiseEventLog: false,
embedProxy: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_EMBED_PROXY,
true,
),
changeRequests: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_CHANGE_REQUESTS,
false,
),
embedProxyFrontend: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_EMBED_PROXY_FRONTEND,
true,
),
batchMetrics: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_BATCH_METRICS,
false,
),
responseTimeWithAppName: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_RESPONSE_TIME_WITH_APP_NAME,
false,
),
proxyReturnAllToggles: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_PROXY_RETURN_ALL_TOGGLES,
false,
),
variantsPerEnvironment: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_VARIANTS_PER_ENVIRONMENT,
false,
),
favorites: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_FAVORITES,
false,
),
maintenance: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_MAINTENANCE,
false,
),
networkView: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_NETWORK_VIEW,
false,
),
},
const flags = {
E: false,
ENABLE_DARK_MODE_SUPPORT: false,
anonymiseEventLog: false,
embedProxy: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_EMBED_PROXY,
true,
),
changeRequests: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_CHANGE_REQUESTS,
false,
),
embedProxyFrontend: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_EMBED_PROXY_FRONTEND,
true,
),
batchMetrics: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_BATCH_METRICS,
false,
),
responseTimeWithAppName: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_RESPONSE_TIME_WITH_APP_NAME,
false,
),
proxyReturnAllToggles: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_PROXY_RETURN_ALL_TOGGLES,
false,
),
variantsPerEnvironment: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_VARIANTS_PER_ENVIRONMENT,
false,
),
favorites: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_FAVORITES,
false,
),
networkView: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_NETWORK_VIEW,
false,
),
maintenance: parseEnvVarBoolean(
process.env.UNLEASH_EXPERIMENTAL_MAINTENANCE,
false,
),
};

export const defaultExperimentalOptions: IExperimentalOptions = {
flags,
externalResolver: { isEnabled: (): boolean => false },
};

export interface IExperimentalOptions {
flags: {
[key: string]: boolean;
ENABLE_DARK_MODE_SUPPORT?: boolean;
embedProxy?: boolean;
embedProxyFrontend?: boolean;
batchMetrics?: boolean;
anonymiseEventLog?: boolean;
changeRequests?: boolean;
proxyReturnAllToggles?: boolean;
variantsPerEnvironment?: boolean;
favorites?: boolean;
networkView?: boolean;
maintenance?: boolean;
};
flags: IFlags;
externalResolver: IExternalFlagResolver;
}

Expand All @@ -74,9 +65,9 @@ export interface IFlagContext {

export interface IFlagResolver {
getAll: (context?: IFlagContext) => IFlags;
isEnabled: (expName: string, context?: IFlagContext) => boolean;
isEnabled: (expName: IFlagKey, context?: IFlagContext) => boolean;
}

export interface IExternalFlagResolver {
isEnabled: (flagName: string, context?: IFlagContext) => boolean;
isEnabled: (flagName: IFlagKey, context?: IFlagContext) => boolean;
}
64 changes: 32 additions & 32 deletions src/lib/util/flag-resolver.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { defaultExperimentalOptions } from '../types/experimental';
import { defaultExperimentalOptions, IFlagKey } from '../types/experimental';
import FlagResolver from './flag-resolver';
import { IExperimentalOptions } from '../types/experimental';

test('should produce empty exposed flags', () => {
const resolver = new FlagResolver(defaultExperimentalOptions);
Expand All @@ -14,8 +15,9 @@ test('should produce UI flags with extra dynamic flags', () => {
...defaultExperimentalOptions,
flags: { extraFlag: false },
};
const resolver = new FlagResolver(config);
const result = resolver.getAll();

const resolver = new FlagResolver(config as IExperimentalOptions);
const result = resolver.getAll() as typeof config.flags;

expect(result.extraFlag).toBe(false);
});
Expand All @@ -29,14 +31,14 @@ test('should use external resolver for dynamic flags', () => {
},
};

const resolver = new FlagResolver({
flags: {
extraFlag: false,
},
const config = {
flags: { extraFlag: false },
externalResolver,
});
};

const result = resolver.getAll();
const resolver = new FlagResolver(config as IExperimentalOptions);

const result = resolver.getAll() as typeof config.flags;

expect(result.extraFlag).toBe(true);
});
Expand All @@ -48,15 +50,14 @@ test('should not use external resolver for enabled experiments', () => {
},
};

const resolver = new FlagResolver({
flags: {
should_be_enabled: true,
extraFlag: false,
},
const config = {
flags: { should_be_enabled: true, extraFlag: false },
externalResolver,
});
};

const result = resolver.getAll();
const resolver = new FlagResolver(config as IExperimentalOptions);

const result = resolver.getAll() as typeof config.flags;

expect(result.should_be_enabled).toBe(true);
});
Expand All @@ -67,16 +68,16 @@ test('should load experimental flags', () => {
return false;
},
};
const resolver = new FlagResolver({
flags: {
extraFlag: false,
someFlag: true,
},

const config = {
flags: { extraFlag: false, someFlag: true },
externalResolver,
});
};

expect(resolver.isEnabled('someFlag')).toBe(true);
expect(resolver.isEnabled('extraFlag')).toBe(false);
const resolver = new FlagResolver(config as IExperimentalOptions);

expect(resolver.isEnabled('someFlag' as IFlagKey)).toBe(true);
expect(resolver.isEnabled('extraFlag' as IFlagKey)).toBe(false);
});

test('should load experimental flags from external provider', () => {
Expand All @@ -88,14 +89,13 @@ test('should load experimental flags from external provider', () => {
},
};

const resolver = new FlagResolver({
flags: {
extraFlag: false,
someFlag: true,
},
const config = {
flags: { extraFlag: false, someFlag: true },
externalResolver,
});
};

const resolver = new FlagResolver(config as IExperimentalOptions);

expect(resolver.isEnabled('someFlag')).toBe(true);
expect(resolver.isEnabled('extraFlag')).toBe(true);
expect(resolver.isEnabled('someFlag' as IFlagKey)).toBe(true);
expect(resolver.isEnabled('extraFlag' as IFlagKey)).toBe(true);
});
5 changes: 3 additions & 2 deletions src/lib/util/flag-resolver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
IFlagContext,
IFlags,
IFlagResolver,
IFlagKey,
} from '../types/experimental';
export default class FlagResolver implements IFlagResolver {
private experiments: IFlags;
Expand All @@ -18,7 +19,7 @@ export default class FlagResolver implements IFlagResolver {
getAll(context?: IFlagContext): IFlags {
const flags: IFlags = { ...this.experiments };

Object.keys(flags).forEach((flagName) => {
Object.keys(flags).forEach((flagName: IFlagKey) => {
if (!this.experiments[flagName])
flags[flagName] = this.externalResolver.isEnabled(
flagName,
Expand All @@ -29,7 +30,7 @@ export default class FlagResolver implements IFlagResolver {
return flags;
}

isEnabled(expName: string, context?: IFlagContext): boolean {
isEnabled(expName: IFlagKey, context?: IFlagContext): boolean {
if (this.experiments[expName]) {
return true;
}
Expand Down