Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2.x] Closes monolog handlers by event listener if the worker stops #854

Merged
merged 10 commits into from
Mar 22, 2024
2 changes: 2 additions & 0 deletions config/octane.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Laravel\Octane\Events\WorkerErrorOccurred;
use Laravel\Octane\Events\WorkerStarting;
use Laravel\Octane\Events\WorkerStopping;
use Laravel\Octane\Listeners\CloseMonologHandlers;
use Laravel\Octane\Listeners\CollectGarbage;
use Laravel\Octane\Listeners\DisconnectFromDatabases;
use Laravel\Octane\Listeners\EnsureUploadedFilesAreValid;
Expand Down Expand Up @@ -114,6 +115,7 @@
],

WorkerStopping::class => [
CloseMonologHandlers::class,
//
],
],
Expand Down
18 changes: 18 additions & 0 deletions src/Listeners/CloseMonologHandlers.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace Laravel\Octane\Listeners;

class CloseMonologHandlers
{
public function handle($event): void
{
if (! $event->app->resolved('log')) {
return;
}

collect($event->app->make('log')->getChannels())
->map->getLogger()
->filter(fn ($logger) => method_exists($logger, 'close'))
->each->close();
}
}
44 changes: 44 additions & 0 deletions tests/Listeners/CloseMonologHandlersTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

namespace Laravel\Octane\Listeners;

use Illuminate\Http\Request;
use Illuminate\Log\Logger;
use Laravel\Octane\Tests\TestCase;
use Mockery;
use Monolog;

class CloseMonologHandlersTest extends TestCase
{
/** @doesNotPerformAssertions */
public function test_logger_are_closed_after_worker_termination()
{
[$app, $worker, $client] = $this->createOctaneContext([
Request::create('/', 'GET'),
Request::create('/', 'GET'),
]);

$app['router']->middleware('web')->get('/', function () {
// ..
});

$worker->run();

$log = $app['log'];

$app['log'] = tap(Mockery::mock($log), function ($logger) {
$logger->shouldReceive('getChannels')->once()->andReturn([
tap(Mockery::mock(Logger::class), function ($logger) {
$logger->shouldReceive('getLogger')->once()->andReturn(
tap(Mockery::mock(Monolog\Logger::class), function ($logger) {
$logger->shouldReceive('close')->once();
}),
);
}),
]);
});

// The listener should call close on the monolog handlers after terminating the worker.
$worker->terminate();
}
}