Main

.github/workflows/ci.yaml

@@ -17,12 +17,15 @@ jobs:
         coverage: ['none']
         symfony-versions:
           - '6.4.*'
-          - '7.0.*'
-          - '7.3.*'
+          - '7.4.*'
+          - '8.0.*'
+        exclude:
+          - php: '8.3'
+            symfony-versions: '8.0.*'
         include:
           - description: 'Log Code Coverage'
             php: '8.3'
-            symfony-versions: '^7.0'
+            symfony-versions: '^6.4'
             doctrine-orm-versions: '^3.0'
             coverage: xdebug
 

.github/workflows/static-analysis.yaml

@@ -36,7 +36,7 @@ jobs:
         run: composer install --no-progress --no-interaction --prefer-dist
 
       - name: Run script
-        run: vendor/bin/phpstan analyse
+        run: vendor/bin/phpstan analyse --configuration=./phpstan.neon
 
   composer-validate:
     name: Composer validate

composer.json

@@ -13,15 +13,15 @@
         }
     },
     "require": {
-        "php": ">=8.3",
-        "symfony/messenger": "^6.4 || ^7.0",
-        "symfony/http-kernel": "^6.4 || ^7.0",
-        "symfony/dependency-injection": "^6.4 || ^7.0",
-        "symfony/config": "^6.4 || ^7.0",
-        "symfony/http-client": "^6.4 || ^7.0"
+        "php": ">=8.3 || >=8.4",
+        "symfony/messenger": "^6.4 || ^7.4 || ^8.0",
+        "symfony/http-kernel": "^6.4 || ^7.4 || ^8.0",
+        "symfony/dependency-injection": "^6.4 || ^7.4 || ^8.0",
+        "symfony/config": "^6.4 || ^7.4 || ^8.0",
+        "symfony/http-client": "^6.4 || ^7.4 || ^8.0"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^10.0",
         "squizlabs/php_codesniffer": "3.7.*"
     },
@@ -44,7 +44,7 @@
             "vendor/bin/phpcbf"
         ],
         "phpstan": [
-            "vendor/bin/phpstan analyse"
+            "vendor/bin/phpstan analyse --memory-limit=512M"
         ],
         "phpunit": [
             "vendor/bin/phpunit"

config/services.yaml

@@ -9,6 +9,7 @@ services:
       $environmentSchema: '%schema_context.environment_schema%'
       $environmentName: '%schema_context.environment_name%'
       $schemaOverridableEnvironments: '%schema_context.overridable_environments%'
+      $logger: '@Macpaw\SchemaContextBundle\Logger\DebugLogger'
     public: true
     shared: true
 
@@ -20,6 +21,7 @@ services:
     arguments:
       $baggageSchemaResolver: '@Macpaw\SchemaContextBundle\Service\BaggageSchemaResolver'
       $schemaRequestHeader: '%schema_context.header_name%'
+      $logger: '@Macpaw\SchemaContextBundle\Logger\DebugLogger'
     tags:
       - { name: kernel.event_subscriber }
 
@@ -28,3 +30,7 @@ services:
       $sendersLocator: '@messenger.senders_locator'
     tags:
       - { name: messenger.middleware }
+
+  Macpaw\SchemaContextBundle\Logger\DebugLogger:
+    arguments:
+      $logger: null

phpstan.neon

@@ -3,8 +3,3 @@ parameters:
     paths:
         - src
         - tests
-    ignoreErrors:
-        -
-            message: '~Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::children\(\).~'
-            count: 1
-            path: ./src/DependencyInjection

src/DependencyInjection/SchemaContextExtension.php

@@ -4,22 +4,44 @@
 
 namespace Macpaw\SchemaContextBundle\DependencyInjection;
 
+use LogicException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
 class SchemaContextExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);
 
-        $container->setParameter('schema_context.header_name', $config['header_name']);
-        $container->setParameter('schema_context.environment_schema', $config['environment_schema']);
-        $container->setParameter('schema_context.environment_name', $config['environment_name']);
-        $container->setParameter('schema_context.overridable_environments', $config['overridable_environments']);
+        $headerName = $config['header_name'];
+        $environmentSchema = $config['environment_schema'];
+        $environmentName = $config['environment_name'];
+        $overridableEnvironments = $config['overridable_environments'];
+
+        if (!is_string($headerName)) {
+            throw new LogicException('Configuration "header_name" must be a string');
+        }
+
+        if (!is_string($environmentSchema)) {
+            throw new LogicException('Configuration "environment_schema" must be a string');
+        }
+
+        if (!is_string($environmentName)) {
+            throw new LogicException('Configuration "environment_name" must be a string');
+        }
+
+        if (!is_array($overridableEnvironments)) {
+            throw new LogicException('Configuration "overridable_environments" must be an array');
+        }
+
+        $container->setParameter('schema_context.header_name', $headerName);
+        $container->setParameter('schema_context.environment_schema', $environmentSchema);
+        $container->setParameter('schema_context.environment_name', $environmentName);
+        $container->setParameter('schema_context.overridable_environments', $overridableEnvironments);
 
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../../config'));
 

