Core: New Status Store #30764

JReinhold · 2025-03-06T11:28:37Z

Closes #

What I did

Replaced the existing status API (experimental_updateStatus et.al.) with a new one, based on a statusStore - that is backed by a Universal Store.

End-user functionality should stay the same, except now statuses are persisted on the server too instead of in browser sesison storage, so they sync between different tabs, they are kept when you close the tab, but they are cleared when you restart the dev server.

Not going to explain the new status API just yet, as it's still considered mainly an internal/experimental thing.

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>

Greptile Summary

This PR introduces a new Status Store system for centralized status management across Storybook's server, manager, and preview environments, replacing the existing experimental status API with a more robust implementation.

Added code/core/src/shared/status-store with comprehensive test coverage and type safety for managing component statuses
Updated A11y and Test addons to use new experimental_useStatusStore hook instead of direct API calls
Removed old status-related types (API_StatusValue, API_StatusObject) in favor of new StatusByTypeId and StatusValue enum
Modified sidebar components to use new status store for error/warning counts and status filtering
Added proper error handling with new StatusTypeIdMismatchError for type validation across environments

…n the state hasn't changed

…tatus

…atus-store

nx-cloud · 2025-03-06T11:35:52Z

View your CI Pipeline Execution ↗ for commit 87c4b2a.

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	1m 53s	View ↗

☁️ Nx Cloud last updated this comment at 2025-03-11 20:42:29 UTC

JReinhold · 2025-03-07T10:15:36Z

code/.storybook/main.ts

