Skip to content

Conversation

@THWiseman
Copy link
Contributor

@THWiseman THWiseman commented Jun 13, 2024

Description

When Cromwell restarts during a failure, it must fail the 'next' upcoming tasks in order to cleanly terminate the workflow. During this process, it was logging an error that isn't really an error (and was very confusing to users).

This PR:

  • Changes the failure reason to something more relevant.
  • Removes the failure reason from the 'Workflow' level failures, since it was not the reason the workflow failed. The failure reason is still attached to the task that never ran.

Release Notes Confirmation

CHANGELOG.md

  • I updated CHANGELOG.md in this PR
  • I assert that this change shouldn't be included in CHANGELOG.md because it doesn't impact community users

Terra Release Notes

  • I added a suggested release notes entry in this Jira ticket
  • I assert that this change doesn't need Jira release notes because it doesn't impact Terra users

@THWiseman THWiseman requested a review from a team as a code owner June 13, 2024 14:59
@THWiseman THWiseman changed the title Remove Confusing Error Message [WX-1361] Remove Confusing Error Message Jun 13, 2024
Copy link
Collaborator

@aednichols aednichols left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work finding a concise solution!

Co-authored-by: Adam Nichols <anichols@broadinstitute.org>
Copy link
Collaborator

@jgainerdewar jgainerdewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job finding such a small and tidy solution!

returnCode: Option[Int] = None,
jobExecutionMap: JobExecutionMap = Map.empty
jobExecutionMap: JobExecutionMap = Map.empty,
omitFromWorkflowLevelFailures: Boolean = false
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick that you can feel free to ignore if you disagree - IMO boolean arguments where true represents negation require readers to think too hard. I think it's easier to understand if it's includeInWorkflowLevelFailures: Boolean = true.

@THWiseman THWiseman enabled auto-merge (squash) June 17, 2024 21:04
@THWiseman THWiseman merged commit e6c1d3c into develop Jun 17, 2024
@THWiseman THWiseman deleted the WX-1361 branch June 17, 2024 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants