Added listener FlushLogContextListener for the logger context flushing (#51)

Author: tarampampam

.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs: # Docs: <https://help.github.com/en/articles/workflow-syntax-for-github-ac
       matrix:
         setup: ['basic', 'lowest']
         php: ['7.4', '8.0']
-        rr: ['2.2.1'] # Releases: <https://github.com/spiral/roadrunner-binary/releases>
+        rr: ['2.3.1'] # Releases: <https://github.com/spiral/roadrunner-binary/releases>
         coverage: ['true']
         include:
           - php: '7.4'

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
 
+## UNRELEASED
+
+### Added
+
+- Listener `FlushLogContextListener` for the logger context flushing
+
 ## v5.0.2
 
 ### Fixed

src/Defaults.php

@@ -83,6 +83,7 @@ public static function afterLoopIteration(): array
     {
         return [
             Listeners\FlushDumperStackListener::class,
+            Listeners\FlushLogContextListener::class,
             Listeners\FlushArrayCacheListener::class,
             Listeners\ResetDatabaseRecordModificationStateListener::class,
             Listeners\ClearInstancesListener::class,

src/Listeners/FlushLogContextListener.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\RoadRunnerLaravel\Listeners;
+
+use Spiral\RoadRunnerLaravel\Events\Contracts\WithApplication;
+
+/**
+ * @link https://github.com/laravel/octane/blob/1.x/src/Listeners/FlushLogContext.php
+ */
+class FlushLogContextListener implements ListenerInterface
+{
+    use Traits\InvokerTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle($event): void
+    {
+        if ($event instanceof WithApplication) {
+            $app = $event->application();
+
+            if (!$app->resolved($log_abstract = 'log')) {
+                return;
+            }
+
+            /** @var \Illuminate\Log\LogManager $log_manager */
+            $log_manager = $app->make($log_abstract);
+
+            /** @var \Psr\Log\LoggerInterface|\Illuminate\Log\Logger $logger */
+            $logger = $log_manager->driver();
+
+            /**
+             * Method `withoutContext` for the Logger available since Laravel v8.49.0.
+             *
+             * @link https://github.com/illuminate/log/blob/v8.49.0/Logger.php#L202-L212 Source code (v8.49.0)
+             * @see  \Illuminate\Log\Logger::withoutContext
+             */
+            $this->invokeMethod($logger, 'withoutContext');
+        }
+    }
+}

tests/Unit/Listeners/FlushLogContextListenerTest.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Spiral\RoadRunnerLaravel\Tests\Unit\Listeners;
+
+use Mockery as m;
+use Spiral\RoadRunnerLaravel\Events\Contracts\WithApplication;
+use Spiral\RoadRunnerLaravel\Listeners\FlushLogContextListener;
+
+/**
+ * @covers \Spiral\RoadRunnerLaravel\Listeners\FlushLogContextListener
+ */
+class FlushLogContextListenerTest extends AbstractListenerTestCase
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function testHandle(): void
+    {
+        /** @var \Illuminate\Log\LogManager $log_manager */
+        $log_manager = $this->app->make('log');
+
+        $logger = $log_manager->driver();
+
+        if (! \method_exists($logger, 'withoutContext')) {
+            $this->markTestSkipped('Current illuminate/log package version does now supports ::withoutContext()');
+        }
+
+        $this->app->instance('log', m::mock($log_manager)
+            ->makePartial()
+            ->expects('driver')
+            ->withNoArgs()
+            ->andReturn(
+                m::mock($logger)
+                    ->makePartial()
+                    ->expects('withoutContext')
+                    ->withNoArgs()
+                    ->andReturn($logger)
+                    ->getMock()
+            )
+            ->getMock());
+
+        /** @var m\MockInterface|WithApplication $event_mock */
+        $event_mock = m::mock(WithApplication::class)
+            ->makePartial()
+            ->expects('application')
+            ->andReturn($this->app)
+            ->getMock();
+
+        $this->listenerFactory()->handle($event_mock);
+    }
+
+    /**
+     * @return FlushLogContextListener
+     */
+    protected function listenerFactory(): FlushLogContextListener
+    {
+        return new FlushLogContextListener();
+    }
+}