improvement(core): log aborted nodes on dep error #5360
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
thsig
force-pushed
the
improve-error-logs-for-aborted-dependants
branch
from
f7d8051 to
0aeb58d
Compare
When a dependency fails, we now log a line for each aborted node. Also fixed the counting logic used in the command error summary. Before this fix, we used to include aborted nodes in the failed count.
thsig
force-pushed
the
improve-error-logs-for-aborted-dependants
branch
from
0aeb58d to
956d691
Compare
eysi09
reviewed
Nov 7, 2023
| if (!keys.has(depKey)) { | ||
| d.task.log.info({ | ||
| msg: `Aborting because upstream dependency failed.`, | ||
| metadata: metadataForLog(d.task, "error", inputVersion), |
There was a problem hiding this comment.
Not part of this PR per se but we should really try and do away with this metadata field.
I don't think it's really used anywhere and we already have the context field which serves the same purpose.
stefreak
approved these changes
Nov 7, 2023
| ? failedCount | ||
| ? `${failedCount} requested ${taskType} action(s) failed, ${abortedCount} aborted!` | ||
| : `${abortedCount} requested ${taskType} action(s) aborted!` | ||
| : `${failedCount} requested ${taskType} action(s) failed!` |
There was a problem hiding this comment.
This is hard to review due to the cyclomatic complexity of this function; Do we have tests for this error message?
Looking at tests it would be much easier to tell what the error message looks like now.
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.
What this PR does / why we need it:
When a dependency fails, we now log a line for each aborted node.
Also fixed the counting logic used in the command error summary. Before this fix, we used to include aborted nodes in the failed count.
Special notes for your reviewer:
Note that we're no longer copying the error from the failed dependency to all the failed dependants in the command result. This might be seen as a breaking change.
If we'd rather keep the machine-readable command output the same, I can modify the logic to set the error for the aborted dependant keys in the command result.