Jira Issues List: Improve user-facing error messages when fetch fails
We currently display a generic error message when the Jira Issues List GET fails. This leaves the user confused as to how to proceed.
We should identify the possible/probable errors and craft error messages that can help the user recover.
Please review other issues on the epic &6002 (closed) and Sentry errors.
Approach
-
frontend Update error handling to use server-provided error message (if it exists) -
backend / UX / Technical Writing Improve existing error messages, and identify areas to add new ones
Considerations
@lvanc made an observation in !60455 (comment 568182963):
Looking at the different error messages, I think we should provide constructive advice on how to fix the problem or at least recommend a next step towards a resolution. Nielsen Norman Group provides some good error message guidelines that I think we should leverage.
The error message in the API response is currently An error occurred while requesting data from the Jira service (https://gitlab.com/gitlab-org/gitlab/-/blob/3ac7208/ee/app/controllers/projects/integrations/jira/issues_controller.rb#L117, thrown here: https://gitlab.com/gitlab-org/gitlab/-/blob/3ac7208/ee/app/finders/projects/integrations/jira/issues_finder.rb#L53)
We then display a separate, generic error message to the user that is defined on the frontend: An error occurred while loading issues
