[UPDATE] Make http_client required (#81)

sensiolabs · Jun 21, 2024 · df54744 · df54744
1 parent 5aa9ceb
commit df54744
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 6 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -26,7 +26,7 @@ Then
 
 sensiolabs_gotenberg:
     assets_directory: '%kernel.project_dir%/assets'
-    http_client: 'gotenberg.client'
+    http_client: 'gotenberg.client' # Required and must have a `base_uri`.
     # Override the request Gotenberg will make to call one of your routes.
     request_context:
         # Used only when using `->route()`. Overrides the guessed `base_url` from the request. May be useful in CLI.

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -24,8 +24,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->defaultValue('%kernel.project_dir%/assets')
                 ->end()
                 ->scalarNode('http_client')
-                    ->info('HTTP Client reference to use.')
-                    ->defaultValue('http_client')
+                    ->info('HTTP Client reference to use. (Must have a base_uri)')
+                    ->isRequired()
+                    ->cannotBeEmpty()
                 ->end()
                 ->arrayNode('request_context')
                     ->info('Override the request Gotenberg will make to call one of your routes.')

diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -17,12 +17,26 @@ public function testDefaultConfigIsCorrect(): void
         $processor = new Processor();
         $config = $processor->processConfiguration(
             new Configuration(),
-            [],
+            [[
+                'http_client' => 'http_client',
+            ]],
         );
 
         self::assertEquals(self::getBundleDefaultConfig(), $config);
     }
 
+    public function testHttpClientIsRequired(): void
+    {
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('The child config "http_client" under "sensiolabs_gotenberg" must be configured: HTTP Client reference to use. (Must have a base_uri)');
+
+        $processor = new Processor();
+        $processor->processConfiguration(
+            new Configuration(),
+            [],
+        );
+    }
+
     /**
      * @return array<string, list<mixed>>
      */
@@ -52,6 +66,7 @@ public function testWithExtraHeadersConfiguration(): void
         /** @var array{'default_options': array<string, mixed>} $config */
         $config = $processor->processConfiguration(new Configuration(), [
             [
+                'http_client' => 'http_client',
                 'default_options' => [
                     'pdf' => [
                         'html' => ['extra_http_headers' => [['name' => 'MyHeader', 'value' => 'MyValue'], ['name' => 'User-Agent', 'value' => 'MyValue']]],

diff --git a/tests/DependencyInjection/SensiolabsGotenbergExtensionTest.php b/tests/DependencyInjection/SensiolabsGotenbergExtensionTest.php
@@ -241,6 +241,7 @@ public function testUrlBuildersCanChangeTheirRequestContext(string $serviceName)
         self::assertNotContains('.sensiolabs_gotenberg.request_context', $containerBuilder->getServiceIds());
 
         $extension->load([[
+            'http_client' => 'http_client',
             'request_context' => [
                 'base_uri' => 'https://sensiolabs.com',
             ],
@@ -270,7 +271,9 @@ public function testDataCollectorIsNotEnabledWhenKernelDebugIsFalse(): void
         $extension = new SensiolabsGotenbergExtension();
 
         $containerBuilder = $this->getContainerBuilder(kernelDebug: false);
-        $extension->load([], $containerBuilder);
+        $extension->load([[
+            'http_client' => 'http_client',
+        ]], $containerBuilder);
 
         self::assertNotContains('sensiolabs_gotenberg.data_collector', $containerBuilder->getServiceIds());
     }
@@ -280,7 +283,9 @@ public function testDataCollectorIsEnabledWhenKernelDebugIsTrue(): void
         $extension = new SensiolabsGotenbergExtension();
 
         $containerBuilder = $this->getContainerBuilder(kernelDebug: true);
-        $extension->load([], $containerBuilder);
+        $extension->load([[
+            'http_client' => 'http_client',
+        ]], $containerBuilder);
 
         self::assertContains('sensiolabs_gotenberg.data_collector', $containerBuilder->getServiceIds());
     }
@@ -291,6 +296,7 @@ public function testDataCollectorIsProperlyConfiguredIfEnabled(): void
 
         $containerBuilder = $this->getContainerBuilder(kernelDebug: true);
         $extension->load([[
+            'http_client' => 'http_client',
             'default_options' => [
                 'pdf' => [
                     'html' => [
@@ -384,6 +390,7 @@ private static function getValidConfig(): array
     {
         return [
             [
+                'http_client' => 'http_client',
                 'default_options' => [
                     'pdf' => [
                         'html' => [

diff --git a/tests/Kernel.php b/tests/Kernel.php
@@ -33,6 +33,9 @@ private function configureContainer(ContainerConfigurator $container, LoaderInte
         $builder->loadFromExtension('framework', [
             'test' => true,
         ]);
+        $builder->loadFromExtension('sensiolabs_gotenberg', [
+            'http_client' => 'http_client',
+        ]);
         $builder->addCompilerPass($this);
     }