mirrors/barkey
1
0
Fork 0
mirror of https://codeberg.org/yeentown/barkey.git synced 2025-04-30 10:46:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix type errors from new rate limit definitions

Browse source
This commit is contained in:
Hazelnoot 2024-12-08 13:07:55 -05:00
parent fc4599ec07
commit 2946f85592
7 changed files with 25 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/backend/src/misc/rate-limit-utils.ts
View file

@ -6,6 +6,7 @@
import { FastifyReply } from 'fastify'; import { FastifyReply } from 'fastify';
export type RateLimit = BucketRateLimit | LegacyRateLimit; export type RateLimit = BucketRateLimit | LegacyRateLimit;
export type Keyed<T> = T & { key: string };
/** /**
* Rate limit based on "leaky bucket" logic. * Rate limit based on "leaky bucket" logic.
@ -16,7 +17,7 @@ export interface BucketRateLimit {
/** /**
* Unique key identifying the particular resource (or resource group) being limited. * Unique key identifying the particular resource (or resource group) being limited.
*/ */
key: string; key?: string;
/** /**
* Constant value identifying the type of rate limit. * Constant value identifying the type of rate limit.
@ -50,7 +51,7 @@ export interface LegacyRateLimit {
/** /**
* Unique key identifying the particular resource (or resource group) being limited. * Unique key identifying the particular resource (or resource group) being limited.
*/ */
key: string; key?: string;
/** /**
* Constant value identifying the type of rate limit. * Constant value identifying the type of rate limit.

8
packages/backend/src/server/FileServerService.ts
View file

@ -32,7 +32,7 @@ import { getIpHash } from '@/misc/get-ip-hash.js';
import { AuthenticateService } from '@/server/api/AuthenticateService.js'; import { AuthenticateService } from '@/server/api/AuthenticateService.js';
import { RoleService } from '@/core/RoleService.js'; import { RoleService } from '@/core/RoleService.js';
import { SkRateLimiterService } from '@/server/api/SkRateLimiterService.js'; import { SkRateLimiterService } from '@/server/api/SkRateLimiterService.js';
import { RateLimit, sendRateLimitHeaders } from '@/misc/rate-limit-utils.js'; import { Keyed, RateLimit, sendRateLimitHeaders } from '@/misc/rate-limit-utils.js';
import type { FastifyInstance, FastifyRequest, FastifyReply, FastifyPluginOptions } from 'fastify'; import type { FastifyInstance, FastifyRequest, FastifyReply, FastifyPluginOptions } from 'fastify';
const _filename = fileURLToPath(import.meta.url); const _filename = fileURLToPath(import.meta.url);
@ -633,7 +633,7 @@ export class FileServerService {
} }
private async checkResourceLimit(reply: FastifyReply, actor: string, group: string, resource: string, factor = 1): Promise<boolean> { private async checkResourceLimit(reply: FastifyReply, actor: string, group: string, resource: string, factor = 1): Promise<boolean> {
const limit: RateLimit = { const limit: Keyed<RateLimit> = {
// Group by resource // Group by resource
key: `${group}${resource}`, key: `${group}${resource}`,
type: 'bucket', type: 'bucket',
@ -647,7 +647,7 @@ export class FileServerService {
} }
private async checkSharedLimit(reply: FastifyReply, actor: string, group: string, factor = 1): Promise<boolean> { private async checkSharedLimit(reply: FastifyReply, actor: string, group: string, factor = 1): Promise<boolean> {
const limit: RateLimit = { const limit: Keyed<RateLimit> = {
key: group, key: group,
type: 'bucket', type: 'bucket',
@ -658,7 +658,7 @@ export class FileServerService {
return await this.checkLimit(reply, actor, limit, factor); return await this.checkLimit(reply, actor, limit, factor);
} }
private async checkLimit(reply: FastifyReply, actor: string, limit: RateLimit, factor = 1): Promise<boolean> { private async checkLimit(reply: FastifyReply, actor: string, limit: Keyed<RateLimit>, factor = 1): Promise<boolean> {
const info = await this.rateLimiterService.limit(limit, actor, factor); const info = await this.rateLimiterService.limit(limit, actor, factor);
sendRateLimitHeaders(reply, info); sendRateLimitHeaders(reply, info);

4
packages/backend/src/server/api/ApiCallService.ts
View file

@ -18,7 +18,7 @@ import { createTemp } from '@/misc/create-temp.js';
import { bindThis } from '@/decorators.js'; import { bindThis } from '@/decorators.js';
import { RoleService } from '@/core/RoleService.js'; import { RoleService } from '@/core/RoleService.js';
import type { Config } from '@/config.js'; import type { Config } from '@/config.js';
import { RateLimit, sendRateLimitHeaders } from '@/misc/rate-limit-utils.js'; import { sendRateLimitHeaders } from '@/misc/rate-limit-utils.js';
import { SkRateLimiterService } from '@/server/api/SkRateLimiterService.js'; import { SkRateLimiterService } from '@/server/api/SkRateLimiterService.js';
import { ApiError } from './error.js'; import { ApiError } from './error.js';
import { ApiLoggerService } from './ApiLoggerService.js'; import { ApiLoggerService } from './ApiLoggerService.js';
@ -327,7 +327,7 @@ export class ApiCallService implements OnApplicationShutdown {
const limit = { const limit = {
key: ep.name, key: ep.name,
...endpointLimit, ...endpointLimit,
} as RateLimit; };
// Rate limit // Rate limit
const info = await this.rateLimiterService.limit(limit, limitActor, factor); const info = await this.rateLimiterService.limit(limit, limitActor, factor);

3
packages/backend/src/server/api/RateLimiterService.ts
View file

@ -10,6 +10,7 @@ import { DI } from '@/di-symbols.js';
import type Logger from '@/logger.js'; import type Logger from '@/logger.js';
import { LoggerService } from '@/core/LoggerService.js'; import { LoggerService } from '@/core/LoggerService.js';
import { bindThis } from '@/decorators.js'; import { bindThis } from '@/decorators.js';
import { LegacyRateLimit } from '@/misc/rate-limit-utils.js';
import type { IEndpointMeta } from './endpoints.js'; import type { IEndpointMeta } from './endpoints.js';
/** @deprecated Use SkRateLimiterService instead */ /** @deprecated Use SkRateLimiterService instead */
@ -32,7 +33,7 @@ export class RateLimiterService {
} }
@bindThis @bindThis
public limit(limitation: IEndpointMeta['limit'] & { key: NonNullable<string> }, actor: string, factor = 1) { public limit(limitation: LegacyRateLimit & { key: NonNullable<string> }, actor: string, factor = 1) {
return new Promise<void>((ok, reject) => { return new Promise<void>((ok, reject) => {
if (this.disabled) ok(); if (this.disabled) ok();

16
packages/backend/src/server/api/SkRateLimiterService.ts
View file

@ -10,7 +10,7 @@ import { TimeService } from '@/core/TimeService.js';
import { EnvService } from '@/core/EnvService.js'; import { EnvService } from '@/core/EnvService.js';
import { DI } from '@/di-symbols.js'; import { DI } from '@/di-symbols.js';
import type Logger from '@/logger.js'; import type Logger from '@/logger.js';
import { BucketRateLimit, LegacyRateLimit, LimitInfo, RateLimit, hasMinLimit, isLegacyRateLimit } from '@/misc/rate-limit-utils.js'; import { BucketRateLimit, LegacyRateLimit, LimitInfo, RateLimit, hasMinLimit, isLegacyRateLimit, Keyed } from '@/misc/rate-limit-utils.js';
@Injectable() @Injectable()
export class SkRateLimiterService { export class SkRateLimiterService {
@ -34,7 +34,7 @@ export class SkRateLimiterService {
this.disabled = envService.env.NODE_ENV !== 'production'; // TODO disable in TEST *only* this.disabled = envService.env.NODE_ENV !== 'production'; // TODO disable in TEST *only*
} }
public async limit(limit: RateLimit, actor: string, factor = 1): Promise<LimitInfo> { public async limit(limit: Keyed<RateLimit>, actor: string, factor = 1): Promise<LimitInfo> {
if (this.disabled || factor === 0) { if (this.disabled || factor === 0) {
return { return {
blocked: false, blocked: false,
@ -57,7 +57,7 @@ export class SkRateLimiterService {
} }
} }
private async limitLegacy(limit: LegacyRateLimit, actor: string, factor: number): Promise<LimitInfo> { private async limitLegacy(limit: Keyed<LegacyRateLimit>, actor: string, factor: number): Promise<LimitInfo> {
const promises: Promise<LimitInfo | null>[] = []; const promises: Promise<LimitInfo | null>[] = [];
// The "min" limit - if present - is handled directly. // The "min" limit - if present - is handled directly.
@ -90,7 +90,7 @@ export class SkRateLimiterService {
}; };
} }
private async limitMin(limit: LegacyRateLimit & { minInterval: number }, actor: string, factor: number): Promise<LimitInfo | null> { private async limitMin(limit: Keyed<LegacyRateLimit> & { minInterval: number }, actor: string, factor: number): Promise<LimitInfo | null> {
if (limit.minInterval === 0) return null; if (limit.minInterval === 0) return null;
if (limit.minInterval < 0) throw new Error(`Invalid rate limit ${limit.key}: minInterval is negative (${limit.minInterval})`); if (limit.minInterval < 0) throw new Error(`Invalid rate limit ${limit.key}: minInterval is negative (${limit.minInterval})`);
@ -126,7 +126,7 @@ export class SkRateLimiterService {
return limitInfo; return limitInfo;
} }
private async limitBucket(limit: BucketRateLimit, actor: string, factor: number): Promise<LimitInfo> { private async limitBucket(limit: Keyed<BucketRateLimit>, actor: string, factor: number): Promise<LimitInfo> {
if (limit.size < 1) throw new Error(`Invalid rate limit ${limit.key}: size is less than 1 (${limit.size})`); if (limit.size < 1) throw new Error(`Invalid rate limit ${limit.key}: size is less than 1 (${limit.size})`);
if (limit.dripRate != null && limit.dripRate < 1) throw new Error(`Invalid rate limit ${limit.key}: dripRate is less than 1 (${limit.dripRate})`); if (limit.dripRate != null && limit.dripRate < 1) throw new Error(`Invalid rate limit ${limit.key}: dripRate is less than 1 (${limit.dripRate})`);
if (limit.dripSize != null && limit.dripSize < 1) throw new Error(`Invalid rate limit ${limit.key}: dripSize is less than 1 (${limit.dripSize})`); if (limit.dripSize != null && limit.dripSize < 1) throw new Error(`Invalid rate limit ${limit.key}: dripSize is less than 1 (${limit.dripSize})`);
@ -166,7 +166,7 @@ export class SkRateLimiterService {
return limitInfo; return limitInfo;
} }
private async getLimitCounter(limit: RateLimit, actor: string, subject: string): Promise<LimitCounter> { private async getLimitCounter(limit: Keyed<RateLimit>, actor: string, subject: string): Promise<LimitCounter> {
const key = createLimitKey(limit, actor, subject); const key = createLimitKey(limit, actor, subject);
const value = await this.redisClient.get(key); const value = await this.redisClient.get(key);
@ -177,7 +177,7 @@ export class SkRateLimiterService {
return JSON.parse(value); return JSON.parse(value);
} }
private async setLimitCounter(limit: RateLimit, actor: string, counter: LimitCounter, expiration: number, subject: string): Promise<void> { private async setLimitCounter(limit: Keyed<RateLimit>, actor: string, counter: LimitCounter, expiration: number, subject: string): Promise<void> {
const key = createLimitKey(limit, actor, subject); const key = createLimitKey(limit, actor, subject);
const value = JSON.stringify(counter); const value = JSON.stringify(counter);
const expirationSec = Math.max(expiration, 1); const expirationSec = Math.max(expiration, 1);
@ -185,7 +185,7 @@ export class SkRateLimiterService {
} }
} }
function createLimitKey(limit: RateLimit, actor: string, subject: string): string { function createLimitKey(limit: Keyed<RateLimit>, actor: string, subject: string): string {
return `rl_${actor}_${limit.key}_${subject}`; return `rl_${actor}_${limit.key}_${subject}`;
} }

2
packages/backend/src/server/api/endpoints.ts
View file

@ -856,7 +856,7 @@ interface IEndpointMetaBase {
* エンドポイントのリミテーションに関するやつ * エンドポイントのリミテーションに関するやつ
* 省略した場合はリミテーションは無いものとして解釈されます。 * 省略した場合はリミテーションは無いものとして解釈されます。
*/ */
readonly limit?: Readonly<RateLimit | Omit<RateLimit, 'key'>>; readonly limit?: Readonly<RateLimit>;
/** /**
* ファイルの添付を必要とするか否か * ファイルの添付を必要とするか否か

18
packages/backend/test/unit/server/api/SkRateLimiterServiceTests.ts
View file

@ -8,7 +8,7 @@ import { jest } from '@jest/globals';
import type Redis from 'ioredis'; import type Redis from 'ioredis';
import { LimitCounter, SkRateLimiterService } from '@/server/api/SkRateLimiterService.js'; import { LimitCounter, SkRateLimiterService } from '@/server/api/SkRateLimiterService.js';
import { LoggerService } from '@/core/LoggerService.js'; import { LoggerService } from '@/core/LoggerService.js';
import { BucketRateLimit, LegacyRateLimit } from '@/misc/rate-limit-utils.js'; import { BucketRateLimit, Keyed, LegacyRateLimit } from '@/misc/rate-limit-utils.js';
/* eslint-disable @typescript-eslint/no-non-null-assertion */ /* eslint-disable @typescript-eslint/no-non-null-assertion */
/* eslint-disable @typescript-eslint/no-unnecessary-condition */ /* eslint-disable @typescript-eslint/no-unnecessary-condition */
@ -142,7 +142,7 @@ describe(SkRateLimiterService, () => {
}); });
describe('with bucket limit', () => { describe('with bucket limit', () => {
let limit: BucketRateLimit = null!; let limit: Keyed<BucketRateLimit> = null!;
beforeEach(() => { beforeEach(() => {
limit = { limit = {
@ -387,7 +387,7 @@ describe(SkRateLimiterService, () => {
}); });
describe('with min interval', () => { describe('with min interval', () => {
let limit: MutableLegacyRateLimit = null!; let limit: Keyed<LegacyRateLimit> = null!;
beforeEach(() => { beforeEach(() => {
limit = { limit = {
@ -570,7 +570,7 @@ describe(SkRateLimiterService, () => {
}); });
describe('with legacy limit', () => { describe('with legacy limit', () => {
let limit: MutableLegacyRateLimit = null!; let limit: Keyed<LegacyRateLimit> = null!;
beforeEach(() => { beforeEach(() => {
limit = { limit = {
@ -726,7 +726,7 @@ describe(SkRateLimiterService, () => {
}); });
describe('with legacy limit and min interval', () => { describe('with legacy limit and min interval', () => {
let limit: MutableLegacyRateLimit = null!; let limit: Keyed<LegacyRateLimit> = null!;
beforeEach(() => { beforeEach(() => {
limit = { limit = {
@ -855,11 +855,3 @@ describe(SkRateLimiterService, () => {
}); });
}); });
}); });
// The same thing, but mutable
interface MutableLegacyRateLimit extends LegacyRateLimit {
key: string;
duration?: number;
max?: number;
minInterval?: number;
}