feat: throw new CommitError if an API error occurs during commit process #434
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
chingor13
force-pushed
the
commit-error
branch
from
a8f38ab
to
43b5626
Compare
bcoe
approved these changes
Jan 5, 2023
| cause: Error; | ||
| constructor(message: string, cause: Error) { | ||
| super(message); | ||
| this.cause = cause; |
There was a problem hiding this comment.
The purpose of this is to wrap the original error, so someone catching it upstream can get at the original underlying issue?
| logger.info(`Successfully created commit. See commit at ${url}`); | ||
| return sha; | ||
| } catch (e) { | ||
| throw new CommitError(`Error creating commit for: ${treeSha}`, e as Error); |
There was a problem hiding this comment.
It's annoying that TypeScript doesn't type the argument passed to catch, I wish this as could be avoided -- one option would be:
if (e instanceof Error) {
throw new CommitError(...);
} else {
throw e;
}
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.
Towards googleapis/repo-automation-bots#4537
This will allow us to handle this particular class of errors (likely log a warning and ignore). It's easier for us to classify these errors as we throw them rather than trying to get the caller to distinguish which portion of the call to
createPullRequestfailed.