unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
94 lines • 5.08 kB
JavaScript
import Controller from '../../routes/controller.js';
import { NONE, serializeDates, } from '../../types/index.js';
import { createRequestSchema, createResponseSchema, emptyResponse, exportResultSchema, getStandardResponses, importTogglesValidateSchema, } from '../../openapi/index.js';
import { extractUsername } from '../../util/index.js';
import { BadDataError } from '../../error/index.js';
import ApiUser from '../../types/api-user.js';
class ExportImportController extends Controller {
constructor(config, { exportService, importService, openApiService, }) {
super(config);
this.exportService = exportService;
this.importService = importService;
this.openApiService = openApiService;
this.route({
method: 'post',
path: '/export',
permission: NONE,
handler: this.export,
middleware: [
this.openApiService.validPath({
tags: ['Import/Export'],
operationId: 'exportFeatures',
requestBody: createRequestSchema('exportQuerySchema'),
responses: {
200: createResponseSchema('exportResultSchema'),
...getStandardResponses(404),
},
description: "Exports all features listed in the `features` property from the environment specified in the request body. If set to `true`, the `downloadFile` property will let you download a file with the exported data. Otherwise, the export data is returned directly as JSON. Refer to the documentation for more information about [Unleash's export functionality](https://docs.getunleash.io/concepts/import-export#export-feature-flags).",
summary: 'Export feature flags from an environment',
}),
],
});
this.route({
method: 'post',
path: '/validate',
permission: NONE,
handler: this.validateImport,
middleware: [
openApiService.validPath({
tags: ['Import/Export'],
operationId: 'validateImport',
requestBody: createRequestSchema('importTogglesSchema'),
responses: {
200: createResponseSchema('importTogglesValidateSchema'),
...getStandardResponses(404),
},
summary: 'Validate feature import data',
description: `Validates a feature flag data set. Checks whether the data can be imported into the specified project and environment. The returned value is an object that contains errors, warnings, and permissions required to perform the import, as described in the [import documentation](https://docs.getunleash.io/concepts/import-export#import-feature-flags).`,
}),
],
});
this.route({
method: 'post',
path: '/import',
permission: NONE,
handler: this.importData,
middleware: [
openApiService.validPath({
tags: ['Import/Export'],
operationId: 'importToggles',
requestBody: createRequestSchema('importTogglesSchema'),
responses: {
200: emptyResponse,
...getStandardResponses(404),
},
summary: 'Import feature flags',
description: `[Import feature flags](https://docs.getunleash.io/concepts/import-export#import-feature-flags) into a specific project and environment.`,
}),
],
});
}
async export(req, res) {
const query = req.body;
const _userName = extractUsername(req);
const data = await this.exportService.export(query, req.audit);
this.openApiService.respondWithValidation(200, res, exportResultSchema.$id, serializeDates(data));
}
async validateImport(req, res) {
const dto = req.body;
const { user } = req;
const validation = await this.importService.transactional((service) => service.validate(dto, user));
this.openApiService.respondWithValidation(200, res, importTogglesValidateSchema.$id, validation);
}
async importData(req, res) {
const { user, audit } = req;
if (user instanceof ApiUser && user.type === 'admin') {
throw new BadDataError(`You can't use an admin token to import features. Please use either a personal access token (https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens) or a service account (https://docs.getunleash.io/concepts/service-accounts).`);
}
const dto = req.body;
await this.importService.transactional((service) => service.import(dto, user, audit));
res.status(200).end();
}
}
export default ExportImportController;
//# sourceMappingURL=export-import-controller.js.map