feat(acot-runner-storybook): add timeout options

acot-a11y · Apr 18, 2021 · 41b06f9 · 41b06f9
1 parent e0dee85
commit 41b06f9
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/packages/acot-runner-storybook/README.md b/packages/acot-runner-storybook/README.md
@@ -79,6 +79,25 @@ The Story name pattern to exclude in the audit target. See the [micromatch][mm]
 }
 ```
 
+### `timeout`
+
+**Type:** `number`  
+**Default:** `60000`  
+**Required:** `false`
+
+Maximum time in milliseconds to wait for the browser instance to collect stories.
+
+```json
+{
+  "runner": {
+    "uses": "@acot/storybook",
+    "with": {
+      "timeout": 120000
+    }
+  }
+}
+```
+
 ## Storybook compatibility
 
 ### Storybook versions

diff --git a/packages/acot-runner-storybook/src/index.ts b/packages/acot-runner-storybook/src/index.ts
@@ -11,6 +11,8 @@ import type { AcotRunnerCollectResult } from '@acot/acot-runner';
 import { AcotRunner } from '@acot/acot-runner';
 const debug = require('debug')('acot:runner:storybook');
 
+const DEFAULT_TIMEOUT = 60 * 1000;
+
 type StoryParams = Omit<ConfigEntry, 'include' | 'exclude'>;
 
 type Story = {
@@ -73,6 +75,7 @@ const filterStories = (
 type Options = {
   include?: string[];
   exclude?: string[];
+  timeout?: number;
 };
 
 const schema: Schema = {
@@ -89,6 +92,10 @@ const schema: Schema = {
         type: 'string',
       },
     },
+    timeout: {
+      type: 'number',
+      minimum: 0,
+    },
   },
   required: [],
   additionalProperties: false,
@@ -100,6 +107,8 @@ export class StorybookRunner extends AcotRunner<Options> {
     const browser = await puppeteer.launch(this.config.launchOptions);
     const page = await browser.newPage();
 
+    page.setDefaultTimeout(this.options.timeout ?? DEFAULT_TIMEOUT);
+
     let stories: AcotStory[] = [];
 
     try {