Implement debugging level

area17 · Sep 23, 2024 · 06c8902 · 06c8902
1 parent 6c2694a
commit 06c8902
Show file tree

Hide file tree

Showing 10 changed files with 112 additions and 85 deletions.
diff --git a/config/edge-flush.php b/config/edge-flush.php
@@ -23,5 +23,7 @@
     /**
      * Enable/disable the pacakge
      */
-    'debug' => env('EDGE_FLUSH_DEBUG', false),
+    'debug_level' => ($level = env('EDGE_FLUSH_DEBUG_LEVEL', 0)),
+
+    'debug' => env('EDGE_FLUSH_DEBUG', $level > 0),
 ];
diff --git a/src/Behaviours/MakeTag.php b/src/Behaviours/MakeTag.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Behaviours;
 
@@ -32,7 +34,7 @@ public function makeModelName(mixed $model, string $key = null, array $allowedKe
                 ? $model->getCDNCacheTag($key, $type)
                 : $this->getCDNCacheTagFromModel($model, $key, $type);
         } catch (\Exception $exception) {
-            Helpers::debug("Exception on makeModelName: ".$exception->getMessage());
+            Helpers::debug('MAKE-TAG:EXCEPTION: on makeModelName: ' . $exception->getMessage());
 
             return null;
         }
@@ -66,9 +68,7 @@ public function tagIsExcluded(string $tag): bool
         /**
          * @param callable(string $pattern): boolean $pattern
          */
-        return $this->excludedModels->contains(
-            fn(string $pattern) => EdgeFlush::match($pattern, $tag),
-        );
+        return $this->excludedModels->contains(fn(string $pattern) => EdgeFlush::match($pattern, $tag));
     }
 
     public function tagIsNotExcluded(string $tag): bool
