feat: added cache logger

Author: andrepimpao

src/Config.php

@@ -21,10 +21,9 @@ public function __construct(array $options = [])
     {
         $resolver = new OptionsResolver();
         $this->configureOptions($resolver);
-
         $this->options = $resolver->resolve($options);
 
-        $this->configureAdapters();
+        $this->configureAware();
     }
 
     private function configureOptions(OptionsResolver $resolver): void
@@ -53,7 +52,7 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedValues('language', Language::getList());
     }
 
-    private function configureAdapters(): void
+    private function configureAware(): void
     {
         if ($this->getLogger() !== null) {
             $this->getHttpClientBuilder()->addPlugin(

src/Endpoint/AbstractEndpoint.php

@@ -19,6 +19,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriInterface;
+use Psr\Log\LoggerInterface;
 
 class AbstractEndpoint
 {
@@ -27,6 +28,8 @@ class AbstractEndpoint
 
     private HttpMethodsClient $httpClient;
 
+    private ?LoggerInterface $logger;
+
     private ?CacheItemPoolInterface $cache;
 
     private bool $cacheInvalidation = false;
@@ -42,6 +45,7 @@ public function __construct(protected OpenWeatherMap $api)
         $config = $this->api->getConfig();
 
         $this->httpClient = $config->getHttpClientBuilder()->getHttpClient();
+        $this->logger = $config->getLogger();
         $this->cache = $config->getCache();
         $this->measurementSystem = $config->getMeasurementSystem();
         $this->language = $config->getLanguage();
@@ -70,15 +74,19 @@ protected function sendRequest(
         if ($this->cache !== null) {
             $cacheKey = $this->getCacheKey($uri);
 
-            // Invalidate cache (if exists) to force renewal
+            // Invalidate cache to force new
             if ($this->cacheInvalidation === true) {
+                $this->logger?->info('Cache invalidated', ['key' => $cacheKey]);
+
                 $this->cache->deleteItem($cacheKey);
             }
 
             $cacheItem = $this->cache->getItem($cacheKey);
 
-            // If cache does not exist...
-            if (!$cacheItem->isHit()) {
+            if ($cacheItem->isHit()) {
+                $this->logger?->info(\sprintf('Cache hit: %s %s', $method, $uri), ['key' => $cacheKey]);
+            }
+            else {
                 $response = ResponseMediator::toArray(
                     $this->handleRequest($method, $uri, $headers, $body)
                 );
@@ -87,6 +95,8 @@ protected function sendRequest(
                 $cacheItem->expiresAfter($this->cacheTtl);
 
                 $this->cache->save($cacheItem);
+
+                $this->logger?->info('Cached response', ['ttl' => $this->cacheTtl, 'key' => $cacheKey]);
             }
 
             return $cacheItem->get();