Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] Bubble errors up from workflows (or document how to debug errors) #581

Open
lilyminium opened this issue Oct 9, 2024 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@lilyminium
Copy link
Contributor

lilyminium commented Oct 9, 2024

Is your feature request related to a problem? Please describe.

When something goes wrong, an exception is raised in a workflow protocol and a WorkflowException is given in two ways:

  • in the protocol output JSON saved in the working directory, which typically has an informative message
  • returned to the EvaluatorClient as a "WorkflowException(None)"

This latter message is fairly unhelpful and confusing, especially to new users. This is especially the case since the default EvaluatorServer sets delete_working_files=True, which means that when the server stops due to an error happening, all the working data with the complete error message is also deleted.

Describe the solution you'd like

It would be great if the workflow exception message in the protocol could somehow bubble back up to the client.

Describe alternatives you've considered

Additional context

How I debug: I navigate to the working-directory/SimulationLayer/<run-hash>, less all the */*.json files, and go through them one-by-one until I hit the error.

@lilyminium lilyminium added enhancement New feature or request priority-low and removed priority-low labels Oct 9, 2024
@mattwthompson mattwthompson added the good first issue Good for newcomers label Oct 16, 2024
@mattwthompson
Copy link
Member

Sounds like a good idea to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants