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

Author: dbu

.github/workflows/continuous-integration.yml

@@ -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,14 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 # Version 1
 
+# 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

@@ -42,12 +42,13 @@
         "symfony/options-resolver": "^5.4 || ^6.0 || ^7.0"
     },
     "conflict": {
+        "kriswallsmith/buzz": "<0.17",
         "php-http/guzzle6-adapter": "<1.1",
         "php-http/cache-plugin": "<1.7",
         "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",

src/DependencyInjection/Configuration.php

@@ -619,6 +619,18 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
             ->end()
         ->end();
         // End error plugin
+
+        $throttle = $children->arrayNode('throttle')
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->scalarNode('name')->end()
+                ->scalarNode('key')->defaultNull()->end()
+                ->integerNode('tokens')->defaultValue(1)->end()
+                ->floatNode('max_time')->defaultNull()->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".');
+                }
+
+                $key = $config['name'] ? '.'.$config['name'] : '';
+                $container
+                    ->register($serviceId.$key, LimiterInterface::class)
+                    ->setFactory([new Reference('limiter.'.$config['name']), 'create'])
+                    ->addArgument($config['key'])
+                    ->setPublic(false);
+
+                $definition->replaceArgument(0, new Reference($serviceId.$key));
+                $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',