@@ -101,7 +101,7 @@ const config = defineMain({
    '@storybook/addon-designs',
    '@storybook/addon-test',
    '@storybook/addon-a11y',
-    '@chromatic-com/storybook',


temporary, until VTA has been updated with the new Status API

JReinhold · 2025-03-07T10:34:17Z

code/addons/test/src/manager-store.ts

+export const componentTestStatusStore = experimental_getStatusStore(STATUS_TYPE_ID_COMPONENT_TEST);
+export const a11yStatusStore = experimental_getStatusStore(STATUS_TYPE_ID_A11Y);


Because addon-test both handles CT statuses and a11y statuses, we get a status store slice for each of the two type ids, that operates independently of each other.

JReinhold · 2025-03-07T10:36:37Z

code/addons/test/src/manager.tsx

-              )
-            );
-          })();
+          componentTestStatusStore.set(


from an addon's perspective, this change is the main difference between the old and the new API.

code/addons/test/src/manager.tsx

JReinhold · 2025-03-07T10:38:24Z

code/addons/test/src/node/boot-test-runner.ts

@@ -67,7 +67,10 @@ const bootTestRunner = async (channel: Channel) => {

  const startChildProcess = () =>
    new Promise<void>((resolve, reject) => {
-      child = execaNode(vitestModulePath);
+      child = execaNode(vitestModulePath, {
+        env: { VITEST: 'true', TEST: 'true', NODE_ENV: process.env.NODE_ENV ?? 'test' },


these were already set at runtime in the vitest module, but setting them immediately here means that they will be set before anything else.

code/addons/test/src/node/reporter.ts

JReinhold · 2025-03-07T10:40:03Z

code/core/src/core-server/stores/status.ts

+
+const statusStore = createStatusStore({
+  universalStatusStore:
+    process.env.VITEST !== 'true'


this is a temporary workaround, until we fix UniversalStore leader/follower determination on a holistic level.

code/core/src/core-server/stores/status.ts

greptile-apps

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

code/addons/a11y/src/components/A11yContext.test.tsx

code/addons/test/src/manager-store.mock.ts

code/addons/test/src/manager-store.ts

code/addons/test/src/manager.tsx

code/core/src/shared/status-store/index.ts

code/core/src/shared/universal-store/use-universal-store-manager.ts

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

… into jeppe/status-store

code/core/src/manager-api/modules/stories.ts

code/core/src/shared/status-store/index.ts

…re changes

storybook-pr-benchmarking · 2025-03-11T20:20:19Z

Package Benchmarks

^{Commit: 87c4b2a, ran on 11 March 2025 at 20:46:57 UTC}

The following packages have significant changes to their size or dependencies:

`storybook`

	Before	After	Difference
Dependency count	98	98	0
Self size	21.54 MB	21.59 MB	🚨 +52 KB 🚨
Dependency size	21.69 MB	21.69 MB	🚨 +145 B 🚨
Bundle Size Analyzer	Link	Link

`@storybook/nextjs`

	Before	After	Difference
Dependency count	540	539	🎉 -1 🎉
Self size	219 KB	219 KB	0 B
Dependency size	58.82 MB	58.62 MB	🎉 -203 KB 🎉
Bundle Size Analyzer	Link	Link

`sb`

	Before	After	Difference
Dependency count	99	99	0
Self size	1 KB	1 KB	0 B
Dependency size	43.24 MB	43.29 MB	🚨 +52 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/cli`

	Before	After	Difference
Dependency count	388	388	0
Self size	284 KB	284 KB	0 B
Dependency size	93.38 MB	93.44 MB	🚨 +61 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/codemod`

	Before	After	Difference
Dependency count	309	309	0
Self size	614 KB	614 KB	0 B
Dependency size	74.99 MB	75.05 MB	🚨 +57 KB 🚨
Bundle Size Analyzer	Link	Link

JReinhold added 13 commits March 4, 2025 22:41

initial status store

a357cc9

ensure getSnapshot in useUniversalStore returns the same variable whe…

a203a32

…n the state hasn't changed

changed data structure to a double nested record storyId > typeId > s…

3686972

…tatus

export status stores from entrypoints

8d37bb1

add functionality to trigger onSelect on statuses

56f1728

use new statusStore in addon-test

47be9e9

update sidebar to be backed by new statusStore

a275053

Merge branch 'next' of github.com:storybookjs/storybook into jeppe/st…

60ebee1

…atus-store

set vitest process environments during spawning

802c1e3

server statusStore is not leader when running in vitest process

6fbbacb

add fullStatusStore to manager-api exports

ed893ef

fix fullStatusStore import

7e859c5

Merge branch 'next' of github.com:storybookjs/storybook into jeppe/st…

3eb2cfb

…atus-store

JReinhold added the ci: do not merge label Mar 6, 2025

JReinhold added 7 commits March 6, 2025 13:35

fix core-events type generation

26c70ea

remove existing updateStatus api

4e1dc17

cleanup

3818256

temporarily disable statusStore in vitest sub-process

d2cef73

use statusStore in sidebar ui components

f3d31d1

remove old types and usages, temporarily disable VTA

61e6020

update sidebar stories

bc28a63

JReinhold commented Mar 7, 2025

View reviewed changes

code/addons/test/src/manager.tsx Outdated Show resolved Hide resolved

JReinhold commented Mar 7, 2025

View reviewed changes

code/addons/test/src/node/reporter.ts Show resolved Hide resolved

JReinhold commented Mar 7, 2025

View reviewed changes

code/core/src/core-server/stores/status.ts Outdated Show resolved Hide resolved

JReinhold added 2 commits March 10, 2025 14:47

use StorybookError for typeId mismatches

5fd6446

add migration notes for status store

f7b8f81

JReinhold added maintenance User-facing maintenance tasks core addon: test and removed ci: do not merge labels Mar 10, 2025

JReinhold self-assigned this Mar 10, 2025

JReinhold added the ci:normal label Mar 10, 2025

JReinhold requested a review from yannbf March 10, 2025 14:02

JReinhold marked this pull request as ready for review March 10, 2025 14:02

greptile-apps bot reviewed Mar 10, 2025

View reviewed changes

JReinhold and others added 6 commits March 10, 2025 16:08

use new storybook/test entrypoint

f525f20

Apply suggestions from code review

7bada6e

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

Update code/core/src/shared/status-store/index.test.ts

b030498

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

fix statuses in Search

474b477

Merge branch 'jeppe/status-store' of github.com:storybookjs/storybook…

c1b556f

… into jeppe/status-store

add environment to all createStatusStore calls

107e6ad

JReinhold commented Mar 11, 2025

View reviewed changes

code/core/src/manager-api/modules/stories.ts Show resolved Hide resolved

fix tests

b73be0e

JReinhold commented Mar 11, 2025

View reviewed changes

code/core/src/shared/status-store/index.ts Outdated Show resolved Hide resolved

JReinhold commented Mar 11, 2025

View reviewed changes

code/core/src/shared/status-store/index.ts Outdated Show resolved Hide resolved

JReinhold added 5 commits March 11, 2025 14:08

make tests work in node

6863fa6

fix types

e423593

rename status store functions to getAll and onAllStatusChange

24e2461

fix useUniversalStore not re-rendering when the selector/universalSto…

68ac392

…re changes

fix test

772a244

JReinhold requested a review from ghengeveld March 11, 2025 14:22

fix dts generation in core

306b04a

Merge branch 'next' into jeppe/status-store

87c4b2a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Core: New Status Store #30764

Core: New Status Store #30764

JReinhold commented Mar 6, 2025 •

edited

Loading

nx-cloud bot commented Mar 6, 2025 •

edited

Loading

JReinhold Mar 7, 2025

JReinhold Mar 7, 2025

JReinhold Mar 7, 2025

JReinhold Mar 7, 2025

JReinhold Mar 7, 2025

greptile-apps bot left a comment

storybook-pr-benchmarking bot commented Mar 11, 2025 •

edited

Loading

		export const componentTestStatusStore = experimental_getStatusStore(STATUS_TYPE_ID_COMPONENT_TEST);
		export const a11yStatusStore = experimental_getStatusStore(STATUS_TYPE_ID_A11Y);

Core: New Status Store #30764

Are you sure you want to change the base?

Core: New Status Store #30764

Conversation

JReinhold commented Mar 6, 2025 • edited Loading

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

nx-cloud bot commented Mar 6, 2025 • edited Loading

JReinhold Mar 7, 2025

Choose a reason for hiding this comment

JReinhold Mar 7, 2025

Choose a reason for hiding this comment

JReinhold Mar 7, 2025

Choose a reason for hiding this comment

JReinhold Mar 7, 2025

Choose a reason for hiding this comment

JReinhold Mar 7, 2025

Choose a reason for hiding this comment

greptile-apps bot left a comment

Choose a reason for hiding this comment

storybook-pr-benchmarking bot commented Mar 11, 2025 • edited Loading

Package Benchmarks

storybook

@storybook/nextjs

sb

@storybook/cli

@storybook/codemod

JReinhold commented Mar 6, 2025 •

edited

Loading

nx-cloud bot commented Mar 6, 2025 •

edited

Loading

storybook-pr-benchmarking bot commented Mar 11, 2025 •

edited

Loading

`storybook`

`@storybook/nextjs`

`sb`

`@storybook/cli`

`@storybook/codemod`