Configurable header names and pass-through

floriankraemer · web-flow · commit cb43dbc2ffe2 · 2024-03-28T19:43:11.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 /vendor/
 /tools/
 /bin/
+/tmp/
 /.phpunit.cache/
 composer.lock
diff --git a/.phive/phars.xml b/.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>
diff --git a/README.md b/README.md
@@ -14,6 +14,29 @@ This is a Symfony bridge for the framework agnostic [Correlation ID library](htt
  * [The value of a correlation ID](https://blog.rapid7.com/2016/12/23/the-value-of-correlation-ids/)
  * [Identity Correlation on Wikipedia](https://en.wikipedia.org/wiki/Identity_correlation)
 
+## Installation
+
+```sh
+composer require phauthentic/correlation-id-symfony-bundle
+```
+
+## Configuration
+
+You can configure three different settings to control the behavior:
+
+* `response_header_name` - The name of the response header for the ID.
+* `request_header_name` - The name of the request header for the ID.
+* `pass_through` - If the ID from the request should be passed to the response enable this. This is useful if you are dealing with a microservice that is not exposed to the public but gets further actions delegated from the entry point and must retain the original ID.
+
+`config/correlation_id.yaml`:
+
+```yaml
+correlation_id:
+    response_header_name: 'X-Correlation-ID'
+    request_header_name: 'X-Correlation-ID'
+    pass_through: false
+```
+
 ## Copyright & License
 
 Licensed under the [MIT license](LICENSE).
diff --git a/composer.lock b/composer.lock
diff --git a/config/correlation_id.yaml b/config/correlation_id.yaml
@@ -0,0 +1,3 @@
+correlation_id:
+    response_header_name: 'X-Correlation-ID'
+    request_header_name: 'X-Correlation-ID'
diff --git a/config/services.yaml b/config/services.yaml
@@ -1,4 +1,9 @@
 services:
     Phauthentic\CorrelationIdBundle\EventSubscriber\CorrelationIdSubscriber:
+        arguments:
+            $config:
+                response_header_name: '%correlation_id.response_header_name%'
+                request_header_name: '%correlation_id.request_header_name%'
+                pass_through: '%correlation_id.pass_through%'
         tags:
             - { name: 'kernel.event_subscriber' }
diff --git a/grumphp.yml b/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
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,22 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="tests/bootstrap.php" cacheDirectory=".phpunit.cache">
-    <php>
-        <ini name="display_errors" value="1"/>
-        <ini name="error_reporting" value="-1"/>
-        <server name="APP_ENV" value="test" force="true"/>
-        <server name="SHELL_VERBOSITY" value="-1"/>
-        <server name="SYMFONY_PHPUNIT_REMOVE" value=""/>
-        <server name="SYMFONY_PHPUNIT_VERSION" value="10.5.15"/>
-    </php>
-    <testsuites>
-        <testsuite name="Project Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
+  <php>
+    <ini name="display_errors" value="1"/>
+    <ini name="error_reporting" value="-1"/>
+    <server name="APP_ENV" value="test" force="true"/>
+    <server name="SHELL_VERBOSITY" value="-1"/>
+    <server name="SYMFONY_PHPUNIT_REMOVE" value=""/>
+    <server name="SYMFONY_PHPUNIT_VERSION" value="10.5.15"/>
+  </php>
+  <testsuites>
+    <testsuite name="Project Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/resources/grumphp-grumpy.txt b/resources/grumphp-grumpy.txt
diff --git a/resources/grumphp-happy.txt b/resources/grumphp-happy.txt
@@ -0,0 +1,2 @@
+
+All good!
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -0,0 +1,32 @@
+<?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');
+
+        /* @phpstan-ignore-next-line */
+        $treeBuilder->getRootNode()
+            ->children()
+                ->booleanNode('pass_through')
+                    ->defaultValue(false)
+                ->end()
+                ->scalarNode('response_header_name')
+                    ->defaultValue('X-Correlation-ID')
+                ->end()
+                ->scalarNode('request_header_name')
+                    ->defaultValue('X-Correlation-ID')
+                ->end()
+            ->end();
+
+        return $treeBuilder;
+    }
+}
diff --git a/src/DependencyInjection/CorrelationIdExtension.php b/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'));
+        $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']);
+        $container->setParameter('correlation_id.pass_through', $config['pass_through']);
+
+        $yamlLoader = new Loader\YamlFileLoader(
+            $container,
+            new FileLocator(__DIR__ . '/../../config')
+        );
+
         $yamlLoader->load('services.yaml');
     }
 }
diff --git a/src/EventSubscriber/CorrelationIdSubscriber.php b/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['pass_through'])) {
+            $this->passthrough = (bool)$config['pass_through'];
+        }
+    }
+
+    /**
+     * @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
diff --git a/src/Resources/config/correlation_id.yaml b/src/Resources/config/correlation_id.yaml
diff --git a/tests/EventSubscriber/CorrelationIdSubscriberTest.php b/tests/EventSubscriber/CorrelationIdSubscriberTest.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+correlation_id:`
	`2`	`+ response_header_name: 'X-Correlation-ID'`
	`3`	`+ request_header_name: 'X-Correlation-ID'`