Throttle plugin configuration documentation

Author: Maxim Solovev

composer.json

@@ -57,6 +57,7 @@
         "php-http/cache-plugin": "^1.7",
         "php-http/mock-client": "^1.2",
         "php-http/promise": "^1.0",
+        "php-http/throttle-plugin": "^1.1",
         "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",

src/DependencyInjection/Configuration.php

@@ -630,12 +630,21 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('name')
-                    ->info('The name of the configured symfony/rate-limiter to use')
                     ->isRequired()
+                    ->info('Rate limiter service name from symfony/rate-limiter configuration. E.g. for a rate limiter http_client you specify limiter.http_client here')
+                ->end()
+                ->scalarNode('key')
+                    ->defaultNull()
+                    ->info('Key to avoid sharing this rate limiter with other clients or other services. You can use the name of the client for example.')
+                ->end()
+                ->integerNode('tokens')
+                    ->defaultValue(1)
+                    ->info('How many tokens spending per request')
+                ->end()
+                ->floatNode('max_time')
+                    ->defaultNull()
+                    ->info('Maximum accepted waiting time in seconds')
                 ->end()
-                ->scalarNode('key')->defaultNull()->end()
-                ->integerNode('tokens')->defaultValue(1)->end()
-                ->floatNode('max_time')->defaultNull()->end()
             ->end()
         ->end();
         // End throttle plugin

src/DependencyInjection/HttplugExtension.php

@@ -299,13 +299,14 @@ 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".');
                 }
 
+                $limiterServiceId = $serviceId.'.'.$config['name'];
                 $container
-                    ->register($serviceId.$config['name'], LimiterInterface::class)
-                    ->setFactory([new Reference('limiter.'.$config['name']), 'create'])
+                    ->register($limiterServiceId, LimiterInterface::class)
+                    ->setFactory([new Reference($config['name']), 'create'])
                     ->addArgument($config['key'])
                     ->setPublic(false);
 
-                $definition->replaceArgument(0, new Reference($serviceId.$config['name']));
+                $definition->replaceArgument(0, new Reference($limiterServiceId));
                 $definition->setArgument('$tokens', $config['tokens']);
                 $definition->setArgument('$maxTime', $config['max_time']);
 

tests/Unit/DependencyInjection/HttplugExtensionTest.php

@@ -130,6 +130,11 @@ public function testClientPlugins(): void
                                 'headers' => ['X-FOO'],
                             ],
                         ],
+                        [
+                            'query_defaults' => [
+                                'parameters' => ['locale' => 'en'],
+                            ],
+                        ],
                         [
                             'request_seekable_body' => [
                                 'use_file_buffer' => true,
@@ -139,8 +144,8 @@ public function testClientPlugins(): void
                             'response_seekable_body' => true,
                         ],
                         [
-                            'query_defaults' => [
-                                'parameters' => ['locale' => 'en'],
+                            'throttle' => [
+                                'name' => 'limiter.test',
                             ],
                         ],
                         [
@@ -178,9 +183,10 @@ public function testClientPlugins(): void
             'httplug.client.acme.plugin.header_defaults',
             'httplug.client.acme.plugin.header_set',
             'httplug.client.acme.plugin.header_remove',
+            'httplug.client.acme.plugin.query_defaults',
             'httplug.client.acme.plugin.request_seekable_body',
             'httplug.client.acme.plugin.response_seekable_body',
-            'httplug.client.acme.plugin.query_defaults',
+            'httplug.client.acme.plugin.throttle',
             'httplug.client.acme.authentication.my_basic',
             'httplug.client.acme.plugin.cache',
             'httplug.client.acme.plugin.error',