complete changelog

CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://git.d3data.de/D3Public/guzzleFactory/compare/1.0.0...rel_1.x)
+## [Unreleased](https://git.d3data.de/D3Public/guzzleFactory/compare/1.1.0...rel_1.x)
+
+## [1.1.0](https://git.d3data.de/D3Public/guzzleFactory/compare/1.0.0...1.1.0) - 2025-01-27
+### Added
+- combined OXID logger and file logger
+  - errors are written here (expected behaviour)
+  - all error level are written to custom log file
 
 ## [1.0.0](https://git.d3data.de/D3Public/guzzleFactory/releases/tag/1.0.0) - 2025-01-01
 ### Added

README.md

@@ -1,3 +1,7 @@
+![stability mature](https://img.shields.io/badge/stability-mature-008000.svg)
+[![latest tag](https://img.shields.io/packagist/v/d3/guzzle-factory?label=release)](https://packagist.org/packages/d3/guzzle-factory)
+[![MIT License](https://img.shields.io/packagist/l/d3/guzzle-factory)](https://git.d3data.de/D3Public/guzzleFactory/src/branch/main/LICENSE.md)
+
 # Guzzle Factory
 
 Guzzle factory for everyday simple configuration
@@ -18,6 +22,7 @@ $guzzleFactory->setMessageFormatter(
     '{method} {uri} HTTP/{version} {req_body}'.PHP_EOL.'RESPONSE: {code} - {res_body}',
     ['myUsername', 'myPassword']
 );
+$guzzleFactory->setMessageLevel(Logger::INFO);
 $httpClient = $guzzleFactory->getGuzzle('https://remoteApi.com');
 ```
 

composer.json

@@ -39,6 +39,7 @@
   },
   "scripts": {
     "test": "./vendor/bin/phpunit --no-coverage",
+    "test-coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html=coverage",
     "check-style": "./vendor/bin/php-cs-fixer fix --verbose --dry-run",
     "fix-style": "./vendor/bin/php-cs-fixer fix --verbose",
     "check-code": "./vendor/bin/phpstan analyse -c phpstan.neon --no-progress --ansi"

src/Apps/OxidLoggerTrait.php

@@ -17,6 +17,10 @@ declare(strict_types=1);
 
 namespace D3\GuzzleFactory\Apps;
 
+use Exception;
+use InvalidArgumentException;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
 use OxidEsales\Eshop\Core\Registry;
 use RuntimeException;
 
@@ -31,6 +35,36 @@ trait OxidLoggerTrait
         $this->loggers['oxid'] = Registry::getLogger();
     }
 
+    /**
+     * @throws Exception
+     * @throws InvalidArgumentException
+     */
+    public function addCombinedOxidAndFileLogger(
+        string $loggerName,
+        string $filePath,
+        int $logLevel = Logger::INFO,
+        ?int $maxFiles = null
+    ): void
+    {
+        if (!class_exists(Registry::class)) {
+            throw new RuntimeException(__METHOD__.' can executed in OXID eShop installations only');
+        }
+
+        $logger = new Logger($loggerName);
+        $stream_handler = $this->getFileLoggerStreamHandler($filePath, $logLevel, $maxFiles);
+        $logger->pushHandler($stream_handler);
+
+        $oxidLogFilePath = $this->getOxidLogPath('oxideshop.log');
+        $oxidStreamHandler = new StreamHandler($oxidLogFilePath, Logger::ERROR);
+        $logger->pushHandler($oxidStreamHandler);
+
+        if (isset($this->loggers['oxid'])) {
+            unset($this->loggers['oxid']);
+        }
+
+        $this->loggers[$loggerName] = $logger;
+    }
+
     public function getOxidLogPath(string $fileName): string
     {
         if (!class_exists(Registry::class)) {

src/LoggerTrait.php

@@ -20,6 +20,7 @@ namespace D3\GuzzleFactory;
 use D3\GuzzleFactory\Apps\OxidLoggerTrait;
 use Exception;
 use InvalidArgumentException;
+use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
@@ -37,17 +38,38 @@ trait LoggerTrait
      * @throws Exception
      * @throws InvalidArgumentException
      */
-    public function addFileLogger(string $loggerName, string $filePath, int $logLevel = Logger::INFO, ?int $maxFiles = null): void
+    public function addFileLogger(
+        string $loggerName,
+        string $filePath,
+        int $logLevel = Logger::INFO,
+        ?int $maxFiles = null
+    ): void
     {
         $logger = new Logger($loggerName);
-        $stream_handler = is_null($maxFiles) ?
-            new StreamHandler($filePath, $logLevel) :
-            new RotatingFileHandler($filePath, $maxFiles, $logLevel);
+        $stream_handler = $this->getFileLoggerStreamHandler($filePath, $logLevel, $maxFiles);
         $logger->pushHandler($stream_handler);
 
         $this->loggers[$loggerName] = $logger;
     }
 
+    /**
+     * @param string $filePath
+     * @param int $logLevel
+     * @param int|null $maxFiles
+     * @return AbstractProcessingHandler
+     * @throws Exception
+     */
+    public function getFileLoggerStreamHandler(
+        string $filePath,
+        int $logLevel = Logger::INFO,
+        ?int $maxFiles = null
+    ): AbstractProcessingHandler
+    {
+        return is_null($maxFiles) ?
+            new StreamHandler($filePath, $logLevel) :
+            new RotatingFileHandler($filePath, $maxFiles, $logLevel);
+    }
+
     public function addConfiguredLogger(LoggerInterface $logger): void
     {
         $this->loggers[md5(serialize($logger))] = $logger;

tests/Apps/OxidLoggerTestTrait.php

@@ -40,6 +40,25 @@ trait OxidLoggerTestTrait
         );
     }
 
+    /**
+     * @test
+     * @return void
+     * @throws ReflectionException
+     * @covers \D3\GuzzleFactory\GuzzleFactory::addCombinedOxidAndFileLogger
+     */
+    public function testAddCombinedOxidAndFileLoggerWithoutOxid(): void
+    {
+        $sut = GuzzleFactory::create();
+
+        $this->expectException(RuntimeException::class);
+
+        $this->callMethod(
+            $sut,
+            'addCombinedOxidAndFileLogger',
+            ['nameFixture', 'file/path.log', 1, 5]
+        );
+    }
+
     /**
      * @test
      * @return void
@@ -84,6 +103,32 @@ trait OxidLoggerTestTrait
         $this->assertInstanceOf(Logger::class, $loggers['oxid']);
     }
 
+    /**
+     * @test
+     * @return void
+     * @throws ReflectionException
+     * @covers \D3\GuzzleFactory\GuzzleFactory::addCombinedOxidAndFileLogger
+     */
+    public function testAddCombinedOxidAndFileLoggerInOxid(): void
+    {
+        require_once __DIR__.'/../Helpers/classAliases.php';
+
+        $sut = GuzzleFactory::create();
+
+        $this->setValue($sut, 'loggers', ['oxid' => 1]);
+
+        $this->callMethod(
+            $sut,
+            'addCombinedOxidAndFileLogger',
+            ['nameFixture', 'file/path.log', 1, 5]
+        );
+
+        $loggers = $this->getValue($sut, 'loggers');
+        $this->assertArrayHasKey('nameFixture', $loggers);
+        $this->assertArrayNotHasKey('oxid', $loggers);
+        $this->assertInstanceOf(Logger::class, $loggers['nameFixture']);
+    }
+
     /**
      * @test
      * @return void

tests/LoggerTestTrait.php

@@ -28,6 +28,7 @@ trait LoggerTestTrait
      * @test
      * @throws ReflectionException
      * @covers       \D3\GuzzleFactory\GuzzleFactory::addFileLogger
+     * @covers       \D3\GuzzleFactory\GuzzleFactory::getFileLoggerStreamHandler
      * @dataProvider addFileLoggerDataProvider
      */
     public function testAddFileLogger(int $logLevel, ?int $maxFiles, string $expectedHandlerClass): void