1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-04 00:18:01 +01:00
unleash.unleash/src/lib/services/pat-service.ts
Nuno Góis ccfc046937
feat: adds the PAT_DELETE event (#2965)
<img width="973" alt="image"
src="https://user-images.githubusercontent.com/14320932/214047789-830adae4-daf1-4761-9b77-a49c9b92d0d8.png">

Adds the `PAT_DELETE` event so we can log the relevant information when
a PAT is deleted.

Should cover the following scenarios:

- User deletes their own PAT;
- Admin deletes another user's PAT;
- Admin deletes a Service Account token;
2023-01-23 15:11:16 +02:00

105 lines
3.0 KiB
TypeScript

import { IUnleashConfig, IUnleashStores } from '../types';
import { Logger } from '../logger';
import { IPatStore } from '../types/stores/pat-store';
import { IEventStore } from '../types/stores/event-store';
import { PAT_CREATED, PAT_DELETED } from '../types/events';
import { IPat } from '../types/models/pat';
import crypto from 'crypto';
import User from '../types/user';
import BadDataError from '../error/bad-data-error';
import NameExistsError from '../error/name-exists-error';
import { OperationDeniedError } from '../error/operation-denied-error';
import { PAT_LIMIT } from '../util/constants';
export default class PatService {
private config: IUnleashConfig;
private logger: Logger;
private patStore: IPatStore;
private eventStore: IEventStore;
constructor(
{
patStore,
eventStore,
}: Pick<IUnleashStores, 'patStore' | 'eventStore'>,
config: IUnleashConfig,
) {
this.config = config;
this.logger = config.getLogger('services/pat-service.ts');
this.patStore = patStore;
this.eventStore = eventStore;
}
async createPat(pat: IPat, forUserId: number, editor: User): Promise<IPat> {
await this.validatePat(pat, forUserId);
pat.secret = this.generateSecretKey();
pat.userId = forUserId;
const newPat = await this.patStore.create(pat);
pat.secret = '***';
await this.eventStore.store({
type: PAT_CREATED,
createdBy: editor.email || editor.username,
data: pat,
});
return newPat;
}
async getAll(userId: number): Promise<IPat[]> {
return this.patStore.getAllByUser(userId);
}
async deletePat(
id: number,
forUserId: number,
editor: User,
): Promise<void> {
const pat = await this.patStore.get(id);
pat.secret = '***';
await this.eventStore.store({
type: PAT_DELETED,
createdBy: editor.email || editor.username,
data: pat,
});
return this.patStore.deleteForUser(id, forUserId);
}
async validatePat(
{ description, expiresAt }: IPat,
userId: number,
): Promise<void> {
if (!description) {
throw new BadDataError('PAT description cannot be empty');
}
if (new Date(expiresAt) < new Date()) {
throw new BadDataError('The expiry date should be in future.');
}
if ((await this.patStore.countByUser(userId)) >= PAT_LIMIT) {
throw new OperationDeniedError(
`Too many PATs (${PAT_LIMIT}) already exist for this user.`,
);
}
if (
await this.patStore.existsWithDescriptionByUser(description, userId)
) {
throw new NameExistsError('PAT description already exists');
}
}
private generateSecretKey() {
const randomStr = crypto.randomBytes(28).toString('hex');
return `user:${randomStr}`;
}
}
module.exports = PatService;