Merge remote-tracking branch 'origin/1.x' into update-1-to-2

Author: dbu

.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"
 
@@ -78,7 +78,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
         with:
           fetch-depth: 2
 
@@ -88,18 +88,18 @@ jobs:
           php-version: "${{ matrix.php-version }}"
           coverage: "pcov"
           ini-values: "zend.assertions=1"
+          tools: "flex"
 
       - name: "Enforce using stable dependencies"
         run: "composer config minimum-stability stable"
         if: "${{ matrix.stability == 'stable' }}"
 
       - name: "Add dependencies and enable flex"
         run: |
-          composer require --no-update symfony/flex ${{ matrix.dependencies }}
-          composer config --no-plugins allow-plugins.symfony/flex true
+          composer require --no-update ${{ matrix.dependencies }}
 
       - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v2"
+        uses: "ramsey/composer-install@v3"
         with:
           dependency-versions: "${{ matrix.dependency-versions }}"
           composer-options: "${{ matrix.composer-options }}"

.github/workflows/php-cs-fixer.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
       - name: "PHP-CS-Fixer"
         uses: "docker://oskarstark/php-cs-fixer-ga:2.19.0"
         with:

CHANGELOG.md

@@ -19,6 +19,26 @@ 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.
+
+# 1.33.1 - 2024-05-27
+
+- Fixed extension to depend on the DependencyInjection component rather than the HttpKernel.
+
 # 1.33.0 - 2024-02-27
 
 - Support php-http/cache-plugin 2.0 and bump minimal version to 1.7 by defaulting the stream factory for cache to `httplug.psr17_stream_factory` (#448).

composer.json

@@ -47,22 +47,24 @@
         "php-http/curl-client": "<2.0",
         "php-http/socket-client": "<2.0",
         "kriswallsmith/buzz": "<0.17",
-        "php-http/react-adapter": "<3.0"
+        "php-http/react-adapter": "<3.0",
+        "php-http/throttle-plugin": "<1.1"
     },
     "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": "^5.4 || ^6.0 || ^7.0",
         "symfony/cache": "^5.4 || ^6.0 || ^7.0",
         "symfony/dom-crawler": "^5.4 || ^6.0 || ^7.0",
         "symfony/framework-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/http-foundation": "^5.4 || ^6.0 || ^7.0",
-        "symfony/phpunit-bridge": "^7.0.3",
         "symfony/stopwatch": "^5.4 || ^6.0 || ^7.0",
         "symfony/twig-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/web-profiler-bundle": "^5.4 || ^6.0 || ^7.0",
@@ -95,7 +97,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/DependencyInjection/Configuration.php

@@ -611,14 +611,38 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
         ->end();
         // End stopwatch plugin
 
-        $error = $children->arrayNode('error')
+        $children->arrayNode('error')
             ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('only_server_exception')->defaultFalse()->end()
             ->end()
         ->end();
         // End error plugin
+
+        $children->arrayNode('throttle')
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->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

@@ -10,6 +10,7 @@
 use Http\Client\Common\HttpMethodsClient;
 use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin\AuthenticationPlugin;
+use Http\Client\Common\Plugin\ThrottlePlugin;
 use Http\Client\Common\PluginClient;
 use Http\Client\Common\PluginClientFactory;
 use Http\Client\HttpAsyncClient;
@@ -30,9 +31,10 @@
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\RateLimiter\LimiterInterface;
 use Twig\Environment as TwigEnvironment;
 
 /**
@@ -284,6 +286,24 @@ private function configurePluginByName($name, Definition $definition, array $con
 
                 break;
 
+            case 'throttle':
+                if (!\class_exists(ThrottlePlugin::class)) {
+                    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($limiterServiceId, LimiterInterface::class)
+                    ->setFactory([new Reference($config['name']), 'create'])
+                    ->addArgument($config['key'])
+                    ->setPublic(false);
+
+                $definition->replaceArgument(0, new Reference($limiterServiceId));
+                $definition->setArgument('$tokens', $config['tokens']);
+                $definition->setArgument('$maxTime', $config['max_time']);
+
+                break;
+
             /* client specific plugins */
 
             case 'add_host':

src/Resources/config/plugins.xml

@@ -28,6 +28,9 @@
         <service id="httplug.plugin.stopwatch" class="Http\Client\Common\Plugin\StopwatchPlugin" public="false" abstract="true">
             <argument />
         </service>
+        <service id="httplug.plugin.throttle" class="Http\Client\Common\Plugin\ThrottlePlugin" public="false" abstract="true">
+            <argument />
+        </service>
 
         <!-- client specific plugin definition prototypes -->
 

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -89,6 +89,12 @@ class ConfigurationTest extends AbstractExtensionConfigurationTestCase
                 'enabled' => false,
                 'only_server_exception' => false,
             ],
+            'throttle' => [
+                'enabled' => false,
+                'key' => null,
+                'tokens' => 1,
+                'max_time' => null,
+            ],
         ],
         'discovery' => [
             'client' => 'auto',
@@ -293,6 +299,12 @@ public function testSupportsAllConfigFormats(): void
                     'enabled' => false,
                     'only_server_exception' => false,
                 ],
+                'throttle' => [
+                    'enabled' => false,
+                    'key' => null,
+                    'tokens' => 1,
+                    'max_time' => null,
+                ],
             ],
             'discovery' => [
                 'client' => 'auto',

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\Plugin\Vcr\Recorder\InMemoryRecorder;
 use Http\HttplugBundle\Collector\PluginClientFactoryListener;
 use Http\HttplugBundle\DependencyInjection\HttplugExtension;
@@ -80,7 +81,7 @@ public function testConfigLoadService(): void
 
     public function testClientPlugins(): void
     {
-        $this->load([
+        $config = [
             'clients' => [
                 'acme' => [
                     'factory' => 'httplug.factory.curl',
@@ -131,6 +132,11 @@ public function testClientPlugins(): void
                                 'headers' => ['X-FOO'],
                             ],
                         ],
+                        [
+                            'query_defaults' => [
+                                'parameters' => ['locale' => 'en'],
+                            ],
+                        ],
                         [
                             'request_seekable_body' => [
                                 'use_file_buffer' => true,
@@ -139,11 +145,6 @@ public function testClientPlugins(): void
                         [
                             'response_seekable_body' => true,
                         ],
-                        [
-                            'query_defaults' => [
-                                'parameters' => ['locale' => 'en'],
-                            ],
-                        ],
                         [
                             'authentication' => [
                                 'my_basic' => [
@@ -166,7 +167,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',
@@ -179,13 +189,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);