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: handle errors during hasWorkspacePackageJSON function #14394

Conversation

sapphi-red
Copy link
Member

@sapphi-red sapphi-red commented Sep 17, 2023

Description

Found hasWorkspacePackageJSON lacks error handling.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the PR Title Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@sapphi-red sapphi-red added the p3-minor-bug An edge case that only affects very specific usage (priority) label Sep 17, 2023
@stackblitz
Copy link

stackblitz bot commented Sep 17, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@sapphi-red sapphi-red force-pushed the fix/handle-errors-during-search-root-functions branch from 673497f to 2eb7a9c Compare September 17, 2023 12:25
Comment on lines +30 to +35
try {
const content = JSON.parse(fs.readFileSync(path, 'utf-8')) || {}
return !!content.workspaces
} catch {
return false
}
Copy link
Member Author

Choose a reason for hiding this comment

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

fs.readFileSync might throw an error if path is not a file (isFileReadable doesn't check whether path is a file or not).
JSON.parse might throw an error if the content is not a valid JSON.

Copy link
Member

Choose a reason for hiding this comment

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

Could we remove the if (!isFileReadable(path)) { check directly in this case since we can rely on the try catch instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it's better to keep it. isFileReadable will filter the popular case (file doesn't exist) and we can avoid the slow try-catch.
It only affects if the project root is deep, but I think it's worth as this is only three lines of code.

@sapphi-red sapphi-red changed the title fix: handle errors during searchFor* functions fix: handle errors during hasWorkspacePackageJSON function Sep 17, 2023
@sapphi-red sapphi-red merged commit c3e4791 into vitejs:main Sep 18, 2023
12 checks passed
@sapphi-red sapphi-red deleted the fix/handle-errors-during-search-root-functions branch September 18, 2023 09:09
@bluwy bluwy mentioned this pull request Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p3-minor-bug An edge case that only affects very specific usage (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants