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

UI: Fix sidebar search hanging when selecting a story in touch mode #26807

Merged
merged 8 commits into from
Apr 15, 2024

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Apr 11, 2024

Closes #26755

What I did

  1. Upgraded Downshift (requiring some typing changes since their types got more accurate)
  2. Moved all side-effects from the Downshift state reducer into separate event handlers

The original bug was that selecting a story from search results would cause the browser to hang in an infinite loop but only when in a touch device (or touch emulator using the browsers DevTools). So this also happened in the desktop layout, but it didn't happen when in a no-touch device.

The bug got introduced in 8.0.0-alpha.0 with the new layout engine, so probably something with the changes to the manager API that was conflicting with Downshift's handling of touch events.

Either way, the search combobox had a lot of side-effects in Downshift's stateReducer which is invalid, reducers should always be side-effect-free. Moving those out to their respective event handlers fixed the infinite loop.

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

  1. Open any of the published Storybooks from this PR.
  2. Using DevTools, emulate a mobile touch device
  3. Open the sidebar panel, search for a story and select it
  4. See that it correctly navigates to the story and doesn't hang
  5. Repeat in a desktop layout.

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

Copy link

nx-cloud bot commented Apr 11, 2024

☁️ Nx Cloud Report

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

Sent with 💌 from NxCloud.

@JReinhold JReinhold marked this pull request as ready for review April 11, 2024 11:36
Copy link
Member

@ghengeveld ghengeveld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one. Was able to reproduce and it seems fixed on this PR. QA looks good.

@JReinhold JReinhold added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Apr 15, 2024
@JReinhold JReinhold merged commit e967840 into next Apr 15, 2024
56 of 63 checks passed
@JReinhold JReinhold deleted the jeppe/fix-halt-on-search branch April 15, 2024 13:48
shilman pushed a commit that referenced this pull request Apr 16, 2024
UI: Fix sidebar search hanging when selecting a story in touch mode
(cherry picked from commit e967840)
yannbf pushed a commit that referenced this pull request Apr 19, 2024
UI: Fix sidebar search hanging when selecting a story in touch mode
(cherry picked from commit e967840)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal empathy 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 ui: search
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Mobile ui search breaks into an infinite loop
2 participants