Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-6396

Throw more human readable error messages instead of uninformative exceptions

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Neutral Neutral
    • None
    • None
    • None
    • None
    • Human readable errors

      Current situation

      In many situations, the user is faced with exceptions with little additional information. They do not know what caused a problem, they do not know what information to pass on to the administrator and the situation is quite unprofessional sometimes with stack traces in a foreign language. See example steps to reproduce below.

      Desired situation

      In this old page there was this agreement, without associated Jira ticket

      Exceptions/Stack traces in error messages & whoops page

      • We want to get rid of exception names and stack traces. They are not user-friendly, but admin-friendly at best
        • We want to point to the server logs for more details.
        • We have to carry either an error code or timestamp that the normal user can forward to the admin
      • We want more human-readable error messages
        • e.g. convention for i18n keys for exception types (already done for login screen!)

      Another thing to consider is to throw custom Magnolia Exceptions so we can distinguish exceptions that we know hold the information we want to show to the user eventually (localized)

      Example Steps to reproduce

      Go to JCR Browser and attempt to export any contact.

      Actual result

      Red banner ** is shown with message "An error occurred while executing an action." with description "Action execution failed for action: export"

      Expected result

      A popup, notification, or error banner with a meaningful user-facing maybe even translated message that helps the user understand the problem and point him to a solution or to whom they should turn with questions.

        Acceptance criteria

              Unassigned Unassigned
              sdemocko Šimon Demočko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: