Skip to content

adds object of useful error when widget fails to render #5141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ValJed merged 4 commits into from
Nov 18, 2025
Merged

adds object of useful error when widget fails to render #5141

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6bc44d
adds object of useful error when widget fails to render
ValJed Nov 5, 2025
0e8fe9b
feedback: logs object with info AND the original error
ValJed Nov 13, 2025
cf15e0c
adds changelog
ValJed Nov 13, 2025
aff1df8
feedback: checks that body exist in error
ValJed Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
### Changes

* Bump nodemailer to v7.x.
* Improves client error log when unable to render a widget.

### Fixes

Expand Down
9 changes: 8 additions & 1 deletion modules/@apostrophecms/widget-type/ui/apos/composables/AposWidget.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,15 @@ export async function _renderContent(props) {
}
return {};
} catch (e) {
const errData = {
widgetTitle: widget.title,
widgetType: props.type,
documentId: props.docId,
errors: e.body.data?.errors || []

@ValJed ValJed Nov 13, 2025

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.

Could name it fieldErrors maybe ?

@haroun haroun Nov 14, 2025

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.

Sorry I missed it the first time. I don't think we can be absolutely sure that e.body will be an object. I'll do e.body?.data?.errors instead

@boutell boutell Nov 14, 2025

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.

Agree.

@ValJed ValJed Nov 18, 2025

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.

Good point, done.

};

// eslint-disable-next-line no-console
console.error('Unable to render widget. Possibly the schema has been changed and the existing widget does not pass validation.', e);
console.error('Unable to render widget', errData, e);
return {
data: '<p>Unable to render this widget.</p>',
error: true
Expand Down