Core: Implement afterEach by kasperpeulen · Pull Request #29584 · storybookjs/storybook

kasperpeulen · 2024-11-11T13:58:07Z

Closes #

What I did

Working on top of this csf canary:
ComponentDriven/csf#109

To implement this RFC:
#29583

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	78.2 MB	78.2 MB	0 B	1.13	0%
initSize	143 MB	143 MB	2.15 kB	1.38	0%
diffSize	65.2 MB	65.2 MB	2.15 kB	0.91	0%
buildSize	6.88 MB	6.88 MB	1.32 kB	28.17	0%
buildSbAddonsSize	1.51 MB	1.51 MB	820 B	123.53	0.1%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	1.9 MB	1.9 MB	-100 B	-0.65	0%
buildSbPreviewSize	271 kB	271 kB	596 B	Infinity	0.2%
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	3.88 MB	3.88 MB	1.32 kB	28.17	0%
buildPreviewSize	3 MB	3 MB	0 B	-	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	22.9s	25.8s	2.8s	1.69	🔺11%
generateTime	23s	21.9s	-1s -72ms	-0.11	-4.9%
initTime	15.5s	15s	-452ms	-0.19	-3%
buildTime	8.3s	9.1s	811ms	0.21	8.9%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	5.4s	5.6s	234ms	-0.4	4.1%
devManagerResponsive	3.4s	3.6s	201ms	-0.18	5.6%
devManagerHeaderVisible	519ms	589ms	70ms	0.29	11.9%
devManagerIndexVisible	594ms	621ms	27ms	-0.15	4.3%
devStoryVisibleUncached	862ms	1.1s	322ms	0.41	27.2%
devStoryVisible	592ms	620ms	28ms	0.01	4.5%
devAutodocsVisible	507ms	534ms	27ms	0.08	5.1%
devMDXVisible	520ms	498ms	-22ms	-0.38	-4.4%
buildManagerHeaderVisible	490ms	491ms	1ms	-1.19	0.2%
buildManagerIndexVisible	502ms	507ms	5ms	-1.15	1%
buildStoryVisible	492ms	486ms	-6ms	-1.23	-1.2%
buildAutodocsVisible	467ms	419ms	-48ms	-0.85	-11.5%
buildMDXVisible	406ms	443ms	37ms	-0.25	8.4%

Greptile Summary

Here's my summary of the PR implementing afterEach functionality in Storybook:

Adds afterEach lifecycle hook to Storybook's story execution pipeline, allowing cleanup operations to be performed after each story runs, with proper phase management and error handling.

Added applyAfterEach to PreparedStory type and implementation to execute finalizers in reverse order (story -> component -> project)
Added 'afterEach' phase to RenderPhase and updated StoryRender to run afterEach hooks before transitioning to 'played' or 'errored' states
Added afterEach field to composeConfigs return object using existing getArrayField helper
Added story.applyAfterEach(context) call in runStory function with proper abort signal handling
Updated CSF dependency to canary version 0.1.12--canary.109.4d1d54a.0 across multiple packages

nx-cloud · 2024-11-11T14:02:19Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e038e8b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

nx run-many -t build --parallel=3

Sent with 💌 from NxCloud.

greptile-apps

_{14 file(s) reviewed, 10 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2024-11-11T13:58:46Z

  },
  "dependencies": {
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


logic: Pinning to a canary version (0.1.12--canary.109.4d1d54a.0) instead of using ^0.1.11 could cause version conflicts. Consider if this specific version is required or if a caret range would be more appropriate.

greptile-apps · 2024-11-11T13:59:14Z

  },
  "dependencies": {
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


logic: Using a canary version (0.1.12--canary) in production dependencies could introduce instability. Consider waiting for a stable release.

greptile-apps · 2024-11-11T14:01:21Z

+
+  await story.applyAfterEach(context);


logic: afterEach should run even if playFunction throws an error. Consider wrapping the play function in try/finally to ensure afterEach always executes.

greptile-apps · 2024-11-11T14:01:53Z

+      if (context.abortSignal.aborted) {
+        return;
+      }


style: Consider handling errors from finalizers to ensure all cleanup runs even if one fails

greptile-apps · 2024-11-11T14:02:53Z

  },
  "dependencies": {
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


style: Pinning to a canary version in production dependencies could cause issues if the canary version has bugs or breaking changes. Consider waiting for a stable release.

greptile-apps · 2024-11-11T14:03:27Z

    "@babel/types": "^7.24.0",
    "@storybook/core": "workspace:*",
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


style: Using a canary version in production dependencies could cause instability. Consider waiting for a stable release.

greptile-apps · 2024-11-11T14:04:02Z

  },
  "dependencies": {
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


style: Using a canary version in production dependencies can be unstable. Consider waiting for a stable release or document the rationale for using this specific pre-release version.

greptile-apps · 2024-11-11T14:04:34Z

  },
  "dependencies": {
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


style: Using a specific canary version instead of a caret range could cause issues if other packages depend on different versions of @storybook/csf

greptile-apps · 2024-11-11T14:05:09Z

    "@storybook/core": "workspace:*",
    "@storybook/core-webpack": "workspace:*",
-    "@storybook/csf": "0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


logic: Using a canary version (0.1.12--canary.109.4d1d54a.0) in production dependencies could lead to instability. Consider using a stable version instead.

greptile-apps · 2024-11-11T14:05:41Z

  "dependencies": {
    "@storybook/components": "workspace:*",
-    "@storybook/csf": "^0.1.11",
+    "@storybook/csf": "0.1.12--canary.109.4d1d54a.0",


style: using a canary version in production dependencies could cause instability - consider waiting for a stable release

valentinpalkovic · 2024-11-13T12:35:06Z

+          await this.runPhase(abortSignal, 'afterEach', async () => {
+            await applyAfterEach(context);
+          });
+


I would assume that this phase runs after the played event in line 327

valentinpalkovic · 2024-11-15T14:59:07Z

Merged into valentin/unified-a11y-testing

Implement afterEach

a913610

kasperpeulen marked this pull request as draft November 11, 2024 13:58

kasperpeulen added ci:normal Run our default set of CI jobs (choose this for most PRs). feature request labels Nov 11, 2024

greptile-apps Bot reviewed Nov 11, 2024

View reviewed changes

Test afterEach

3065626

kasperpeulen changed the title ~~Implement afterEach~~ Core: Implement afterEach Nov 12, 2024

kasperpeulen added 4 commits November 12, 2024 15:35

Add afterEach normalizers

83af2a6

Fix test

8029b37

Bump @storybook/csf

b918869

Make dedicated order-of-hooks test

312b25d

valentinpalkovic reviewed Nov 13, 2024

View reviewed changes

Fix tests

e038e8b

valentinpalkovic mentioned this pull request Nov 14, 2024

[Tracking]: Unified a11y tests #29555

Closed

valentinpalkovic assigned kasperpeulen Nov 14, 2024

valentinpalkovic closed this Nov 15, 2024

kasperpeulen deleted the kasper/after-each branch April 4, 2026 19:13

Uh oh!

Uh oh!

Conversation

kasperpeulen commented Nov 11, 2024 • edited by storybook-app-bot Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

Uh oh!

nx-cloud Bot commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

greptile-apps Bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

valentinpalkovic Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

valentinpalkovic commented Nov 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kasperpeulen commented Nov 11, 2024 •

edited by storybook-app-bot Bot

Loading

nx-cloud Bot commented Nov 11, 2024 •

edited

Loading