fix: tweak the delay factor when downloading artifacts (#244)

Author: kormide

dist/cli/index.js

@@ -67,7 +67,7 @@ describe('Artifact', () => {
 
       expect(axiosRetry).toHaveBeenCalledWith(axios, {
         retries: 3,
-
+        onRetry: expect.any(Function),
         retryCondition: expect.matchesPredicate(
           // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
           (retryConditionFn: Function) => {
@@ -79,21 +79,18 @@ describe('Artifact', () => {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
         retryDelay: expect.matchesPredicate((retryDelayFn: Function) => {
           // Make sure the retry delays follow exponential backoff
-          // and the final retry happens after at least 1 minute total
-          // (in this case, at least 70 seconds).
-          // Axios randomly adds an extra 0-20% of jitter to each delay.
-          // Test upper bounds as well to ensure the workflow completes reasonably quickly
-          // (in this case, no more than 84 seconds total).
+          // Axios randomly adds an extra 0-20% of jitter to each delay:
+          // https://github.com/softonic/axios-retry/blob/3f9557920b816ec4f692870d89939ae739d7f8ed/src/index.ts#L169
           const firstRetryDelay = retryDelayFn.call(this, 0);
           const secondRetryDelay = retryDelayFn.call(this, 1);
           const thirdRetryDelay = retryDelayFn.call(this, 2);
           return (
-            10000 <= firstRetryDelay &&
-            firstRetryDelay <= 12000 &&
-            20000 <= secondRetryDelay &&
-            secondRetryDelay <= 24000 &&
-            40000 <= thirdRetryDelay &&
-            thirdRetryDelay <= 48000
+            2000 <= firstRetryDelay &&
+            firstRetryDelay <= 2400 &&
+            4000 <= secondRetryDelay &&
+            secondRetryDelay <= 4800 &&
+            8000 <= thirdRetryDelay &&
+            thirdRetryDelay <= 9600
           );
         }),
         shouldResetTimeout: true,

src/domain/artifact.spec.ts

@@ -23,6 +23,7 @@ export class ArtifactDownloadError extends Error {
  * An artifact that can be downloaded and have its integrity hash computed.
  */
 export class Artifact {
+  public static readonly MAX_RETRIES = 3;
   private _diskPath: string | null = null;
   public constructor(public readonly url: string) {}
 
@@ -66,10 +67,14 @@ export class Artifact {
     const writer = fs.createWriteStream(dest, { flags: 'w' });
 
     // Retry the request in case the artifact is still being uploaded.
-    // Exponential backoff with 3 retries and a delay factor of 10 seconds
-    // gives you at least 70 seconds to upload a release archive.
     axiosRetry(axios, {
-      retries: 3,
+      onRetry(retryCount, error, _requestConfig) {
+        console.error(`Failed to download artifact; ${error.message}`);
+        console.error(
+          `Retry atempt ${retryCount} / ${Artifact.MAX_RETRIES}...`
+        );
+      },
+      retries: Artifact.MAX_RETRIES,
       retryDelay: exponentialDelay,
       shouldResetTimeout: true,
       retryCondition: defaultRetryPlus404,
@@ -130,8 +135,8 @@ function exponentialDelay(
   retryCount: number,
   error: AxiosError | undefined
 ): number {
-  // Default delay factor is 10 seconds, but can be overridden for testing.
-  const delayFactor = Number(process.env.BACKOFF_DELAY_FACTOR) || 10_000;
+  // Default delay factor is 2 seconds, but can be overridden for testing.
+  const delayFactor = Number(process.env.BACKOFF_DELAY_FACTOR) || 2000;
   return axiosRetry.exponentialDelay(retryCount, error, delayFactor);
 }