Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update errorResponseBuilderContext type with ban property #298

Merged
merged 5 commits into from
Jun 13, 2023
Merged

Update errorResponseBuilderContext type with ban property #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d8f1bc
Update index.d.ts
leonitousconforti Jun 10, 2023
a2e58bd
Merge branch 'fastify:master' into patch-1
leonitousconforti Jun 11, 2023
e4063a5
Update index.test-d.ts
leonitousconforti Jun 11, 2023
19c8a94
Update index.test-d.ts
leonitousconforti Jun 11, 2023
956cee2
Update index.test-d.ts
leonitousconforti Jun 11, 2023
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
1 change: 1 addition & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ declare module 'fastify' {
export interface FastifyRateLimitOptions {}

export interface errorResponseBuilderContext {
ban: boolean;
after: string;
max: number;
ttl: number;
Expand Down
16 changes: 15 additions & 1 deletion types/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,21 @@ const options1: RateLimitPluginOptions = {
errorResponseBuilder: (
req: FastifyRequest<RequestGenericInterface>,
context: errorResponseBuilderContext
) => ({ code: 429, timeWindow: context.after, limit: context.max }),
) => {
if (context.ban) {
return {
statusCode: 403,
error: "Forbidden",
message: `You can not access this service as you have sent too many requests that exceed your rate limit. Your IP: ${req.ip} and Limit: ${context.max}`,
}
} else {
return {
statusCode: 429,
error: "Too Many Requests",
message: `You hit the rate limit, please slow down! You can retry in ${context.after}`,
}
}
},
addHeadersOnExceeding: {
'x-ratelimit-limit': false,
'x-ratelimit-remaining': false,
Expand Down