Skip to content

docs: Document Widget error handling on the Dashboard#803

Closed
promptless-for-oss wants to merge 8 commits into
mautic:7.1from
Promptless:promptless/dashboard-widget-errors
Closed

docs: Document Widget error handling on the Dashboard#803
promptless-for-oss wants to merge 8 commits into
mautic:7.1from
Promptless:promptless/dashboard-widget-errors

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Documents the graceful degradation behavior when a Widget encounters an error, based on the bug fix in PR #15989.

Changes

docs/dashboard/dashboard.rst

  • New section: Widget error handling - Documents that:
    • Failing Widgets display an error message while other Widgets continue to load normally
    • This prevents a single failing Widget from blocking access to the entire Dashboard
    • The error may be temporary and resolve on its own
    • Administrators can check server logs for technical details about failures

Context

PR #15989 fixes a bug where a single Widget exception would crash the entire Dashboard with a 500 error. The Dashboard is the default landing page, so this could make the UI completely inaccessible. Now Widget errors are caught, logged server-side, and the failing Widget shows a generic translatable error message while other Widgets continue rendering normally.

Trigger Events


Tip: Request one-off documentation tasks in the Dashboard under New Task 🚀


Widget error handling
*********************

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documented Widget error handling behavior from PR #15989 which wraps widget content generation in DashboardModel::populateWidgetContent() with try/catch to display generic error messages on failing widgets while other widgets continue loading.

Source: mautic/mautic#15989

@adiati98 adiati98 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@promptless-for-oss please address the suggestions.

Comment thread docs/dashboard/dashboard.rst
Comment thread docs/dashboard/dashboard.rst Outdated
Comment thread docs/dashboard/dashboard.rst Outdated
- Wrap the intro paragraph in .. vale off / .. vale on per maintainer suggestion
- Change 'check' to 'review' to satisfy [Google.WordList]
- Wrap the note paragraph in .. vale off / .. vale on per maintainer suggestion
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @adiati98! I've applied all three suggestions:

  • Wrapped the intro paragraph in .. vale off / .. vale on.
  • Addressed the [Google.WordList] warning by changing "check the server logs" to "review the server logs" (this line is outside the vale-off block, so it still needed the fix).
  • Wrapped the .. note:: paragraph in .. vale off / .. vale on.

Vale now passes with 0 errors and 0 warnings on the file. Pushed to the branch.

@adiati98 adiati98 requested a review from escopecz July 10, 2026 09:27

@escopecz escopecz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd close this. The PR improves error handling. That's nothing a user needs to know. It just works.

@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @escopecz — agreed. Closing this.

The Widget error-handling improvement is transparent to users: a failing Widget shows a generic message while the rest of the Dashboard keeps loading, with details logged server-side. There's no new workflow, configuration, or action for users, and the previous crash behavior was never documented — so there's nothing docs need to cover here.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants