feat: added psr-3 logger implementation

Author: andrepimpao

.gitignore

@@ -3,5 +3,6 @@
 /phpunit.xml
 /.phpunit.result.cache
 /vendor/
+/logs/
 /.idea
 /index.php

composer.json

@@ -7,8 +7,7 @@
     "authors": [
         {
             "name": "André Pimpão",
-            "email": "a.pimpao@programmator.dev",
-            "homepage": "https://programmator.dev"
+            "email": "a.pimpao@programmator.dev"
         }
     ],
     "require": {
@@ -18,13 +17,15 @@
         "psr/cache": "^3.0",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
+        "psr/log": "^3.0",
         "symfony/options-resolver": "^6.3"
     },
     "provide": {
         "psr/http-client-implementation": "^1.0",
         "psr/http-factory-implementation": "^1.0"
     },
     "require-dev": {
+        "monolog/monolog": "^3.4",
         "nyholm/psr7": "^1.8",
         "php-http/mock-client": "^1.6",
         "phpunit/phpunit": "^10.0",

src/Config.php

@@ -3,9 +3,11 @@
 namespace ProgrammatorDev\OpenWeatherMap;
 
 use ProgrammatorDev\OpenWeatherMap\HttpClient\HttpClientBuilder;
+use ProgrammatorDev\OpenWeatherMap\HttpClient\Plugin\LoggerPlugin;
 use ProgrammatorDev\OpenWeatherMap\Validator\BlankValidatorTrait;
 use ProgrammatorDev\OpenWeatherMap\Validator\ChoiceValidatorTrait;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class Config
@@ -21,6 +23,8 @@ public function __construct(array $options = [])
         $this->configureOptions($resolver);
 
         $this->options = $resolver->resolve($options);
+
+        $this->configureAdapters();
     }
 
     private function configureOptions(OptionsResolver $resolver): void
@@ -29,7 +33,8 @@ private function configureOptions(OptionsResolver $resolver): void
             'measurementSystem' => MeasurementSystem::METRIC,
             'language' => Language::ENGLISH,
             'httpClientBuilder' => new HttpClientBuilder(),
-            'cache' => null
+            'cache' => null,
+            'logger' => null
         ]);
 
         $resolver->setRequired('applicationKey');
@@ -39,6 +44,7 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('language', 'string');
         $resolver->setAllowedTypes('httpClientBuilder', HttpClientBuilder::class);
         $resolver->setAllowedTypes('cache', ['null', CacheItemPoolInterface::class]);
+        $resolver->setAllowedTypes('logger', ['null', LoggerInterface::class]);
 
         $resolver->setAllowedValues('applicationKey', function($value) {
             return !empty($value);
@@ -47,6 +53,15 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedValues('language', Language::getList());
     }
 
+    private function configureAdapters(): void
+    {
+        if ($this->getLogger() !== null) {
+            $this->getHttpClientBuilder()->addPlugin(
+                new LoggerPlugin($this->getLogger())
+            );
+        }
+    }
+
     public function getApplicationKey(): string
     {
         return $this->options['applicationKey'];
@@ -112,4 +127,16 @@ public function setCache(?CacheItemPoolInterface $cache): self
 
         return $this;
     }
+
+    public function getLogger(): ?LoggerInterface
+    {
+        return $this->options['logger'];
+    }
+
+    public function setLogger(?LoggerInterface $logger): self
+    {
+        $this->options['logger'] = $logger;
+
+        return $this;
+    }
 }

