import { Request, Response } from 'express'; import Controller from '../controller'; import { NONE, UPDATE_APPLICATION } from '../../types/permissions'; import { IUnleashConfig } from '../../types/option'; import { IUnleashServices } from '../../types/services'; import { Logger } from '../../logger'; import ClientInstanceService from '../../services/client-metrics/instance-service'; import { createRequestSchema } from '../../openapi/util/create-request-schema'; import { createResponseSchema } from '../../openapi/util/create-response-schema'; import { ApplicationSchema } from '../../openapi/spec/application-schema'; import { ApplicationsSchema } from '../../openapi/spec/applications-schema'; import { emptyResponse, getStandardResponses, } from '../../openapi/util/standard-responses'; import { CreateApplicationSchema } from '../../openapi/spec/create-application-schema'; import { IAuthRequest } from '../unleash-types'; class MetricsController extends Controller { private logger: Logger; private clientInstanceService: ClientInstanceService; constructor( config: IUnleashConfig, { clientInstanceService, openApiService, }: Pick, ) { super(config); this.logger = config.getLogger('/admin-api/metrics.ts'); this.clientInstanceService = clientInstanceService; // deprecated routes this.get('/seen-toggles', this.deprecated); this.get('/seen-apps', this.deprecated); this.get('/feature-toggles', this.deprecated); this.get('/feature-toggles/:name', this.deprecated); this.route({ method: 'post', path: '/applications/:appName', handler: this.createApplication, permission: UPDATE_APPLICATION, middleware: [ openApiService.validPath({ tags: ['Metrics'], operationId: 'createApplication', summary: 'Create an application to connect reported metrics', description: 'Is used to report usage as well which sdk the application uses', responses: { 202: emptyResponse, ...getStandardResponses(400, 401, 403), }, requestBody: createRequestSchema('createApplicationSchema'), }), ], }); this.route({ method: 'delete', path: '/applications/:appName', handler: this.deleteApplication, permission: UPDATE_APPLICATION, acceptAnyContentType: true, middleware: [ openApiService.validPath({ tags: ['Metrics'], operationId: 'deleteApplication', summary: 'Delete an application', description: `Delete the application specified in the request URL. Returns 200 OK if the application was successfully deleted or if it didn't exist`, responses: { 200: emptyResponse, ...getStandardResponses(401, 403), }, }), ], }); this.route({ method: 'get', path: '/applications', handler: this.getApplications, permission: NONE, middleware: [ openApiService.validPath({ tags: ['Metrics'], summary: 'Get all applications', description: 'Returns all applications registered with Unleash. Applications can be created via metrics reporting or manual creation', operationId: 'getApplications', responses: { 200: createResponseSchema('applicationsSchema'), }, }), ], }); this.route({ method: 'get', path: '/applications/:appName', handler: this.getApplication, permission: NONE, middleware: [ openApiService.validPath({ tags: ['Metrics'], operationId: 'getApplication', summary: 'Get application data', description: 'Returns data about the specified application (`appName`). The data contains information on the name of the application, sdkVersion (which sdk reported these metrics, typically `unleash-client-node:3.4.1` or `unleash-client-java:7.1.0`), as well as data about how to display this application in a list.', responses: { 200: createResponseSchema('applicationSchema'), ...getStandardResponses(404), }, }), ], }); } async deprecated(req: Request, res: Response): Promise { res.status(410).json({ lastHour: {}, lastMinute: {}, maturity: 'deprecated', }); } async deleteApplication( req: Request<{ appName: string }>, res: Response, ): Promise { const { appName } = req.params; await this.clientInstanceService.deleteApplication(appName); res.status(200).end(); } async createApplication( req: Request<{ appName: string }, unknown, CreateApplicationSchema>, res: Response, ): Promise { const input = { ...req.body, appName: req.params.appName, }; await this.clientInstanceService.createApplication(input); res.status(202).end(); } async getApplications( req: IAuthRequest, res: Response, ): Promise { const { user } = req; const query = req.query.strategyName ? { strategyName: req.query.strategyName as string } : {}; const applications = await this.clientInstanceService.getApplications( query, user.id, ); res.json({ applications }); } async getApplication( req: Request, res: Response, ): Promise { const { appName } = req.params; const appDetails = await this.clientInstanceService.getApplication( appName, ); res.json(appDetails); } } export default MetricsController;