Skip to content

Automigrate: Fix missing await #33333

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.

Sign up for GitHub

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

Jump to bottom
Merged
yannbf merged 2 commits into from
Dec 10, 2025
Merged

Automigrate: Fix missing await #33333

yannbf merged 2 commits into from
Dec 10, 2025
+1 −1

Conversation

@valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 10, 2025 •
edited by coderabbitai bot
Loading

Closes #

What I did

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

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-storybook/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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Refactor
    • Improved dependency installation handling during auto-migration to ensure dependencies are fully installed before proceeding with subsequent steps.

✏️ Tip: You can customize this high-level summary in your review settings.

@valentinpalkovic valentinpalkovic self-assigned this Dec 10, 2025
@valentinpalkovic valentinpalkovic added ci:normal bug patch:yes Bugfix & documentation PR that need to be picked to main branch labels Dec 10, 2025
@nx-cloud
Copy link

nx-cloud bot commented Dec 10, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 896a078

Command Status Duration Result
nx run-many -t compile,check,knip,test,pretty-d... ✅ Succeeded 10m 3s View ↗

☁️ Nx Cloud last updated this comment at 2025-12-10 21:41:37 UTC

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 10, 2025

📝 Walkthrough

Walkthrough

The automigrate function now awaits the installation of dependencies asynchronously when fixes are applied and installation is not skipped, rather than calling the installation synchronously.

Changes

Cohort / File(s) Summary
Async dependency installation
code/lib/cli-storybook/src/automigrate/index.ts		 Modified to await installDependencies() instead of calling it synchronously when applied fixes exist and installation is not skipped

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Review the specific lines where the synchronous call was changed to an awaited async call to confirm proper async/await syntax and error handling
✨ Finishing touches
  • 📝 Generate docstrings
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cfe4488 and 4dd9f9f.

📒 Files selected for processing (1)
  • code/lib/cli-storybook/src/automigrate/index.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{js,jsx,json,html,ts,tsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Use ESLint and Prettier configurations that are enforced in the codebase

Files:

  • code/lib/cli-storybook/src/automigrate/index.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Enable TypeScript strict mode

Files:

  • code/lib/cli-storybook/src/automigrate/index.ts
code/**/*.{ts,tsx,js,jsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

code/**/*.{ts,tsx,js,jsx,mjs}: Use server-side logger from 'storybook/internal/node-logger' for Node.js code
Use client-side logger from 'storybook/internal/client-logger' for browser code
Do not use console.log, console.warn, or console.error directly unless in isolated files where importing loggers would significantly increase bundle size

Files:

  • code/lib/cli-storybook/src/automigrate/index.ts
code/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Export functions that need to be tested from their modules

Files:

  • code/lib/cli-storybook/src/automigrate/index.ts
code/**/*.{js,jsx,json,html,ts,tsx,mjs}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

code/**/*.{js,jsx,json,html,ts,tsx,mjs}: Run Prettier with --write flag to format code before committing
Run ESLint with yarn lint:js:cmd to check for linting issues and fix errors before committing

Files:

  • code/lib/cli-storybook/src/automigrate/index.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: nx
  • GitHub Check: nx
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
code/lib/cli-storybook/src/automigrate/index.ts (1)

86-88: Awaiting installDependencies correctly sequences migration side effects

Awaiting the dependency installation here is a good fix: it ensures installs finish before doctor runs or the command exits, and avoids leaving a pending promise from the package manager call.

Please double‑check that JsPackageManager.installDependencies is declared as returning a Promise (or is compatible with being awaited) in your current typings so TypeScript stays happy under strict mode.

Comment @coderabbitai help to get the list of available commands and usage tips.

@yannbf yannbf merged commit b3c3b40 into next Dec 10, 2025
68 checks passed
@yannbf yannbf deleted the valentin/fix-missing-await-for-dependency-install branch December 10, 2025 22:25
This was referenced Dec 10, 2025
Merged
Closed
Open
valentinpalkovic pushed a commit that referenced this pull request Dec 11, 2025
@yannbf @storybook-bot
Merge pull request #33333 from storybookjs/valentin/fix-missing-await…
0f078c4 
…-for-dependency-install

Automigrate: Fix missing await
(cherry picked from commit b3c3b40)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Dec 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yannbf yannbf yannbf approved these changes

Assignees

@valentinpalkovic valentinpalkovic

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@valentinpalkovic @yannbf