[RateLimiter] Add RateLimiterFactoryInterface

alexandre-daubois · alexandre-daubois · commit 17fb0fe9a70d · 2024-11-20T11:32:12.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `RateLimiterFactoryInterface` as an alias of the `limiter` service
+
 7.2
 ---
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/rate_limiter.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/rate_limiter.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Symfony\Component\RateLimiter\RateLimiterFactory;
+use Symfony\Component\RateLimiter\RateLimiterFactoryInterface;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
@@ -26,5 +27,7 @@
                 abstract_arg('storage'),
                 null,
             ])
+
+        ->alias(RateLimiterFactoryInterface::class, 'limiter')
     ;
 };
diff --git a/src/Symfony/Component/RateLimiter/CHANGELOG.md b/src/Symfony/Component/RateLimiter/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `RateLimiterFactoryInterface`
+
 6.4
 ---
 
diff --git a/src/Symfony/Component/RateLimiter/RateLimiterFactory.php b/src/Symfony/Component/RateLimiter/RateLimiterFactory.php
@@ -24,7 +24,7 @@
 /**
  * @author Wouter de Jong <wouter@wouterj.nl>
  */
-final class RateLimiterFactory
+final class RateLimiterFactory implements RateLimiterFactoryInterface
 {
     private array $config;
 
@@ -53,15 +53,15 @@ public function create(?string $key = null): LimiterInterface
         };
     }
 
-    protected static function configureOptions(OptionsResolver $options): void
+    private static function configureOptions(OptionsResolver $options): void
     {
         $intervalNormalizer = static function (Options $options, string $interval): \DateInterval {
             // Create DateTimeImmutable from unix timesatmp, so the default timezone is ignored and we don't need to
             // deal with quirks happening when modifying dates using a timezone with DST.
             $now = \DateTimeImmutable::createFromFormat('U', time());
 
             try {
-                $nowPlusInterval = @$now->modify('+' . $interval);
+                $nowPlusInterval = @$now->modify('+'.$interval);
             } catch (\DateMalformedStringException $e) {
                 throw new \LogicException(\sprintf('Cannot parse interval "%s", please use a valid unit as described on https://www.php.net/datetime.formats.relative.', $interval), 0, $e);
             }
diff --git a/src/Symfony/Component/RateLimiter/RateLimiterFactoryInterface.php b/src/Symfony/Component/RateLimiter/RateLimiterFactoryInterface.php
@@ -0,0 +1,23 @@
+<?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 Alexandre Daubois <alex.daubois@gmail.com>
+ */
+interface RateLimiterFactoryInterface
+{
+    /**
+     * @param string|null $key an optional key used to identify the limiter
+     */
+    public function create(?string $key = null): LimiterInterface;
+}

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`/**`
`25`	`25`	`* @author Wouter de Jong <wouter@wouterj.nl>`
`26`	`26`	`*/`
`27`		`-final class RateLimiterFactory`
	`27`	`+final class RateLimiterFactory implements RateLimiterFactoryInterface`
`28`	`28`	`{`
`29`	`29`	`private array $config;`
`30`	`30`
`@@ -53,15 +53,15 @@ public function create(?string $key = null): LimiterInterface`
`53`	`53`	`};`
`54`	`54`	`}`
`55`	`55`
`56`		`- protected static function configureOptions(OptionsResolver $options): void`
	`56`	`+ private static function configureOptions(OptionsResolver $options): void`
`57`	`57`	`{`
`58`	`58`	`$intervalNormalizer = static function (Options $options, string $interval): \DateInterval {`
`59`	`59`	`// Create DateTimeImmutable from unix timesatmp, so the default timezone is ignored and we don't need to`
`60`	`60`	`// deal with quirks happening when modifying dates using a timezone with DST.`
`61`	`61`	`$now = \DateTimeImmutable::createFromFormat('U', time());`
`62`	`62`
`63`	`63`	`try {`
`64`		`- $nowPlusInterval = @$now->modify('+' . $interval);`
	`64`	`+ $nowPlusInterval = @$now->modify('+'.$interval);`
`65`	`65`	`} catch (\DateMalformedStringException $e) {`
`66`	`66`	`throw new \LogicException(\sprintf('Cannot parse interval "%s", please use a valid unit as described on https://www.php.net/datetime.formats.relative.', $interval), 0, $e);`
`67`	`67`	`}`