unleash.unleash/src/lib/features/feature-search/feature-search-controller.ts

import { Response } from 'express';
import Controller from '../../routes/controller';
import { FeatureSearchService, OpenApiService } from '../../services';
import {
    IFlagResolver,
    IUnleashConfig,
    IUnleashServices,
    NONE,
} from '../../types';
import { Logger } from '../../logger';
import { createResponseSchema, getStandardResponses } from '../../openapi';
import { IAuthRequest } from '../../routes/unleash-types';
import { InvalidOperationError } from '../../error';
import {
    FeatureSearchQueryParameters,
    featureSearchQueryParameters,
} from '../../openapi/spec/feature-search-query-parameters';

const PATH = '/features';

type FeatureSearchServices = Pick<
    IUnleashServices,
    'openApiService' | 'featureSearchService'
>;

export default class FeatureSearchController extends Controller {
    private openApiService: OpenApiService;

    private flagResolver: IFlagResolver;

    private featureSearchService: FeatureSearchService;

    private readonly logger: Logger;

    constructor(
        config: IUnleashConfig,
        { openApiService, featureSearchService }: FeatureSearchServices,
    ) {
        super(config);
        this.openApiService = openApiService;
        this.flagResolver = config.flagResolver;
        this.featureSearchService = featureSearchService;
        this.logger = config.getLogger(
            '/feature-search/feature-search-controller.ts',
        );

        this.route({
            method: 'get',
            path: PATH,
            handler: this.searchFeatures,
            permission: NONE,
            middleware: [
                openApiService.validPath({
                    tags: ['Search'],
                    summary: 'Search and filter features',
                    description: 'Search and filter by selected fields.',
                    operationId: 'searchFeatures',
                    // top level array needs to be mutable according to openapi library
                    parameters: [...featureSearchQueryParameters],
                    responses: {
                        200: createResponseSchema('searchFeaturesSchema'),
                        ...getStandardResponses(401, 403, 404),
                    },
                }),
            ],
        });
    }

    async searchFeatures(
        req: IAuthRequest<any, any, any, FeatureSearchQueryParameters>,
        res: Response,
    ): Promise<void> {
        if (this.config.flagResolver.isEnabled('featureSearchAPI')) {
            const {
                query,
                project,
                type,
                tag,
                segment,
                createdAt,
                state,
                status,
                offset,
                limit = '50',
                sortOrder,
                sortBy,
                favoritesFirst,
            } = req.query;
            const userId = req.user.id;
            const normalizedQuery = query
                ?.split(',')
                .map((query) => query.trim())
                .filter((query) => query);
            const normalizedStatus = status
                ?.map((tag) => tag.split(':'))
                .filter(
                    (tag) =>
                        tag.length === 2 &&
                        ['enabled', 'disabled'].includes(tag[1]),
                );
            const normalizedLimit =
                Number(limit) > 0 && Number(limit) <= 50 ? Number(limit) : 50;
            const normalizedOffset = Number(offset) > 0 ? Number(offset) : 0;
            const normalizedSortBy: string = sortBy ? sortBy : 'createdAt';
            const normalizedSortOrder =
                sortOrder === 'asc' || sortOrder === 'desc' ? sortOrder : 'asc';
            const normalizedFavoritesFirst = favoritesFirst === 'true';
            const { features, total } = await this.featureSearchService.search({
                searchParams: normalizedQuery,
                project,
                type,
                userId,
                tag,
                segment,
                state,
                createdAt,
                status: normalizedStatus,
                offset: normalizedOffset,
                limit: normalizedLimit,
                sortBy: normalizedSortBy,
                sortOrder: normalizedSortOrder,
                favoritesFirst: normalizedFavoritesFirst,
            });

            res.json({ features, total });
        } else {
            throw new InvalidOperationError(
                'Feature Search API is not enabled',
            );
        }
    }
}