Support exception handling for error handling.

Created on 8 December 2023, 12 months ago
Updated 29 January 2024, 10 months ago

Problem/Motivation

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Component

Code

Created by

🇮🇳India pratik_kamble Pune, India

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

Merge Requests

Comments & Activities

  • Issue created by @pratik_kamble
  • I might pick this up. I'm working on https://www.drupal.org/project/api_client/issues/3376946 and finding a few places where it would be nice to throw and error, but this breaks a lot of the current tests. So instead of gilding that one I will start on this.

    Here are my thoughts on what the API should look like:

    We need to be able to return an error from `fetch`. We can change the return type to a tuple like so:

    async fetch(
        input: RequestInfo | URL,
        init?: RequestInit,
      ): Promise<[Response | null, Error | null]>
    

    This has some advantages and some disadvantages: any time `fetch` is called, the result would need to be a destructured array, and we will have to check if Error is not null. This is similar to Golang's convention which can feel kind of verbose, but does enforce error checking and handling.

    We could also use an object for this but that detail isn't super important to me. The important part is actually returning and not throwing the error from `fetch`, allowing us to throw or handle the error as the end user sees fit.

    Thoughts?

  • 🇮🇳India pratik_kamble Pune, India

    @coby.sher Make sense to me. Considering 5XX will be treated as normal response only.

  • 🇺🇸United States brianperry

    What you outlined makes sense to me as well.

    > The important part is actually returning and not throwing the error from `fetch`, allowing us to throw or handle the error as the end user sees fit.

    Do you have any thoughts on how we'd expose that error handling to users? Anything like what we did for Drupal State: https://project.pages.drupalcode.org/drupal_state/en/error-handling/ or something different?

  • Do you have any thoughts on how we'd expose that error handling to users? Anything like what we did for Drupal State: https://project.pages.drupalcode.org/drupal_state/en/error-handling/ or something different?

    At the moment I figured we'd just throw the error and let the user handle it via try/catch, but we could implement an onError hook. Should that be an enhancement or part of this ticket?

  • 🇺🇸United States brianperry

    > At the moment I figured we'd just throw the error and let the user handle it via try/catch. Meaning, when we call our fetch method internally, if the error exists we will throw it. So we will throw from getResource or getCollection but not fetch itself.

    That makes sense to me.

    > We could implement an onError hook. Should that be an enhancement or part of this ticket?

    Given what you outlined, feels like an enhancement.

  • Merge request !34Update error handling for fetch → (Merged) created by coby.sher
  • Status changed to Needs review 11 months ago
  • Status changed to Needs work 11 months ago
  • Status changed to Needs review 11 months ago
  • Status changed to Fixed 10 months ago
  • 🇺🇸United States brianperry

    Merged to canary and marked as fixed. Thanks!

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

Production build 0.71.5 2024