[10.x] Deduplicate exceptions

[timacdonald]

Adds the ability to deduplicate exception reporting.

Exceptions may sometimes be caught, reported, re-thrown only to be re-reported at a higher level - potentially a few times throughout the application layers.

This adds a lever to the exception handler to deduplicate exceptions to ensure a single instance of an exception is only reported on time.

use Illuminate\Contracts\Debug\ExceptionHandler;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        // …

        $this->callAfterResolving(ExceptionHandler::class, function ($handler) {
            $handler->deduplicateReporting();
        });
    }
}

If the same exception is now reported more than once, it will only actually report a single time.

$e = new RuntimeException('abc');

report($e);

report($e);

try {
    throw $e;
} catch (Exception $exception) {
    report($exception);
}

// only reported once

There is already precedent for this kind of feature in the framework with something like middleware.

Route::middleware(MyMiddleware::class)->group(function () {
     Route::get(/* ... */)->middleware(MyMiddleware::class);
});

The MyMiddleware is not executed twice, as the framework deduplicates them for us.

[nunomaduro]

I understand the reasoning; however, this doesn't seem like good practice to me. I believe this issue should be resolved at the application level.

Additionally, it raises other questions; as the WeakMap needs to be cleared between requests or between jobs, etc.

[timacdonald]

As a WeakMap doesn't hold a reference to the object, we don't need to clear anything. The exception will be garbage collected in the same way it currently is.

[mpyw]

Clever solution with WeakMap 👍

[rodrigopedra]

Very nice addition @timacdonald ... I implemented a very similar solution 2 weeks ago to an app a client's was always asking about exception's duplicates...

Unfortunately it is still a Laravel 8 app, as it still runs on PHP 7.4 on centOS, so I couldn't use a WeakMap.

This client is planning to migrate to a newer server later this year, so knowing you already got this covered makes me very happy and eager to finally migrate this app to a newer Laravel version.

Thanks a lot! Have a nice day =)

[timacdonald]

Really appreciate that feedback, @rodrigopedra ❤️

Hopefully once you get moved over and updated you can delete some code 🎉

[rodrigopedra]

Hey @timacdonald I told my client about this PR, and he asked me about some other features we might be missing or reimplementing, and... we are migrating the server this weekend to Rocky 9, PHP 8.2 and Laravel 10!

well I will be working on migrating the codebase tomorrow and Friday, and he prefers to manage his servers himself

So I guess I own you a second thank you =)

(and need to stop posting on this thread before being called a spammer 🤐)

Thanks again, and may God bless you. Have a nice day!

[timacdonald]

yo, @rodrigopedra, if this is spam - sign me up!

This is amazing to hear. I love that this feature helped move the discussion forward. Very awesome ☺️