unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
185 lines • 8.12 kB
JavaScript
import Controller from '../controller.js';
import { extractUsername } from '../../util/extract-user.js';
import { CREATE_STRATEGY, DELETE_STRATEGY, NONE, UPDATE_STRATEGY, } from '../../types/permissions.js';
import { emptyResponse, getStandardResponses, } from '../../openapi/util/standard-responses.js';
import { createRequestSchema } from '../../openapi/util/create-request-schema.js';
import { createResponseSchema, resourceCreatedResponseSchema, } from '../../openapi/util/create-response-schema.js';
import { strategySchema, } from '../../openapi/spec/strategy-schema.js';
import { strategiesSchema, } from '../../openapi/spec/strategies-schema.js';
const version = 1;
class StrategyController extends Controller {
constructor(config, { strategyService, openApiService, }) {
super(config);
this.strategyService = strategyService;
this.openApiService = openApiService;
this.route({
method: 'get',
path: '',
handler: this.getAllStrategies,
permission: NONE,
middleware: [
openApiService.validPath({
summary: 'Get all strategies',
description: 'Retrieves all strategy types ([predefined](https://docs.getunleash.io/concepts/activation-strategies "predefined strategies") and [custom strategies](https://docs.getunleash.io/concepts/activation-strategies#custom-strategies)) that are defined on this Unleash instance.',
tags: ['Strategies'],
operationId: 'getAllStrategies',
responses: {
200: createResponseSchema('strategiesSchema'),
...getStandardResponses(401),
},
}),
],
});
this.route({
method: 'get',
path: '/:name',
handler: this.getStrategy,
permission: NONE,
middleware: [
openApiService.validPath({
summary: 'Get a strategy definition',
description: 'Retrieves the definition of the strategy specified in the URL',
tags: ['Strategies'],
operationId: 'getStrategy',
responses: {
200: createResponseSchema('strategySchema'),
...getStandardResponses(401, 404),
},
}),
],
});
this.route({
method: 'delete',
path: '/:name',
handler: this.removeStrategy,
permission: DELETE_STRATEGY,
acceptAnyContentType: true,
middleware: [
openApiService.validPath({
summary: 'Delete a strategy',
description: 'Deletes the specified strategy definition',
tags: ['Strategies'],
operationId: 'removeStrategy',
responses: {
200: emptyResponse,
...getStandardResponses(401, 403, 404),
},
}),
],
});
this.route({
method: 'post',
path: '',
handler: this.createStrategy,
permission: CREATE_STRATEGY,
middleware: [
openApiService.validPath({
tags: ['Strategies'],
operationId: 'createStrategy',
summary: 'Create a strategy',
description: 'Creates a custom strategy type based on the supplied data.',
requestBody: createRequestSchema('createStrategySchema'),
responses: {
201: resourceCreatedResponseSchema('strategySchema'),
...getStandardResponses(401, 403, 409, 415),
},
}),
],
});
this.route({
method: 'put',
path: '/:name',
handler: this.updateStrategy,
permission: UPDATE_STRATEGY,
middleware: [
openApiService.validPath({
tags: ['Strategies'],
summary: 'Update a strategy type',
description: 'Updates the specified strategy type. Any properties not specified in the request body are left untouched.',
operationId: 'updateStrategy',
requestBody: createRequestSchema('updateStrategySchema'),
responses: {
200: emptyResponse,
...getStandardResponses(401, 403, 404, 415),
},
}),
],
});
this.route({
method: 'post',
path: '/:strategyName/deprecate',
handler: this.deprecateStrategy,
permission: UPDATE_STRATEGY,
acceptAnyContentType: true,
middleware: [
openApiService.validPath({
tags: ['Strategies'],
summary: 'Deprecate a strategy',
description: 'Marks the specified strategy as deprecated.',
operationId: 'deprecateStrategy',
responses: {
200: emptyResponse,
...getStandardResponses(401, 403, 404),
},
}),
],
});
this.route({
method: 'post',
path: '/:strategyName/reactivate',
handler: this.reactivateStrategy,
permission: UPDATE_STRATEGY,
acceptAnyContentType: true,
middleware: [
openApiService.validPath({
tags: ['Strategies'],
operationId: 'reactivateStrategy',
summary: 'Reactivate a strategy',
description: "Marks the specified strategy as not deprecated. If the strategy wasn't already deprecated, nothing changes.",
responses: {
200: emptyResponse,
...getStandardResponses(401, 403, 404),
},
}),
],
});
}
async getAllStrategies(_req, res) {
const strategies = await this.strategyService.getStrategies();
this.openApiService.respondWithValidation(200, res, strategiesSchema.$id, { version, strategies });
}
async getStrategy(req, res) {
const strategy = await this.strategyService.getStrategy(req.params.name);
this.openApiService.respondWithValidation(200, res, strategySchema.$id, strategy);
}
async removeStrategy(req, res) {
const strategyName = req.params.name;
const _userName = extractUsername(req);
await this.strategyService.removeStrategy(strategyName, req.audit);
res.status(200).end();
}
async createStrategy(req, res) {
const _userName = extractUsername(req);
const strategy = await this.strategyService.createStrategy(req.body, req.audit);
this.openApiService.respondWithValidation(201, res, strategySchema.$id, strategy, { location: `strategies/${strategy.name}` });
}
async updateStrategy(req, res) {
const _userName = extractUsername(req);
await this.strategyService.updateStrategy({ ...req.body, name: req.params.name }, req.audit);
res.status(200).end();
}
async deprecateStrategy(req, res) {
const _userName = extractUsername(req);
const { strategyName } = req.params;
await this.strategyService.deprecateStrategy(strategyName, req.audit);
res.status(200).end();
}
async reactivateStrategy(req, res) {
const _userName = extractUsername(req);
const { strategyName } = req.params;
await this.strategyService.reactivateStrategy(strategyName, req.audit);
res.status(200).end();
}
}
export default StrategyController;
//# sourceMappingURL=strategy.js.map