Introduce abort-after-seconds

CHANGELOG.md

@@ -13,4 +13,4 @@
 
 ## 0.1.0
 
-* Initial release
+* Initial release

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions)  action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript.
 
-You can bootstrap your envrinment with a modern version of npm and by running `npm i` at the root of this repo.
+You can bootstrap your environment with a modern version of npm and by running `npm i` at the root of this repo.
 
 ## testing
 
@@ -15,4 +15,3 @@ Source code can be found under the `src` directory. Running `npm run build` will
 ## formatting
 
 A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`
-

README.md

@@ -87,7 +87,31 @@ jobs:
       - name: Turnstyle
         uses: softprops/turnstyle@v1
         with:
-+         continue-after-seconds: 180 
++         continue-after-seconds: 180
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Deploy
+        run: sleep 30
+```
+
+or before aborting the step with `jobs.<job_id>.steps.with.abort-after-seconds`
+
+
+```diff
+name: Main
+
+on: push
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Turnstyle
+        uses: softprops/turnstyle@v1
+        with:
++         abort-after-seconds: 180
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Deploy
@@ -96,11 +120,12 @@ jobs:
 
 #### inputs
 
-| Name        | Type    | Description                                                     |
-|-------------|---------|-----------------------------------------------------------------|
-| `continue-after-seconds`   | number  | Maximum number of seconds to wait before moving forward (unbound by default)                          |
-| `poll-interval-seconds`      | number  | Number of seconds to wait in between checks for previous run completion (defaults to 60)                |
-| `same-branch-only`      | boolean  | Only wait on other runs from the same branch (defaults to true)                |
+| Name                    | Type    | Description                                                                                                                    |
+|-------------------------|---------|--------------------------------------------------------------------------------------------------------------------------------|
+| `continue-after-seconds`| number  | Maximum number of seconds to wait before moving forward (unbound by default). Mutually exclusive with abort-after-seconds      |
+| `abort-after-seconds`   | number  | Maximum number of seconds to wait before aborting the job (unbound by default). Mutually exclusive with continue-after-seconds |
+| `poll-interval-seconds` | number  | Number of seconds to wait in between checks for previous run completion (defaults to 60)                                       |
+| `same-branch-only`      | boolean | Only wait on other runs from the same branch (defaults to true)                                                                |
 
 #### outputs
 

__tests__/input.test.ts

@@ -23,12 +23,54 @@ describe("input", () => {
           workflowName: "test",
           runId: 1,
           continueAfterSeconds: 10,
+          abortAfterSeconds: undefined,
           pollIntervalSeconds: 5,
           sameBranchOnly: false
         }
       );
     });
 
+    it("parses config from env with abortAfterSeconds", () => {
+      assert.deepEqual(
+        parseInput({
+          GITHUB_TOKEN: "s3cr3t",
+          GITHUB_REF: "refs/heads/foo",
+          GITHUB_REPOSITORY: "softprops/turnstyle",
+          GITHUB_WORKFLOW: "test",
+          GITHUB_RUN_ID: "1",
+          "INPUT_ABORT-AFTER-SECONDS": "10",
+          "INPUT_POLL-INTERVAL-SECONDS": "5",
+          "INPUT_SAME-BRANCH-ONLY": "false"
+        }),
+        {
+          githubToken: "s3cr3t",
+          owner: "softprops",
+          repo: "turnstyle",
+          branch: "foo",
+          workflowName: "test",
+          runId: 1,
+          continueAfterSeconds: undefined,
+          abortAfterSeconds: 10,
+          pollIntervalSeconds: 5,
+          sameBranchOnly: false
+        }
+      );
+    });
+
+    it("rejects env with continueAfterSeconds and abortAfterSeconds", () => {
+      assert.throws(() =>
+        parseInput({
+          GITHUB_TOKEN: "s3cr3t",
+          GITHUB_REF: "refs/heads/foo",
+          GITHUB_REPOSITORY: "softprops/turnstyle",
+          GITHUB_WORKFLOW: "test",
+          GITHUB_RUN_ID: "1",
+          "INPUT_CONTINUE-AFTER-SECONDS": "10",
+          "INPUT_ABORT-AFTER-SECONDS": "2"
+        })
+      );
+    });
+
     it("parses config from env with defaults", () => {
       assert.deepEqual(
         parseInput({
@@ -46,6 +88,7 @@ describe("input", () => {
           workflowName: "test",
           runId: 1,
           continueAfterSeconds: undefined,
+          abortAfterSeconds: undefined,
           pollIntervalSeconds: 60,
           sameBranchOnly: true
         }
@@ -70,6 +113,7 @@ describe("input", () => {
           workflowName: "test",
           runId: 1,
           continueAfterSeconds: undefined,
+          abortAfterSeconds: undefined,
           pollIntervalSeconds: 60,
           sameBranchOnly: true
         }

__tests__/wait.test.ts

@@ -17,6 +17,7 @@ describe("wait", () => {
         input = {
           branch: "master",
           continueAfterSeconds: undefined,
+          abortAfterSeconds: undefined,
           pollIntervalSeconds: 1,
           githubToken: "fake-token",
           owner: "org",
@@ -61,6 +62,43 @@ describe("wait", () => {
         ]);
       });
 
+      it("will abort after a prescribed number of seconds", async () => {
+        input.abortAfterSeconds = 1;
+        const inProgressRun = {
+          id: 1,
+          status: "in_progress",
+          html_url: ""
+        };
+        const githubClient = {
+          runs: async (
+            owner: string,
+            repo: string,
+            branch: string | undefined,
+            workflowId: number
+          ) => Promise.resolve([inProgressRun]),
+          workflows: async (owner: string, repo: string) =>
+            Promise.resolve([workflow])
+        };
+
+        const messages: Array<string> = [];
+        const waiter = new Waiter(
+          workflow.id,
+          githubClient,
+          input,
+          (message: string) => {
+            messages.push(message);
+          }
+        );
+        await assert.rejects(waiter.wait(), {
+          name: "Error",
+          message: "Aborted after waiting 1 seconds"
+        });
+        assert.deepEqual(messages, [
+          "✋Awaiting run  ...",
+          "🛑Exceeded wait seconds. Aborting..."
+        ]);
+      });
+
       it("will return when a run is completed", async () => {
         const run: Run = {
           id: 1,

action.yml

@@ -11,7 +11,9 @@ inputs:
   poll-interval-seconds:
     description: "Number of seconds to wait in between checks for previous run completion (defaults to 60)"
   continue-after-seconds:
-    description: "Maximum number of seconds to wait before moving forward (unbound by default)"
+    description: "Maximum number of seconds to wait before moving forward (unbound by default). Mutually exclusive with abort-after-seconds"
+  abort-after-seconds:
+    description: "Maximum number of seconds to wait before failing the step (unbound by default). Mutually exclusive with continue-after-seconds"
   same-branch-only:
     description: "Only wait on other runs from the same branch (defaults to true)"
 branding:

src/input.ts

@@ -7,6 +7,7 @@ export interface Input {
   runId: number;
   pollIntervalSeconds: number;
   continueAfterSeconds: number | undefined;
+  abortAfterSeconds: number | undefined;
   sameBranchOnly: boolean;
 }
 
@@ -23,6 +24,14 @@ export const parseInput = (env: Record<string, string | undefined>): Input => {
   const continueAfterSeconds = env["INPUT_CONTINUE-AFTER-SECONDS"]
     ? parseInt(env["INPUT_CONTINUE-AFTER-SECONDS"], 10)
     : undefined;
+  const abortAfterSeconds = env["INPUT_ABORT-AFTER-SECONDS"]
+    ? parseInt(env["INPUT_ABORT-AFTER-SECONDS"], 10)
+    : undefined;
+  if (continueAfterSeconds !== undefined && abortAfterSeconds !== undefined) {
+    throw new Error(
+      "Only one of continue-after-seconds and abort-after-seconds may be defined"
+    );
+  }
   const sameBranchOnly =
     env["INPUT_SAME-BRANCH-ONLY"] === "true" ||
     env["INPUT_SAME-BRANCH-ONLY"] === undefined; // true if not specified
@@ -35,6 +44,7 @@ export const parseInput = (env: Record<string, string | undefined>): Input => {
     runId,
     pollIntervalSeconds,
     continueAfterSeconds,
+    abortAfterSeconds,
     sameBranchOnly
   };
 };

src/wait.ts

@@ -32,6 +32,14 @@ export class Waiter implements Wait {
       return secondsSoFar || 0;
     }
 
+    if (
+      this.input.abortAfterSeconds &&
+      (secondsSoFar || 0) >= this.input.abortAfterSeconds
+    ) {
+      this.info(`🛑Exceeded wait seconds. Aborting...`);
+      throw new Error(`Aborted after waiting ${secondsSoFar} seconds`);
+    }
+
     const runs = await this.githubClient.runs(
       this.input.owner,
       this.input.repo,