feature #48275 [FrameworkBundle] Allow to avoid limit definition in a RateLimiter configuration when using the no_limit policy (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit c1d281d0b504 · 2022-12-13T11:37:25.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #48268 | License | MIT | Doc PR | N/A As stated in the issue, DX will be improved if we can avoid setting a `limit` when using `no_limit` policy. Targets 6.3, as it can be considered as a feature. Commits ------- cd02eac [FrameworkBundle][DX] Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `DomCrawlerAssertionsTrait::assertSelectorCount(int $count, string $selector)`
+ * Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy
 
 6.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -2104,7 +2104,6 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode, callable $
                                     ->end()
                                     ->integerNode('limit')
                                         ->info('The maximum allowed hits in a fixed interval or burst')
-                                        ->isRequired()
                                     ->end()
                                     ->scalarNode('interval')
                                         ->info('Configures the fixed interval if "policy" is set to "fixed_window" or "sliding_window". The value must be a number followed by "second", "minute", "hour", "day", "week" or "month" (or their plural equivalent).')
@@ -2119,6 +2118,10 @@ private function addRateLimiterSection(ArrayNodeDefinition $rootNode, callable $
                                         ->end()
                                     ->end()
                                 ->end()
+                                ->validate()
+                                    ->ifTrue(function ($v) { return 'no_limit' !== $v['policy'] && !isset($v['limit']); })
+                                    ->thenInvalid('A limit must be provided when using a policy different than "no_limit".')
+                                ->end()
                             ->end()
                         ->end()
                     ->end()
