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

fix: [M3-8924] - Storybook optimizeDeps config to improve cold start #11278

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

abailly-akamai
Copy link
Contributor

@abailly-akamai abailly-akamai commented Nov 19, 2024

Description 📝

This PR attempts to config Storybook's optimizeDeps to stabilize the developer experience during the @linode/ui migration. Often time devs are getting dev build errors with cache validation when using storybook locally after components have been migrated, and especially while switching branches.. Clearing cache manually does not always achieve a clean slate, but I have found this config to help and not add friction or performance degradation.

Changes 🔄

  • Add optimizeDeps config to storybook

How to test 🧪

Verification steps

  • Check out this PR and run yarn storybook
    • Confirm no error when storybook opens
    • Confirm no performance degradation

As an Author, before moving this PR from Draft to Open, I confirmed ✅

  • All unit tests are passing
  • TypeScript compilation succeeded without errors
  • Code passes all linting rules

@abailly-akamai abailly-akamai self-assigned this Nov 19, 2024
@abailly-akamai abailly-akamai marked this pull request as ready for review November 19, 2024 03:32
@abailly-akamai abailly-akamai requested a review from a team as a code owner November 19, 2024 03:32
@abailly-akamai abailly-akamai requested review from mjac0bs, bnussman-akamai and hkhalil-akamai and removed request for a team November 19, 2024 03:32
Copy link

Coverage Report:
Base Coverage: 86.88%
Current Coverage: 86.88%

@linode-gh-bot
Copy link
Collaborator

Cloud Manager UI test results

🎉 453 passing tests on test run #3 ↗︎

❌ Failing✅ Passing↪️ Skipped🕐 Duration
0 Failing453 Passing2 Skipped89m 45s

Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

I haven't personally experienced the Storybook issues described in this PR description, likely because I've only run Storybook locally on a few PRs while this migration has been happening.

I did verify that on this branch, yarn storybook loaded Storybook as expected (slowly, but no more slowly than it normally loads for me) and I did not see any error output.

@mjac0bs mjac0bs added the Add'tl Approval Needed Waiting on another approval! label Nov 19, 2024
Copy link
Member

@bnussman-akamai bnussman-akamai left a comment

Choose a reason for hiding this comment

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

Similar to @mjac0bs, I haven't been experience any issues like the ones described. I haven't been running storybook often. Maybe 2 or 3 times per week.

Happy to support this if it helps the workflow of the team!

@bnussman-akamai bnussman-akamai added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! labels Nov 19, 2024
@abailly-akamai abailly-akamai merged commit 255e3ec into linode:develop Nov 19, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Multiple approvals and ready to merge! Storybook
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants