refactor: optimize cloudfront invalidation dispatch with chunking and retries

Author: carlalexander

src/CloudProvider/Aws/CloudFrontClient.php

@@ -87,6 +87,26 @@ public function clearUrls($urls)
         });
     }
 
+    /**
+     * Invalidate the given paths.
+     */
+    public function invalidatePaths(array $paths)
+    {
+        $concretePaths = array_filter($paths, function (string $path) {
+            return !str_ends_with($path, '*');
+        });
+        $wildcardPaths = array_filter($paths, function (string $path) {
+            return str_ends_with($path, '*');
+        });
+
+        while (!empty($wildcardPaths) || !empty($concretePaths)) {
+            $batch = array_splice($wildcardPaths, 0, 15);
+            $batch = array_merge($batch, array_splice($concretePaths, 0, 3000 - count($batch)));
+
+            $this->sendInvalidation($batch);
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -104,7 +124,7 @@ public function sendClearRequest(?callable $guard = null)
             return;
         }
 
-        $this->createInvalidation($paths);
+        $this->invalidatePaths($paths);
     }
 
     /**
@@ -139,28 +159,6 @@ private function addPath(string $path)
         $this->invalidationPaths[] = $path;
     }
 
-    /**
-     * Create an invalidation request.
-     */
-    private function createInvalidation($paths)
-    {
-        if (is_string($paths)) {
-            $paths = [$paths];
-        } elseif (!is_array($paths)) {
-            throw new \InvalidArgumentException('"paths" argument must be an array or a string');
-        }
-
-        if (count($paths) > 1) {
-            $paths = $this->filterUniquePaths($paths);
-        }
-
-        $response = $this->request('post', "/2020-05-31/distribution/{$this->distributionId}/invalidation", $this->generateInvalidationPayload($paths));
-
-        if (201 !== $this->parseResponseStatusCode($response)) {
-            throw new \RuntimeException($this->createExceptionMessage('Invalidation request failed', $response));
-        }
-    }
-
     /**
      * Filter all paths and only keep unique ones.
      */
@@ -180,20 +178,16 @@ private function filterUniquePaths(array $paths): array
         });
 
         $wildcardPaths = $wildcardPaths->map(function (string $path) use ($wildcardPaths) {
-            $filteredWildcardPaths = preg_grep(sprintf('/%s/', str_replace('\*', '.*', preg_quote($path, '/'))), $wildcardPaths->all(), PREG_GREP_INVERT);
+            $filteredWildcardPaths = preg_grep(sprintf('/^%s/', str_replace('\*', '.*', preg_quote($path, '/'))), $wildcardPaths->all(), PREG_GREP_INVERT);
             $filteredWildcardPaths[] = $path;
 
             return $filteredWildcardPaths;
         });
 
         $wildcardPaths = new Collection(!$wildcardPaths->isEmpty() ? array_intersect(...$wildcardPaths->all()) : []);
 
-        if ($wildcardPaths->count() > 15) {
-            throw new \RuntimeException('CloudFront only allows for a maximum of 15 wildcard invalidations');
-        }
-
         $wildcardPaths->each(function (string $path) use (&$filteredPaths) {
-            $filteredPaths = preg_grep(sprintf('/%s/', str_replace('\*', '.*', preg_quote($path, '/'))), $filteredPaths, PREG_GREP_INVERT);
+            $filteredPaths = preg_grep(sprintf('/^%s/', str_replace('\*', '.*', preg_quote($path, '/'))), $filteredPaths, PREG_GREP_INVERT);
         });
 
         return array_merge($wildcardPaths->all(), $filteredPaths);
@@ -244,4 +238,36 @@ private function generateInvalidationPayload(array $paths): string
 
         return $xml;
     }
+
+    /**
+     * Send an invalidation request.
+     */
+    private function sendInvalidation(array $paths)
+    {
+        $attempts = 0;
+        $maxAttempts = 3;
+        $payload = $this->generateInvalidationPayload($paths);
+
+        while ($attempts < $maxAttempts) {
+            ++$attempts;
+
+            $response = $this->request('post', "/2020-05-31/distribution/{$this->distributionId}/invalidation", $payload);
+            $statusCode = $this->parseResponseStatusCode($response);
+
+            if (201 === $statusCode) {
+                return;
+            }
+
+            $awsError = $this->parseAwsError($response['body'] ?? '');
+            $errorCode = $awsError['code'] ?? '';
+
+            $shouldRetry = $statusCode >= 500 || 429 === $statusCode || (400 === $statusCode && in_array($errorCode, ['Throttling', 'TooManyInvalidationsInProgress'], true));
+
+            if (!$shouldRetry || $attempts >= $maxAttempts) {
+                throw new \RuntimeException($this->createExceptionMessage('Invalidation request failed', $response));
+            }
+
+            sleep($attempts * 2);
+        }
+    }
 }