Configure the API client to retry more often when in test mode

src/api-client.test.ts

@@ -36,6 +36,7 @@ test("getApiClient", async (t) => {
       baseUrl: "http://api.github.localhost",
       log: sinon.match.any,
       userAgent: `CodeQL-Action/${actionsUtil.getActionVersion()}`,
+      retry: api.getRetryConfig(),
     }),
   );
 });

src/api-client.ts

@@ -12,6 +12,7 @@ import {
   GitHubVariant,
   GitHubVersion,
   isHTTPError,
+  isInTestMode,
   parseGitHubUrl,
   parseMatrixInput,
 } from "./util";
@@ -38,6 +39,20 @@ export interface GitHubApiExternalRepoDetails {
   apiURL: string | undefined;
 }
 
+export function getRetryConfig(): {
+  retries: number;
+  retryAfterBaseValue?: number;
+} {
+  // If we are in test mode, increase the allowed number of retries to 10
+  // and the base backoff from 1s to 10s. `plugin-retry` will wait
+  // `(failedAttempts ^ 2) * retryAfterBaseValue`-long (in ms) after
+  // each failed attempt.
+  // If we are not in test mode, we use the default configuration.
+  return isInTestMode()
+    ? { retries: 10, retryAfterBaseValue: 10_000 }
+    : { retries: 3, retryAfterBaseValue: 1_000 };
+}
+
 function createApiClientWithDetails(
   apiDetails: GitHubApiCombinedDetails,
   { allowExternal = false } = {},
@@ -50,6 +65,7 @@ function createApiClientWithDetails(
       baseUrl: apiDetails.apiURL,
       userAgent: `CodeQL-Action/${getActionVersion()}`,
       log: consoleLogLevel({ level: "debug" }),
+      retry: getRetryConfig(),
     }),
   );
 }