mirror of
https://github.com/Unleash/unleash.git
synced 2024-11-01 19:07:38 +01:00
e55ad1a21e
* Feat: return reasons why a feature evaluated to true or false
Note: this is very rough and just straight ripped from the nodejs
client. It will need a lot of work, but is a good place to start
* Feat: add suggested shape for new payload
* Chore: minor cleanup
* Wip: make server compile again
* Remove unused schema ref
* Export new schemas
* Chore: fix some tests to use sub property
* Fix: fix some tests
* Refactor: rename some variables, uncomment some stuff
* Add segments type to bootstrap options
* Add segments capability to offline feature evaluator
* Fix function calls after turning params into an option abject
* Feat: test strategy order, etc
* Feat: add test to check that all strats are returned correctly
* Feat: allow you to include strategy ids in clients
* Wip: hook up segments in the offline client.
Note: compared to regular clients, they still fail
* Feat: add segments validation
* Fix: fix test case invariant.
* Chore: revert to returning only `boolean` from strategies.
This _should_ make it work with custom strategies too 🤞
* Feat: make more properties of the returned feature required
* Wip: add some comments and unfinished tests for edge cases
* Feat: add `isEnabledInCurrentEnvironment` prop
* Feat: consider more strategy failure cases
* Feat: test that isenabledinenvironment matches expectations
* Feat: add unknown strategies
* Fix: fix property access typo
* Feat: add unknown strategy for fallback purposes
* Feat: test edge case: all unknown strategies
* Feat: add custom strategy to arbitrary
* Feat: test that features can be true, even if not enabled in env
* Chore: add some comments
* Wip: fix sdk tests
* Remove comments, improve test logging
* Feat: add descriptions and examples to playground feature schema
* Switch `examples` for `example`
* Update schemas with descriptions and examples
* Fix: update snapshot
* Fix: openapi example
* Fix: merge issues
* Fix: fix issue where feature evaluation state was wrong
* Chore: update openapi spec
* Fix: fix broken offline client tests
* Refactor: move schemas into separate files
* Refactor: remove "reason" for incomplete evaluation.
The only instances where evaluation is incomplete is when we don't
know what the strategy is.
* Refactor: move unleash node client into test and dev dependencies
* Wip: further removal of stuff
* Chore: remove a bunch of code that we don't use
* Chore: remove comment
* Chore: remove unused code
* Fix: fix some prettier errors
* Type parameters in strategies to avoid `any`
* Fix: remove commented out code
* Feat: make `id` required on playground strategies
* Chore: remove redundant type
* Fix: remove redundant if and fix fallback evaluation
* Refactor: reduce nesting and remove duplication
* Fix: remove unused helper function
* Refactor: type `parameters` as `unknown`
* Chore: remove redundant comment
* Refactor: move constraint code into a separate file
* Refactor: rename `unleash` -> `feature-evaluator`
* Rename class `Unleash` -> `FeatureEvaluator`
* Refactor: remove this.ready and sync logic from feature evaluator
* Refactor: remove unused code, rename config type
* Refactor: remove event emission from the Unleash client
* Remove unlistened-for events in feature evaluator
* Refactor: make offline client synchronous; remove code
* Fix: update openapi snapshot after adding required strategy ids
* Feat: change `strategies` format.
This commit changes the format of a playground feature's `strategies`
properties from a list of strategies to an object with properties
`result` and `data`. It looks a bit like this:
```ts
type Strategies = {
result: boolean | "unknown",
data: Strategy[]
}
```
The reason is that this allows us to avoid the breaking change that
was previously suggested in the PR:
`feature.isEnabled` used to be a straight boolean. Then, when we found
out we couldn't necessarily evaluate all strategies (custom strats are
hard!) we changed it to `boolean | 'unevaluated'`. However, this is
confusing on a few levels as the playground results are no longer the
same as the SDK would be, nor are they strictly boolean anymore.
This change reverts the `isEnabled` functionality to what it was
before (so it's always a mirror of what the SDK would show).
The equivalent of `feature.isEnabled === 'unevaluated'` now becomes
`feature.isEnabled && strategy.result === 'unknown'`.
* Fix: Fold long string descriptions over multiple lines.
* Fix: update snapshot after adding line breaks to descriptions
106 lines
3.9 KiB
TypeScript
106 lines
3.9 KiB
TypeScript
import FeatureToggleService from './feature-toggle-service';
|
|
import { SdkContextSchema } from 'lib/openapi/spec/sdk-context-schema';
|
|
import { IUnleashServices } from 'lib/types/services';
|
|
import { ALL } from '../../lib/types/models/api-token';
|
|
import { PlaygroundFeatureSchema } from 'lib/openapi/spec/playground-feature-schema';
|
|
import { Logger } from '../logger';
|
|
import { IUnleashConfig } from 'lib/types';
|
|
import { offlineUnleashClient } from '../util/offline-unleash-client';
|
|
import { FeatureInterface } from 'lib/util/feature-evaluator/feature';
|
|
import { FeatureStrategiesEvaluationResult } from 'lib/util/feature-evaluator/client';
|
|
import { SegmentService } from './segment-service';
|
|
|
|
export class PlaygroundService {
|
|
private readonly logger: Logger;
|
|
|
|
private readonly featureToggleService: FeatureToggleService;
|
|
|
|
private readonly segmentService: SegmentService;
|
|
|
|
constructor(
|
|
config: IUnleashConfig,
|
|
{
|
|
featureToggleServiceV2,
|
|
segmentService,
|
|
}: Pick<IUnleashServices, 'featureToggleServiceV2' | 'segmentService'>,
|
|
) {
|
|
this.logger = config.getLogger('services/playground-service.ts');
|
|
this.featureToggleService = featureToggleServiceV2;
|
|
this.segmentService = segmentService;
|
|
}
|
|
|
|
async evaluateQuery(
|
|
projects: typeof ALL | string[],
|
|
environment: string,
|
|
context: SdkContextSchema,
|
|
): Promise<PlaygroundFeatureSchema[]> {
|
|
const [features, segments] = await Promise.all([
|
|
this.featureToggleService.getClientFeatures(
|
|
{
|
|
project: projects === ALL ? undefined : projects,
|
|
environment,
|
|
},
|
|
true,
|
|
),
|
|
this.segmentService.getActive(),
|
|
]);
|
|
|
|
const [head, ...rest] = features;
|
|
if (!head) {
|
|
return [];
|
|
} else {
|
|
const client = await offlineUnleashClient({
|
|
features: [head, ...rest],
|
|
context,
|
|
logError: this.logger.error,
|
|
segments,
|
|
});
|
|
|
|
const variantsMap = features.reduce((acc, feature) => {
|
|
acc[feature.name] = feature.variants;
|
|
return acc;
|
|
}, {});
|
|
|
|
const clientContext = {
|
|
...context,
|
|
currentTime: context.currentTime
|
|
? new Date(context.currentTime)
|
|
: undefined,
|
|
};
|
|
const output: PlaygroundFeatureSchema[] = await Promise.all(
|
|
client
|
|
.getFeatureToggleDefinitions()
|
|
.map(async (feature: FeatureInterface) => {
|
|
const strategyEvaluationResult: FeatureStrategiesEvaluationResult =
|
|
client.isEnabled(feature.name, clientContext);
|
|
|
|
const isEnabled =
|
|
strategyEvaluationResult.result === true &&
|
|
feature.enabled;
|
|
|
|
return {
|
|
isEnabled,
|
|
isEnabledInCurrentEnvironment: feature.enabled,
|
|
strategies: {
|
|
result: strategyEvaluationResult.result,
|
|
data: strategyEvaluationResult.strategies,
|
|
},
|
|
projectId:
|
|
await this.featureToggleService.getProjectId(
|
|
feature.name,
|
|
),
|
|
variant: client.getVariant(
|
|
feature.name,
|
|
clientContext,
|
|
),
|
|
name: feature.name,
|
|
variants: variantsMap[feature.name] || [],
|
|
};
|
|
}),
|
|
);
|
|
|
|
return output;
|
|
}
|
|
}
|
|
}
|