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(core): improve error message when native binaries are not found for a supported platform #17817

Merged
merged 8 commits into from
Jun 29, 2023

Conversation

Cammisuli
Copy link
Member

@Cammisuli Cammisuli commented Jun 27, 2023

Current Behavior

When a platform is supported but native binaries are not found, the error message says that the platform is not supported. Even though it is.

Expected Behavior

A supported platform with missing dependencies will have a clearer message

Related Issue(s)

Related #17767

@Cammisuli Cammisuli requested a review from a team as a code owner June 27, 2023 11:45
@Cammisuli Cammisuli requested a review from AgentEnder June 27, 2023 11:45
@vercel
Copy link

vercel bot commented Jun 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 29, 2023 11:51am

@Cammisuli Cammisuli force-pushed the improve_non_supported_message branch from 42640c5 to dc29ee7 Compare June 27, 2023 11:47
@nx-cloud
Copy link

nx-cloud bot commented Jun 27, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8b64819. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

packages/nx/bin/nx.ts Outdated Show resolved Hide resolved
Copy link
Member

@AgentEnder AgentEnder left a comment

Choose a reason for hiding this comment

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

Small suggestion for a change to keep the initial error as the cause in case it is helpful. Supported in Node 16.9+, but shouldnt cause issues if its present in older versions.

@Cammisuli Cammisuli force-pushed the improve_non_supported_message branch from 121ed14 to 9b082e6 Compare June 28, 2023 11:14
@Cammisuli Cammisuli requested a review from a team as a code owner June 28, 2023 11:14
@Cammisuli Cammisuli requested a review from bcabanes June 28, 2023 11:14
…rtedPlatform

The comments that explained the purpose of the assertSupportedPlatform function were removed as they were deemed unnecessary. The function is self-explanatory and the comments were creating clutter. As part of the change, 'For more information...' line is also added to provide a troubleshooting link to users encountering installation issues.
@Cammisuli Cammisuli force-pushed the improve_non_supported_message branch from 9b082e6 to 33240fc Compare June 28, 2023 14:57
@Cammisuli Cammisuli requested a review from a team as a code owner June 28, 2023 14:57
packages/nx/bin/post-install.ts Show resolved Hide resolved
Comment on lines 31 to 37
Be prepared to give as much detail as possible about your system, we will need the following information at a minimum:

- Operating system
- Operating system version
- CPU Architecture (x64, arm64, etc)
- Node version
- Package manager (npm, yarn, pnpm, etc), it's version and the install command
Copy link
Collaborator

Choose a reason for hiding this comment

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

All of this is available in nx report right? We should tell them to include that rather than listing this out?

@FrozenPandaz FrozenPandaz merged commit fc4b6a8 into nrwl:master Jun 29, 2023
@Cammisuli Cammisuli deleted the improve_non_supported_message branch June 29, 2023 20:24
FrozenPandaz pushed a commit that referenced this pull request Jun 29, 2023
…or a supported platform (#17817)

(cherry picked from commit fc4b6a8)
@github-actions
Copy link

github-actions bot commented Jul 5, 2023

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants