Contrib.social

JSON and other serialization formats now handle non-4xx exceptions

Open on Drupal.org →
Created on 21 August 2022, over 2 years ago
Updated 15 June 2024, 5 months ago

Problem/Motivation

Despite claims to the contrary in various code snippets in the exception handling system, non-HTML requests to Drupal aren't that rare, anymore. Modules such as JSON-RPC and Simple OAuth work almost entirely over a JSON, for instance, but exceptions thrown while handling their routes many times come back as HTML.

I am working on getting exceptions thrown during Simple OAuth's processing (e.g., with an extension grant type) and even after adding a default _format: 'json' notation in the route's requirements, I still get HTML error pages.

This is because ExceptionJsonSubscriber and Serialization module's DefaultExceptionSubscriber (which overrides the former, if the module is enabled) both only explicitly handle 4xx.

JSON:API has its own DefaultExceptionSubscriber implementation which does also handle 5xx. I propose extracting this logic to the above two other handlers, so we can get mostly automatic exception handling on non-HTML routes.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

📌 Task
Status

Needs work

Version

11.0 🔥

Component
Base  →

Last updated 22 minutes ago

Created by

🇺🇸United States bradjones1 Digital Nomad Life

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Status changed to Needs review 6 months ago
  • Comment 6 months ago →
    🇺🇸United States bradjones1 Digital Nomad Life

    Rebased and cleaned up for 11.x. I think this could be considered a bug, or a task, but definitely a DX improvement for decoupled environments.

  • Status changed to RTBC 6 months ago
  • Comment 6 months ago →
    🇳🇱Netherlands bbrala Netherlands

    It looks good, tests are available so removing tag.

    Added a changerecord, since that was still needed.

    This chnage is awesome, and upping the game a little more for API users.

  • Comment 6 months ago →
    🇳🇿New Zealand quietone
  • Status changed to Needs work 6 months ago
  • Comment 6 months ago →
    needs-review-queue-bot

    The Needs Review Queue Bot → tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

    This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

    Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

  • Status changed to RTBC 6 months ago
  • Comment 6 months ago →
    🇺🇸United States bradjones1 Digital Nomad Life

    Coding standards bumped, keeping RTBC.

  • Status changed to Needs work 5 months ago
  • Comment 5 months ago →
    🇬🇧United Kingdom alexpott 🇪🇺🌍

    Added a couple of comments to the MR.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024