Skip to content

fix(scripts): add error handling to verify-treeshaking script #13192

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

listar
Copy link

@listar listar commented Apr 12, 2025

This PR adds basic error handling to the verify-treeshaking.js script to ensure build failures are properly caught and reported.

Summary by CodeRabbit

  • Chores
    • Improved error handling in the build verification process for treeshaking issues. Errors are now logged more clearly, and the process exits with a failure code if problems are detected.

@edison1105 edison1105 added ready to merge The PR is ready to be merged. 🧹 p1-chore Priority 1: this doesn't change code behavior. labels Apr 14, 2025
Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 100 kB 38.1 kB 34.4 kB
vue.global.prod.js 158 kB 58.3 kB 51.9 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.4 kB 18.1 kB 16.6 kB
createApp 54.4 kB 21.2 kB 19.4 kB
createSSRApp 58.6 kB 22.9 kB 20.9 kB
defineCustomElement 59.2 kB 22.7 kB 20.7 kB
overall 68.5 kB 26.3 kB 24 kB

Copy link

coderabbitai bot commented May 13, 2025

Walkthrough

The script for verifying treeshaking was reformatted to use a multi-line promise chain with explicit .then() and .catch() blocks. This restructuring adds explicit error logging and process termination on failure, but does not alter the underlying logic or the conditions being checked.

Changes

File(s) Change Summary
scripts/verify-treeshaking.js Reformatted promise chain to multi-line with explicit .catch() for error handling and process exit.

Poem

In the land of scripts, a chain grew long,
Promises lined up, sturdy and strong.
Now with a catch, no error slips by—
If treeshaking fails, the script waves goodbye!
With logs and exits, it keeps things neat,
This bunny’s code is hard to beat. 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
scripts/verify-treeshaking.js (1)

45-49: Consider including file paths in error messages.

While the error throwing logic works correctly, it could be improved by including the paths of the files that were checked in the error message. This would make it easier to debug issues, especially for new contributors.

  if (errors.length) {
    throw new Error(
-     `Found the following treeshaking errors:\n\n- ${errors.join('\n\n- ')}`,
+     `Found the following treeshaking errors in packages/vue/dist/vue.runtime.global.js and packages/vue/dist/vue.runtime.global.prod.js:\n\n- ${errors.join('\n\n- ')}`,
    )
  }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7dad6d and 714f35f.

📒 Files selected for processing (1)
  • scripts/verify-treeshaking.js (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
scripts/verify-treeshaking.js (2)
scripts/utils.js (1)
  • exec (64-114)
packages/compiler-sfc/src/script/context.ts (1)
  • error (153-157)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
🔇 Additional comments (2)
scripts/verify-treeshaking.js (2)

5-6: Good improvement to error handling!

The restructuring of this script to use a proper Promise chain with .then() and .catch() blocks adds essential error handling that was missing before. This will properly catch and report failures during the build process, improving the developer experience.

Also applies to: 50-54


51-54: Clear error reporting and process termination.

The error handling implementation follows best practices:

  • Descriptive error message that includes the original error details
  • Process exits with code 1 to signal failure to CI/CD systems

This will help developers quickly identify and fix issues when the treeshaking verification fails.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧹 p1-chore Priority 1: this doesn't change code behavior. ready to merge The PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants