Upgrade to node16 (#101 )

> Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: nick-fields/retry Co-authored-by: Nick Fields <46869826+nick-fields@users.noreply.github.com>
fix(github): bump to @actions/core@1.10.0 (#104 )
2026-02-10 07:05:29 +00:00 · 2022-10-14 20:45:08 -04:00 · 2022-10-14 20:41:20 -04:00 · 2022-08-16 11:11:46 -04:00 · 2022-08-05 23:31:37 -04:00
10 changed files with 1251 additions and 337 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -3,7 +3,7 @@ name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: ''
-assignees: nick-invision
+assignees: nick-fields
 ---

 **Describe the bug**
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -0,0 +1,10 @@
+_Replace the bullet points below with your answers_
+
+### Description
+
+- What change is being made and why?
+
+### Testing
+
+- What tests were added?
+  - These can be either ["integration tests"](./workflows/ci_cd.yml) or unit tests
--- a/.github/workflows/ci_cd.yml
+++ b/.github/workflows/ci_cd.yml
@@ -24,6 +24,117 @@ jobs:
          directory: ./coverage/
          verbose: true

+  ci_integration:
+    name: Run Integration Tests
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
+      - name: happy-path
+        id: happy_path
+        uses: ./
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          command: npm -v
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: true
+          actual: ${{ steps.happy_path.outputs.total_attempts == '1' && steps.happy_path.outputs.exit_code == '0' }}
+
+      - name: log examples
+        uses: ./
+        with:
+          command: node ./.github/scripts/log-examples.js
+          timeout_minutes: 1
+
+      - name: sad-path (error)
+        id: sad_path_error
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          command: node -e "process.exit(1)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.sad_path_error.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.sad_path_error.outcome }}
+
+      - name: retry_on (timeout) fails early if error encountered
+        id: retry_on_timeout_fail
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 3
+          retry_on: timeout
+          command: node -e "process.exit(2)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 1
+          actual: ${{ steps.retry_on_timeout_fail.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_timeout_fail.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_timeout_fail.outputs.exit_code }}
+
+      - name: retry_on (error)
+        id: retry_on_error
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          retry_on: error
+          command: node -e "process.exit(2)"
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_error.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.retry_on_error.outcome }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.retry_on_error.outputs.exit_code }}
+
+      - name: sad-path (wrong shell for OS)
+        id: wrong_shell
+        uses: ./
+        continue-on-error: true
+        with:
+          timeout_minutes: 1
+          max_attempts: 2
+          shell: cmd
+          command: 'dir'
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: 2
+          actual: ${{ steps.wrong_shell.outputs.total_attempts }}
+      - uses: nick-invision/assert-action@v1
+        with:
+          expected: failure
+          actual: ${{ steps.wrong_shell.outcome }}
+
  ci_integration_envvar:
    name: Run Integration Env Var Tests
    if: startsWith(github.ref, 'refs/heads')
@@ -175,8 +286,8 @@ jobs:
          expected: success
          actual: ${{ steps.sad_path_continue_on_error.outcome }}

-  ci_integration:
-    name: Run Integration Tests
+  ci_integration_retry_wait_seconds:
+    name: Run Integration Tests (retry_wait_seconds)
    if: startsWith(github.ref, 'refs/heads')
    runs-on: ubuntu-latest
    steps:
@@ -189,24 +300,6 @@ jobs:
      - name: Install dependencies
        run: npm ci

-      - name: happy-path
-        id: happy_path
-        uses: ./
-        with:
-          timeout_minutes: 1
-          max_attempts: 2
-          command: npm -v
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: true
-          actual: ${{ steps.happy_path.outputs.total_attempts == '1' && steps.happy_path.outputs.exit_code == '0' }}
-
-      - name: log examples
-        uses: ./
-        with:
-          command: node ./.github/scripts/log-examples.js
-          timeout_minutes: 1
-
      - name: sad-path (retry_wait_seconds)
        id: sad_path_wait_sec
        uses: ./
@@ -230,6 +323,20 @@ jobs:
          actual: ${{ steps.sad_path_wait_sec.outputs.exit_error }}
          comparison: contains

+  ci_integration_on_retry_cmd:
+    name: Run Integration Tests (on_retry_command)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
      - name: new-command-on-retry
        id: new-command-on-retry
        uses: ./
