Problem/Motivation

When #3502161: Drupal.org JSON API modules endpoint returns a 400 error when requested by the Project browser we could see that there was an error with the query. It is great that we could see that there was an error, but the front-end user doesn't probably need to have that much information in the front-end.

Error message

Steps to reproduce

Locally, you can go to src/Plugin/ProjectBrowserSource/DrupalDotOrgJsonApi.php and change this line:
'include' => 'field_module_categories,field_maintenance_status,field_development_status,uid,field_project_images',

to be
'include' => 'field_module_categories,field_maintenance_status,field_development_status,uid,field_project_images,another_non_existent_field',

Then clear the storage and query the front-end again.

Proposed resolution

Only display that there was an error in the front-end and log the full error via the logger service (watchdog or similar).
new message

CommentFileSizeAuthor
#6 Screenshot 2025-01-27 at 10.27.57.png41.06 KBfjgarlin
#2 Screenshot 2025-01-25 at 12.25.27 AM.png204.78 KBfjgarlin

Issue fork project_browser-3502465

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

fjgarlin created an issue. See original summary.

fjgarlin’s picture

fjgarlin commented
Issue summary: View changes
StatusFileSize
new Screenshot 2025-01-25 at 12.25.27 AM.png204.78 KB

fjgarlin opened merge request !685

fjgarlin’s picture

fjgarlin commented
Status: Active » Needs review

This will show up a generic short message to the front-end while still logging the full message via the logger service.
Ready for review.

fjgarlin’s picture

fjgarlin commented
Title: Reduce amount of information relayed on error to the front-end » Reduce the amount of information relayed on error by the DrupalOrgJsonApi plugin to the front-end
fjgarlin’s picture

fjgarlin commented
Issue summary: View changes
StatusFileSize
new Screenshot 2025-01-27 at 10.27.57.png41.06 KB

Proposed message:
new message

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
commented

I think this is a great idea.

I would maybe rephrase the error, though. How about something like:

An error occurred while fetching data from drupal.org. See the error log for details, or report the issue. While this error persists, you can browse the project catalog on drupal.org.

fjgarlin’s picture

fjgarlin commented

Suggestion from #7 about the text applied, except that I didn't offer a link in the words "error log" and that the link to report an issue is against the "drupalorg" project. We can triage the issue from there and move back to PB queue if needed (also, PB might be merged into core at some point so the link would need to change).

fjgarlin credited tim.plunkett.

fjgarlin’s picture

fjgarlin commented
phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
commented
Status: Needs review » Needs work

One further suggestion but otherwise I'm fine with your changes.

fjgarlin’s picture

fjgarlin commented
Status: Needs work » Needs review

Suggestion applied.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
commented
Status: Needs review » Reviewed & tested by the community

Not sure how to manually test this, but I think that this is a much better user experience which doesn't compromise debuggability, since it logs the original error.

fjgarlin’s picture

fjgarlin commented

Easy to test manually via Drupalpod. See the change that I cleaned up in this commit: https://git.drupalcode.org/project/project_browser/-/merge_requests/685/...

If you add that bit, you can see the error message. Just don't commit it (like I did 🙈).

chrisfromredfin made their first commit to this issue’s fork.

chrisfromredfin’s picture

chrisfromredfin
he/him/his
Primary language English
Location Portland, Maine
commented
Status: Reviewed & tested by the community » Fixed

Clean up error messages, always a better UX.

fjgarlin opened merge request !687

fjgarlin’s picture

fjgarlin commented
Status: Fixed » Needs review

Some language nitpicks https://git.drupalcode.org/project/project_browser/-/merge_requests/687/...

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
commented
Status: Needs review » Reviewed & tested by the community

Fine with that.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.