Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manager: Fix useAddonState when using a setter function #24237

Merged
merged 3 commits into from
Sep 20, 2023

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Sep 20, 2023

Closes #23787

What I did

The useAddonState hook allows for a setter function.
This setter function takes the existing value, and returns a new value.
However due to a race condition due to the way we set the default state (without an sync re-render) this default state can be set in the state too late.

By globalizing the addonCache and retreiving the value form the cache instead of state when api.getAddonState is called we ensure the correct value is always set.

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

The issue here: #23787
... has a repro to reproduce the issue with.

  • create a repro out of the download (follow some extra steps)
  • build storybook in the monorepo
  • copy code/ui/manager/dist to the node_modules/@storybook/manager/dist directory
  • run the storybook in the repro

expect that the storybook functions correctly

  • click the primary button manually
  • refresh the page
  • do it again
  • open the interactions tab
  • press the button manually
  • refresh the page

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>

@ndelangen ndelangen changed the title fix a bug in useAddonState when using a setter function Manager: Fix useAddonState when using a setter function Sep 20, 2023
@ndelangen ndelangen self-assigned this Sep 20, 2023
@ndelangen ndelangen added bug patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Sep 20, 2023
@ndelangen ndelangen merged commit ec0aaba into next Sep 20, 2023
14 of 15 checks passed
@ndelangen ndelangen deleted the norbert/use-addon-state-bug branch September 20, 2023 14:45
storybook-bot pushed a commit that referenced this pull request Sep 20, 2023
Manager: Fix useAddonState when using a setter function
(cherry picked from commit ec0aaba)
@github-actions github-actions bot mentioned this pull request Sep 20, 2023
4 tasks
storybook-bot pushed a commit that referenced this pull request Sep 20, 2023
Manager: Fix useAddonState when using a setter function
(cherry picked from commit ec0aaba)
storybook-bot pushed a commit that referenced this pull request Sep 22, 2023
Manager: Fix useAddonState when using a setter function
(cherry picked from commit ec0aaba)
storybook-bot pushed a commit that referenced this pull request Sep 22, 2023
Manager: Fix useAddonState when using a setter function
(cherry picked from commit ec0aaba)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Sep 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: TypeError: Cannot read properties of undefined (reading 'count') with onClick action
1 participant