perf(nuxt): defer version/config checks to after vite build by danielroe · Pull Request #30567 · nuxt/nuxt

danielroe · 2025-01-13T14:43:30Z

🔗 Linked issue

📚 Description

this slightly improves Nuxt startup performance by deferring the start of these checks until after a successful vite build.

(they were already non-blocking but might have contended for fs access)

bolt-new-by-stackblitz · 2025-01-13T14:43:35Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-01-13T14:55:08Z

Walkthrough

The pull request introduces modifications to error handling and control flow in two core Nuxt files: builder.ts and nuxt.ts. In builder.ts, the function checkForExternalConfigurationFiles() is now conditionally executed only when nuxt.options.dev is true and nuxt.options.test is false, and it is wrapped in a hook that triggers after the build process completes. Additionally, error handling has been added to log warnings without interrupting the build flow.

In nuxt.ts, the visibility of the keyDependencies variable has been changed to exported, and the logic for checking dependency versions has been updated to occur after the build process, using the build:done hook. The checkDependencyVersion function has also been exported.

The changes enhance the testing coverage by introducing a new test suite for dependency version checks while removing an outdated test suite that previously handled dependency mismatches.

📜 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 45e7ce4 and 23f2fdb.

📒 Files selected for processing (4)

packages/nuxt/src/core/builder.ts (1 hunks)
packages/nuxt/src/core/nuxt.ts (3 hunks)
packages/nuxt/test/check-dependencies.test.ts (1 hunks)
packages/nuxt/test/load-nuxt.test.ts (0 hunks)

💤 Files with no reviewable changes (1)

packages/nuxt/test/load-nuxt.test.ts

🚧 Files skipped from review as they are similar to previous changes (1)

packages/nuxt/src/core/builder.ts

🔇 Additional comments (7)

packages/nuxt/test/check-dependencies.test.ts (4)

7-11: LGTM! Good practice using vi.stubGlobal for console.

The console stub implementation preserves the original methods while allowing for spying on them.

13-19: LGTM! Clean mock implementation of readPackageJSON.

The mock preserves original functionality while allowing for controlled testing scenarios.

25-40: LGTM! Well-structured test for dependency version mismatch.

The test effectively verifies that warnings are logged for mismatched versions, with clear expectations and cleanup.

41-62: LGTM! Good use of parameterized testing.

The test efficiently covers both lower version and matching version scenarios using it.sequential.each.

packages/nuxt/src/core/nuxt.ts (3)

84-87: LGTM! Clear declaration of key dependencies to check.

The array is now exported to enable testing and reuse.

805-811: LGTM! Good implementation of deferred version checks.

The version checks are now:

Deferred until after build completion

Only run in development mode

Skipped in test mode

Include proper error handling

Line range hint 830-838: LGTM! Well-implemented version check function.

The function includes:

Proper path resolution with fallback

Null checks

Clear warning message for version mismatches

Finishing Touches

📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-01-13T15:21:02Z

Open in Stackblitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@30567

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@30567

nuxt

npm i https://pkg.pr.new/nuxt@30567

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@30567

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@30567

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@30567

commit: 23f2fdb

perf(nuxt): defer version/config checks to after vite build

45e7ce4

github-actions Bot added 3.x ⚡ performance Performance degradation or optimization opportunity labels Jan 13, 2025

danielroe added 2 commits January 14, 2025 10:00

test: update test

c78811b

Merge remote-tracking branch 'origin/main' into perf/defer-checkes

23f2fdb

danielroe merged commit 50ebb8b into main Jan 14, 2025

danielroe deleted the perf/defer-checkes branch January 14, 2025 10:43

github-actions Bot mentioned this pull request Jan 14, 2025

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request Jan 14, 2025

perf(nuxt): defer version/config warnings to after build (#30567)

77d34f7

github-actions Bot mentioned this pull request Jan 14, 2025

v3.15.2 #30470

Merged

Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025

perf(nuxt): defer version/config warnings to after build (nuxt#30567)

4accc44

Navigation Menu

Uh oh!

Uh oh!

perf(nuxt): defer version/config checks to after vite build - #30567

perf(nuxt): defer version/config checks to after vite build#30567
danielroe merged 3 commits into
mainfrom
perf/defer-checkes

danielroe commented Jan 13, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz Bot commented Jan 13, 2025

Uh oh!

coderabbitai Bot commented Jan 13, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Jan 13, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

danielroe commented Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz Bot commented Jan 13, 2025

Uh oh!

coderabbitai Bot commented Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

danielroe commented Jan 13, 2025 •

edited

Loading

coderabbitai Bot commented Jan 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new Bot commented Jan 13, 2025 •

edited

Loading