PSR-15 middleware to use Whoops as error handler

Middlewares

Last update: Jun 23, 2022

Related tags

API http middleware error-handling psr-15 whoops

Overview

middlewares/whoops

Middleware to use Whoops as error handler.

Requirements

Installation

This package is installable and autoloadable via Composer as middlewares/whoops.

composer require middlewares/whoops

Example

$dispatcher = new Dispatcher([
    new Middlewares\Whoops()
]);

$response = $dispatcher->dispatch(new ServerRequest());

Usage

The constructor accepts a Whoops\Run instance but creates one automatically if it's not provided. Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface as the second argument to create the response. If it's not defined, Middleware\Utils\Factory will be used to detect it automatically.

$whoops = new Whoops\Run();
$responseFactory = new MyOwnResponseFactory();

//Create a Run instance automatically
$middleware = new Middlewares\Whoops();

//Pass your own Run instance
$middleware = new Middlewares\Whoops($whoops);

//Pass a Run instance and ResponseFactory
$middleware = new Middlewares\Whoops($whoops, $responseFactory);

catchErrors

To catch not only throwable exceptions, but also php errors. This makes whoops to be registered temporary in order to capture the errors using set_error_handler. It's enabled by default so, to disable it you have to use ->catchErrors(false);

//Do not catch errors
$middleware = (new Middlewares\Whoops())->catchErrors(false);

handlerContainer

This option allows to define a custom PSR-11 container used to create the intance of Whoops\Handler\HandlerInterface based in the Accept header in the request.

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.

Stepup Middleware - This component is part of "Step-up Authentication as-a Service".

Step-up Middleware This component is part of "Step-up Authentication as-a Service". See Stepup-Deploy for an overview and installation instructions fo

4 Nov 2, 2022

Middleware to provide IP filtering

middlewares/firewall Middleware to provide IP filtering using M6Web/Firewall. Requirements PHP = 7.2 A PSR-7 http library A PSR-15 middleware dispatc

10 Dec 1, 2022

A based PSR-15 microframework that also sets maximum flexibility with minimum complexity and easy replaceability of the individual components, but also of the framework.

chubbyphp-framework Description A based PSR-15 microframework that also sets maximum flexibility with minimum complexity and easy replaceability of th

106 Dec 9, 2022

The efficient and elegant, PSR-7 compliant JSON:API 1.1 client library for PHP

Woohoo Labs. Yang Woohoo Labs. Yang is a PHP framework which helps you to communicate with JSON:API servers more easily. Table of Contents Introductio

160 Oct 16, 2022

OpenAPI(v3) Validators for Symfony http-foundation, using `league/openapi-psr7-validator` and `symfony/psr-http-message-bridge`.

openapi-http-foundation-validator OpenAPI(v3) Validators for Symfony http-foundation, using league/openapi-psr7-validator and symfony/psr-http-message

2 Nov 19, 2021

It validates PSR-7 messages (HTTP request/response) against OpenAPI specifications

OpenAPI PSR-7 Message (HTTP Request/Response) Validator This package can validate PSR-7 messages against OpenAPI (3.0.x) specifications expressed in Y

421 Jan 3, 2023

Tukio is a complete and robust implementation of the PSR-14 Event Dispatcher specification

Tukio is a complete and robust implementation of the PSR-14 Event Dispatcher specification. It supports normal and debug Event Dispatchers, both runtime and compiled Providers, complex ordering of Listeners, and attribute-based registration on PHP 8.

70 Dec 19, 2022

A simple PHP package for sending messages to Slack, with a focus on ease of use and elegant syntax.

Slack for PHP | A simple PHP package for sending messages to Slack with incoming webhooks, focused on ease-of-use and elegant syntax. supports: PHP 7.

128 Nov 28, 2022

Quickly and easily expose Doctrine entities as REST resource endpoints with the use of simple configuration with annotations, yaml, json or a PHP array.

Drest Dress up doctrine entities and expose them as REST resources This library allows you to quickly annotate your doctrine entities into restful res

88 Nov 5, 2022

Comments

Allow a default handler to be used

I want to take advantage of the content type guessing this library does, while at the same time specifying which editor the PrettyPageHandler should use.

This PR allows this behaviour by supporting a default handler to be used if no content specific one is in use

opened by duncan3dc 20
Fatal errors result in an empty 500 response

With this middleware enabled any E_ERROR that is triggered during inner middleware execution will result in a HTTP 500 with an empty body.

This is because Whoops uses an output buffer to render fatal errors as part of the shutdown handler, and this middleware throws away the output buffer that contains the error message.

I tried numerous things to work around this but couldn't come up with a good way to do it in PHP <7.0. I don't really expect this issue to be resolved but I did want it documented.
bug help wanted

opened by shadowhand 2
Support PHP 8
Tests almost pass, there is one problem with the test itself:

$this->assertNotFalse(strpos((string) $response->getBody(), 'Undefined variable: b'));

The message has changed and now contains dollar sign: PHP Warning: Undefined variable $b

Obvious blocker as I understand: https://github.com/middlewares/utils/issues/22
opened by arokettu 1