[TRACKER] More useful error messages

topher-lo commented 3 months ago

NOTE:

For users encountering poor UX related to Tracecat errors, please kindly add your error message to this issue. We aim to have a <24 hour turnover for every insufficiently useful error message.

Problem

We designed the parser from first principles that fits according to parser / complier / arithmetic theory. Therefore existing error messages e.g.

Failed to parse expression: Unexpected end-of-input. Expected one of: \n\t* IF\n\t* OPERATOR\n\t* RPAR\n\t* COMMA\n'

areoften cryptic and do no provide sufficient next steps / information to the user i.e. good for SWEs / development / unit tests but not great for the end user.

Solution

Do an audit of all error messages. Make sure we reraise exceptions with a user friendly explanation of the error.
Make sure every exception comes with concrete next-steps on how to resolve the issue.
Next steps must provide concrete examples, links to docs, references to the UI

bjackson2001 commented 3 months ago

Committing Empty Workflows - Error message on UI reads "Error committing Workflow"

topher-lo commented 3 months ago

^Non-informative error when JSONPath KeyError. For example:

This errored: ${{ ACTIONS.analyze_url.result.data.last_analysis_stats }}
Correct usage: ${{ ACTIONS.analyze_url.result.data.attributes.last_analysis_stats }}

^ missing .attributes

daryllimyt commented 3 months ago

^Non-informative error when JSONPath KeyError. For example:
This errored: ${{ ACTIONS.analyze_url.result.data.last_analysis_stats }}
Correct usage: ${{ ACTIONS.analyze_url.result.data.attributes.last_analysis_stats }}
^ missing .attributes

This issue should be fixed in #353. It's actually a known issue with loguru.

daryllimyt commented 3 months ago

Committing Empty Workflows - Error message on UI reads "Error committing Workflow"

This has also been addressed in a previous PR. Will link if I find it.

TracecatHQ / tracecat