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
6 changes: 3 additions & 3 deletions src/http-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export interface HttpRequestOptions {
* // Don't retry client errors (except 429)
* if (error instanceof HttpResponseError) {
* if (error.response.status === 429) {
* const retryAfter = parseRetryAfter(error.response.headers['retry-after'])
* const retryAfter = parseRetryAfterHeader(error.response.headers['retry-after'])
* return retryAfter ?? undefined
* }
* if (error.response.status >= 400 && error.response.status < 500) {
Expand Down Expand Up @@ -548,13 +548,13 @@ export class HttpResponseError extends Error {
*
* @example
* ```ts
* const delay = parseRetryAfter(response.headers['retry-after'])
* const delay = parseRetryAfterHeader(response.headers['retry-after'])
* if (delay !== undefined) {
* await new Promise(resolve => setTimeout(resolve, delay))
* }
* ```
*/
export function parseRetryAfter(
export function parseRetryAfterHeader(
value: string | string[] | undefined,
): number | undefined {
if (!value) {
Expand Down
34 changes: 17 additions & 17 deletions test/unit/http-request.test.mts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
httpRequest,
httpText,
parseChecksums,
parseRetryAfter,
parseRetryAfterHeader,
readIncomingResponse,
sanitizeHeaders,
} from '@socketsecurity/lib/http-request'
Expand Down Expand Up @@ -2578,50 +2578,50 @@ abc123def456789012345678901234567890123456789012345678901234abcd
})
})

describe('parseRetryAfter', () => {
describe('parseRetryAfterHeader', () => {
it('should parse integer seconds', () => {
expect(parseRetryAfter('120')).toBe(120_000)
expect(parseRetryAfterHeader('120')).toBe(120_000)
})

it('should parse zero seconds', () => {
expect(parseRetryAfter('0')).toBe(0)
expect(parseRetryAfterHeader('0')).toBe(0)
})

it('should return undefined for undefined input', () => {
expect(parseRetryAfter(undefined)).toBeUndefined()
expect(parseRetryAfterHeader(undefined)).toBeUndefined()
})

it('should return undefined for empty string', () => {
expect(parseRetryAfter('')).toBeUndefined()
expect(parseRetryAfterHeader('')).toBeUndefined()
})

it('should return undefined for empty array', () => {
expect(parseRetryAfter([])).toBeUndefined()
expect(parseRetryAfterHeader([])).toBeUndefined()
})

it('should take first value from array', () => {
expect(parseRetryAfter(['60', '120'])).toBe(60_000)
expect(parseRetryAfterHeader(['60', '120'])).toBe(60_000)
})

it('should parse future HTTP-date', () => {
const future = new Date(Date.now() + 5000).toUTCString()
const result = parseRetryAfter(future)!
const result = parseRetryAfterHeader(future)!

expect(result).toBeGreaterThan(0)
expect(result).toBeLessThanOrEqual(6000)
})

it('should return undefined for past HTTP-date', () => {
const past = new Date(Date.now() - 60_000).toUTCString()
expect(parseRetryAfter(past)).toBeUndefined()
expect(parseRetryAfterHeader(past)).toBeUndefined()
})

it('should return undefined for negative seconds', () => {
expect(parseRetryAfter('-5')).toBeUndefined()
expect(parseRetryAfterHeader('-5')).toBeUndefined()
})

it('should return undefined for non-parseable string', () => {
expect(parseRetryAfter('not-a-number-or-date')).toBeUndefined()
expect(parseRetryAfterHeader('not-a-number-or-date')).toBeUndefined()
})
})

Expand Down Expand Up @@ -3001,7 +3001,7 @@ abc123def456789012345678901234567890123456789012345678901234abcd
retryDelay: 10,
onRetry: (_attempt, error) => {
if (error instanceof HttpResponseError) {
const retryAfter = parseRetryAfter(
const retryAfter = parseRetryAfterHeader(
error.response.headers['retry-after'],
)
return retryAfter ?? undefined
Expand Down Expand Up @@ -3059,10 +3059,10 @@ abc123def456789012345678901234567890123456789012345678901234abcd
})
})

describe('parseRetryAfter - additional edge cases', () => {
describe('parseRetryAfterHeader - additional edge cases', () => {
it('should reject partial numeric strings like "10abc"', () => {
// Strict parsing — "10abc" is not a valid delay-seconds value
expect(parseRetryAfter('10abc')).toBeUndefined()
expect(parseRetryAfterHeader('10abc')).toBeUndefined()
})
})

Expand Down Expand Up @@ -3115,10 +3115,10 @@ abc123def456789012345678901234567890123456789012345678901234abcd
})
})

describe('parseRetryAfter - whitespace', () => {
describe('parseRetryAfterHeader - whitespace', () => {
it('should handle whitespace-padded integer', () => {
// parseInt trims leading whitespace
expect(parseRetryAfter(' 60 ')).toBe(60_000)
expect(parseRetryAfterHeader(' 60 ')).toBe(60_000)
})
})

Expand Down