All files / src/lib/services segment-service.ts

66.67% Statements 32/48
28.57% Branches 4/14
68.75% Functions 11/16
66.67% Lines 32/48

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166        60x     60x 60x             60x 60x         60x                                       147x 147x 147x 147x               4x       2x         15x                 14x 14x 12x   12x   12x                                                                           15x 14x                 12x       12x               15x   15x       15x 1x                 14x   14x 33x 33x   14x 2x            
import { IUnleashConfig } from '../types/option';
import { IEventStore } from '../types/stores/event-store';
import { IUnleashStores } from '../types';
import { Logger } from '../logger';
import NameExistsError from '../error/name-exists-error';
import { ISegmentStore } from '../types/stores/segment-store';
import { IFeatureStrategy, ISegment } from '../types/model';
import { segmentSchema } from './segment-schema';
import {
    SEGMENT_CREATED,
    SEGMENT_DELETED,
    SEGMENT_UPDATED,
} from '../types/events';
import User from '../types/user';
import { IFeatureStrategiesStore } from '../types/stores/feature-strategies-store';
import BadDataError from '../error/bad-data-error';
import {
    SEGMENT_VALUES_LIMIT,
    STRATEGY_SEGMENTS_LIMIT,
} from '../util/segments';
 
export class SegmentService {
    private logger: Logger;
 
    private segmentStore: ISegmentStore;
 
    private featureStrategiesStore: IFeatureStrategiesStore;
 
    private eventStore: IEventStore;
 
    constructor(
        {
            segmentStore,
            featureStrategiesStore,
            eventStore,
        }: Pick<
            IUnleashStores,
            'segmentStore' | 'featureStrategiesStore' | 'eventStore'
        >,
        { getLogger }: Pick<IUnleashConfig, 'getLogger'>,
    ) {
        this.segmentStore = segmentStore;
        this.featureStrategiesStore = featureStrategiesStore;
        this.eventStore = eventStore;
        this.logger = getLogger('services/segment-service.ts');
    }
 
    async get(id: number): Promise<ISegment> {
        return this.segmentStore.get(id);
    }
 
    async getAll(): Promise<ISegment[]> {
        return this.segmentStore.getAll();
    }
 
    async getActive(): Promise<ISegment[]> {
        return this.segmentStore.getActive();
    }
 
    // Used by unleash-enterprise.
    async getByStrategy(strategyId: string): Promise<ISegment[]> {
        return this.segmentStore.getByStrategy(strategyId);
    }
 
    // Used by unleash-enterprise.
    async getStrategies(id: number): Promise<IFeatureStrategy[]> {
        return this.featureStrategiesStore.getStrategiesBySegment(id);
    }
 
    async create(data: unknown, user: User): Promise<void> {
        const input = await segmentSchema.validateAsync(data);
        SegmentService.validateSegmentValuesLimit(input);
        await this.validateName(input.name);
 
        const segment = await this.segmentStore.create(input, user);
 
        await this.eventStore.store({
            type: SEGMENT_CREATED,
            createdBy: user.email || user.username,
            data: segment,
        });
    }
 
    async update(id: number, data: unknown, user: User): Promise<void> {
        const input = await segmentSchema.validateAsync(data);
        SegmentService.validateSegmentValuesLimit(input);
        const preData = await this.segmentStore.get(id);
 
        Iif (preData.name !== input.name) {
            await this.validateName(input.name);
        }
 
        const segment = await this.segmentStore.update(id, input);
 
        await this.eventStore.store({
            type: SEGMENT_UPDATED,
            createdBy: user.email || user.username,
            data: segment,
            preData,
        });
    }
 
    async delete(id: number, user: User): Promise<void> {
        const segment = this.segmentStore.get(id);
        await this.segmentStore.delete(id);
        await this.eventStore.store({
            type: SEGMENT_DELETED,
            createdBy: user.email || user.username,
            data: segment,
        });
    }
 
    // Used by unleash-enterprise.
    async addToStrategy(id: number, strategyId: string): Promise<void> {
        await this.validateStrategySegmentLimit(strategyId);
        await this.segmentStore.addToStrategy(id, strategyId);
    }
 
    // Used by unleash-enterprise.
    async removeFromStrategy(id: number, strategyId: string): Promise<void> {
        await this.segmentStore.removeFromStrategy(id, strategyId);
    }
 
    async validateName(name: string): Promise<void> {
        Iif (!name) {
            throw new BadDataError('Segment name cannot be empty');
        }
 
        Iif (await this.segmentStore.existsByName(name)) {
            throw new NameExistsError('Segment name already exists');
        }
    }
 
    private async validateStrategySegmentLimit(
        strategyId: string,
    ): Promise<void> {
        const limit = STRATEGY_SEGMENTS_LIMIT;
 
        Iif (typeof limit === 'undefined') {
            return;
        }
 
        if ((await this.getByStrategy(strategyId)).length >= limit) {
            throw new BadDataError(
                `Strategies may not have more than ${limit} segments`,
            );
        }
    }
 
    private static validateSegmentValuesLimit(
        segment: Omit<ISegment, 'id'>,
    ): void {
        const limit = SEGMENT_VALUES_LIMIT;
 
        const valuesCount = segment.constraints
            .flatMap((constraint) => constraint.values?.length ?? 0)
            .reduce((acc, length) => acc + length, 0);
 
        if (valuesCount > limit) {
            throw new BadDataError(
                `Segments may not have more than ${limit} values`,
            );
        }
    }
}