@@ -147,9 +147,9 @@ protected function attributeMustBeIgnored(Model|string $model, string $attribute
     {
         $model = $model instanceof Model ? get_class($model) : $model;
 
-        $attributes = Helpers::configArray("edge-flush.invalidations.attributes.ignore", []);
+        $attributes = Helpers::configArray('edge-flush.invalidations.attributes.ignore', []);
 
-        $ignore = array_merge($attributes[$model] ?? [], ($attributes['*'] ?? []));
+        $ignore = array_merge($attributes[$model] ?? [], $attributes['*'] ?? []);
 
         return in_array($attribute, $ignore);
     }

diff --git a/src/Services/Akamai/Service.php b/src/Services/Akamai/Service.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Services\Akamai;
 
@@ -89,7 +91,8 @@ public function createInvalidationRequest(Invalidation|array $invalidation = nul
             $invalidation = (new Invalidation())->setUrls($invalidation);
         }
 
-        $urls = $invalidation->urls()
+        $urls = $invalidation
+            ->urls()
             ->map(function ($item) {
                 return $item instanceof Url ? $item->url_hash : $item;
             })
@@ -104,7 +107,9 @@ public function createInvalidationRequest(Invalidation|array $invalidation = nul
             'objects' => $urls->toArray(),
         ];
 
-        Helpers::debug('[AKAMAI] dispatching invalidations for ' . $urls->count() . ' urls');
+        Helpers::debug('AKAMAI: dispatching invalidations for ' . $urls->count() . ' urls');
+
+        Helpers::debug('AKAMAI: invalidating these URLs: ' . json_encode($body), 4);
 
         // Create an instance of the Timer
         $timer = new Timer();
@@ -143,9 +148,7 @@ public function createInvalidationRequest(Invalidation|array $invalidation = nul
 
     public function isProperlyConfigured(): bool
     {
-        return filled($this->getClientToken())
-            && filled($this->getClientSecret())
-            && filled($this->getAccessToken());
+        return filled($this->getClientToken()) && filled($this->getClientSecret()) && filled($this->getAccessToken());
     }
 
     public function getClientToken(): string|null

diff --git a/src/Services/BaseService.php b/src/Services/BaseService.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Services;
 
@@ -14,7 +16,8 @@
 
 abstract class BaseService implements ServiceContract
 {
-    use ControlsInvalidations, CastObject;
+    use ControlsInvalidations;
+    use CastObject;
 
     protected bool|null $enabled = null;
 
@@ -41,7 +44,10 @@ public function makeResponse(Response $response): Response
             return $response;
         }
 
-        Helpers::debug('CACHABLE-MATRIX: ' . json_encode(EdgeFlush::cacheControl()->getCachableMatrix($response)));
+        Helpers::debug(
+            'RESPONSE:CACHABLE-MATRIX: ' . json_encode(EdgeFlush::cacheControl()->getCachableMatrix($response)),
+            3,
+        );
 
         return $this->addHeadersToResponse(
             $response,
@@ -99,9 +105,9 @@ public function getInvalidationPathsForTags(Invalidation $invalidation): Collect
 
     public function addHeadersFromRequest(Response $response): void
     {
-        (new Collection(Helpers::configArray('edge-flush.strategies.headers.from-request')))->each(function (string $header) use (
-            $response
-        ) {
+        (new Collection(Helpers::configArray('edge-flush.strategies.headers.from-request')))->each(function (
+            string $header
+        ) use ($response) {
             if (filled($value = request()->header($header))) {
                 $response->headers->set($header, $value);
             }

diff --git a/src/Services/CdnBaseService.php b/src/Services/CdnBaseService.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Services;
 
@@ -33,7 +35,7 @@ public function invalidateAll(): Invalidation
         }
 
         return $this->createInvalidationRequest(
-            Helpers::configArray('edge-flush.services.'.static::$serviceName.'.invalidate_all_paths'),
+            Helpers::configArray('edge-flush.services.' . static::$serviceName . '.invalidate_all_paths'),
         );
     }
 
@@ -80,10 +82,10 @@ public function invalidatePaths(Invalidation $invalidation): Invalidation
     {
         return $this->createInvalidationRequest($invalidation);
     }
-    
+
     public function maxUrls(): int
     {
-        return Helpers::configInt('edge-flush.services.'.static::$serviceName.'.max_urls') ?? 300;
+        return Helpers::configInt('edge-flush.services.' . static::$serviceName . '.max_urls') ?? 300;
     }
 
     public function enabled(): bool
@@ -92,27 +94,27 @@ public function enabled(): bool
             return $this->enabled;
         }
 
-        $enabled = EdgeFlush::enabled() &&
-            $this->serviceIsEnabled() &&
-            $this->isProperlyConfigured();
+        $enabled = EdgeFlush::enabled() && $this->serviceIsEnabled() && $this->isProperlyConfigured();
 
         if (!$enabled) {
-            Helpers::debug('Service is not enabled or not properly configured: '.static::$serviceName);
+            Helpers::debug('CDN-SERVICE: service is not enabled or not properly configured: ' . static::$serviceName);
         }
 
         return $this->enabled = $enabled;
     }
 
     public function serviceIsEnabled(): bool
     {
-        return Helpers::configBool('edge-flush.services.'.static::$serviceName.'.enabled', true);
+        return Helpers::configBool('edge-flush.services.' . static::$serviceName . '.enabled', true);
     }
 
     public function canInvalidateAll(): bool
     {
         return collect(
-            Helpers::configString('edge-flush.services.'.static::$serviceName.'.invalidate_all_paths') ?? []
-        )->filter()->isNotEmpty();
+            Helpers::configString('edge-flush.services.' . static::$serviceName . '.invalidate_all_paths') ?? [],
+        )
+            ->filter()
+            ->isNotEmpty();
     }
 
     public function createInvalidationRequest(Invalidation|array $invalidation = null): Invalidation

diff --git a/src/Services/CloudFront/Service.php b/src/Services/CloudFront/Service.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Services\CloudFront;
 
@@ -36,19 +38,19 @@ protected function instantiate(): void
 
     protected function getDistributionId(): string|null
     {
-        return Helpers::configString('edge-flush.services.'.static::$serviceName.'.distribution_id');
+        return Helpers::configString('edge-flush.services.' . static::$serviceName . '.distribution_id');
     }
 
     public function getClient(): CloudFrontClient|null
     {
         $config = [
-            'region' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.region'),
+            'region' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.region'),
 
-            'version' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.sdk_version'),
+            'version' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.sdk_version'),
 
             'credentials' => [
-                'key' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.key'),
-                'secret' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.secret'),
+                'key' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.key'),
+                'secret' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.secret'),
             ],
         ];
 
@@ -57,13 +59,13 @@ public function getClient(): CloudFrontClient|null
         }
 
         return new CloudFrontClient([
-            'region' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.region'),
+            'region' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.region'),
 
-            'version' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.sdk_version'),
+            'version' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.sdk_version'),
 
             'credentials' => [
-                'key' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.key'),
-                'secret' => Helpers::configString('edge-flush.services.'.static::$serviceName.'.secret'),
+                'key' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.key'),
+                'secret' => Helpers::configString('edge-flush.services.' . static::$serviceName . '.secret'),
             ],
         ]);
     }
@@ -96,20 +98,16 @@ public function createInvalidationRequest(Invalidation|array $invalidation = nul
         $invalidation = $this->createInvalidation($invalidation);
 
         if ($this->client() === null) {
-            Helpers::debug('[CLOUD FRONT]: Service is disabled.');
+            Helpers::debug('CLOUD-FRONT: Service is disabled.');
 
             return $invalidation;
         }
 
         $paths = $invalidation->paths()->toArray();
 
-        Helpers::debug(
-            '[CLOUD FRONT]: Invalidating ' .
-            count($paths) .
-            ' path(s): (' .
-            (new Collection($paths))->take(20)->implode(', ') .
-            ')...',
-        );
+        Helpers::debug('CLOUD-FRONT:INVALIDATION: path count: ' . count($paths));
+
+        Helpers::debug('CLOUD-FRONT:INVALIDATION: paths: ' . (new Collection($paths))->take(20)->implode(', '), 5);
 
         try {
             $response = $this->client()->createInvalidation([
@@ -124,10 +122,10 @@ public function createInvalidationRequest(Invalidation|array $invalidation = nul
             ]);
         } catch (\Exception $e) {
             Log::error(
-                '[EDGE-FLUSH] [CLOUD FRONT] Invalidation request failed: ' .
-                $e->getMessage() .
-                ' - PATHS: ' .
-                json_encode($paths),
+                '[EDGE-FLUSH] CLOUD-FRONT Invalidation request failed: ' .
+                    $e->getMessage() .
+                    ' - PATHS: ' .
+                    json_encode($paths),
             );
 
             return $invalidation;

diff --git a/src/Services/Entity.php b/src/Services/Entity.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace A17\EdgeFlush\Services;
 
@@ -133,7 +135,7 @@ public function getDirtyModelNames(): Collection
         foreach ($this->attributes as $key => $value) {
             $castTypeNew = gettype($value);
             $castTypeOld = gettype($this->original[$key]);
-            
+
             $original = $this->encodeValueForComparison($this->original[$key], $castTypeOld);
             $updated = $this->encodeValueForComparison($value, $castTypeNew);
 
@@ -146,7 +148,9 @@ public function getDirtyModelNames(): Collection
                     }
 
                     if (!isset($this->modelNames[$modelName])) {
-                        Helpers::debug("ATTRIBUTE CHANGED: {$modelName} - old: {$original}({$castTypeOld}) - new: {$updated}({$castTypeNew})");
+                        Helpers::debug(
+                            "ENTITY:ATTRIBUTE-CHANGED: {$modelName} - old: {$original}({$castTypeOld}) - new: {$updated}({$castTypeNew})",
+                        );
 
                         $this->modelNames[$modelName] = $modelName;
                     }
@@ -164,7 +168,7 @@ public function getDirtyModelNames(): Collection
                     }
 
                     if (!isset($this->modelNames[$modelName])) {
-                        Helpers::debug("RELATION CHANGED: {$modelName}");
+                        Helpers::debug("ENTITY:RELATION-CHANGED: {$modelName}");
 
                         $this->modelNames[$modelName] = $modelName;
                     }