Merge pull request #464 from php-http/fix-throttle

throttle plugin requires a name
php-http · Sep 1, 2024 · 3fdfecc · 3fdfecc
2 parents 5380dad + 64362f1
commit 3fdfecc
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 # Version 1
 
+# 1.34.1 - 2024-09-01
+
+- The rate-limiter name in the throttle plugin configuration is required.
+
 # 1.34.0 - 2024-06-17
 
 - Support to configure the throttle plugin.

diff --git a/composer.json b/composer.json
@@ -50,18 +50,19 @@
     },
     "require-dev": {
         "guzzlehttp/psr7": "^1.7 || ^2.0",
-        "matthiasnoback/symfony-dependency-injection-test": "^4.0 || ^5.0",
+        "matthiasnoback/symfony-config-test": "^4.3 || ^5.0",
+        "matthiasnoback/symfony-dependency-injection-test": "^4.3.1 || ^5.0",
         "nyholm/nsa": "^1.1",
         "nyholm/psr7": "^1.2.1",
         "php-http/cache-plugin": "^1.7",
         "php-http/mock-client": "^1.2",
         "php-http/promise": "^1.0",
+        "phpunit/phpunit": "^9.6",
         "symfony/browser-kit": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/cache": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/dom-crawler": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/framework-bundle": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/http-foundation": "^4.4.19 || ^5.0 || ^6.0 || ^7.0",
-        "symfony/phpunit-bridge": "^6.4.1",
         "symfony/stopwatch": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/twig-bundle": "^4.4 || ^5.0 || ^6.0 || ^7.0",
         "symfony/web-profiler-bundle": "^4.4.19 || ^5.0 || ^6.0 || ^7.0",
@@ -97,7 +98,7 @@
     },
     "prefer-stable": false,
     "scripts": {
-        "test": "vendor/bin/simple-phpunit",
-        "test-ci": "vendor/bin/simple-phpunit --coverage-text --coverage-clover=build/coverage.xml"
+        "test": "vendor/bin/phpunit",
+        "test-ci": "vendor/bin/phpunit --coverage-text --coverage-clover=build/coverage.xml"
     }
 }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -616,7 +616,7 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
         ->end();
         // End stopwatch plugin
 
-        $error = $children->arrayNode('error')
+        $children->arrayNode('error')
             ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
@@ -625,11 +625,14 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
         ->end();
         // End error plugin
 
-        $throttle = $children->arrayNode('throttle')
+        $children->arrayNode('throttle')
             ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
-                ->scalarNode('name')->end()
+                ->scalarNode('name')
+                    ->info('The name of the configured symfony/rate-limiter to use')
+                    ->isRequired()
+                ->end()
                 ->scalarNode('key')->defaultNull()->end()
                 ->integerNode('tokens')->defaultValue(1)->end()
                 ->floatNode('max_time')->defaultNull()->end()

diff --git a/src/DependencyInjection/HttplugExtension.php b/src/DependencyInjection/HttplugExtension.php
@@ -299,14 +299,13 @@ private function configurePluginByName($name, Definition $definition, array $con
                     throw new InvalidConfigurationException('You need to require the Throttle Plugin to be able to use it: "composer require php-http/throttle-plugin".');
                 }
 
-                $key = $config['name'] ? '.'.$config['name'] : '';
                 $container
-                    ->register($serviceId.$key, LimiterInterface::class)
+                    ->register($serviceId.$config['name'], LimiterInterface::class)
                     ->setFactory([new Reference('limiter.'.$config['name']), 'create'])
                     ->addArgument($config['key'])
                     ->setPublic(false);
 
-                $definition->replaceArgument(0, new Reference($serviceId.$key));
+                $definition->replaceArgument(0, new Reference($serviceId.$config['name']));
                 $definition->setArgument('$tokens', $config['tokens']);
                 $definition->setArgument('$maxTime', $config['max_time']);