Add a "Debug" (email report) tab to Workflow Invocations

[ahmedhamidawan]

Fixes #20569

NOTE: The tab has been renamed to Debug instead of Feedback

add_error_tab_in_invocation_view.mp4

• Adds a new tab for reporting any issues with invocations.
• Finds and shows steps with failed jobs, and workflow invocation message(s) if they exist.
• Adds a reusable EmailReportForm component which shows the user's email and has a text field. It requires a submit method as prop which it waits for to show any response messages.
• Makes sure this reusable email component only allows the current user to email reports related to their own jobs/invocations. Decided against this because in the past we have even allowed anon reports. Although, added a conditional which in the case of invocation reports enforces log in at the very least.
• Adds a backend endpoint for POST /api/invocations/{invocation_id}/error

How to test the changes?

(Select all options that apply)

• I've included appropriate automated tests.
• This is a refactoring of components with existing test coverage.
• Instructions for manual testing are as follows:
  1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

• I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

[mvdbeek]

• Uses store to cache step jobs summary: no need to fetch it over and over if an invocation is terminal.

Can you open a separate PR for this please ?

[ahmedhamidawan]

One of the changes made here is that error reporting can only be done by the user who ran the job or invocation. So, this affects the existing bug reporting for jobs/datasets as well where the form is not rendered if you're looking at another user's public failed dataset like so:

Before	After

This makes sense, right? Especially when it comes to reporting problems for invocations (only the user who owns the history and ran the workflow can report feedback)?

Note:

I do see that (before my changes) in case a different user (or even an anonymous user) reported a job error, we would see the following in the email:

(here, test is the reporting user, and ahmedawan7 is the original job running user)

[ahmedhamidawan]

One of the changes made here is that error reporting can only be done by the user who ran the job or inv...

About this ^

I now see #5791

So we are okay with anon (and hence, I'll assume also different) users making these reports.

I'll revert that change then, and allow anyone to make these reports, regardless of who ran the job/workflow.

UPDATE: I've gone ahead and done that; removed a few commits, bug reporting for dataset/job errors remains unchanged. Although, added a conditional which in the case of invocation reports enforces log in at the very least.

[ahmedhamidawan]

• Change tab name from Feedback to Debug.

@jmchilton , I reckon I should still keep the component name as WorkflowInvocationFeedback, since the user/researcher is submitting "feedback" on an invocation that has an error. The invocation debugging feature you have planned could go into a parent component (set of components etc.).

[jmchilton]

#20735 this is my dream for next steps.