2022-07-12 13:01:10 +02:00
|
|
|
import { Request, Response } from 'express';
|
|
|
|
import { IUnleashConfig } from '../../types/option';
|
|
|
|
import { IUnleashServices } from '../../types/services';
|
|
|
|
import { NONE } from '../../types/permissions';
|
|
|
|
import Controller from '../controller';
|
|
|
|
import { OpenApiService } from '../../services/openapi-service';
|
|
|
|
import { createResponseSchema } from '../../openapi/util/create-response-schema';
|
|
|
|
import { endpointDescriptions } from '../../openapi/endpoint-descriptions';
|
|
|
|
import { getStandardResponses } from '../../../lib/openapi/util/standard-responses';
|
|
|
|
import { createRequestSchema } from '../../../lib/openapi/util/create-request-schema';
|
|
|
|
import {
|
|
|
|
PlaygroundResponseSchema,
|
|
|
|
playgroundResponseSchema,
|
|
|
|
} from '../../../lib/openapi/spec/playground-response-schema';
|
|
|
|
import { PlaygroundRequestSchema } from '../../../lib/openapi/spec/playground-request-schema';
|
|
|
|
import { PlaygroundService } from '../../../lib/services/playground-service';
|
|
|
|
|
|
|
|
export default class PlaygroundController extends Controller {
|
|
|
|
private openApiService: OpenApiService;
|
|
|
|
|
|
|
|
private playgroundService: PlaygroundService;
|
|
|
|
|
|
|
|
constructor(
|
|
|
|
config: IUnleashConfig,
|
|
|
|
{
|
|
|
|
openApiService,
|
|
|
|
playgroundService,
|
|
|
|
}: Pick<IUnleashServices, 'openApiService' | 'playgroundService'>,
|
|
|
|
) {
|
|
|
|
super(config);
|
|
|
|
this.openApiService = openApiService;
|
|
|
|
this.playgroundService = playgroundService;
|
|
|
|
|
|
|
|
this.route({
|
|
|
|
method: 'post',
|
|
|
|
path: '',
|
|
|
|
handler: this.evaluateContext,
|
|
|
|
permission: NONE,
|
|
|
|
middleware: [
|
|
|
|
openApiService.validPath({
|
|
|
|
operationId: 'getPlayground',
|
2022-08-12 11:37:57 +02:00
|
|
|
tags: ['Playground'],
|
2022-07-12 13:01:10 +02:00
|
|
|
responses: {
|
|
|
|
...getStandardResponses(400, 401),
|
|
|
|
200: createResponseSchema('playgroundResponseSchema'),
|
|
|
|
},
|
|
|
|
requestBody: createRequestSchema('playgroundRequestSchema'),
|
|
|
|
...endpointDescriptions.admin.playground,
|
|
|
|
}),
|
|
|
|
],
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
async evaluateContext(
|
|
|
|
req: Request<any, any, PlaygroundRequestSchema>,
|
|
|
|
res: Response<PlaygroundResponseSchema>,
|
|
|
|
): Promise<void> {
|
feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839)
* 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
2022-08-04 15:41:52 +02:00
|
|
|
const response = {
|
2022-07-12 13:01:10 +02:00
|
|
|
input: req.body,
|
|
|
|
features: await this.playgroundService.evaluateQuery(
|
|
|
|
req.body.projects,
|
|
|
|
req.body.environment,
|
|
|
|
req.body.context,
|
|
|
|
),
|
|
|
|
};
|
|
|
|
|
|
|
|
this.openApiService.respondWithValidation(
|
|
|
|
200,
|
|
|
|
res,
|
|
|
|
playgroundResponseSchema.$id,
|
|
|
|
response,
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|