feat: better error when package is not found #5213
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arcanis
requested changes
Jan 15, 2018
src/errors.js
Outdated
| @@ -4,9 +4,11 @@ export class MessageError extends Error { | |||
| constructor(msg: string, code?: string) { | |||
| super(msg); | |||
| this.code = code; | |||
| this.isMessageError = true; | |||
There was a problem hiding this comment.
Can we use an instanceof check instead?
There was a problem hiding this comment.
Yeah I was thinking about using instanceof, but what if subclasses of MessageError are thrown? Should I check for all of them or only MessageError?
There was a problem hiding this comment.
Only MessageError is fine. If they're subclass, the instanceof will work as expected and will return true, even if they are from a derived class.
GAumala
force-pushed
the
not-found-error
branch
from
be4a0bd to
198c5ea
Compare
When a package is not found during installation, show which package is requiring it (if any) in the error message. If there is no parent request, throw the same error as before. Add new localized string 'requiredPackageNotFoundRegistry' which is the same 'packageNotFoundRegistry', but includes the parent package pattern.
|
This change will increase the build size from 10.4 MB to 10.4 MB, an increase of 2.06 KB (0%)
|
arcanis
approved these changes
Jan 29, 2018
|
Thanks! |
agoldis
added a commit
to agoldis/yarn
that referenced
this pull request
Feb 2, 2018
…readdir_files * upstream/master: (34 commits) feat(upgrade, add): Separately log added/upgraded dependencies (yarnpkg#5227) feat(publish): Publish command uses publishConfig.access in package.json (yarnpkg#5290) fix(CLI): Use process exit instead of exitCode for node < 4 (yarnpkg#5291) feat(cli): error on missing workspace directory (yarnpkg#5206) (yarnpkg#5222) feat: better error when package is not found (yarnpkg#5213) Allow scoped package as alias source (yarnpkg#5229) fix(cli): Use correct directory for upgrade-interactive (yarnpkg#5272) nohoist baseline implementation (yarnpkg#4979) 1.4.1 1.4.0 Show current version, when new version is not supplied on "yarn publish" (yarnpkg#4947) fix(install): use node-gyp from homebrew npm (yarnpkg#4994) Fix transient symlinks overriding direct ones v2 (yarnpkg#5016) fix(auth): Fixes authentication conditions and logic with registries (yarnpkg#5216) chore(package): move devDeps to appropriate place (yarnpkg#5166) fix(resolution) Eliminate "missing peerDep" warning when dep exists at root level. (yarnpkg#5088) fix(cli): improve guessing of package names that contain a dot (yarnpkg#5102) (yarnpkg#5135) feat(cli): include notice with license when generating disclaimer (yarnpkg#5072) (yarnpkg#5111) feat(cli): group by license in licenses list (yarnpkg#5074) (yarnpkg#5110) feat(cli): improve error message when file resolver can't find file (yarnpkg#5134) (yarnpkg#5145) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
When a package is not found during installation, show which package is requiring it (if any) in the
error message. If there is no parent request, throw the same error as before.
Add new localized string 'requiredPackageNotFoundRegistry' which is the same 'packageNotFoundRegistry', but includes the parent package pattern.
Add isMessageError boolean value to MessageError class to distinguish
between errors thrown by yarn from errors thrown by yarn dependencies.
Test plan
Use a workspace with at least 2 packages
fooandbar.bardepends onfoo. If you manually bump the package version offoo, running the install command will fail because the npm registry doesn't have the latestfooversion that was just created.Error shown (Before)
Error shown (After)
To implement this I decided to put a try catch statement in
PackageRequest'sfindVersionOnRegistrymethod. I think the error is actually thrown by therequestmodule but I decided to catch the error here because I still have access to the reference to the parent request. I didn't want to hide anyMessageErrorerrors that may be thrown in the underlying function so I added aisMessageErrorattribute to that class so that I can identify such errors.Please let me know if there is a better way to implement this feature.