@@ -259,88 +366,9 @@ jobs:
          command: node -e "process.exit(1)"
          on_retry_command: node -e "throw new Error('This is an on-retry command error')"

-      - name: sad-path (error)
-        id: sad_path_error
-        uses: ./
-        continue-on-error: true
-        with:
-          timeout_minutes: 1
-          max_attempts: 2
-          command: node -e "process.exit(1)"
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 2
-          actual: ${{ steps.sad_path_error.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: failure
-          actual: ${{ steps.sad_path_error.outcome }}
-
-      - name: retry_on (timeout) fails early if error encountered
-        id: retry_on_timeout_fail
-        uses: ./
-        continue-on-error: true
-        with:
-          timeout_minutes: 1
-          max_attempts: 3
-          retry_on: timeout
-          command: node -e "process.exit(2)"
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 1
-          actual: ${{ steps.retry_on_timeout_fail.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: failure
-          actual: ${{ steps.retry_on_timeout_fail.outcome }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 2
-          actual: ${{ steps.retry_on_timeout_fail.outputs.exit_code }}
-
-      - name: retry_on (error)
-        id: retry_on_error
-        uses: ./
-        continue-on-error: true
-        with:
-          timeout_minutes: 1
-          max_attempts: 2
-          retry_on: error
-          command: node -e "process.exit(2)"
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 2
-          actual: ${{ steps.retry_on_error.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: failure
-          actual: ${{ steps.retry_on_error.outcome }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 2
-          actual: ${{ steps.retry_on_error.outputs.exit_code }}
-
-      - name: sad-path (wrong shell for OS)
-        id: wrong_shell
-        uses: ./
-        continue-on-error: true
-        with:
-          timeout_minutes: 1
-          max_attempts: 2
-          shell: cmd
-          command: 'dir'
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: 2
-          actual: ${{ steps.wrong_shell.outputs.total_attempts }}
-      - uses: nick-invision/assert-action@v1
-        with:
-          expected: failure
-          actual: ${{ steps.wrong_shell.outcome }}
-
  # timeout tests take longer to run so run in parallel
-  ci_integration_timeout:
-    name: Run Integration Timeout Tests
+  ci_integration_timeout_seconds:
+    name: Run Integration Timeout Tests (seconds)
    if: startsWith(github.ref, 'refs/heads')
    runs-on: ubuntu-latest
    steps:
@@ -370,6 +398,20 @@ jobs:
          expected: failure
          actual: ${{ steps.sad_path_timeout.outcome }}

+  ci_integration_timeout_retry_on_timeout:
+    name: Run Integration Timeout Tests (retry_on timeout)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
      - name: retry_on (timeout)
        id: retry_on_timeout
        uses: ./
@@ -388,6 +430,20 @@ jobs:
          expected: failure
          actual: ${{ steps.retry_on_timeout.outcome }}

+  ci_integration_timeout_retry_on_error:
+    name: Run Integration Timeout Tests (retry_on error)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
      - name: retry_on (error) fails early if timeout encountered
        id: retry_on_error_fail
        uses: ./
@@ -410,6 +466,20 @@ jobs:
          expected: 1
          actual: ${{ steps.retry_on_error_fail.outputs.exit_code }}

+  ci_integration_timeout_minutes:
+    name: Run Integration Timeout Tests (minutes)
+    if: startsWith(github.ref, 'refs/heads')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm ci
+
      - name: sad-path (timeout minutes)
        id: sad_path_timeout_minutes
        uses: ./
@@ -421,11 +491,11 @@ jobs:
      - uses: nick-invision/assert-action@v1
        with:
          expected: 2
-          actual: ${{ steps.sad_path_timeout.outputs.total_attempts }}
+          actual: ${{ steps.sad_path_timeout_minutes.outputs.total_attempts }}
      - uses: nick-invision/assert-action@v1
        with:
          expected: failure
-          actual: ${{ steps.sad_path_timeout.outcome }}
+          actual: ${{ steps.sad_path_timeout_minutes.outcome }}

  ci_windows:
    name: Run Windows Tests
@@ -479,10 +549,32 @@ jobs:
            echo "this is
            a test"

+  ci_all_tests_passed:
+    name: All tests passed
+    needs:
+      [
+        ci_unit,
+        ci_integration,
+        ci_integration_envvar,
+        ci_integration_large_output,
+        ci_integration_on_retry_cmd,
+        ci_integration_retry_wait_seconds,
+        ci_integration_continue_on_error,
+        ci_integration_retry_on_exit_code,
+        ci_integration_timeout_seconds,
+        ci_integration_timeout_minutes,
+        ci_integration_timeout_retry_on_timeout,
+        ci_integration_timeout_retry_on_error,
+        ci_windows,
+      ]
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "If this is hit, all tests successfully passed"
+
  # runs on push to master only
  cd:
    name: Publish Action
-    needs: [ci_integration, ci_integration_timeout, ci_windows]
+    needs: [ci_all_tests_passed]
    if: github.ref == 'refs/heads/master'
    runs-on: ubuntu-latest
    steps:
--- a/action.yml
+++ b/action.yml
@@ -50,5 +50,5 @@ outputs:
  exit_error:
    description: The final error returned by the command
 runs:
-  using: 'node12'
+  using: 'node16'
  main: 'dist/index.js'
--- a/dist/index.js
+++ b/dist/index.js
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
      "version": "0.0.0-managed-by-semantic-release",
      "license": "ISC",
      "dependencies": {
-        "@actions/core": "^1.9.0",
+        "@actions/core": "^1.10.0",
        "milliseconds": "^1.0.3",
        "tree-kill": "^1.2.2"
      },
@@ -39,11 +39,12 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.9.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.0.tgz",
-      "integrity": "sha512-5pbM693Ih59ZdUhgk+fts+bUWTnIdHV3kwOSr+QIoFHMLg7Gzhwm0cifDY/AG68ekEJAkHnQVpcy4f6GjmzBCA==",
+      "version": "1.10.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
+      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
      "dependencies": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
      }
    },
    "node_modules/@actions/http-client": {
@@ -12813,6 +12814,14 @@
      "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=",
      "dev": true
    },
+    "node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
+      }
+    },
    "node_modules/v8-compile-cache": {
      "version": "2.3.0",
      "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz",
@@ -13081,11 +13090,12 @@
  },
  "dependencies": {
    "@actions/core": {
-      "version": "1.9.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.0.tgz",
-      "integrity": "sha512-5pbM693Ih59ZdUhgk+fts+bUWTnIdHV3kwOSr+QIoFHMLg7Gzhwm0cifDY/AG68ekEJAkHnQVpcy4f6GjmzBCA==",
+      "version": "1.10.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
+      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
      "requires": {
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
      }
    },
    "@actions/http-client": {
@@ -22431,6 +22441,11 @@
      "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=",
      "dev": true
    },
+    "uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
+    },
    "v8-compile-cache": {
      "version": "2.3.0",
      "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz",
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
  },
  "homepage": "https://github.com/nick-invision/retry#readme",
  "dependencies": {
-    "@actions/core": "^1.9.0",
+    "@actions/core": "^1.10.0",
    "milliseconds": "^1.0.3",
    "tree-kill": "^1.2.2"
  },
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,24 +1,10 @@
-import { getInput, error, warning, info, debug, setOutput } from '@actions/core';
+import { error, warning, info, debug, setOutput } from '@actions/core';
 import { execSync, spawn } from 'child_process';
 import ms from 'milliseconds';
 import kill from 'tree-kill';

-import { wait } from './util';
-
-// inputs
-const TIMEOUT_MINUTES = getInputNumber('timeout_minutes', false);
-const TIMEOUT_SECONDS = getInputNumber('timeout_seconds', false);
-const MAX_ATTEMPTS = getInputNumber('max_attempts', true) || 3;
-const COMMAND = getInput('command', { required: true });
-const RETRY_WAIT_SECONDS = getInputNumber('retry_wait_seconds', false) || 10;
-const SHELL = getInput('shell');
-const POLLING_INTERVAL_SECONDS = getInputNumber('polling_interval_seconds', false) || 1;
-const RETRY_ON = getInput('retry_on') || 'any';
-const WARNING_ON_RETRY = getInput('warning_on_retry').toLowerCase() === 'true';
-const ON_RETRY_COMMAND = getInput('on_retry_command');
-const CONTINUE_ON_ERROR = getInputBoolean('continue_on_error');
-const NEW_COMMAND_ON_RETRY = getInput('new_command_on_retry');
-const RETRY_ON_EXIT_CODE = getInputNumber('retry_on_exit_code', false);
+import { getInputs, getTimeout, Inputs, validateInputs } from './inputs';
+import { retryWait, wait } from './util';

 const OS = process.platform;
 const OUTPUT_TOTAL_ATTEMPTS_KEY = 'total_attempts';
@@ -28,117 +14,69 @@ const OUTPUT_EXIT_ERROR_KEY = 'exit_error';
 let exit: number;
 let done: boolean;

-function getInputNumber(id: string, required: boolean): number | undefined {
-  const input = getInput(id, { required });
-  const num = Number.parseInt(input);
-
-  // empty is ok
-  if (!input && !required) {
-    return;
-  }
-
-  if (!Number.isInteger(num)) {
-    throw `Input ${id} only accepts numbers.  Received ${input}`;
-  }
-
-  return num;
-}
-
-function getInputBoolean(id: string): boolean {
-  const input = getInput(id);
-
-  if (!['true', 'false'].includes(input.toLowerCase())) {
-    throw `Input ${id} only accepts boolean values.  Received ${input}`;
-  }
-  return input.toLowerCase() === 'true';
-}
-
-async function retryWait() {
-  const waitStart = Date.now();
-  await wait(ms.seconds(RETRY_WAIT_SECONDS));
-  debug(`Waited ${Date.now() - waitStart}ms`);
-  debug(`Configured wait: ${ms.seconds(RETRY_WAIT_SECONDS)}ms`);
-}
-
-async function validateInputs() {
-  if ((!TIMEOUT_MINUTES && !TIMEOUT_SECONDS) || (TIMEOUT_MINUTES && TIMEOUT_SECONDS)) {
-    throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
-  }
-}
-
-function getTimeout(): number {
-  if (TIMEOUT_MINUTES) {
-    return ms.minutes(TIMEOUT_MINUTES);
-  } else if (TIMEOUT_SECONDS) {
-    return ms.seconds(TIMEOUT_SECONDS);
-  }
-
-  throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
-}
-
-function getExecutable(): string {
-  if (!SHELL) {
+function getExecutable(inputs: Inputs): string {
+  if (!inputs.shell) {
    return OS === 'win32' ? 'powershell' : 'bash';
  }

  let executable: string;
-  switch (SHELL) {
+  switch (inputs.shell) {
    case 'bash':
    case 'python':
    case 'pwsh': {
-      executable = SHELL;
+      executable = inputs.shell;
      break;
    }
    case 'sh': {
      if (OS === 'win32') {
-        throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
+        throw new Error(`Shell ${inputs.shell} not allowed on OS ${OS}`);
      }
-      executable = SHELL;
+      executable = inputs.shell;
      break;
    }
    case 'cmd':
    case 'powershell': {
      if (OS !== 'win32') {
-        throw new Error(`Shell ${SHELL} not allowed on OS ${OS}`);
+        throw new Error(`Shell ${inputs.shell} not allowed on OS ${OS}`);
      }
-      executable = SHELL + '.exe';
+      executable = inputs.shell + '.exe';
      break;
    }
    default: {
      throw new Error(
-        `Shell ${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/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell for supported shells`
      );
    }
  }
  return executable;
 }

-async function runRetryCmd(): Promise<void> {
+async function runRetryCmd(inputs: Inputs): Promise<void> {
  // if no retry script, just continue
-  if (!ON_RETRY_COMMAND) {
+  if (!inputs.on_retry_command) {
    return;
  }

  try {
-    await execSync(ON_RETRY_COMMAND, { stdio: 'inherit' });
+    await execSync(inputs.on_retry_command, { stdio: 'inherit' });
    // eslint-disable-next-line
  } catch (error: any) {
    info(`WARNING: Retry command threw the error ${error.message}`);
  }
 }

-async function runCmd(attempt: number) {
-  const end_time = Date.now() + getTimeout();
-  const executable = getExecutable();
+async function runCmd(attempt: number, inputs: Inputs) {
+  const end_time = Date.now() + getTimeout(inputs);
+  const executable = getExecutable(inputs);

  exit = 0;
  done = false;

-  debug(`Running command ${COMMAND} on ${OS} using shell ${executable}`);
+  debug(`Running command ${inputs.command} on ${OS} using shell ${executable}`);
  const child =
-    attempt > 1 && NEW_COMMAND_ON_RETRY
-      ? spawn(NEW_COMMAND_ON_RETRY, { shell: executable })
-      : spawn(COMMAND, { shell: executable });
+    attempt > 1 && inputs.new_command_on_retry
+      ? spawn(inputs.new_command_on_retry, { shell: executable })
+      : spawn(inputs.command, { shell: executable });

  child.stdout?.on('data', (data) => {
    process.stdout.write(data);
@@ -161,46 +99,46 @@ async function runCmd(attempt: number) {
  });

  do {
-    await wait(ms.seconds(POLLING_INTERVAL_SECONDS));
+    await wait(ms.seconds(inputs.polling_interval_seconds));
  } while (Date.now() < end_time && !done);

  if (!done && child.pid) {
    kill(child.pid);
-    await retryWait();
-    throw new Error(`Timeout of ${getTimeout()}ms hit`);
+    await retryWait(ms.seconds(inputs.retry_wait_seconds));
+    throw new Error(`Timeout of ${getTimeout(inputs)}ms hit`);
  } else if (exit > 0) {
-    await retryWait();
+    await retryWait(ms.seconds(inputs.retry_wait_seconds));
    throw new Error(`Child_process exited with error code ${exit}`);
  } else {
    return;
  }
 }

-async function runAction() {
-  await validateInputs();
+async function runAction(inputs: Inputs) {
+  await validateInputs(inputs);

-  for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
+  for (let attempt = 1; attempt <= inputs.max_attempts; attempt++) {
    try {
      // just keep overwriting attempts output
      setOutput(OUTPUT_TOTAL_ATTEMPTS_KEY, attempt);
-      await runCmd(attempt);
+      await runCmd(attempt, inputs);
      info(`Command completed after ${attempt} attempt(s).`);
      break;
      // eslint-disable-next-line
    } catch (error: any) {
-      if (attempt === MAX_ATTEMPTS) {
+      if (attempt === inputs.max_attempts) {
        throw new Error(`Final attempt failed. ${error.message}`);
-      } else if (!done && RETRY_ON === 'error') {
+      } else if (!done && inputs.retry_on === 'error') {
        // error: timeout
        throw error;
-      } else if (RETRY_ON_EXIT_CODE && RETRY_ON_EXIT_CODE !== exit) {
+      } else if (inputs.retry_on_exit_code && inputs.retry_on_exit_code !== exit) {
        throw error;
-      } else if (exit > 0 && RETRY_ON === 'timeout') {
+      } else if (exit > 0 && inputs.retry_on === 'timeout') {
        // error: error
        throw error;
      } else {
-        await runRetryCmd();
-        if (WARNING_ON_RETRY) {
+        await runRetryCmd(inputs);
+        if (inputs.warning_on_retry) {
          warning(`Attempt ${attempt} failed. Reason: ${error.message}`);
        } else {
          info(`Attempt ${attempt} failed. Reason: ${error.message}`);
@@ -210,7 +148,9 @@ async function runAction() {
  }
 }

-runAction()
+const inputs = getInputs();
+
+runAction(inputs)
  .then(() => {
    setOutput(OUTPUT_EXIT_CODE_KEY, 0);
    process.exit(0); // success
@@ -219,7 +159,7 @@ runAction()
    // exact error code if available, otherwise just 1
    const exitCode = exit > 0 ? exit : 1;

-    if (CONTINUE_ON_ERROR) {
+    if (inputs.continue_on_error) {
      warning(err.message);
    } else {
      error(err.message);
@@ -231,5 +171,5 @@ runAction()

    // if continue_on_error, exit with exact error code else exit gracefully
    // mimics native continue-on-error that is not supported in composite actions
-    process.exit(CONTINUE_ON_ERROR ? 0 : exitCode);
+    process.exit(inputs.continue_on_error ? 0 : exitCode);
  });
--- a/src/inputs.ts
+++ b/src/inputs.ts
@@ -0,0 +1,94 @@
+import { getInput } from '@actions/core';
+import ms from 'milliseconds';
+
+export interface Inputs {
+  timeout_minutes: number | undefined;
+  timeout_seconds: number | undefined;
+  max_attempts: number;
+  command: string;
+  retry_wait_seconds: number;
+  shell: string | undefined;
+  polling_interval_seconds: number;
+  retry_on: string | undefined;
+  warning_on_retry: boolean;
+  on_retry_command: string | undefined;
+  continue_on_error: boolean;
+  new_command_on_retry: string | undefined;
+  retry_on_exit_code: number | undefined;
+}
+
+export function getInputNumber(id: string, required: boolean): number | undefined {
+  const input = getInput(id, { required });
+  const num = Number.parseInt(input);
+
+  // empty is ok
+  if (!input && !required) {
+    return;
+  }
+
+  if (!Number.isInteger(num)) {
+    throw `Input ${id} only accepts numbers.  Received ${input}`;
+  }
+
+  return num;
+}
+
+export function getInputBoolean(id: string): boolean {
+  const input = getInput(id);
+
+  if (!['true', 'false'].includes(input.toLowerCase())) {
+    throw `Input ${id} only accepts boolean values.  Received ${input}`;
+  }
+  return input.toLowerCase() === 'true';
+}
+
+export async function validateInputs(inputs: Inputs) {
+  if (
+    (!inputs.timeout_minutes && !inputs.timeout_seconds) ||
+    (inputs.timeout_minutes && inputs.timeout_seconds)
+  ) {
+    throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
+  }
+}
+
+export function getTimeout(inputs: Inputs): number {
+  if (inputs.timeout_minutes) {
+    return ms.minutes(inputs.timeout_minutes);
+  } else if (inputs.timeout_seconds) {
+    return ms.seconds(inputs.timeout_seconds);
+  }
+
+  throw new Error('Must specify either timeout_minutes or timeout_seconds inputs');
+}
+
+export function getInputs(): Inputs {
+  const timeout_minutes = getInputNumber('timeout_minutes', false);
+  const timeout_seconds = getInputNumber('timeout_seconds', false);
+  const max_attempts = getInputNumber('max_attempts', true) || 3;
+  const command = getInput('command', { required: true });
+  const retry_wait_seconds = getInputNumber('retry_wait_seconds', false) || 10;
+  const shell = getInput('shell');
+  const polling_interval_seconds = getInputNumber('polling_interval_seconds', false) || 1;
+  const retry_on = getInput('retry_on') || 'any';
+  const warning_on_retry = getInput('warning_on_retry').toLowerCase() === 'true';
+  const on_retry_command = getInput('on_retry_command');
+  const continue_on_error = getInputBoolean('continue_on_error');
+  const new_command_on_retry = getInput('new_command_on_retry');
+  const retry_on_exit_code = getInputNumber('retry_on_exit_code', false);
+
+  return {
+    timeout_minutes,
+    timeout_seconds,
+    max_attempts,
+    command,
+    retry_wait_seconds,
+    shell,
+    polling_interval_seconds,
+    retry_on,
+    warning_on_retry,
+    on_retry_command,
+    continue_on_error,
+    new_command_on_retry,
+    retry_on_exit_code,
+  };
+}
--- a/src/util.ts
+++ b/src/util.ts
@@ -1,3 +1,12 @@
+import { debug } from '@actions/core';
+
 export async function wait(ms: number) {
  return new Promise((r) => setTimeout(r, ms));
 }
+
+export async function retryWait(retryWaitSeconds: number) {
+  const waitStart = Date.now();
+  await wait(retryWaitSeconds);
+  debug(`Waited ${Date.now() - waitStart}ms`);
+  debug(`Configured wait: ${retryWaitSeconds}ms`);
+}
Author	SHA1	Message	Date
Sven Schliesing	3e91a01664	Upgrade to node16 (#101 ) > Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: nick-fields/retry Co-authored-by: Nick Fields <46869826+nick-fields@users.noreply.github.com>	2022-10-14 20:45:08 -04:00
Peter Colapietro	48bc5d4b1c	fix(github): bump to `@actions/core@1.10.0` (#104 ) > Action authors who are using the toolkit should update the `@actions/core` package to `v1.10.0` or greater to get the updated `saveState` and `setOutput` functions. - https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ closes: https://github.com/nick-fields/retry/issues/103	2022-10-14 20:41:20 -04:00
Nick Fields	7d4a377045	docs: add pr template and change owner in issues template (#94 )	2022-08-16 11:11:46 -04:00
Nick Fields	b4fa57557d	Refactor to make testing easier (#90 ) * minor: refactor to make testing easier * patch: retrieve inputs into object rather than globals * test: run more "integration" tests in parallel * test: fix needs and rearrange ci_integration_* jobs * test: forgot comma * test: fix sad_path_timeout_minutes assertions * test: add single ci_all_tests_passed job that can be required for CI rather than each individual job * test: add single ci_all_tests_passed job that can be required for CI rather than each individual job	2022-08-05 23:31:37 -04:00