Skip to content

refactor: optimize throttler header suffix computation #2558

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

Open
ankitbelal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor: optimize throttler header suffix computation #2558

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 8 additions & 11 deletions src/throttler.guard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ export class ThrottlerGuard implements CanActivate {
if (Array.isArray(ignoreUserAgents)) {
for (const pattern of ignoreUserAgents) {
if (pattern.test(req.headers['user-agent'])) {
return true;
}
return true;
}
}
}
const tracker = await getTracker(req, context);
Expand All @@ -174,13 +174,13 @@ export class ThrottlerGuard implements CanActivate {

const getThrottlerSuffix = (name: string) => (name === 'default' ? '' : `-${name}`);
const setHeaders = throttler.setHeaders ?? this.commonOptions.setHeaders ?? true;

const suffix = getThrottlerSuffix(throttler.name);
// Throw an error when the user reached their limit.
if (isBlocked) {
if (setHeaders) {
res.header(`Retry-After${getThrottlerSuffix(throttler.name)}`, timeToBlockExpire);
res.header(`Retry-After${suffix}`, timeToBlockExpire);
}

await this.throwThrottlingException(context, {
limit,
ttl,
Expand All @@ -194,14 +194,11 @@ export class ThrottlerGuard implements CanActivate {
}

if (setHeaders) {
res.header(`${this.headerPrefix}-Limit${getThrottlerSuffix(throttler.name)}`, limit);
res.header(`${this.headerPrefix}-Limit${suffix}`, limit);
// We're about to add a record so we need to take that into account here.
// Otherwise the header says we have a request left when there are none.
res.header(
`${this.headerPrefix}-Remaining${getThrottlerSuffix(throttler.name)}`,
Math.max(0, limit - totalHits),
);
res.header(`${this.headerPrefix}-Reset${getThrottlerSuffix(throttler.name)}`, timeToExpire);
res.header(`${this.headerPrefix}-Remaining${suffix}`, Math.max(0, limit - totalHits));
res.header(`${this.headerPrefix}-Reset${suffix}`, timeToExpire);
}

return true;
Expand Down