updates to logger component

CHANGELOG.md

@@ -10,6 +10,7 @@ To get the diff between two versions, go to https://github.com/SonsOfPHP/sonsofp
 
 ## [Unreleased]
 
+* [PR #214](https://github.com/SonsOfPHP/sonsofphp/pull/214) [Logger] Bug fixes and updates
 * [PR #51](https://github.com/SonsOfPHP/sonsofphp/pull/51) Added new Filesystem component
 * [PR #59](https://github.com/SonsOfPHP/sonsofphp/pull/59) Added new HttpMessage component
 * [PR #59](https://github.com/SonsOfPHP/sonsofphp/pull/59) Added new HttpFactory component

docs/components/logger/index.md

@@ -21,7 +21,7 @@ Simple Usage Example
 use SonsOfPHP\Component\Logger\Logger;
 
 // Logger is PSR-3 Logger
-$logger = new Logger('app');
+$logger = new Logger();
 $logger->debug('Debug Log Message');
 ```
 

src/SonsOfPHP/Component/Logger/Enricher/HostnameEnricher.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Enricher;
+
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+use SonsOfPHP\Contract\Logger\RecordInterface;
+
+/**
+ * @author Joshua Estes <joshua@sonsofphp.com>
+ */
+class HostnameEnricher implements EnricherInterface
+{
+    public function __invoke(RecordInterface $record): RecordInterface
+    {
+        $context = $record->getContext();
+        $context['hostname'] = gethostname();
+
+        return $record->withContext($context);
+    }
+}

src/SonsOfPHP/Component/Logger/Formatter/SimpleFormatter.php

@@ -16,9 +16,7 @@ class SimpleFormatter implements FormatterInterface
 {
     public function formatMessage(RecordInterface $record): string
     {
-        $output = "[%datetime%] %channel%.%level_name%: %message% %context%\n";
-        $message = '[' . $record->getDatetime()->format('c') . '] ' . $record->getChannel() . '.' . $record->getLevel()->getName() . ' ' . $record->getMessage();
-
+        $output  = "[%datetime%] %channel%.%level_name%: %message% %context%\n";
         $message = $record->getMessage();
         foreach ($record->getContext() as $key => $value) {
             if (!is_array($value) && (!is_object($value) || method_exists($value, '__toString'))) {

src/SonsOfPHP/Component/Logger/Handler/AbstractHandler.php

@@ -4,6 +4,7 @@
 
 namespace SonsOfPHP\Component\Logger\Handler;
 
+use SonsOfPHP\Component\Logger\Formatter\SimpleFormatter;
 use SonsOfPHP\Contract\Logger\FilterInterface;
 use SonsOfPHP\Contract\Logger\FormatterInterface;
 use SonsOfPHP\Contract\Logger\HandlerInterface;
@@ -20,7 +21,7 @@ public function __construct(
         protected ?FormatterInterface $formatter = null,
     ) {}
 
-    //abstract public function doHandle(RecordInterface $record, string $message): void;
+    abstract public function doHandle(RecordInterface $record, string $message): void;
 
     public function getFilter(): ?FilterInterface
     {
@@ -34,7 +35,7 @@ public function setFilter(FilterInterface $filter): void
 
     public function getFormatter(): ?FormatterInterface
     {
-        return $this->formatter ?? null;
+        return $this->formatter ?? new SimpleFormatter();
     }
 
     public function setFormatter(FormatterInterface $formatter): void
@@ -50,7 +51,7 @@ public function handle(RecordInterface $record): void
 
         $message = $record->getMessage();
         if ($this->getFormatter() instanceof FormatterInterface) {
-            $message = $record->withMessage($this->formatter->formatMessage($record));
+            $message = $this->getFormatter()->formatMessage($record);
         }
 
         $this->doHandle($record, $message);

src/SonsOfPHP/Component/Logger/Handler/FileHandler.php

@@ -5,15 +5,14 @@
 namespace SonsOfPHP\Component\Logger\Handler;
 
 use RuntimeException;
-use SonsOfPHP\Contract\Logger\HandlerInterface;
 use SonsOfPHP\Contract\Logger\RecordInterface;
 
 /**
  * Logs messages to a file
  *
  * @author Joshua Estes <joshua@sonsofphp.com>
  */
-class FileHandler extends AbstractHandler implements HandlerInterface
+class FileHandler extends AbstractHandler
 {
     private bool $isOpen = false;
     private $handle;

src/SonsOfPHP/Component/Logger/Handler/NullHandler.php

@@ -4,15 +4,14 @@
 
 namespace SonsOfPHP\Component\Logger\Handler;
 
-use SonsOfPHP\Contract\Logger\HandlerInterface;
 use SonsOfPHP\Contract\Logger\RecordInterface;
 
 /**
  * The handler that says, "fuck your message"
  *
  * @author Joshua Estes <joshua@sonsofphp.com>
  */
-class NullHandler extends AbstractHandler implements HandlerInterface
+class NullHandler extends AbstractHandler
 {
-    public function handle(RecordInterface $record): void {}
+    public function doHandle(RecordInterface $record, string $message): void {}
 }

src/SonsOfPHP/Component/Logger/Handler/StreamHandler.php

@@ -5,13 +5,12 @@
 namespace SonsOfPHP\Component\Logger\Handler;
 
 use RuntimeException;
-use SonsOfPHP\Contract\Logger\HandlerInterface;
 use SonsOfPHP\Contract\Logger\RecordInterface;
 
 /**
  * @author Joshua Estes <joshua@sonsofphp.com>
  */
-class StreamHandler extends AbstractHandler implements HandlerInterface
+class StreamHandler extends AbstractHandler
 {
     private bool $isOpen = false;
 

src/SonsOfPHP/Component/Logger/Record.php

@@ -102,8 +102,12 @@ public function getDatetime(): DateTimeImmutable
 
     public function withDatetime(DateTimeImmutable $datetime): static
     {
+        if ($this->datetime === $datetime) {
+            return $this;
+        }
+
         $that = clone $this;
-        $that->datatime = $datatime;
+        $that->datetime = $datetime;
 
         return $that;
     }

src/SonsOfPHP/Component/Logger/Tests/ContextTest.php

@@ -8,11 +8,8 @@
 use PHPUnit\Framework\TestCase;
 use SonsOfPHP\Component\Logger\Context;
 use SonsOfPHP\Contract\Logger\ContextInterface;
+use stdClass;
 
-/**
- * @uses \SonsOfPHP\Component\Logger\Context
- * @coversNothing
- */
 #[CoversClass(Context::class)]
 final class ContextTest extends TestCase
 {
@@ -88,4 +85,44 @@ public function testOffsetSet(): void
         $this->assertTrue(isset($context['key']));
         $this->assertNotEmpty($context['key']);
     }
+
+    public function testItWillThrowExceptionDuringOffsetExistsWithInvalidOffset(): void
+    {
+        $context = new Context();
+
+        $this->expectException('InvalidArgumentException');
+        isset($context[new stdClass()]);
+    }
+
+    public function testItWillThrowExceptionDuringOffsetGetWithInvalidOffset(): void
+    {
+        $context = new Context();
+
+        $this->expectException('InvalidArgumentException');
+        $context[new stdClass()];
+    }
+
+    public function testItWillThrowExceptionDuringOffsetSetWithInvalidOffset(): void
+    {
+        $context = new Context();
+
+        $this->expectException('InvalidArgumentException');
+        $context[new stdClass()] = 'test';
+    }
+
+    public function testItWillThrowExceptionDuringOffsetSetWithInvalidOffsetValue(): void
+    {
+        $context = new Context();
+
+        $this->expectException('InvalidArgumentException');
+        $context['test'] = new stdClass();
+    }
+
+    public function testItWillThrowExceptionDuringOffsetUnsetWithInvalidOffset(): void
+    {
+        $context = new Context();
+
+        $this->expectException('InvalidArgumentException');
+        unset($context[new stdClass()]);
+    }
 }

src/SonsOfPHP/Component/Logger/Tests/Enricher/HostnameEnricherTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SonsOfPHP\Component\Logger\Tests\Enricher;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\TestCase;
+use SonsOfPHP\Component\Logger\Context;
+use SonsOfPHP\Component\Logger\Enricher\HostnameEnricher;
+use SonsOfPHP\Component\Logger\Level;
+use SonsOfPHP\Component\Logger\Record;
+use SonsOfPHP\Contract\Logger\EnricherInterface;
+
+#[CoversClass(HostnameEnricher::class)]
+#[UsesClass(Context::class)]
+#[UsesClass(Record::class)]
+final class HostnameEnricherTest extends TestCase
+{
+    /**
+     * @coversNothing
+     */
+    public function testItHasTheCorrectInterface(): void
+    {
+        $enricher = new HostnameEnricher();
+
+        $this->assertInstanceOf(EnricherInterface::class, $enricher);
+    }
+
+    public function testInvoke(): void
+    {
+        $enricher = new HostnameEnricher();
+        $record = $enricher(new Record(
+            channel: 'test',
+            level: Level::Debug,
+            message: '',
+            context: new Context(),
+        ));
+
+        $this->assertArrayHasKey('hostname', $record->getContext());
+    }
+}

src/SonsOfPHP/Component/Logger/Tests/Handler/FileHandlerTest.php

@@ -9,6 +9,7 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 use SonsOfPHP\Component\Logger\Context;
+use SonsOfPHP\Component\Logger\Formatter\SimpleFormatter;
 use SonsOfPHP\Component\Logger\Handler\AbstractHandler;
 use SonsOfPHP\Component\Logger\Handler\FileHandler;
 use SonsOfPHP\Component\Logger\Level;
@@ -19,6 +20,8 @@
 #[UsesClass(Context::class)]
 #[UsesClass(AbstractHandler::class)]
 #[UsesClass(Record::class)]
+#[UsesClass(SimpleFormatter::class)]
+#[UsesClass(Level::class)]
 final class FileHandlerTest extends TestCase
 {
     public function setUp(): void

src/SonsOfPHP/Component/Logger/Tests/Handler/StreamHandlerTest.php

@@ -9,6 +9,7 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 use SonsOfPHP\Component\Logger\Context;
+use SonsOfPHP\Component\Logger\Formatter\SimpleFormatter;
 use SonsOfPHP\Component\Logger\Handler\AbstractHandler;
 use SonsOfPHP\Component\Logger\Handler\StreamHandler;
 use SonsOfPHP\Component\Logger\Level;
@@ -19,6 +20,8 @@
 #[UsesClass(Context::class)]
 #[UsesClass(AbstractHandler::class)]
 #[UsesClass(Record::class)]
+#[UsesClass(SimpleFormatter::class)]
+#[UsesClass(Level::class)]
 final class StreamHandlerTest extends TestCase
 {
     public function setUp(): void

src/SonsOfPHP/Component/Logger/Tests/LevelTest.php

@@ -34,6 +34,13 @@ public function testFromNameWithInvalidName(): void
 
     public function testFromName(): void
     {
+        $this->assertSame(Level::Emergency, Level::fromName('emergency'));
+        $this->assertSame(Level::Alert, Level::fromName('alert'));
+        $this->assertSame(Level::Critical, Level::fromName('critical'));
+        $this->assertSame(Level::Error, Level::fromName('error'));
+        $this->assertSame(Level::Warning, Level::fromName('warning'));
+        $this->assertSame(Level::Notice, Level::fromName('notice'));
+        $this->assertSame(Level::Info, Level::fromName('info'));
         $this->assertSame(Level::Debug, Level::fromName('debug'));
     }
 

src/SonsOfPHP/Component/Logger/Tests/LoggerTest.php

@@ -111,4 +111,11 @@ public function testaddHandler(): void
         $logger->addHandler(new NullHandler());
         $this->assertCount(2, $handlers->getValue($logger));
     }
+
+    public function testLogWillThrowExceptionWhenLevelIsInvalid(): void
+    {
+        $logger = new Logger();
+        $this->expectException('InvalidArgumentException');
+        $logger->log('test level', 'message');
+    }
 }

src/SonsOfPHP/Component/Logger/Tests/RecordTest.php

@@ -4,6 +4,7 @@
 
 namespace SonsOfPHP\Component\Logger\Tests;
 
+use DateTimeImmutable;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
@@ -100,4 +101,20 @@ public function testWithContextWhenArgumentIsArray(): void
         $this->assertArrayHasKey('key', $record->getContext());
         $this->assertSame('value', $record->getContext()['key']);
     }
+
+    public function testDatetime(): void
+    {
+        $ts = new DateTimeImmutable();
+        $record = new Record(
+            channel: 'app',
+            level: Level::Debug,
+            message: 'testing',
+            context: new Context(),
+            datetime: $ts,
+        );
+
+        $this->assertSame($ts, $record->getDatetime());
+        $this->assertSame($record, $record->withDatetime($ts));
+        $this->assertNotSame($record, $record->withDatetime(new DateTimeImmutable()));
+    }
 }

src/SonsOfPHP/Component/Logger/composer.json

@@ -32,7 +32,7 @@
     "prefer-stable": true,
     "require": {
         "php": ">=8.2",
-        "psr/log": "^1.0 || ^2.0 || ^3.0",
+        "psr/log": "^2.0 || ^3.0",
         "sonsofphp/logger-contract": "0.3.x-dev"
     },
     "provide": {
@@ -55,4 +55,4 @@
             "url": "https://tidelift.com/subscription/pkg/packagist-sonsofphp-sonsofphp"
         }
     ]
-}
+}