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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core-Server: Ignore all node_module folders for watchpack #24553

Merged

Conversation

valentinpalkovic
Copy link
Contributor

Closes #23696

What I did

The current default configuration for watchpack in the core-server package only excludes root-level node_modules folders (see here) which will cause way to many watcher instances being opend in monorepository structures.

Adjusting the glob pattern allows the exclusion of all node_modules.

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

Not that easy to test. Follow the test instructions in the linked issue:

  1. Create a monorepository with node_modules folder in sub directories.
  2. Start storybook dev with a breakpoint in the watchEventSource.js file https://github.com/webpack/watchpack/blob/main/lib/watchEventSource.js#L66 and verify that node_modules files are not being watched.

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>

@valentinpalkovic valentinpalkovic merged commit 58b6b0a into next Oct 23, 2023
53 of 59 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/ignore-all-node_modules-in-watchpack branch October 23, 2023 16:27
@valentinpalkovic valentinpalkovic changed the title Core-Server: Ingore all node_module folders for watchpack Core-Server: Ignore all node_module folders for watchpack Oct 23, 2023
@tmeasday
Copy link
Member

Oh! This may explain why I saw that it was faster to build SB from a subdirectory of a large monorepo than from the root. cc @kasperpeulen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Watchpack "ignored" configuration causes to many watchers in larger projects and blocks startup
3 participants