src/HttpClient/Plugin/LoggerPlugin.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace ProgrammatorDev\OpenWeatherMap\HttpClient\Plugin;
+
+use Http\Client\Common\Plugin;
+use Http\Client\Exception;
+use Http\Message\Formatter;
+use Http\Message\Formatter\SimpleFormatter;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Log\LoggerInterface;
+
+class LoggerPlugin implements Plugin
+{
+    use Plugin\VersionBridgePlugin;
+
+    private LoggerInterface $logger;
+
+    private Formatter $formatter;
+
+    public function __construct(LoggerInterface $logger, Formatter $formatter = null)
+    {
+        $this->logger = $logger;
+        $this->formatter = $formatter ?: new SimpleFormatter();
+    }
+
+    /**
+     * @throws Exception
+     */
+    protected function doHandleRequest(RequestInterface $request, callable $next, callable $first)
+    {
+        $start = hrtime(true) / 1E6;
+        $this->logger->info(
+            \sprintf('Sending request: %s', $this->formatter->formatRequest($request))
+        );
+
+        return $next($request)->then(function (ResponseInterface $response) use ($start, $request) {
+            $milliseconds = (int) round(hrtime(true) / 1E6 - $start);
+            $formattedResponse = $this->formatter->formatResponseForRequest($response, $request);
+
+            $this->logger->info(
+                \sprintf('Received response: %s', $formattedResponse), [
+                    'milliseconds' => $milliseconds
+                ]
+            );
+
+            return $response;
+        }, function (Exception $exception) use ($request, $start) {
+            $milliseconds = (int) round((hrtime(true) / 1E6 - $start));
+
+            if ($exception instanceof Exception\HttpException) {
+                $formattedResponse = $this->formatter->formatResponseForRequest(
+                    $exception->getResponse(),
+                    $exception->getRequest()
+                );
+
+                $this->logger->error(
+                    \sprintf('Error: %s with response: %s', $exception->getMessage(), $formattedResponse), [
+                        'exception' => $exception,
+                        'milliseconds' => $milliseconds
+                    ]
+                );
+            }
+            else {
+                $this->logger->error(
+                    \sprintf(
+                        'Error: %s when sending request: %s',
+                        $exception->getMessage(),
+                        $this->formatter->formatRequest($request)
+                    ), [
+                        'exception' => $exception,
+                        'milliseconds' => $milliseconds
+                    ]
+                );
+            }
+
+            throw $exception;
+        });
+    }
+}

tests/ConfigTest.php

@@ -2,12 +2,14 @@
 
 namespace ProgrammatorDev\OpenWeatherMap\Test;
 
+use Monolog\Logger;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use ProgrammatorDev\OpenWeatherMap\Config;
 use ProgrammatorDev\OpenWeatherMap\HttpClient\HttpClientBuilder;
 use ProgrammatorDev\OpenWeatherMap\Test\DataProvider\InvalidParamDataProvider;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
@@ -32,6 +34,7 @@ public function testConfigDefaultOptions()
         $this->assertSame('en', $this->config->getLanguage());
         $this->assertInstanceOf(HttpClientBuilder::class, $this->config->getHttpClientBuilder());
         $this->assertSame(null, $this->config->getCache());
+        $this->assertSame(null, $this->config->getLogger());
     }
 
     public function testConfigWithOptions()
@@ -41,14 +44,16 @@ public function testConfigWithOptions()
             'measurementSystem' => 'imperial',
             'language' => 'pt',
             'httpClientBuilder' => new HttpClientBuilder(),
-            'cache' => new FilesystemAdapter()
+            'cache' => new FilesystemAdapter(),
+            'logger' => new Logger('test')
         ]);
 
         $this->assertSame('newtestappkey', $config->getApplicationKey());
         $this->assertSame('imperial', $config->getMeasurementSystem());
         $this->assertSame('pt', $config->getLanguage());
         $this->assertInstanceOf(HttpClientBuilder::class, $config->getHttpClientBuilder());
         $this->assertInstanceOf(CacheItemPoolInterface::class, $config->getCache());
+        $this->assertInstanceOf(LoggerInterface::class, $config->getLogger());
     }
 
     #[DataProvider('provideInvalidConfigOptionsData')]
@@ -136,4 +141,10 @@ public function testConfigSetCache()
         $this->config->setCache(new FilesystemAdapter());
         $this->assertInstanceOf(CacheItemPoolInterface::class, $this->config->getCache());
     }
+
+    public function testConfigSetLogger()
+    {
+        $this->config->setLogger(new Logger('test'));
+        $this->assertInstanceOf(LoggerInterface::class, $this->config->getLogger());
+    }
 }