Improve error message for 'package-registry publish' #6576
Merged
Conversation
This file contains hidden or 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
Motivation: When registry publish fails with client error, the current error message is "Error: failed publishing: invalid registry response status '400', expected '[201, 202]'", which doesn't provide much information on what went wrong. rdar://109410245 Modifications: - Wrap 4xx status response in `RegistryError.clientError` and 5xx in `RegistryError.serverError`. Both errors include response body as details. - Change `package-registry publish` to throw the wrapped `clientError` such that more details (i.e., response body) get displayed.
yim-lee
requested review from
abertelrud,
neonichu,
tomerd and
MaxDesiatov
as code owners
|
@swift-ci please smoke test |
neonichu
approved these changes
May 17, 2023
tomerd
reviewed
May 17, 2023
| "\(packageIdentity) version \(packageVersion) was successfully submitted to \(registryURL) and is being processed. Publishing status is available at '\(statusURL)'." | ||
| ) | ||
| } | ||
| } catch RegistryError.failedPublishing(let error) { |
There was a problem hiding this comment.
not sure about this change - we had cases in the past where we were missing the context and the fact the error is in publishing is material context
There was a problem hiding this comment.
What do you mean? That not all failedPublishing is from failed publishing?
There was a problem hiding this comment.
sorry, I meant this change strips the the "FailedPublishing" context, and the underlying error could be hard to reason about without that context. we had a similar issue in the login flow
There was a problem hiding this comment.
OK, I reverted this part of the change. The introduction of .clientError should be good enough.
yim-lee
force-pushed
the
better-publish-error
branch
from
63b9f7a to
cc3cc1c
Compare
|
@swift-ci please smoke test |
|
@swift-ci please test Windows platform |
tomerd
approved these changes
May 18, 2023
yim-lee
added a commit
to yim-lee/swift-package-manager
that referenced
this pull request
May 18, 2023
* Improve error message for 'package-registry publish' Motivation: When registry publish fails with client error, the current error message is "Error: failed publishing: invalid registry response status '400', expected '[201, 202]'", which doesn't provide much information on what went wrong. rdar://109410245 Modifications: - Wrap 4xx status response in `RegistryError.clientError` and 5xx in `RegistryError.serverError`. Both errors include response body as details. - Change `package-registry publish` to throw the wrapped `clientError` such that more details (i.e., response body) get displayed. * Don't lose failedPublishing context
yim-lee
added a commit
that referenced
this pull request
May 19, 2023
* Improve error message for 'package-registry publish' Motivation: When registry publish fails with client error, the current error message is "Error: failed publishing: invalid registry response status '400', expected '[201, 202]'", which doesn't provide much information on what went wrong. rdar://109410245 Modifications: - Wrap 4xx status response in `RegistryError.clientError` and 5xx in `RegistryError.serverError`. Both errors include response body as details. - Change `package-registry publish` to throw the wrapped `clientError` such that more details (i.e., response body) get displayed. * Don't lose failedPublishing context
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.
Motivation:
When registry publish fails with client error, the current error message is "Error: failed publishing: invalid registry response status '400', expected '[201, 202]'", which doesn't provide much information on what went wrong.
rdar://109410245
Modifications:
RegistryError.clientErrorand 5xx inRegistryError.serverError. Both errors include response body as details.package-registry publishto throw the wrappedclientErrorsuch that more details (i.e., response body) get displayed.