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
2 changes: 1 addition & 1 deletion packages/core/src/transports/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export function createTransport(
options.bufferSize || DEFAULT_TRANSPORT_BUFFER_SIZE,
),
): Transport {
let rateLimits: RateLimits = {};
let rateLimits: Readonly<RateLimits> = {};
const flush = (timeout?: number): PromiseLike<boolean> => buffer.drain(timeout);

function recordItemLoss(reason: EventDropReason, [headers, payload]: EnvelopeItem, type: EnvelopeItemType): void {
Expand Down
29 changes: 21 additions & 8 deletions packages/core/src/utils/ratelimit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,28 @@ export function isRateLimited(limits: RateLimits, dataCategory: DataCategory, no
*/
export function updateRateLimits(
limits: RateLimits,
{ statusCode, headers }: TransportMakeRequestResponse,
response: TransportMakeRequestResponse,
now: number = safeDateNow(),
): RateLimits {
const updatedRateLimits: RateLimits = {
...limits,
};

forEachRateLimit(response, now, (category, until) => {
updatedRateLimits[category] = Math.max(updatedRateLimits[category] || 0, until);
});

return updatedRateLimits;
}

/**
* Calls `extendRateLimit` with the category and deadline of each rate limit in the response.
*/
function forEachRateLimit(
{ statusCode, headers }: TransportMakeRequestResponse,
now: number,
extendRateLimit: (category: string, until: number) => void,
): void {
// "The name is case-insensitive."
// https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
const rateLimitHeader = headers?.['x-sentry-rate-limits'];
Expand All @@ -84,25 +99,23 @@ export function updateRateLimits(
const headerDelay = parseInt(retryAfter, 10);
const delay = (!isNaN(headerDelay) ? headerDelay : 60) * 1000; // 60sec default
if (!categories) {
updatedRateLimits.all = now + delay;
extendRateLimit('all', now + delay);
} else {
for (const category of categories.split(';')) {
if (category === 'metric_bucket') {
// namespaces will be present when category === 'metric_bucket'
if (!namespaces || namespaces.split(';').includes('custom')) {
updatedRateLimits[category] = now + delay;
extendRateLimit(category, now + delay);
}
} else {
updatedRateLimits[category] = now + delay;
extendRateLimit(category, now + delay);
}
}
}
}
} else if (retryAfterHeader) {
updatedRateLimits.all = now + parseRetryAfterHeader(retryAfterHeader, now);
extendRateLimit('all', now + parseRetryAfterHeader(retryAfterHeader, now));
} else if (statusCode === 429) {
updatedRateLimits.all = now + 60 * 1000;
extendRateLimit('all', now + 60 * 1000);
}

return updatedRateLimits;
}
22 changes: 18 additions & 4 deletions packages/core/test/lib/utils/ratelimit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,29 @@ describe('updateRateLimits()', () => {
expect(updatedRateLimits.transaction).toEqual(15 * 1000);
});

test('should use last entry from multi `x-sentry-rate-limits` header for a given category', () => {
test('should use longest entry from multi `x-sentry-rate-limits` header for a given category', () => {
const rateLimits: RateLimits = {};
const headers = {
'retry-after': null,
'x-sentry-rate-limits': '13:error,15:transaction;error',
'x-sentry-rate-limits': '15:error,22:error,13:transaction;error',
};
const updatedRateLimits = updateRateLimits(rateLimits, { headers }, 0);
expect(updatedRateLimits.error).toEqual(15 * 1000);
expect(updatedRateLimits.transaction).toEqual(15 * 1000);
expect(updatedRateLimits.error).toEqual(22 * 1000);
expect(updatedRateLimits.transaction).toEqual(13 * 1000);
});

test('should keep a stored limit when a new one is shorter, and replace it when a new one is longer', () => {
const rateLimits: RateLimits = { error: 15 * 1000 };
const shorterHeaders = {
'retry-after': null,
'x-sentry-rate-limits': '13:error',
};
const longerHeaders = {
'retry-after': null,
'x-sentry-rate-limits': '20:error',
};
expect(updateRateLimits(rateLimits, { headers: shorterHeaders }, 0).error).toEqual(15 * 1000);
expect(updateRateLimits(rateLimits, { headers: longerHeaders }, 0).error).toEqual(20 * 1000);
});

test('should fallback to `all` if `x-sentry-rate-limits` header is missing a category', () => {
Expand Down
Loading