.github/workflows/continuous-integration.yml

@@ -43,7 +43,7 @@ jobs:
           - dependencies: "php-http/guzzle7-adapter"
             php-version: "8.2"
             symfony-deprecations-helper: "weak"
-          - dependencies: "php-http/guzzle7-adapter"
+          - dependencies: "php-http/guzzle7-adapter php-http/throttle-plugin"
             php-version: "8.3"
             symfony-deprecations-helper: "weak"
 

CHANGELOG.md

@@ -4,6 +4,18 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 # Version 1
 
+# 1.34.3 - 2024-09-01
+
+- Same as 1.34.2 but tagged on the 1.x banch instead of the feature branch.
+
+# 1.34.2 - 2024-09-01
+
+- More cleanup of the rate-limiter configuration. The service name is the full service name of the rate limiter, e.g. `limiter.my_name` when configuring `framework.rate_limiter.my_name`.
+
+# 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.

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"
     }
 }

src/ClientFactory/AutoDiscoveryFactory.php

@@ -10,6 +10,8 @@
  * Use auto discovery to find a HTTP client.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class AutoDiscoveryFactory implements ClientFactory
 {

src/ClientFactory/BuzzFactory.php

@@ -11,6 +11,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class BuzzFactory implements ClientFactory
 {

src/ClientFactory/CurlFactory.php

@@ -10,6 +10,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class CurlFactory implements ClientFactory
 {

src/ClientFactory/Guzzle5Factory.php

@@ -10,6 +10,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class Guzzle5Factory implements ClientFactory
 {

src/ClientFactory/Guzzle6Factory.php

@@ -8,6 +8,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class Guzzle6Factory implements ClientFactory
 {

src/ClientFactory/Guzzle7Factory.php

@@ -8,6 +8,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class Guzzle7Factory implements ClientFactory
 {

src/ClientFactory/ReactFactory.php

@@ -9,6 +9,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class ReactFactory implements ClientFactory
 {

src/ClientFactory/SocketFactory.php

@@ -9,6 +9,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class SocketFactory implements ClientFactory
 {

src/ClientFactory/SymfonyFactory.php

@@ -11,6 +11,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class SymfonyFactory implements ClientFactory
 {

src/Collector/Collector.php

@@ -18,6 +18,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class Collector extends DataCollector
 {

src/Collector/Formatter.php

@@ -20,6 +20,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class Formatter implements MessageFormatter
 {

src/Collector/ProfileClient.php

@@ -22,6 +22,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class ProfileClient implements HttpClient, HttpAsyncClient
 {

src/Collector/ProfileClientFactory.php

@@ -17,6 +17,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class ProfileClientFactory implements ClientFactory
 {

src/Collector/ProfilePlugin.php

@@ -16,6 +16,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class ProfilePlugin implements Plugin
 {

src/Collector/StackPlugin.php

@@ -16,6 +16,7 @@
  * @author Fabien Bourigault <bourigaultfabien@gmail.com>
  *
  * @internal
+ * @final
  */
 class StackPlugin implements Plugin
 {

src/Collector/Twig/HttpMessageMarkupExtension.php

@@ -13,6 +13,8 @@
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class HttpMessageMarkupExtension extends AbstractExtension
 {

src/DependencyInjection/Configuration.php

@@ -31,6 +31,8 @@
  *
  * @author David Buchmann <mail@davidbu.ch>
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class Configuration implements ConfigurationInterface
 {
@@ -616,7 +618,7 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
         ->end();
         // End stopwatch plugin
 
-        $error = $children->arrayNode('error')
+        $children->arrayNode('error')
             ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
@@ -625,14 +627,26 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
         ->end();
         // End error plugin
 
-        $throttle = $children->arrayNode('throttle')
+        $children->arrayNode('throttle')
             ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
-                ->scalarNode('name')->end()
-                ->scalarNode('key')->defaultNull()->end()
-                ->integerNode('tokens')->defaultValue(1)->end()
-                ->floatNode('max_time')->defaultNull()->end()
+                ->scalarNode('name')
+                    ->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()
             ->end()
         ->end();
         // End throttle plugin

src/DependencyInjection/HttplugExtension.php

@@ -42,6 +42,8 @@
 /**
  * @author David Buchmann <mail@davidbu.ch>
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class HttplugExtension extends Extension
 {
@@ -299,14 +301,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".');
                 }
 
-                $key = $config['name'] ? '.'.$config['name'] : '';
+                $limiterServiceId = $serviceId.'.'.$config['name'];
                 $container
-                    ->register($serviceId.$key, 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.$key));
+                $definition->replaceArgument(0, new Reference($limiterServiceId));
                 $definition->setArgument('$tokens', $config['tokens']);
                 $definition->setArgument('$maxTime', $config['max_time']);
 

src/Discovery/ConfiguredClientsStrategy.php

@@ -14,6 +14,8 @@
  * we can use the web debug toolbar for clients found with the discovery.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class ConfiguredClientsStrategy implements DiscoveryStrategy
 {

src/Discovery/ConfiguredClientsStrategyListener.php

@@ -9,6 +9,8 @@
 
 /**
  * @author Wouter de Jong <wouter@wouterj.nl>
+ *
+ * @final
  */
 class ConfiguredClientsStrategyListener implements EventSubscriberInterface
 {

src/HttplugBundle.php

@@ -9,6 +9,8 @@
 /**
  * @author David Buchmann <mail@davidbu.ch>
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * @final
  */
 class HttplugBundle extends Bundle
 {

src/Resources/views/stack.html.twig

@@ -7,16 +7,14 @@
         {% endif %}
         <span class="label httplug-method httplug-method-{{ stack.requestMethod|lower }}">{{ stack.requestMethod }}</span>
     </div>
-    {% apply spaceless %}
-        <div class="label httplug-stack-header-target">
-            <span class="httplug-scheme">{{ stack.requestScheme }}://</span>
-            <span class="httplug-host">{{ stack.requestHost }}</span>
-            {% if stack.requestPort not in [null, 80, 443] %}
-                <span class="httplug-port">:{{ stack.requestPort }}</span>
-            {% endif %}
-            <span class="httplug-target">{{ (stack.requestTarget|default('/') starts with '/' ? '' : '/')  ~ stack.requestTarget }}</span>
-        </div>
-    {% endapply %}
+    <div class="label httplug-stack-header-target">
+        <span class="httplug-scheme">{{ stack.requestScheme }}://</span>
+        <span class="httplug-host">{{ stack.requestHost }}</span>
+        {% if stack.requestPort not in [null, 80, 443] %}
+            <span class="httplug-port">:{{ stack.requestPort }}</span>
+        {% endif %}
+        <span class="httplug-target">{{ (stack.requestTarget|default('/') starts with '/' ? '' : '/')  ~ stack.requestTarget }}</span>
+    </div>
     <div>
         <span class="label httplug-duration">{{ stack.duration|number_format }} ms</span>
         {% if stack.responseCode >= 400 and stack.responseCode <= 599 %}

tests/Functional/ProfilerTest.php

@@ -28,7 +28,7 @@ public function testShowProfiler(): void
         $client->request('GET', '/_profiler/latest?panel=httplug');
         $content = $client->getResponse()->getContent();
         $this->assertStringContainsString(<<<HTML
-            <div class="label httplug-stack-header-target"><span class="httplug-scheme">https://</span><span class="httplug-host">jsonplaceholder.typicode.com</span><span class="httplug-target">/posts/1</span></div>
+        <span class="httplug-host">jsonplaceholder.typicode.com</span>
         HTML, $content);
     }
 }

tests/Unit/DependencyInjection/HttplugExtensionTest.php

@@ -5,6 +5,7 @@
 namespace Http\HttplugBundle\Tests\Unit\DependencyInjection;
 
 use Http\Adapter\Guzzle7\Client;
+use Http\Client\Common\Plugin\ThrottlePlugin;
 use Http\Client\HttpClient;
 use Http\Client\Plugin\Vcr\Recorder\InMemoryRecorder;
 use Http\HttplugBundle\Collector\PluginClientFactoryListener;
@@ -79,7 +80,7 @@ public function testConfigLoadService(): void
 
     public function testClientPlugins(): void
     {
-        $this->load([
+        $config = [
             'clients' => [
                 'acme' => [
                     'factory' => 'httplug.factory.curl',
@@ -130,6 +131,11 @@ public function testClientPlugins(): void
                                 'headers' => ['X-FOO'],
                             ],
                         ],
+                        [
+                            'query_defaults' => [
+                                'parameters' => ['locale' => 'en'],
+                            ],
+                        ],
                         [
                             'request_seekable_body' => [
                                 'use_file_buffer' => true,
@@ -138,11 +144,6 @@ public function testClientPlugins(): void
                         [
                             'response_seekable_body' => true,
                         ],
-                        [
-                            'query_defaults' => [
-                                'parameters' => ['locale' => 'en'],
-                            ],
-                        ],
                         [
                             'authentication' => [
                                 'my_basic' => [
@@ -165,7 +166,16 @@ public function testClientPlugins(): void
                     ],
                 ],
             ],
-        ]);
+        ];
+        if (class_exists(ThrottlePlugin::class)) {
+            $config['clients']['acme']['plugins'][] = [
+                'throttle' => [
+                    'name' => 'limiter.test',
+                ],
+            ];
+        }
+
+        $this->load($config);
 
         $plugins = [
             'httplug.client.acme.plugin.decoder',
@@ -178,13 +188,16 @@ 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.authentication.my_basic',
             'httplug.client.acme.plugin.cache',
             'httplug.client.acme.plugin.error',
         ];
+        if (\class_exists(ThrottlePlugin::class)) {
+            $plugins[] = 'httplug.client.acme.plugin.throttle';
+        }
         $pluginReferences = array_map(function ($id) {
             return new Reference($id);
         }, $plugins);