feat: improve error logs #37
Open
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
Contributor
cchanche
commented
Jan 17, 2023
cchanche
commented
- Removed obsolete error log (300d187)
- Add log to suggest checking the jira-token when the jira GET request fails with status code 401 (58d17dd)
cakeinpanic
requested changes
Aug 31, 2023
| @@ -26,7 +26,6 @@ async function run(): Promise<void> { | |||
| const details = await jiraConnector.getTicketDetails(issueKey); | |||
| await githubConnector.updatePrDetails(details); | |||
| } catch (error) { | |||
| console.log('JIRA key was not found'); | |||
There was a problem hiding this comment.
please don't remove this output, it's needed for the case when token is ok, just the jira task not exisitng
There was a problem hiding this comment.
Oh I see, my mistake
| throw new Error(JSON.stringify(error.response, null, 4)); | ||
| if (isAxiosError(error) && error?.response?.status === 401) { | ||
| coreError('Jira request failed, check your jira-token.'); | ||
| coreInfo('Does your jira-token include the required prefix ? See https://github.com/cakeinpanic/jira-description-action#jira-token'); |
cakeinpanic
reviewed
Aug 31, 2023
| @@ -46,8 +48,9 @@ export class JiraConnector { | |||
| }, | |||
| }; | |||
| } catch (error) { | |||
| if (error.response) { | |||
| throw new Error(JSON.stringify(error.response, null, 4)); | |||
| if (isAxiosError(error) && error?.response?.status === 401) { | |||
There was a problem hiding this comment.
I also played with this and could not get a 401, even if I'm having incorrect credentials, I'm getting 404
There was a problem hiding this comment.
That's weird, I am not sure how that used to play out for me though...
Maybe a simple info-log with the error code could do the trick, whatever the type of error
Reverts part of commit 300d187
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.