feature #59929 [RateLimiter] Add CompoundRateLimiterFactory (kbond)

fabpot · fabpot · commit 3fd7ea826441 · 2025-03-21T14:55:21.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [RateLimiter] Add `CompoundRateLimiterFactory` | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | #59925 | License | MIT First step for #59925. Commits ------- aae5b46 [RateLimiter] add `CompoundRateLimiterFactory`
diff --git a/src/Symfony/Component/RateLimiter/CHANGELOG.md b/src/Symfony/Component/RateLimiter/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `RateLimiterFactoryInterface`
+ * Add `CompoundRateLimiterFactory`
 
 6.4
 ---
diff --git a/src/Symfony/Component/RateLimiter/CompoundRateLimiterFactory.php b/src/Symfony/Component/RateLimiter/CompoundRateLimiterFactory.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\RateLimiter;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class CompoundRateLimiterFactory implements RateLimiterFactoryInterface
+{
+    /**
+     * @param iterable<RateLimiterFactoryInterface> $rateLimiterFactories
+     */
+    public function __construct(private iterable $rateLimiterFactories)
+    {
+    }
+
+    public function create(?string $key = null): LimiterInterface
+    {
+        $rateLimiters = [];
+
+        foreach ($this->rateLimiterFactories as $rateLimiterFactory) {
+            $rateLimiters[] = $rateLimiterFactory->create($key);
+        }
+
+        return new CompoundLimiter($rateLimiters);
+    }
+}
diff --git a/src/Symfony/Component/RateLimiter/Tests/CompoundRateLimiterFactoryTest.php b/src/Symfony/Component/RateLimiter/Tests/CompoundRateLimiterFactoryTest.php
@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\RateLimiter\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\RateLimiter\CompoundLimiter;
+use Symfony\Component\RateLimiter\CompoundRateLimiterFactory;
+use Symfony\Component\RateLimiter\LimiterInterface;
+use Symfony\Component\RateLimiter\RateLimiterFactoryInterface;
+
+class CompoundRateLimiterFactoryTest extends TestCase
+{
+    public function testCreate()
+    {
+        $factory1 = $this->createMock(RateLimiterFactoryInterface::class);
+        $factory1
+            ->method('create')
+            ->with('foo')
+            ->willReturn($this->createMock(LimiterInterface::class))
+        ;
+        $factory2 = $this->createMock(RateLimiterFactoryInterface::class);
+        $factory2
+            ->method('create')
+            ->with('foo')
+            ->willReturn($this->createMock(LimiterInterface::class))
+        ;
+
+        $compoundFactory = new CompoundRateLimiterFactory([$factory1, $factory2]);
+
+        $this->assertInstanceOf(CompoundLimiter::class, $compoundFactory->create('foo'));
+    }
+}
