ruby-grape / grape / 25569862791

97%

master: 97%

Build Type

Pull #2703

github

Committed by ericproulx

Commit Message

Catch and route exceptions raised inside rescue_from blocks

Resolves #2482. Today, an exception raised inside a `rescue_from`
block bubbles up uncaught and produces the Rack default 500 page,
which means deliberate re-raises (a common pattern for translating
one exception class into another) don't compose with the rest of a
user's `rescue_from` configuration, and accidental crashes inside a
handler are not framed as Grape responses.

The middleware now wraps the user's handler invocation with a
StandardError rescue and, on raise, routes the new exception through
one of three paths:

  1. If the re-raised exception's class has a registered `rescue_from`
     handler, run it (with `redispatched: true` so a second raise stops
     the chain — bounded at one redispatch to prevent loops).
  2. If the re-raised exception is a `Grape::Exceptions::Base` subclass,
     render it via the default Grape error path with its own `status`
     and `message`. Inheritance signals the message is part of the API
     contract.
  3. Otherwise, fall through to `safe_default`: log the original
     exception via the API's logger, expose it on
     `env['grape.exception']` for upstream Rack middleware to observe,
     and render `Grape::Exceptions::InternalServerError` (status 500,
     generic message). The original exception's message is never
     surfaced to the API consumer in this branch.

Also adds:
  - `Grape::Exceptions::InternalServerError` — i18n-backed safe stand-in.
  - `Grape::Env::GRAPE_EXCEPTION` — env key carrying the original.
  - `oneof: 'does not match...'` removed (was on a different branch).

Existing behaviour preserved when the handler returns a non-Response
non-error value (still produces `InvalidResponse` via the default
handler).

UPGRADING note + README rescue_from section updated to document the
new behaviour and the registered-handler escape hatch for users who
want raw exception messages exposed (e.g. development mode).

Co-Authored-By: Claud... (continued)

Pull Request Pull Request #2703: Catch exceptions raised inside rescue_from blocks (#2482)

Coverage Stats

1090 of 1179 branches covered (92.45%)

Branch coverage included in aggregate %.

38 of 39 new or added lines in 4 files covered. (97.44%)

3 existing lines in 2 files now uncovered.

3435 of 3492 relevant lines covered (98.37%)

32029.99 hits per line