Core: Only render once when changing args while loading/rendering

[JReinhold]

Telescopes on top of #26753

Works on #26637

What I did

Changed the rerendering logic to enqueue rerenders if a render is already loading/rendering/playing instead of immediately triggering a rerender while it is already rendering. Having multiple renders run simlutanously would cause side-effectful loaders to interfere with each other. AFAIK this only fixes problems if any of the steps in the flow has side-effects.

Enqueueing rerenders means that it won't immediately rerender, it will rerender when the current running render is done. It will also only put one rerender in the queue even if rerender is triggered 10 times during a running render.

Also added e2e tests that covers the changes made here and in #26735 and #26753. They depend a bit on timing so they could end up being too flaky for us to use. Let's try and see.

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

Covered by E2E tests.

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/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>

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit db09f63. 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 2 targets

• nx affected -t check -c production --parallel=7
• nx run-many -t build -c production --parallel=3

---

Sent with 💌 from NxCloud.

[tmeasday]

Nice. I like how simple it is! One minor nit.

[kasperpeulen]

LGTM