Add documentation for HTTP retry strategy and update .gitignore

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>
Signed-off-by: Emilien Escalle <emilien.escalle@escemi.com>

Author: Copilot

.gitignore

@@ -6,4 +6,4 @@
 composer.lock
 .cache
 tests/.phpunit.result.cache
-build/
+build/

tests/Fixtures/Downloader/CachedHttpDownloader.php

@@ -6,6 +6,8 @@
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Exception\RequestException;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 
 class CachedHttpDownloader
 {
@@ -62,7 +64,7 @@ public function fetch(string $url, bool $forceRefresh = false): string
         return $body;
     }
 
-    private function fetchWithRetry(string $url, array $options = []): \Psr\Http\Message\ResponseInterface
+    private function fetchWithRetry(string $url, array $options = []): ResponseInterface
     {
         $attempt = 0;
         $maxRetries = $this->maxRetries;
@@ -79,7 +81,7 @@ private function fetchWithRetry(string $url, array $options = []): \Psr\Http\Mes
 
                 $response = $this->client->get($url, $options);
                 return $response;
-                
+
             } catch (ClientException $e) {
                 // Check if it's a 429 (Too Many Requests) or other retryable client error
                 if ($e->getResponse() && in_array($e->getResponse()->getStatusCode(), [429, 503, 502, 504])) {
@@ -98,7 +100,7 @@ private function fetchWithRetry(string $url, array $options = []): \Psr\Http\Mes
                 throw $e;
             }
         }
-        
-        throw new \RuntimeException("Max retries ({$maxRetries}) exceeded for URL: {$url}");
+
+        throw new RuntimeException("Max retries ({$maxRetries}) exceeded for URL: {$url}");
     }
 }

tests/Fixtures/Downloader/CssReferentialScraper.php

@@ -27,10 +27,10 @@ public function __construct(bool $forceRefresh = false)
     public function fetchReferentials(): array
     {
         $w3cReferencial = $this->fetchW3CReferential();
-        
+
         // Add delay between different API calls to be respectful to servers
         usleep(2000000); // 2 seconds
-        
+
         $mdnReferencial = $this->fetchMdnReferential();
 
         $properties = $w3cReferencial['properties'] ?? [];

tests/TestSuite/CachedHttpDownloaderTest.php renamed to tests/TestSuite/Fixtures/Downloader/CachedHttpDownloaderTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Tests\TestSuite;
+namespace Tests\TestSuite\Fixtures\Downloader;
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
@@ -10,6 +10,9 @@
 use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\TestCase;
 use Tests\Fixtures\Downloader\CachedHttpDownloader;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use ReflectionClass;
 
 class CachedHttpDownloaderTest extends TestCase
 {
@@ -18,7 +21,7 @@ class CachedHttpDownloaderTest extends TestCase
     protected function setUp(): void
     {
         $this->tempCacheDir = sys_get_temp_dir() . '/test_cache_' . uniqid();
-        mkdir($this->tempCacheDir, 0777, true);
+        mkdir($this->tempCacheDir, 0o777, true);
     }
 
     protected function tearDown(): void
@@ -39,15 +42,15 @@ public function testRetryOn429Error(): void
         $client = new Client(['handler' => $handlerStack]);
 
         $downloader = new CachedHttpDownloader('test', $this->tempCacheDir, 10, 3); // 10ms delay, 3 max retries
-        
+
         // Use reflection to replace the client
-        $reflection = new \ReflectionClass($downloader);
+        $reflection = new ReflectionClass($downloader);
         $clientProperty = $reflection->getProperty('client');
         $clientProperty->setAccessible(true);
         $clientProperty->setValue($downloader, $client);
 
         $result = $downloader->fetch('http://test.com', true);
-        
+
         $this->assertEquals('success content', $result);
     }
 
@@ -65,9 +68,9 @@ public function testRetryFailsAfterMaxAttempts(): void
         $client = new Client(['handler' => $handlerStack]);
 
         $downloader = new CachedHttpDownloader('test', $this->tempCacheDir, 10, 3); // 10ms delay, 3 max retries
-        
+
         // Use reflection to replace the client
-        $reflection = new \ReflectionClass($downloader);
+        $reflection = new ReflectionClass($downloader);
         $clientProperty = $reflection->getProperty('client');
         $clientProperty->setAccessible(true);
         $clientProperty->setValue($downloader, $client);
@@ -87,15 +90,15 @@ public function testSuccessfulRequest(): void
         $client = new Client(['handler' => $handlerStack]);
 
         $downloader = new CachedHttpDownloader('test', $this->tempCacheDir, 10, 3);
-        
+
         // Use reflection to replace the client
-        $reflection = new \ReflectionClass($downloader);
+        $reflection = new ReflectionClass($downloader);
         $clientProperty = $reflection->getProperty('client');
         $clientProperty->setAccessible(true);
         $clientProperty->setValue($downloader, $client);
 
         $result = $downloader->fetch('http://test.com', true);
-        
+
         $this->assertEquals('success content', $result);
     }
 
@@ -109,8 +112,8 @@ public function testCachedResponse(): void
         $client1 = new Client(['handler' => $handlerStack1]);
 
         $downloader = new CachedHttpDownloader('test', $this->tempCacheDir, 10, 3);
-        
-        $reflection = new \ReflectionClass($downloader);
+
+        $reflection = new ReflectionClass($downloader);
         $clientProperty = $reflection->getProperty('client');
         $clientProperty->setAccessible(true);
         $clientProperty->setValue($downloader, $client1);
@@ -135,10 +138,10 @@ private function removeDirectory(string $dir): void
         if (!is_dir($dir)) {
             return;
         }
-        
-        $files = new \RecursiveIteratorIterator(
-            new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS),
-            \RecursiveIteratorIterator::CHILD_FIRST
+
+        $files = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
+            RecursiveIteratorIterator::CHILD_FIRST
         );
 
         foreach ($files as $fileinfo) {
@@ -148,4 +151,4 @@ private function removeDirectory(string $dir): void
 
         rmdir($dir);
     }
-}
+}