Add a customized GitRepositoryError and funnel all Git operations thr ough a method that throws one of those if the operation fails #2987
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
abertelrud
requested review from
aciidgh,
friedbunny and
neonichu
as code owners
|
@swift-ci please smoke test |
| } | ||
| } | ||
|
|
||
| public func checkout(newBranch: String) throws { | ||
| precondition(isWorkingRepo, "This operation should run in a working repo.") | ||
| precondition(isWorkingRepo, "This operation is only value in a working repository") |
There was a problem hiding this comment.
Did you mean: This operation is only valid in a working repository ?
valid
There was a problem hiding this comment.
Yes indeed I did. I was trying to improve the wording on each of these messages. Thanks for catching it!
federicobucchi
approved these changes
Oct 20, 2020
…ough a method that throws one of those if the operation fails. This makes sure that Git failures clients can distinguish from other Process errors (so failure handling can be customized), and that they all have a location.
abertelrud
force-pushed
the
eng/git-repository-invocation-cleanup
branch
from
852a2e7 to
da6000e
Compare
|
@swift-ci please smoke test |
|
Thanks for reviewing! |
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.
This makes sure that Git failures clients can distinguish from other Process errors (so failure handling can be customized), and that they all have a location. At present the location for an error during a cloning operation is the remote URL, while the operation for an operation on a local clone is the path of the local clone.
We might want to extend this in the future so that local clones also keep track of the URL, but this will require the GitRepository to keep a copy of the associated RepositorySpecifier of its origin remote. This would in turn require a change to the Repository protocol so that all methods take a RepositorySpecificier, and it would require changes to all the clients. So that should be a separate PR, if we do it.
This is a re-opening of a PR (#2958) that was reverted as part of reverting a ToolsSupportCore regression, with the only change being to remove the use of the ToolSupportCore parameter that got reverted. It is not needed for the correct functioning of this PR.