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

78 lines
1.7 KiB
TypeScript
Raw Normal View History

2022-02-27 07:21:25 +02:00
import Limiter from 'ratelimiter';
import { CacheableLocalUser, User } from '@/models/entities/user.js';
import Logger from '@/services/logger.js';
2022-06-14 12:01:23 +03:00
import { redisClient } from '../../db/redis.js';
import { IEndpointMeta } from './endpoints.js';
2016-12-29 00:49:51 +02:00
2019-02-03 09:45:13 +02:00
const logger = new Logger('limiter');
2017-01-23 11:25:52 +02:00
export const limiter = (limitation: IEndpointMeta['limit'] & { key: NonNullable<string> }, actor: string) => new Promise<void>((ok, reject) => {
if (process.env.NODE_ENV === 'test') ok();
const hasShortTermLimit = typeof limitation.minInterval === 'number';
2016-12-29 00:49:51 +02:00
2017-03-01 15:33:43 +02:00
const hasLongTermLimit =
typeof limitation.duration === 'number' &&
typeof limitation.max === 'number';
2016-12-29 00:49:51 +02:00
2017-03-01 15:33:43 +02:00
if (hasShortTermLimit) {
2016-12-29 00:49:51 +02:00
min();
2017-03-01 15:33:43 +02:00
} else if (hasLongTermLimit) {
2016-12-29 00:49:51 +02:00
max();
} else {
ok();
}
// Short-term limit
2022-01-21 10:15:14 +02:00
function min(): void {
2016-12-29 00:49:51 +02:00
const minIntervalLimiter = new Limiter({
id: `${actor}:${limitation.key}:min`,
2017-03-01 15:33:43 +02:00
duration: limitation.minInterval,
2016-12-29 00:49:51 +02:00
max: 1,
2021-12-09 16:58:30 +02:00
db: redisClient,
2016-12-29 00:49:51 +02:00
});
2017-01-23 11:25:52 +02:00
minIntervalLimiter.get((err, info) => {
if (err) {
return reject('ERR');
}
logger.debug(`${actor} ${limitation.key} min remaining: ${info.remaining}`);
2017-01-23 11:25:52 +02:00
if (info.remaining === 0) {
2016-12-29 00:49:51 +02:00
reject('BRIEF_REQUEST_INTERVAL');
} else {
2017-03-01 15:33:43 +02:00
if (hasLongTermLimit) {
2016-12-29 00:49:51 +02:00
max();
} else {
ok();
}
}
});
}
// Long term limit
2022-01-21 10:15:14 +02:00
function max(): void {
2016-12-29 00:49:51 +02:00
const limiter = new Limiter({
id: `${actor}:${limitation.key}`,
2017-03-01 15:33:43 +02:00
duration: limitation.duration,
max: limitation.max,
2021-12-09 16:58:30 +02:00
db: redisClient,
2016-12-29 00:49:51 +02:00
});
2017-01-23 11:25:52 +02:00
limiter.get((err, info) => {
if (err) {
return reject('ERR');
}
logger.debug(`${actor} ${limitation.key} max remaining: ${info.remaining}`);
2017-01-23 11:25:52 +02:00
if (info.remaining === 0) {
2016-12-29 00:49:51 +02:00
reject('RATE_LIMIT_EXCEEDED');
} else {
ok();
}
});
}
});