src/EventListener/BaggageRequestListener.php

@@ -4,6 +4,7 @@
 
 namespace Macpaw\SchemaContextBundle\EventListener;
 
+use Macpaw\SchemaContextBundle\Logger\DebugLogger;
 use Macpaw\SchemaContextBundle\Service\BaggageCodec;
 use Macpaw\SchemaContextBundle\Service\BaggageSchemaResolver;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
@@ -16,6 +17,7 @@ public function __construct(
         private BaggageSchemaResolver $baggageSchemaResolver,
         private BaggageCodec $baggageCodec,
         private string $schemaRequestHeader,
+        private DebugLogger $logger,
     ) {
     }
 
@@ -37,6 +39,7 @@ public function onKernelRequest(RequestEvent $event): void
             $schema = $baggage[$this->schemaRequestHeader] ?? null;
         }
 
+        $this->logger->logInfoFromRequest($baggage, $schema);
         $this->baggageSchemaResolver->setBaggage($baggage);
         $this->baggageSchemaResolver->setSchema($schema);
     }

src/HttpClient/BaggageAwareHttpClient.php

@@ -4,6 +4,7 @@
 
 namespace Macpaw\SchemaContextBundle\HttpClient;
 
+use Macpaw\SchemaContextBundle\Logger\DebugLogger;
 use Macpaw\SchemaContextBundle\Service\BaggageCodec;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -16,6 +17,7 @@ public function __construct(
         private HttpClientInterface $inner,
         private BaggageSchemaResolver $baggageSchemaResolver,
         private BaggageCodec $baggageCodec,
+        private DebugLogger $logger,
     ) {
     }
 
@@ -28,7 +30,7 @@ public function request(string $method, string $url, array $options = []): Respo
             ? $options['headers']
             : [];
 
-        $baggage = isset($headers['baggage'])
+        $baggage = isset($headers['baggage']) && is_string($headers['baggage'])
             ? $this->baggageCodec->decode($headers['baggage'])
             : [];
 
@@ -40,6 +42,8 @@ public function request(string $method, string $url, array $options = []): Respo
         $headers['baggage'] = $this->baggageCodec->encode($baggage);
         $options['headers'] = $headers;
 
+        $this->logger->logHttpRequest($baggage);
+
         return $this->inner->request($method, $url, $options);
     }
 
@@ -56,6 +60,6 @@ public function withOptions(array $options): static
         $wrapped = $this->inner->withOptions($options);
 
         /** @phpstan-ignore-next-line */
-        return new self($wrapped, $this->baggageSchemaResolver, $this->baggageCodec);
+        return new self($wrapped, $this->baggageSchemaResolver, $this->baggageCodec, $this->logger);
     }
 }

src/Logger/DebugLogger.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macpaw\SchemaContextBundle\Logger;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+
+class DebugLogger
+{
+    private readonly LoggerInterface $logger;
+
+    public function __construct(
+        LoggerInterface|null $logger = null,
+    ) {
+        $this->logger = $logger ?? new NullLogger();
+    }
+
+    /** @param array<string, string|null>|null $baggage */
+    public function log(string $message, ?array $baggage = null, ?string $schema = null): void
+    {
+        $this->logger->info(
+            'schema_context_' . $message,
+            [
+                'schema' => $schema,
+                'baggage' => $baggage,
+            ]
+        );
+    }
+
+    /** @param array<string, string|null>|null $baggage */
+    public function logInfoFromRequest(array|null $baggage, string|null $schema): void
+    {
+        $this->log('info_from_request', $baggage, $schema);
+    }
+
+    /** @param array<string, string|null> $baggage */
+    public function logHttpRequest(array $baggage): void
+    {
+        $this->log('http_request', $baggage);
+    }
+
+    /** @param array<string, string|null>|null $baggage */
+    public function logSetBaggage(array|null $baggage): void
+    {
+        $this->log('set_baggage', $baggage);
+    }
+
+    public function logSetSchema(string|null $schema): void
+    {
+        $this->log('set_schema', null, $schema);
+    }
+
+    /** @param array<string, string|null>|null $baggage */
+    public function logInfoFromStamp(array|null $baggage, string|null $schema): void
+    {
+        $this->log('info_from_stamp', $baggage, $schema);
+    }
+
+    public function logResetWorkerAfterWorker(): void
+    {
+        $this->log('reset_worker_after_worker');
+    }
+
+    /** @param array<string, string|null>|null $baggage */
+    public function logCreateMessage(array|null $baggage, string|null $schema): void
+    {
+        $this->log('create_message', $baggage, $schema);
+    }
+
+    public function logApplySearchPath(string $schema, bool $isNewConnection): void
+    {
+        $this->logger->info('schema_context_apply_search_path', [
+            'schema' => $schema,
+            'is_new_connection' => $isNewConnection,
+        ]);
+    }
+
+    public function logSkipSearchPath(string $schema, string|null $actualScheme): void
+    {
+        $this->logger->info('schema_context_skip_search_path', [
+            'schema' => $schema,
+            'actualScheme' => $actualScheme,
+        ]);
+    }
+}

