Merge pull request #1494 from github/henrymercer/avoid-waiting-for-timeout

Fix a bug that forced the `init` Action to run for at least two minutes on JavaScript

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## [UNRELEASED]
 
-- Improve stability when choosing the default version of CodeQL to use in code scanning workflow runs on Actions on GitHub.com [#1475](https://github.com/github/codeql-action/pull/1475).
+- Improve stability when choosing the default version of CodeQL to use in code scanning workflow runs on Actions on GitHub.com. [#1475](https://github.com/github/codeql-action/pull/1475)
   - This change addresses customer reports of code scanning alerts on GitHub.com being closed and reopened during the rollout of new versions of CodeQL in the GitHub Actions [runner images](https://github.com/actions/runner-images).
   - **No change is required for the majority of workflows**, including:
     - Workflows on GitHub.com hosted runners using the latest version (`v2`) of the CodeQL Action.
@@ -15,6 +15,7 @@
     - These changes will not affect the majority of code scanning workflows. Continue reading only if your workflow uses [@actions/tool-cache](https://github.com/actions/toolkit/tree/main/packages/tool-cache) or relies on the precise location of CodeQL within the Actions tool cache.
     - The tool cache now contains **two** recent CodeQL versions (previously **one**).
     - Each CodeQL version is located under a directory named after the release date and version number, e.g. CodeQL 2.11.6 is now located under `CodeQL/2.11.6-20221211/x64/codeql` (previously `CodeQL/0.0.0-20221211/x64/codeql`).
+- Fix a bug that forced the `init` Action to run for at least two minutes on JavaScript. [#1494](https://github.com/github/codeql-action/pull/1494)
 
 ## 2.1.39 - 18 Jan 2023
 

lib/util.js

@@ -457,7 +457,9 @@ async function bundleDb(config, language, codeql, dbName) {
 }
 exports.bundleDb = bundleDb;
 async function delay(milliseconds) {
-    return new Promise((resolve) => setTimeout(resolve, milliseconds));
+    // Immediately `unref` the timer such that it only prevents the process from exiting if the
+    // surrounding promise is being awaited.
+    return new Promise((resolve) => setTimeout(resolve, milliseconds).unref());
 }
 exports.delay = delay;
 function isGoodVersion(versionSpec) {
@@ -634,20 +636,19 @@ async function withTimeout(timeoutMs, promise, onTimeout) {
         finished = true;
         return result;
     };
-    const timeout = new Promise((resolve) => {
-        setTimeout(() => {
-            if (!finished) {
-                // Workaround: While the promise racing below will allow the main code
-                // to continue, the process won't normally exit until the asynchronous
-                // task in the background has finished. We set this variable to force
-                // an exit at the end of our code when `checkForTimeout` is called.
-                hadTimeout = true;
-                onTimeout();
-            }
-            resolve(undefined);
-        }, timeoutMs);
-    });
-    return await Promise.race([mainTask(), timeout]);
+    const timeoutTask = async () => {
+        await delay(timeoutMs);
+        if (!finished) {
+            // Workaround: While the promise racing below will allow the main code
+            // to continue, the process won't normally exit until the asynchronous
+            // task in the background has finished. We set this variable to force
+            // an exit at the end of our code when `checkForTimeout` is called.
+            hadTimeout = true;
+            onTimeout();
+        }
+        return undefined;
+    };
+    return await Promise.race([mainTask(), timeoutTask()]);
 }
 exports.withTimeout = withTimeout;
 /**

src/util.ts

@@ -552,7 +552,9 @@ export async function bundleDb(
 }
 
 export async function delay(milliseconds: number) {
-  return new Promise((resolve) => setTimeout(resolve, milliseconds));
+  // Immediately `unref` the timer such that it only prevents the process from exiting if the
+  // surrounding promise is being awaited.
+  return new Promise((resolve) => setTimeout(resolve, milliseconds).unref());
 }
 
 export function isGoodVersion(versionSpec: string) {
@@ -748,21 +750,19 @@ export async function withTimeout<T>(
     finished = true;
     return result;
   };
-  const timeout: Promise<undefined> = new Promise((resolve) => {
-    setTimeout(() => {
-      if (!finished) {
-        // Workaround: While the promise racing below will allow the main code
-        // to continue, the process won't normally exit until the asynchronous
-        // task in the background has finished. We set this variable to force
-        // an exit at the end of our code when `checkForTimeout` is called.
-        hadTimeout = true;
-        onTimeout();
-      }
-      resolve(undefined);
-    }, timeoutMs);
-  });
-
-  return await Promise.race([mainTask(), timeout]);
+  const timeoutTask = async () => {
+    await delay(timeoutMs);
+    if (!finished) {
+      // Workaround: While the promise racing below will allow the main code
+      // to continue, the process won't normally exit until the asynchronous
+      // task in the background has finished. We set this variable to force
+      // an exit at the end of our code when `checkForTimeout` is called.
+      hadTimeout = true;
+      onTimeout();
+    }
+    return undefined;
+  };
+  return await Promise.race([mainTask(), timeoutTask()]);
 }
 
 /**