feat: [Logger] extend Laravel's Logger and log extra info when writing log

Author: koshuang

src/Logger.php

@@ -2,44 +2,61 @@
 
 namespace Onramplab\LaravelLogEnhancement;
 
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Log\Logger as IlluminateLogger;
 use Psr\Log\LoggerInterface;
 use Ramsey\Uuid\Uuid;
 
-class Logger
+class Logger extends IlluminateLogger
 {
+    /**
+     * @var string
+     */
     protected $debugId;
+
+    /**
+     * LoggerInterface
+     */
     protected $logger;
 
     /**
-     * Create an instance of the QueryLogger class
+     * @var string
+     */
+    protected $channelName;
+
+    /**
+     * Create a new log writer instance.
      *
-     * @param \Psr\Log\LoggerInterface $logger
+     * @param  \Psr\Log\LoggerInterface  $logger
+     * @param  \Illuminate\Contracts\Events\Dispatcher|null  $dispatcher
      * @return void
-     *
-     * @throws \Ramsey\Uuid\Exception\UnsatisfiedDependencyException
-     * @throws \InvalidArgumentException
-     * @throws \Exception
      */
-    public function __construct(LoggerInterface $logger)
+    public function __construct(LoggerInterface $logger, Dispatcher $dispatcher = null)
     {
         $this->logger = $logger;
+        $this->dispatcher = $dispatcher;
         $this->debugId = Uuid::uuid4()->toString();
-        //
     }
 
-    public function __call($name, $arguments)
+    /**
+     * Write a message to the log.
+     *
+     * @param  string  $level
+     * @param  string  $message
+     * @param  array  $context
+     * @return void
+     */
+    protected function writeLog($level, $message, $context)
     {
-        $message = $arguments[0];
-        $context = $arguments[1] ?? [];
-
-        // attach caller class
+        // attach class_path
+        // NOTE: it's hardcoded, should find a better way to get caller class
         $caller = debug_backtrace();
-        $caller = $caller[2];
+        $caller = $caller[4];
         $context['class_path'] = $caller['class'];
 
         // attach tracking_id
         $context['tracking_id'] = $this->debugId;
 
-        $this->logger->log($name, $message, $context);
+        parent::writeLog($level, $message, $context);
     }
 }

tests/Unit/LoggerTest.php

@@ -2,9 +2,13 @@
 
 namespace Onramplab\LaravelLogEnhancement\Tests\Unit\Concerns;
 
+use Illuminate\Events\Dispatcher;
+use Illuminate\Foundation\Application;
 use Illuminate\Support\Facades\Log;
+use Mockery;
 use Onramplab\LaravelLogEnhancement\Tests\TestCase;
 use Onramplab\LaravelLogEnhancement\Logger;
+use Psr\Log\LoggerInterface;
 
 class LoggerTest extends TestCase
 {
@@ -15,18 +19,20 @@ class LoggerTest extends TestCase
      */
     public function log_should_include_class_path_and_uuid_in_context()
     {
-      Log::spy();
-      $logger = app()->make(Logger::class);
+      $this->app->instance(Logger::class, Mockery::mock(Logger::class));
 
-      $logger->info('123');
+      $logger = app()
+        ->make(Logger::class)
+        ->makePartial();
 
-      Log
-        ::shouldHaveReceived('log', function ($logLevel, $message, $context) {
+      $logger->shouldReceive('log', function ($logLevel, $message, $context) {
           return $logLevel === 'info'
             && $message === '123'
             && isSet($context['class_path'])
             && isSet($context['tracking_id']);
         })
         ->once();
+
+      $logger->info('123');
     }
 }