src/Messenger/Middleware/BaggageSchemaMiddleware.php

@@ -4,6 +4,7 @@
 
 namespace Macpaw\SchemaContextBundle\Messenger\Middleware;
 
+use Macpaw\SchemaContextBundle\Logger\DebugLogger;
 use Macpaw\SchemaContextBundle\Messenger\Stamp\BaggageSchemaStamp;
 use Macpaw\SchemaContextBundle\Service\BaggageCodec;
 use Macpaw\SchemaContextBundle\Service\BaggageSchemaResolver;
@@ -20,6 +21,7 @@ public function __construct(
         private SendersLocatorInterface $sendersLocator,
         private BaggageSchemaResolver $baggageSchemaResolver,
         private BaggageCodec $baggageCodec,
+        private DebugLogger $logger,
     ) {
     }
 
@@ -28,15 +30,23 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $stamp = $envelope->last(BaggageSchemaStamp::class);
 
         if ($this->isWorker($envelope) && !$this->isSyncTransport($envelope)) {
-            if ($stamp instanceof BaggageSchemaStamp) {
-                $this->baggageSchemaResolver
-                    ->setSchema($stamp->schema)
-                    ->setBaggage($stamp->baggage === null ? null : $this->baggageCodec->decode($stamp->baggage));
-            }
+            try {
+                if ($stamp instanceof BaggageSchemaStamp) {
+                    $schema = $stamp->schema;
+                    $baggage = $stamp->baggage === null ? null : $this->baggageCodec->decode($stamp->baggage);
+
+                    $this->logger->logInfoFromStamp($baggage, $schema);
 
-            $result = $stack->next()->handle($envelope, $stack);
+                    $this->baggageSchemaResolver
+                        ->setSchema($schema)
+                        ->setBaggage($baggage);
+                }
 
-            $this->baggageSchemaResolver->reset();
+                $result = $stack->next()->handle($envelope, $stack);
+            } finally {
+                $this->logger->logResetWorkerAfterWorker();
+                $this->baggageSchemaResolver->reset();
+            }
 
             return $result;
         }
@@ -46,6 +56,8 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
             ? null
             : $this->baggageCodec->encode($this->baggageSchemaResolver->getBaggage());
 
+        $this->logger->logCreateMessage($this->baggageSchemaResolver->getBaggage(), $schema);
+
         $envelope = $envelope->with(new BaggageSchemaStamp($schema, $baggage));
 
         return $stack->next()->handle($envelope, $stack);

src/SchemaContextBundle.php

@@ -11,7 +11,7 @@
 
 class SchemaContextBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(
             new SchemaContextCompilerPass(),

src/Service/BaggageSchemaResolver.php

@@ -5,6 +5,7 @@
 namespace Macpaw\SchemaContextBundle\Service;
 
 use Macpaw\SchemaContextBundle\Exception\EnvironmentSchemaMismatchException;
+use Macpaw\SchemaContextBundle\Logger\DebugLogger;
 
 class BaggageSchemaResolver
 {
@@ -22,6 +23,7 @@ public function __construct(
         private readonly string $environmentSchema,
         private readonly string $environmentName,
         private readonly array $schemaOverridableEnvironments,
+        private readonly DebugLogger $logger,
     ) {
         $this->isSchemaOverridableEnvironment = in_array(
             $this->environmentName,
@@ -47,6 +49,8 @@ public function setBaggage(?array $baggage): self
             $baggage = null;
         }
 
+        $this->logger->logSetBaggage($baggage);
+
         $this->baggage = $baggage;
 
         return $this;
@@ -74,6 +78,8 @@ public function setSchema(?string $schema): self
             );
         }
 
+        $this->logger->logSetSchema($schema);
+
         $this->schema = $schema;
 
         return $this;