Making the listener configurable

.gitignore

@@ -1,5 +1,6 @@
 /vendor/
 /tools/
 /bin/
+/tmp/
 /.phpunit.cache/
 composer.lock

.phive/phars.xml

@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="grumphp" version="^2.5.0" installed="2.5.0" location="./tools/grumphp" copy="false"/>
+  <phar name="grumphp" version="^2.5.0" installed="2.5.0" location="./bin/grumphp" copy="false"/>
+  <phar name="phpmd" version="^2.15.0" installed="2.15.0" location="./bin/phpmd" copy="false"/>
+  <phar name="phpcs" version="^3.7.1" installed="3.7.1" location="./bin/phpcs" copy="false"/>
+  <phar name="phpstan" version="^1.9.2" installed="1.9.2" location="./bin/phpstan" copy="false"/>
 </phive>

config/correlation_id.yaml

@@ -0,0 +1,3 @@
+correlation_id:
+    response_header_name: 'X-Correlation-ID'
+    request_header_name: 'X-Correlation-ID'

grumphp.yml

@@ -0,0 +1,45 @@
+grumphp:
+    ascii:
+        failed: resources/grumphp-grumpy.txt
+        succeeded: resources/grumphp-happy.txt
+    fixer:
+        enabled: true
+        fix_by_default: true
+    tasks:
+        phpstan:
+            autoload_file: ~
+            configuration: phpstan.neon
+            level: null
+            force_patterns: []
+            ignore_patterns: []
+            triggered_by: ['php']
+            memory_limit: "-1"
+            use_grumphp_paths: true
+        phpmd:
+            whitelist_patterns: []
+            exclude: []
+            report_format: text
+            ruleset: ['cleancode', 'codesize', 'naming', 'design', 'unusedcode']
+            triggered_by: ['php']
+        phpcs:
+            standard: []
+            severity: ~
+            error_severity: ~
+            warning_severity: ~
+            tab_width: ~
+            report: full
+            report_width: ~
+            whitelist_patterns: []
+            encoding: ~
+            ignore_patterns: []
+            sniffs: []
+            triggered_by: [php]
+            exclude: []
+            show_sniffs_error_path: true
+        phpunit:
+            config_file: phpunit.xml.dist
+            testsuite: ~
+            group: []
+            exclude_group: []
+            always_execute: false
+            order: null

resources/grumphp-happy.txt

@@ -0,0 +1,2 @@
+
+All good!

src/DependencyInjection/Configuration.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\CorrelationIdBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        $treeBuilder = new TreeBuilder('correlation_id');
+
+        $treeBuilder->getRootNode()
+                ->children()
+                    ->booleanNode('passthrough')
+                    ->defaultValue(false)
+                ->end()
+                ->scalarNode('response_header_name')
+                    ->defaultValue('X-Correlation-ID')
+                ->end()
+                ->scalarNode('request_header_name')
+                    ->defaultValue('X-Correlation-ID')
+                ->end()
+            ->end();
+
+        return $treeBuilder;
+    }
+}

src/DependencyInjection/CorrelationIdExtension.php

@@ -18,7 +18,18 @@ class CorrelationIdExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
-        $yamlLoader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../../config'));
+        $yamlLoader = new Loader\YamlFileLoader(
+            $container,
+            new FileLocator(__DIR__ . '/../../config')
+        );
+
         $yamlLoader->load('services.yaml');
+
+        $configuration = new Configuration();
+
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $container->setParameter('correlation_id.request_header_name', $config['response_header_name']);
+        $container->setParameter('correlation_id.response_header_name', $config['response_header_name']);
     }
 }

src/EventSubscriber/CorrelationIdSubscriber.php

@@ -4,6 +4,8 @@
 
 namespace Phauthentic\CorrelationIdBundle\EventSubscriber;
 
+use InvalidArgumentException;
+use Exception;
 use Phauthentic\Infrastructure\Utils\CorrelationID;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
@@ -12,25 +14,63 @@
 
 class CorrelationIdSubscriber implements EventSubscriberInterface
 {
-    private string $header = 'X-Correlation-ID';
+    private string $requestHeaderName = 'X-Correlation-ID';
+    private string $responseHeaderName = 'X-Correlation-ID';
+    private bool $passthrough = false;
 
+    /**
+     * @param array<string, mixed> $config
+     * @return void
+     */
+    public function __construct(array $config = [])
+    {
+        if (isset($config['request_header_name'])) {
+            $this->requestHeaderName = (string)$config['request_header_name'];
+        }
+
+        if (isset($config['response_header_name'])) {
+            $this->responseHeaderName = (string)$config['response_header_name'];
+        }
+
+        if (isset($config['response_header_name'])) {
+            $this->passthrough = (bool)$config['passthrough'];
+        }
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     *
+     * @param RequestEvent $event
+     * @return void
+     */
     public function onKernelRequest(RequestEvent $event): void
     {
-        $event->getRequest()->attributes->set($this->header, CorrelationID::toString());
+        $event->getRequest()->attributes->set($this->requestHeaderName, CorrelationID::toString());
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     *
+     * @param ResponseEvent $event
+     * @return void
+     * @throws InvalidArgumentException
+     * @throws Exception
+     */
     public function onKernelResponse(ResponseEvent $event): void
     {
-        if ($event->getRequest()->headers->has($this->header)) {
+        if (
+            $this->passthrough
+            && $event->getRequest()->headers->has($this->requestHeaderName)
+        ) {
             $event->getResponse()->headers->set(
-                $this->header,
-                $event->getRequest()->headers->get($this->header)
+                $this->responseHeaderName,
+                $event->getRequest()->headers->get($this->requestHeaderName)
             );
 
             return;
         }
 
-        $event->getResponse()->headers->set($this->header, CorrelationID::toString());
+        $event->getResponse()->headers->set($this->responseHeaderName, CorrelationID::toString());
     }
 
     public static function getSubscribedEvents(): array

src/Resources/config/correlation_id.yaml

@@ -1,4 +1,6 @@
 services:
     Phauthentic\CorrelationIdBundle\EventSubscriber\CorrelationIdSubscriber:
+        arguments:
+            $config: '%correlation_id%'
         tags:
             - { name: 'kernel.event_subscriber' }

tests/EventSubscriber/CorrelationIdSubscriberTest.php

@@ -18,6 +18,9 @@ class CorrelationIdSubscriberTest extends TestCase
 {
     private const CORRELATION_ID = 'd8d089ec-72c8-44c1-a0bf-1906e5fc3524';
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function setUp(): void
     {
         $reflection = new ReflectionClass(CorrelationID::class);
@@ -61,6 +64,9 @@ public function testOnKernelResponse(): void
         $this->assertNotEmpty($response->headers->get('X-Correlation-ID'));
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function testGetSubscribedEvents(): void
     {
         $subscribedEvents = CorrelationIdSubscriber::getSubscribedEvents();