Sharkey/packages/backend/src/server/api/RateLimiterService.ts

101 lines
2.3 KiB
TypeScript
Raw Normal View History

2022-09-17 21:27:08 +03:00
import { Inject, Injectable } from '@nestjs/common';
import Limiter from 'ratelimiter';
import Redis from 'ioredis';
import { DI } from '@/di-symbols.js';
2022-09-18 17:07:41 +03:00
import type Logger from '@/logger.js';
import { LoggerService } from '@/core/LoggerService.js';
import { bindThis } from '@/decorators.js';
import type { IEndpointMeta } from './endpoints.js';
2022-09-17 21:27:08 +03:00
@Injectable()
export class RateLimiterService {
2022-09-18 21:11:50 +03:00
private logger: Logger;
private disabled = false;
2022-09-18 17:07:41 +03:00
2022-09-17 21:27:08 +03:00
constructor(
@Inject(DI.redis)
private redisClient: Redis.Redis,
2022-09-18 17:07:41 +03:00
private loggerService: LoggerService,
2022-09-17 21:27:08 +03:00
) {
2022-09-18 21:11:50 +03:00
this.logger = this.loggerService.getLogger('limiter');
if (process.env.NODE_ENV !== 'production') {
this.disabled = true;
}
2022-09-17 21:27:08 +03:00
}
@bindThis
public limit(limitation: IEndpointMeta['limit'] & { key: NonNullable<string> }, actor: string, factor = 1) {
2022-09-17 21:27:08 +03:00
return new Promise<void>((ok, reject) => {
if (this.disabled) ok();
2022-09-17 21:27:08 +03:00
// Short-term limit
const min = (): void => {
const minIntervalLimiter = new Limiter({
id: `${actor}:${limitation.key}:min`,
2023-02-09 03:55:15 +02:00
duration: limitation.minInterval! * factor,
2022-09-17 21:27:08 +03:00
max: 1,
db: this.redisClient,
});
minIntervalLimiter.get((err, info) => {
if (err) {
return reject('ERR');
}
2022-09-18 21:11:50 +03:00
this.logger.debug(`${actor} ${limitation.key} min remaining: ${info.remaining}`);
2022-09-17 21:27:08 +03:00
if (info.remaining === 0) {
reject('BRIEF_REQUEST_INTERVAL');
} else {
if (hasLongTermLimit) {
max();
} else {
ok();
}
}
});
};
// Long term limit
const max = (): void => {
const limiter = new Limiter({
id: `${actor}:${limitation.key}`,
2023-02-09 03:55:15 +02:00
duration: limitation.duration! * factor,
max: limitation.max! / factor,
2022-09-17 21:27:08 +03:00
db: this.redisClient,
});
limiter.get((err, info) => {
if (err) {
return reject('ERR');
}
2022-09-18 21:11:50 +03:00
this.logger.debug(`${actor} ${limitation.key} max remaining: ${info.remaining}`);
2022-09-17 21:27:08 +03:00
if (info.remaining === 0) {
reject('RATE_LIMIT_EXCEEDED');
} else {
ok();
}
});
};
const hasShortTermLimit = typeof limitation.minInterval === 'number';
const hasLongTermLimit =
typeof limitation.duration === 'number' &&
typeof limitation.max === 'number';
if (hasShortTermLimit) {
min();
} else if (hasLongTermLimit) {
max();
} else {
ok();
}
});
}
}