fix: Retry on timeout (#106)

* fix: do not set return value for timed out runs

Commands that are killed manually due to timeout rarely returns a
success status code (0). These codes should not be treated as errors
but simply produced because of the timeout.

* fix(windows): use variable to track timeout

Use a variable to track timeout instead of relying on SIGTERM, as
processes on Windows are not killed using signals.

.github/ISSUE_TEMPLATE/bug-report.md

@@ -16,4 +16,4 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Logs**
-Enable [debug logging](https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging) then attach the [raw logs](https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) (specifically the raw output of this action).
+Enable [debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging) then attach the [raw logs](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs#downloading-logs) (specifically the raw output of this action).

README.md

@@ -30,7 +30,7 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 ### `shell`
 
-**Optional** Shell to use to execute `command`. Defaults to `powershell` on Windows, `bash` otherwise. Supports bash, python, pwsh, sh, cmd, and powershell per [docs](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell)
+**Optional** Shell to use to execute `command`. Defaults to `powershell` on Windows, `bash` otherwise. Supports bash, python, pwsh, sh, cmd, and powershell per [docs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell)
 
 ### `polling_interval_seconds`
 
@@ -156,7 +156,7 @@ with:
 ```yaml
 - uses: nick-fields/retry@v2
   id: retry
-  # see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error
+  # see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error
   continue-on-error: true
   with:
     timeout_seconds: 15

dist/index.js

@@ -971,7 +971,7 @@ function getExecutable(inputs) {
             break;
         }
         default: {
-            throw new Error("Shell ".concat(inputs.shell, " not supported.  See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell for supported shells"));
+            throw new Error("Shell ".concat(inputs.shell, " not supported.  See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell for supported shells"));
         }
     }
     return executable;
@@ -1005,7 +1005,7 @@ function runRetryCmd(inputs) {
 function runCmd(attempt, inputs) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var end_time, executable, child;
+        var end_time, executable, timeout, child;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
@@ -1013,6 +1013,7 @@ function runCmd(attempt, inputs) {
                     executable = getExecutable(inputs);
                     exit = 0;
                     done = false;
+                    timeout = false;
                     (0, core_1.debug)("Running command ".concat(inputs.command, " on ").concat(OS, " using shell ").concat(executable));
                     child = attempt > 1 && inputs.new_command_on_retry
                         ? (0, child_process_1.spawn)(inputs.new_command_on_retry, { shell: executable })
@@ -1026,13 +1027,17 @@ function runCmd(attempt, inputs) {
                     child.on('exit', function (code, signal) {
                         (0, core_1.debug)("Code: ".concat(code));
                         (0, core_1.debug)("Signal: ".concat(signal));
-                        if (code && code > 0) {
-                            exit = code;
-                        }
                         // timeouts are killed manually
                         if (signal === 'SIGTERM') {
                             return;
                         }
+                        // On Windows signal is null.
+                        if (timeout) {
+                            return;
+                        }
+                        if (code && code > 0) {
+                            exit = code;
+                        }
                         done = true;
                     });
                     _c.label = 1;
@@ -1045,6 +1050,7 @@ function runCmd(attempt, inputs) {
                     _c.label = 4;
                 case 4:
                     if (!(!done && child.pid)) return [3 /*break*/, 6];
+                    timeout = true;
                     (0, tree_kill_1.default)(child.pid);
                     return [4 /*yield*/, (0, util_1.retryWait)(milliseconds_1.default.seconds(inputs.retry_wait_seconds))];
                 case 5:

src/index.ts

@@ -44,7 +44,7 @@ function getExecutable(inputs: Inputs): string {
     }
     default: {
       throw new Error(
-        `Shell ${inputs.shell} not supported.  See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell for supported shells`
+        `Shell ${inputs.shell} not supported.  See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell for supported shells`
       );
     }
   }
@@ -71,6 +71,7 @@ async function runCmd(attempt: number, inputs: Inputs) {
 
   exit = 0;
   done = false;
+  let timeout = false;
 
   debug(`Running command ${inputs.command} on ${OS} using shell ${executable}`);
   const child =
@@ -88,13 +89,21 @@ async function runCmd(attempt: number, inputs: Inputs) {
   child.on('exit', (code, signal) => {
     debug(`Code: ${code}`);
     debug(`Signal: ${signal}`);
-    if (code && code > 0) {
-      exit = code;
-    }
+
     // timeouts are killed manually
     if (signal === 'SIGTERM') {
       return;
     }
+
+    // On Windows signal is null.
+    if (timeout) {
+      return;
+    }
+
+    if (code && code > 0) {
+      exit = code;
+    }
+
     done = true;
   });
 
@@ -103,6 +112,7 @@ async function runCmd(attempt: number, inputs: Inputs) {
   } while (Date.now() < end_time && !done);
 
   if (!done && child.pid) {
+    timeout = true;
     kill(child.pid);
     await retryWait(ms.seconds(inputs.retry_wait_seconds));
     throw new Error(`Timeout of ${getTimeout(inputs)}ms hit`);