Change waitForProcessing to use exponential backoff

Author: robertbrignull

src/upload-lib.ts

@@ -829,8 +829,10 @@ function dumpSarifFile(
   fs.writeFileSync(outputFile, sarifPayload);
 }
 
-const STATUS_CHECK_FREQUENCY_MILLISECONDS = 5 * 1000;
-const STATUS_CHECK_TIMEOUT_MILLISECONDS = 2 * 60 * 1000;
+// Should lead to status checks after 5s, 15s, 35s, 75s, and 155s.
+const STATUS_CHECK_INITIAL_BACKOFF_MILLISECONDS = 5 * 1000;
+const STATUS_CHECK_BACKOFF_MULTIPLIER = 2;
+const STATUS_CHECK_MAX_TRIES = 5;
 
 type ProcessingStatus = "pending" | "complete" | "failed";
 
@@ -854,20 +856,16 @@ export async function waitForProcessing(
   try {
     const client = api.getApiClient();
 
-    const statusCheckingStarted = Date.now();
-    while (true) {
-      if (
-        Date.now() >
-        statusCheckingStarted + STATUS_CHECK_TIMEOUT_MILLISECONDS
-      ) {
-        // If the analysis hasn't finished processing in the allotted time, we continue anyway rather than failing.
-        // It's possible the analysis will eventually finish processing, but it's not worth spending more
-        // Actions time waiting.
-        logger.warning(
-          "Timed out waiting for analysis to finish processing. Continuing.",
-        );
-        break;
-      }
+    // Do an initial wait because processing will always take a minimum of 2-3 seconds
+    let statusCheckBackoff = STATUS_CHECK_INITIAL_BACKOFF_MILLISECONDS;
+    await util.delay(statusCheckBackoff, { allowProcessExit: false });
+
+    let timedOut = true;
+    for (
+      let statusCheckingCount = 0;
+      statusCheckingCount < STATUS_CHECK_MAX_TRIES;
+      statusCheckingCount++
+    ) {
       let response: OctokitResponse<any> | undefined = undefined;
       try {
         response = await client.request(
@@ -882,6 +880,7 @@ export async function waitForProcessing(
         logger.warning(
           `An error occurred checking the status of the delivery. ${e} It should still be processed in the background, but errors that occur during processing may not be reported.`,
         );
+        timedOut = false;
         break;
       }
       const status = response.data.processing_status as ProcessingStatus;
@@ -897,8 +896,10 @@ export async function waitForProcessing(
           status,
           logger,
         );
+        timedOut = false;
         break;
       } else if (status === "complete") {
+        timedOut = false;
         break;
       } else if (status === "failed") {
         const message = `Code Scanning could not process the submitted SARIF file:\n${response.data.errors}`;
@@ -912,9 +913,17 @@ export async function waitForProcessing(
         util.assertNever(status);
       }
 
-      await util.delay(STATUS_CHECK_FREQUENCY_MILLISECONDS, {
-        allowProcessExit: false,
-      });
+      statusCheckBackoff *= STATUS_CHECK_BACKOFF_MULTIPLIER;
+      await util.delay(statusCheckBackoff, { allowProcessExit: false });
+    }
+
+    if (timedOut) {
+      // If the analysis hasn't finished processing in the allotted time, we continue anyway rather than failing.
+      // It's possible the analysis will eventually finish processing, but it's not worth spending more
+      // Actions time waiting.
+      logger.warning(
+        "Timed out waiting for analysis to finish processing. Continuing.",
+      );
     }
   } finally {
     logger.endGroup();