change waitUntil param to take options

changeset
Shopify · Aug 22, 2022 · 0d9702e · 0d9702e
1 parent 9d07c6c
commit 0d9702e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/.changeset/lemon-dragons-count.md b/.changeset/lemon-dragons-count.md
@@ -0,0 +1,5 @@
+---
+'@shopify/storybook-a11y-test': minor
+---
+
+Allow waitUntil param to take options
diff --git a/packages/storybook-a11y-test/src/index.ts b/packages/storybook-a11y-test/src/index.ts
@@ -2,7 +2,7 @@
 import os from 'os';
 import fs from 'fs';
 
-import puppeteer, {Browser} from 'puppeteer';
+import puppeteer, {Browser, PuppeteerLifeCycleEvent} from 'puppeteer';
 import pMap from 'p-map';
 import chalk from 'chalk';
 import Koa from 'koa';
@@ -57,11 +57,13 @@ export class A11yTestRunner {
     storyIds = [],
     concurrentCount = os.cpus().length,
     timeout = 3000,
+    waitUntil = 'load',
     disableAnimation = false,
   }: {
     storyIds: StoryId[];
     concurrentCount?: number;
     timeout?: number;
+    waitUntil?: PuppeteerLifeCycleEvent;
     disableAnimation?: boolean;
   }) {
     console.log(
@@ -75,7 +77,7 @@ export class A11yTestRunner {
     console.log(chalk.bold(`🧪 Testing ${storyIds.length} urls with axe`));
     const results = await pMap(
       storyIds,
-      this.generateTestStoryFunction(timeout, disableAnimation),
+      this.generateTestStoryFunction(timeout, waitUntil, disableAnimation),
       {
         concurrency: concurrentCount,
       },
@@ -146,6 +148,7 @@ export class A11yTestRunner {
 
   private generateTestStoryFunction(
     timeout: number,
+    waitUntil: PuppeteerLifeCycleEvent,
     disableAnimation: boolean,
   ) {
     return async (id: StoryId) => {
@@ -154,7 +157,7 @@ export class A11yTestRunner {
 
       try {
         await page.goto(`${this.iframePath}?id=${id}`, {
-          waitUntil: 'load',
+          waitUntil,
           timeout,
         });