Merge pull request #494 from storybookjs/post-visit-on-failures

Feature: Run postVisit on failures
storybookjs · Nov 28, 2024 · 322bd62 · 322bd62
2 parents 3a2a920 + 3f8071b
commit 322bd62
Show file tree

Hide file tree

Showing 5 changed files with 566 additions and 177 deletions.
diff --git a/src/csf/__snapshots__/transformCsf.test.ts.snap b/src/csf/__snapshots__/transformCsf.test.ts.snap
@@ -29,12 +29,25 @@ if (!require.main) {
           if (globalThis.__sbPreVisit) {
             await globalThis.__sbPreVisit(page, context);
           }
-          const result = await page.evaluate(({
-            id,
-            hasPlayFn
-          }) => __test(id, hasPlayFn), {
-            id: "button--primary"
-          });
+          let result;
+          try {
+            result = await page.evaluate(({
+              id,
+              hasPlayFn
+            }) => __test(id, hasPlayFn), {
+              id: "button--primary"
+            });
+          } catch (err) {
+            if (err.toString().includes('Execution context was destroyed')) {
+              throw err;
+            } else {
+              await globalThis.__sbPostVisit(page, {
+                ...context,
+                hasFailure: true
+              });
+              throw err;
+            }
+          }
           if (globalThis.__sbPostVisit) {
             await globalThis.__sbPostVisit(page, context);
           }
@@ -96,12 +109,25 @@ if (!require.main) {
           if (globalThis.__sbPreVisit) {
             await globalThis.__sbPreVisit(page, context);
           }
-          const result = await page.evaluate(({
-            id,
-            hasPlayFn
-          }) => __test(id, hasPlayFn), {
-            id: "button--primary"
-          });
+          let result;
+          try {
+            result = await page.evaluate(({
+              id,
+              hasPlayFn
+            }) => __test(id, hasPlayFn), {
+              id: "button--primary"
+            });
+          } catch (err) {
+            if (err.toString().includes('Execution context was destroyed')) {
+              throw err;
+            } else {
+              await globalThis.__sbPostVisit(page, {
+                ...context,
+                hasFailure: true
+              });
+              throw err;
+            }
+          }
           if (globalThis.__sbPostVisit) {
             await globalThis.__sbPostVisit(page, context);
           }
@@ -149,12 +175,25 @@ if (!require.main) {
           if (globalThis.__sbPreVisit) {
             await globalThis.__sbPreVisit(page, context);
           }
-          const result = await page.evaluate(({
-            id,
-            hasPlayFn
-          }) => __test(id, hasPlayFn), {
-            id: "button--primary"
-          });
+          let result;
+          try {
+            result = await page.evaluate(({
+              id,
+              hasPlayFn
+            }) => __test(id, hasPlayFn), {
+              id: "button--primary"
+            });
+          } catch (err) {
+            if (err.toString().includes('Execution context was destroyed')) {
+              throw err;
+            } else {
+              await globalThis.__sbPostVisit(page, {
+                ...context,
+                hasFailure: true
+              });
+              throw err;
+            }
+          }
           if (globalThis.__sbPostVisit) {
             await globalThis.__sbPostVisit(page, context);
           }

diff --git a/src/playwright/hooks.ts b/src/playwright/hooks.ts
@@ -5,6 +5,7 @@ export type TestContext = {
   id: string;
   title: string;
   name: string;
+  hasFailure?: boolean;
 };
 
 export type PrepareContext = {