1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-09 00:18:00 +01:00
unleash.unleash/src/lib/services/strategy-service.ts
Christopher Kolstad cf2bd28ff6
feat: use audit info in events (#6872)
I've tried to use/add the audit info to all events I could see/find.
This makes this PR necessarily huge, because we do store quite a few
events. 

I realise it might not be complete yet, but tests
run green, and I think we now have a pattern to follow for other events.
2024-04-18 16:32:35 +02:00

169 lines
5.0 KiB
TypeScript

import type { Logger } from '../logger';
import type { IUnleashConfig } from '../types/option';
import type { IUnleashStores } from '../types/stores';
import type {
IMinimalStrategy,
IStrategy,
IStrategyStore,
} from '../types/stores/strategy-store';
import NotFoundError from '../error/notfound-error';
import type EventService from '../features/events/event-service';
import {
type IAuditUser,
StrategyCreatedEvent,
StrategyDeletedEvent,
StrategyDeprecatedEvent,
StrategyReactivatedEvent,
StrategyUpdatedEvent,
} from '../types';
const strategySchema = require('./strategy-schema');
const NameExistsError = require('../error/name-exists-error');
const {
STRATEGY_CREATED,
STRATEGY_DELETED,
STRATEGY_DEPRECATED,
STRATEGY_REACTIVATED,
STRATEGY_UPDATED,
} = require('../types/events');
class StrategyService {
private logger: Logger;
private strategyStore: IStrategyStore;
private eventService: EventService;
constructor(
{ strategyStore }: Pick<IUnleashStores, 'strategyStore'>,
{ getLogger }: Pick<IUnleashConfig, 'getLogger'>,
eventService: EventService,
) {
this.strategyStore = strategyStore;
this.eventService = eventService;
this.logger = getLogger('services/strategy-service.js');
}
async getStrategies(): Promise<IStrategy[]> {
return this.strategyStore.getAll();
}
async getStrategy(name: string): Promise<IStrategy> {
return this.strategyStore.get(name);
}
async removeStrategy(
strategyName: string,
auditUser: IAuditUser,
): Promise<void> {
const strategy = await this.strategyStore.get(strategyName);
await this._validateEditable(strategy);
await this.strategyStore.delete(strategyName);
await this.eventService.storeEvent(
new StrategyDeletedEvent({
data: {
name: strategyName,
},
auditUser,
}),
);
}
async deprecateStrategy(
strategyName: string,
auditUser: IAuditUser,
): Promise<void> {
if (await this.strategyStore.exists(strategyName)) {
// Check existence
await this.strategyStore.deprecateStrategy({ name: strategyName });
await this.eventService.storeEvent(
new StrategyDeprecatedEvent({
data: {
name: strategyName,
},
auditUser,
}),
);
} else {
throw new NotFoundError(
`Could not find strategy with name ${strategyName}`,
);
}
}
async reactivateStrategy(
strategyName: string,
auditUser: IAuditUser,
): Promise<void> {
await this.strategyStore.get(strategyName); // Check existence
await this.strategyStore.reactivateStrategy({ name: strategyName });
await this.eventService.storeEvent(
new StrategyReactivatedEvent({
data: {
name: strategyName,
},
auditUser,
}),
);
}
async createStrategy(
value: IMinimalStrategy,
auditUser: IAuditUser,
): Promise<IStrategy> {
const strategy = await strategySchema.validateAsync(value);
strategy.deprecated = false;
await this._validateStrategyName(strategy);
await this.strategyStore.createStrategy(strategy);
await this.eventService.storeEvent(
new StrategyCreatedEvent({
data: strategy,
auditUser,
}),
);
return this.strategyStore.get(strategy.name);
}
async updateStrategy(
input: IMinimalStrategy,
auditUser: IAuditUser,
): Promise<void> {
const value = await strategySchema.validateAsync(input);
const strategy = await this.strategyStore.get(input.name);
await this._validateEditable(strategy);
await this.strategyStore.updateStrategy(value);
await this.eventService.storeEvent(
new StrategyUpdatedEvent({
data: value,
auditUser,
}),
);
}
private _validateStrategyName(
data: Pick<IStrategy, 'name'>,
): Promise<Pick<IStrategy, 'name'>> {
return new Promise((resolve, reject) => {
this.strategyStore
.get(data.name)
.then(() =>
reject(
new NameExistsError(
`Strategy with name ${data.name} already exist!`,
),
),
)
.catch(() => resolve(data));
});
}
// This check belongs in the store.
_validateEditable(strategy: IStrategy): void {
if (!strategy.editable) {
throw new Error(`Cannot edit strategy ${strategy.name}`);
}
}
}
export default StrategyService;
module.exports = StrategyService;