Add configuration option to disable registration of default client

Author: ruudk

CHANGELOG.md

@@ -10,6 +10,8 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
   BatchClientInterface if they are enabled on the default/first client.
   (Only available with Httplug 2)
 - Configuration for the content_type plugin
+- Configuration option `register_default_client` to allow disabling registering a
+  default client. This will prevent autowiring the default client without knowing it.
 
 ### Changed
 

src/DependencyInjection/Configuration.php

@@ -108,6 +108,10 @@ public function getConfigTreeBuilder()
             ->end()
             ->fixXmlConfig('client')
             ->children()
+                ->booleanNode('register_default_client')
+                    ->defaultTrue()
+                    ->info('Set to false to not register the default client.')
+                ->end()
                 ->arrayNode('main_alias')
                     ->addDefaultsIfNotSet()
                     ->info('Configure which service the main alias point to.')

src/DependencyInjection/HttplugExtension.php

@@ -87,6 +87,10 @@ public function load(array $configs, ContainerBuilder $container)
         $this->configureClients($container, $config);
         $this->configurePlugins($container, $config['plugins']); // must be after clients, as clients.X.plugins might use plugins as templates that will be removed
         $this->configureAutoDiscoveryClients($container, $config);
+
+        if (!$config['register_default_client']) {
+            $container->removeDefinition('httplug.client.default');
+        }
     }
 
     /**

tests/Functional/DiscoveryTest.php

@@ -71,4 +71,13 @@ public function testNoDiscoveryFallbacks()
         $clientDefinition = $this->container->getDefinition('httplug.client.default');
         $this->assertEquals([HttpClientDiscovery::class, 'find'], $clientDefinition->getFactory());
     }
+
+    public function testDisableDefaultClient()
+    {
+        $this->load([
+            'register_default_client' => false,
+        ]);
+
+        $this->assertContainerBuilderNotHasService('httplug.client.default');
+    }
 }

tests/Resources/Fixtures/config/full.php

@@ -1,6 +1,7 @@
 <?php
 
 $container->loadFromExtension('httplug', [
+    'register_default_client' => false,
     'main_alias' => [
         'client'          => 'my_client',
         'message_factory' => 'my_message_factory',

tests/Resources/Fixtures/config/full.xml

@@ -2,6 +2,7 @@
 <container xmlns="http://symfony.com/schema/dic/services">
 
     <config xmlns="http://example.org/schema/dic/httplug">
+        <register-default-client>false</register-default-client>
         <main-alias>
             <client>my_client</client>
             <message-factory>my_message_factory</message-factory>

tests/Resources/Fixtures/config/full.yml

@@ -1,4 +1,5 @@
 httplug:
+    register_default_client: false
     main_alias:
         client: my_client
         message_factory: my_message_factory

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -12,6 +12,7 @@
 class ConfigurationTest extends AbstractExtensionConfigurationTestCase
 {
     private $emptyConfig = [
+        'register_default_client' => true,
         'main_alias' => [
             'client' => 'httplug.client.default',
             'message_factory' => 'httplug.message_factory.default',
@@ -102,6 +103,7 @@ public function testEmptyConfiguration()
     public function testSupportsAllConfigFormats()
     {
         $expectedConfiguration = [
+            'register_default_client' => false,
             'main_alias' => [
                 'client' => 'my_client',
                 'message_factory' => 'my_message_factory',