Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions __tests__/routes/public/rateLimit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,27 @@ describe('Public API Rate Limiting', () => {

expect(remaining2).toBeLessThan(remaining1);
});

it('should return 429 when user rate limit is exceeded', async () => {
const token = await createTokenForUser(state.con, '5');

// Limit is 60/min/user. Fire until we hit the limit.
let lastRes;
for (let i = 0; i < 61; i++) {
lastRes = await request(state.app.server)
.get('/public/v1/feeds/foryou')
.set('Authorization', `Bearer ${token}`);

if (lastRes.status === 429 && lastRes.body.statusCode === 429) {
break;
}
}

expect(lastRes!.status).toBe(429);
expect(lastRes!.body).toMatchObject({
error: 'rate_limit_exceeded',
message: expect.stringMatching(/rate limit/i),
});
});
});
});
29 changes: 19 additions & 10 deletions src/routes/public/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,17 @@ export default async function (
max: IP_RATE_LIMIT_PER_MINUTE,
timeWindow: '1 minute',
keyGenerator: (request: FastifyRequest) => request.ip,
errorResponseBuilder: () => ({
error: 'rate_limit_exceeded',
message: 'Too many requests from this IP. Please slow down.',
retryAfter: 60,
}),
errorResponseBuilder: () => {
// @fastify/rate-limit throws the return value of this builder. Return
// a proper Error so the global setErrorHandler can read err.name and
// err.statusCode (plain objects lose both).
const err = new Error(
'Too many requests from this IP. Please slow down.',
);
err.name = 'rate_limit_exceeded';
(err as Error & { statusCode: number }).statusCode = 429;
return err;
},
skipOnError: false,
addHeadersOnExceeding: {
'x-ratelimit-limit': false,
Expand Down Expand Up @@ -177,11 +183,14 @@ export default async function (
hook: 'preHandler',
keyGenerator: (request: FastifyRequest) => request.apiUserId,
skip: (request: FastifyRequest) => !request.apiUserId,
errorResponseBuilder: () => ({
error: 'rate_limit_exceeded',
message: 'User rate limit exceeded. Please slow down.',
retryAfter: 60,
}),
errorResponseBuilder: () => {
// See IP rate limiter above. Return a proper Error so name/statusCode
// survive the throw and reach the global setErrorHandler.
const err = new Error('User rate limit exceeded. Please slow down.');
err.name = 'rate_limit_exceeded';
(err as Error & { statusCode: number }).statusCode = 429;
return err;
},
skipOnError: false,
addHeadersOnExceeding: {
'x-ratelimit-limit': true,
Expand Down
Loading