Skip to content

Consistently display error messages from backend  #1943

Closed as not planned
Closed as not planned

Description

@presleyp

As was done in the usersXService, we should go through the frontend and make sure all error messages from the API are being unpacked properly to avoid over-reliance on default error messages, or displaying unhelpful error messages (the error has a less helpful message than the response). getErrorMessage and getFormErrors help with this.

To be done

  • convert this to an epic
  • create issues for each XService

Problem

The frontend does not always display the error messages sent from the backend, and even when it does, it does not display the detail that is sometimes sent along with it.

Definition of done for each ticket

  • There are no uses of displayError in this XService. To replace the error snackbar, render ErrorSummary in the relevant components with the dismissible prop. This way, the user can expand the error detail if desired without the snackbar disappearing on them.
  • There are no uses of getFormHelpers in the relevant components; switch to getFormHelpersWithError even if no error. (We will eventually rename it to replace the original getFormHelpers.)
  • The XService always assigns the API error, rather than a hard-coded error message. If a hard-coded error message is needed as a fallback, send it as a prop to ErrorSummary.
  • Errors are only unpacked in ErrorSummary and getFormHelpersWithError.
  • Storybook has a story for when the error(s) are showing.

Tickets

Activity

  1. self-assigned this
    on Jun 1, 2022
  2. added this to the Community MVP milestone on Jun 2, 2022
  3. self-assigned this
    on Jun 6, 2022
  4. changed the title [-]Error message audit[/-] [+]Consistently display error messages from backend [/+] on Jun 6, 2022
  5. presleyp commented on Jun 8, 2022

    @presleyp
    ContributorAuthor

    I think this should be an epic with one ticket per XService. I'd like to work on it because I already put some thought and code into it, but I don't think it's a high enough priority for pre-launch.

  6. misskniss commented on Jul 19, 2022

    @misskniss

    Deliverable for this sprint would be to create the Epic and shred it into its issues

  7. removed this from the Enterprise MVP milestone on Jul 22, 2022
  8. misskniss commented on Aug 2, 2022

    @misskniss

    Let's pick these off to complete as we get time. These are not high priority but should get attention as we go.

  9. removed their assignment
    on Aug 30, 2022
  10. kylecarbs commented on Sep 23, 2022

    @kylecarbs
    Member

    Seems like this issue is decomposed, so I'm going to close it in favor of the others. They'll still reference this so the context isn't lost.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    siteArea: frontend dashboard

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions