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