ruby-grape / grape / 25865878425

97%

master: 97%

Build Type

Pull #2712

github

Committed by ericproulx

Commit Message

Switch error_formatter to keyword arguments; expose status and headers

The error_formatter contract previously took five positional arguments —
`(message, backtrace, options, env, original_exception)` — which made it
impossible to thread additional context through to custom formatters
without breaking every existing override. Switch to keyword arguments and
add two fields that have been asked for in #2527:

    def call(message:, backtrace:, options:, env:,
             status:, headers:, original_exception:)

`status:` makes JSON:API-style error bodies straightforward (the spec
embeds the HTTP status code in the response). `headers:` lets formatters
react to the response content-type or trace the marker headers set by
`error!`. Both were previously only reachable via
`env[Grape::Env::API_ENDPOINT].status` and friends.

This is a contract break — existing custom formatters that re-declare
`call` with the positional signature will need to migrate. See
UPGRADING.md for the before/after.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Pull Request Pull Request #2712: Switch error_formatter to keyword arguments; expose status and headers

Coverage Stats

1076 of 1159 branches covered (92.84%)

Branch coverage included in aggregate %.

21 of 22 new or added lines in 4 files covered. (95.45%)

1 existing line in 1 file now uncovered.

3475 of 3532 relevant lines covered (98.39%)

32072.61 hits per line