Consolidate JDK metadata retry handling (#1162)

* Consolidate JDK metadata retries

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a5e2549a-0d89-4c8f-b7f3-411ad21c8a06

* Expand distribution retry coverage

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a5e2549a-0d89-4c8f-b7f3-411ad21c8a06

---------

Copilot-Session: a5e2549a-0d89-4c8f-b7f3-411ad21c8a06
This commit is contained in:
Bruno Borges
2026-07-29 00:09:37 -04:00
committed by GitHub
parent e1ce3a3428
commit 5894ef6b27
8 changed files with 792 additions and 213 deletions
@@ -605,6 +605,31 @@ describe('setupJava', () => {
expect(spyCoreSetOutput).not.toHaveBeenCalled();
});
it('should not repeat version resolution when downloadTool fails', async () => {
mockJavaBase = new EmptyJavaBase({
version: '11',
architecture: 'x86',
packageType: 'jdk',
checkLatest: false,
forceDownload: true
});
const findPackageForDownload = jest.fn(async () => ({
version: '11.0.9',
url: 'https://example.com/jdk.tar.gz'
}));
const downloadError = new Error('download failed');
const downloadTool = jest.fn(async () => {
throw downloadError;
});
mockJavaBase['findPackageForDownload'] = findPackageForDownload;
mockJavaBase['downloadTool'] = downloadTool;
await expect(mockJavaBase.setupJava()).rejects.toBe(downloadError);
expect(findPackageForDownload).toHaveBeenCalledTimes(1);
expect(downloadTool).toHaveBeenCalledTimes(1);
});
it.each([
[
{
@@ -1,6 +1,38 @@
import {getJavaDistribution} from '../../src/distributions/distribution-factory.js';
import {RetryingHttpClient} from '../../src/retrying-http-client.js';
describe('getJavaDistribution', () => {
it.each([
'adopt',
'adopt-hotspot',
'adopt-openj9',
'temurin',
'zulu',
'liberica',
'liberica-nik',
'microsoft',
'semeru',
'corretto',
'oracle',
'dragonwell',
'sapmachine',
'graalvm',
'graalvm-community',
'jetbrains',
'kona',
'oracle-openjdk'
])('uses the shared retrying HTTP client for %s', distributionName => {
const distribution = getJavaDistribution(distributionName, {
version: '21',
architecture: 'x64',
packageType: 'jdk',
checkLatest: false
});
expect(distribution).not.toBeNull();
expect(distribution!['http']).toBeInstanceOf(RetryingHttpClient);
});
it("rejects java-package 'jdk+jmods' for non-Temurin distributions", () => {
expect(() =>
getJavaDistribution('zulu', {
@@ -9,7 +9,9 @@ import {
afterAll
} from '@jest/globals';
import https from 'https';
import {HttpClient} from '@actions/http-client';
import {HttpClient, HttpClientResponse} from '@actions/http-client';
import type {IncomingMessage} from 'http';
import {Readable} from 'stream';
import manifestData from '../data/jetbrains.json' with {type: 'json'};
import os from 'os';
@@ -44,6 +46,18 @@ jest.unstable_mockModule('@actions/core', () => ({
const core = await import('@actions/core');
const {JetBrainsDistribution} =
await import('../../src/distributions/jetbrains/installer.js');
const {RetryingHttpClient} = await import('../../src/retrying-http-client.js');
function response(
statusCode: number,
body = '',
headers: IncomingMessage['headers'] = {}
): HttpClientResponse {
const message = Readable.from([Buffer.from(body)]) as IncomingMessage;
message.statusCode = statusCode;
message.headers = headers;
return new HttpClientResponse(message);
}
describe('getAvailableVersions', () => {
let spyHttpClient: any;
@@ -95,6 +109,42 @@ describe('getAvailableVersions', () => {
os.platform() === 'win32' ? manifestData.length : manifestData.length + 2;
expect(availableVersions.length).toBe(length);
}, 10_000);
it('retries a GitHub rate limit using Retry-After', async () => {
spyHttpClient.mockRestore();
const sleep = jest.fn(async () => undefined);
const requestRaw = jest
.spyOn(HttpClient.prototype, 'requestRaw')
.mockResolvedValueOnce(response(429, '', {'retry-after': '2'}))
.mockResolvedValueOnce(response(200, '[]'))
.mockResolvedValueOnce(response(200))
.mockResolvedValueOnce(response(200));
const distribution = new JetBrainsDistribution({
version: '17',
architecture: 'x64',
packageType: 'jdk',
checkLatest: false
});
distribution['http'] = new RetryingHttpClient('test', {
sleep,
random: () => 0
});
const availableVersions = await distribution['getAvailableVersions']();
expect(availableVersions).toHaveLength(2);
expect(requestRaw).toHaveBeenCalledTimes(4);
expect(requestRaw.mock.calls[0][0].options.path).toBe(
requestRaw.mock.calls[1][0].options.path
);
expect(requestRaw.mock.calls[0][0].options.path).toContain(
'/repos/JetBrains/JetBrainsRuntime/releases'
);
expect(sleep).toHaveBeenCalledWith(2000);
expect(core.info).toHaveBeenCalledWith(
'Request attempt 1 of 4 failed (HTTP 429); retrying in 2000 ms'
);
});
});
describe('findPackageForDownload', () => {
+251
View File
@@ -0,0 +1,251 @@
import {jest, describe, it, expect, beforeEach, afterEach} from '@jest/globals';
import type {IncomingMessage} from 'http';
jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn()
}));
const core = await import('@actions/core');
const httpm = await import('@actions/http-client');
const {RetryingHttpClient, isRetryableNetworkError, parseRetryAfter} =
await import('../src/retrying-http-client.js');
function response(
statusCode: number,
retryAfter?: string
): httpm.HttpClientResponse {
return {
message: {
statusCode,
headers: retryAfter ? {'retry-after': retryAfter} : {}
} as IncomingMessage,
readBody: jest.fn(async () => '')
} as unknown as httpm.HttpClientResponse;
}
describe('RetryingHttpClient', () => {
let request: ReturnType<typeof jest.spyOn>;
let sleep: jest.Mock<(delayMs: number) => Promise<void>>;
beforeEach(() => {
request = jest.spyOn(httpm.HttpClient.prototype, 'request');
sleep = jest.fn(async () => undefined);
});
afterEach(() => {
jest.restoreAllMocks();
jest.clearAllMocks();
});
it('uses exponential backoff with jitter for retryable responses', async () => {
request
.mockResolvedValueOnce(response(503))
.mockResolvedValueOnce(response(502))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0,
baseDelayMs: 1000,
maxDelayMs: 10000
});
await expect(client.get('https://example.com')).resolves.toBeDefined();
expect(request).toHaveBeenCalledTimes(3);
expect(sleep).toHaveBeenNthCalledWith(1, 500);
expect(sleep).toHaveBeenNthCalledWith(2, 1000);
expect(core.info).toHaveBeenNthCalledWith(
1,
'Request attempt 1 of 4 failed (HTTP 503); retrying in 500 ms'
);
expect(core.info).toHaveBeenNthCalledWith(
2,
'Request attempt 2 of 4 failed (HTTP 502); retrying in 1000 ms'
);
});
it('honors Retry-After delta-seconds over the client delay', async () => {
request
.mockResolvedValueOnce(response(429, '3'))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0
});
await client.get('https://example.com');
expect(sleep).toHaveBeenCalledWith(3000);
});
it('honors Retry-After HTTP dates over the client delay', async () => {
const now = Date.parse('2026-07-29T00:00:00Z');
request
.mockResolvedValueOnce(response(503, new Date(now + 5000).toUTCString()))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0,
now: () => now
});
await client.get('https://example.com');
expect(sleep).toHaveBeenCalledWith(5000);
});
it('caps Retry-After at the configured maximum delay', async () => {
request
.mockResolvedValueOnce(response(429, '60'))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0,
maxDelayMs: 10000
});
await client.get('https://example.com');
expect(sleep).toHaveBeenCalledWith(10000);
});
it.each([429, 502, 503, 504, 522])(
'retries HTTP %s responses',
async statusCode => {
request
.mockResolvedValueOnce(response(statusCode))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0
});
await client.get('https://example.com');
expect(request).toHaveBeenCalledTimes(2);
}
);
it.each(['ETIMEDOUT', 'ECONNRESET', 'ENOTFOUND', 'ECONNREFUSED'])(
'retries network errors with code %s',
async code => {
request
.mockRejectedValueOnce(Object.assign(new Error(code), {code}))
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0
});
await client.get('https://example.com');
expect(request).toHaveBeenCalledTimes(2);
}
);
it('retries retryable aggregate network errors', async () => {
const aggregateError = Object.assign(new Error('connection failed'), {
errors: [Object.assign(new Error('timed out'), {code: 'ETIMEDOUT'})]
});
request
.mockRejectedValueOnce(aggregateError)
.mockResolvedValueOnce(response(200));
const client = new RetryingHttpClient('test', {
sleep,
random: () => 0
});
await client.get('https://example.com');
expect(request).toHaveBeenCalledTimes(2);
expect(sleep).toHaveBeenCalledWith(500);
});
it('does not retry non-retryable responses or network errors', async () => {
request.mockResolvedValueOnce(response(500));
const client = new RetryingHttpClient('test', {sleep});
await expect(client.get('https://example.com')).resolves.toBeDefined();
expect(request).toHaveBeenCalledTimes(1);
expect(sleep).not.toHaveBeenCalled();
request.mockRejectedValueOnce(
Object.assign(new Error('certificate failed'), {code: 'CERT_HAS_EXPIRED'})
);
await expect(client.get('https://example.com')).rejects.toThrow(
'certificate failed'
);
expect(request).toHaveBeenCalledTimes(2);
expect(sleep).not.toHaveBeenCalled();
});
it('stops after the configured total attempt count', async () => {
request
.mockResolvedValueOnce(response(503))
.mockResolvedValueOnce(response(503));
const client = new RetryingHttpClient('test', {
maxAttempts: 2,
sleep,
random: () => 0
});
const finalResponse = await client.get('https://example.com');
expect(finalResponse.message.statusCode).toBe(503);
expect(request).toHaveBeenCalledTimes(2);
expect(sleep).toHaveBeenCalledTimes(1);
});
it('propagates the final network error after exhausting attempts', async () => {
const finalError = Object.assign(new Error('still unavailable'), {
code: 'ECONNREFUSED'
});
request
.mockRejectedValueOnce(
Object.assign(new Error('unavailable'), {code: 'ECONNREFUSED'})
)
.mockRejectedValueOnce(finalError);
const client = new RetryingHttpClient('test', {
maxAttempts: 2,
sleep,
random: () => 0
});
await expect(client.get('https://example.com')).rejects.toBe(finalError);
expect(request).toHaveBeenCalledTimes(2);
expect(sleep).toHaveBeenCalledTimes(1);
});
it('does not retry write requests', async () => {
request.mockResolvedValueOnce(response(503));
const client = new RetryingHttpClient('test', {sleep});
await client.post('https://example.com', '{}');
expect(request).toHaveBeenCalledTimes(1);
expect(sleep).not.toHaveBeenCalled();
});
});
describe('retry classification', () => {
it('parses valid Retry-After values and ignores invalid or past values', () => {
const now = Date.parse('2026-07-29T00:00:00Z');
expect(parseRetryAfter('7', now)).toBe(7000);
expect(parseRetryAfter(new Date(now + 3000).toUTCString(), now)).toBe(3000);
expect(parseRetryAfter(new Date(now - 3000).toUTCString(), now)).toBe(
undefined
);
expect(parseRetryAfter('not-a-date', now)).toBe(undefined);
});
it('recognizes direct and nested retryable network error codes', () => {
expect(isRetryableNetworkError({code: 'ECONNRESET'})).toBe(true);
expect(
isRetryableNetworkError({errors: [{code: 'ENOTFOUND'}, {code: 'OTHER'}]})
).toBe(true);
expect(isRetryableNetworkError({code: 'CERT_HAS_EXPIRED'})).toBe(false);
expect(isRetryableNetworkError(new Error('unknown'))).toBe(false);
});
});