feat: logging (#5)

Author: babeuloula

.env

@@ -3,6 +3,10 @@ APP_DEBUG=0
 # Cache (in seconds)
 CACHE_TTL=31536000
 
+# Logging
+LOG_STREAM=php://stderr
+LOG_LEVEL=debug
+
 # Allowed domains (seperate by comma)
 ALLOWED_DOMAINS=example.com
 

README.md

@@ -72,7 +72,7 @@ Edit .env.local to match your setup:
 ```
 APP_DEBUG=0
 
-ALLOWED_DOMAINS=https://www.mysite.com,https://www.another-site.com
+ALLOWED_DOMAINS=mysite.com,another-site.com
 STORAGE_TYPE=local # "local" or "s3"
 
 # Local storage configuration
@@ -86,7 +86,11 @@ S3_ACCESS_KEY=your-access-key
 S3_SECRET_KEY=your-secret-key
 
 # Cache (in seconds)
-CACHE_TTL=3600
+CACHE_TTL=31536000
+
+# Logging
+LOG_STREAM=/srv/.cache/log/cdn-php.log
+LOG_LEVEL=debug
 ```
 
 ## Running with Docker

composer.json

@@ -8,6 +8,7 @@
         "babeuloula/phpunit-coverage-checker": "^1.0",
         "bref/bref": "^2.3",
         "bref/extra-php-extensions": "^1.7",
+        "bref/logger": "^1.0",
         "league/flysystem": "^3.29",
         "league/flysystem-aws-s3-v3": "^3.0",
         "league/glide": "^2.3",

composer.lock

@@ -49,7 +49,7 @@
     </rule>
     <rule ref="rulesets/design.xml/CouplingBetweenObjects">
         <properties>
-            <property name="maximum" value="15"/>
+            <property name="maximum" value="20"/>
         </properties>
     </rule>
     <rule ref="rulesets/naming.xml">

phpmd-ruleset.xml

@@ -8,10 +8,12 @@ params:
     prod:
         bucket_prefix: ''
         app_debug: 0
+        log_level: info
 
     dev:
         bucket_prefix: 'dev-'
         app_debug: 1
+        log_level: debug
 
 provider:
     name: aws
@@ -45,6 +47,8 @@ functions:
             S3_REGION: ${ssm:/cdn-php/s3-region}
             S3_ACCESS_KEY: ${ssm:/cdn-php/s3-access-key}
             S3_SECRET_KEY: ${ssm:/cdn-php/s3-secret-key}
+            LOG_STREAM: php://stderr
+            LOG_LEVEL: ${param:log_level}
 
 package:
     patterns:

serverless.yml

@@ -23,6 +23,7 @@
 use BaBeuloula\CdnPhp\Processor\ImageProcessor;
 use BaBeuloula\CdnPhp\Processor\PathProcessor;
 use BaBeuloula\CdnPhp\Storage\Storage;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
@@ -33,7 +34,8 @@ public function __construct(
         private readonly array $allowedDomains,
         private readonly Storage $storage,
         private readonly ImageProcessor $imageProcessor,
-        private readonly Cache $cache
+        private readonly Cache $cache,
+        private readonly LoggerInterface $logger,
     ) {
     }
 
@@ -72,6 +74,8 @@ public function handleRequest(Request $request): Response
             $this->storage->save($cachedPath, $this->storage->read($processedImage));
         }
 
+        $this->logger->info('Serve the image: {cachedPath}', ['cachedPath' => $cachedPath]);
+
         return $this->cache->createResponse($cachedPath, $supportWebp, $request);
     }
 

src/Cdn.php

@@ -18,13 +18,15 @@
 use BaBeuloula\CdnPhp\Flysystem\Adapter\UrlFilesystemAdapter;
 use BaBeuloula\CdnPhp\Processor\ImageProcessor;
 use BaBeuloula\CdnPhp\Storage\Storage;
+use Bref\Logger\StderrLogger as BrefLogger;
 use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
 use League\Flysystem\AwsS3V3\PortableVisibilityConverter;
 use League\Flysystem\Filesystem as LeagueFilesystem;
 use League\Flysystem\FilesystemAdapter;
 use League\Flysystem\Local\LocalFilesystemAdapter;
 use League\Flysystem\Visibility;
 use Pimple\Container;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Filesystem\Filesystem as SymfonyFilesystem;
 
 final class ContainerConfig extends Container
@@ -38,6 +40,11 @@ public function __construct()
         $this['cache_ttl'] = (int) getenv('CACHE_TTL');
         $this['allowed_domains'] = explode(',', (string) getenv('ALLOWED_DOMAINS'));
 
+        $this[LoggerInterface::class] = static fn () => new BrefLogger(
+            (string) getenv('LOG_LEVEL'),
+            (string) getenv('LOG_STREAM')
+        );
+
         $this[SymfonyFilesystem::class] = static fn() => new SymfonyFilesystem();
 
         switch ($this['storage_driver']) {
@@ -76,12 +83,14 @@ public function __construct()
         $this[LeagueFilesystem::class] = static fn(self $c) => new LeagueFilesystem($c[FilesystemAdapter::class]);
         $this[Storage::class] = static fn (self $c) => new Storage(
             $c[LeagueFilesystem::class],
-            $c[SymfonyFilesystem::class]
+            $c[SymfonyFilesystem::class],
+            $c[LoggerInterface::class],
         );
 
         $this[ImageProcessor::class] = static fn(self $c) => new ImageProcessor(
             $c[FilesystemAdapter::class],
-            $c[UrlFilesystemAdapter::class]
+            $c[UrlFilesystemAdapter::class],
+            $c[LoggerInterface::class],
         );
 
         $this[Cache::class] = static fn(self $c) => new Cache($c[Storage::class], $c['cache_ttl']);
@@ -91,6 +100,7 @@ public function __construct()
             $c[Storage::class],
             $c[ImageProcessor::class],
             $c[Cache::class],
+            $c[LoggerInterface::class],
         );
     }
 }

src/ContainerConfig.php

@@ -29,7 +29,10 @@ private function __construct(
         int $watermarkSize,
         int $watermarkOpacity,
     ) {
-        $this->watermarkUrl = explode('://', (string) $watermarkUrl)[1] ?? null;
+        $this->watermarkUrl = (true === str_contains((string) $watermarkUrl, '://'))
+            ? (explode('://', (string) $watermarkUrl)[1] ?? null)
+            : $watermarkUrl
+        ;
 
         if ($watermarkSize < 0) {
             $watermarkSize = 0;

src/Dto/QueryParams.php

@@ -18,12 +18,14 @@
 use League\Flysystem\Filesystem;
 use League\Flysystem\FilesystemAdapter;
 use League\Glide\ServerFactory;
+use Psr\Log\LoggerInterface;
 
 final class ImageProcessor
 {
     public function __construct(
         private readonly FilesystemAdapter $adapter,
         private readonly UrlFilesystemAdapter $urlFilesystemAdapter,
+        private readonly LoggerInterface $logger,
     ) {
     }
 
@@ -40,6 +42,14 @@ public function process(string $path, QueryParams $params): string
             ],
         );
 
+        $this->logger->info(
+            'Process image: {path} with params {params}',
+            [
+                'path' => $path,
+                'params' => json_encode($params->toArray(), flags: JSON_THROW_ON_ERROR),
+            ]
+        );
+
         return $server->makeImage(basename($path), $params->toArray());
     }
 }