feature #26941 [Messenger] Allow to configure the transport (sroze)

This PR was squashed before being merged into the 4.1-dev branch (closes #26941).

Discussion
----------

[Messenger] Allow to configure the transport

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | ish
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #26900, #26908, #26935
| License       | MIT
| Doc PR        | ø

We allow users to configure the encoder/decoder used by the built-in adapter(s). This also adds the support of configuring the default's encoder/decoder format and context.

Commits
-------

1a3f0bbb14 [Messenger] Allow to configure the transport

Author: sroze

DependencyInjection/MessengerPass.php

@@ -53,12 +53,6 @@ public function process(ContainerBuilder $container)
             $container->removeDefinition('messenger.middleware.debug.logging');
         }
 
-        if (!$container->has('serializer')) {
-            $container->removeDefinition('messenger.transport.serialize_message_with_type_in_headers');
-            $container->removeAlias('messenger.transport.default_encoder');
-            $container->removeAlias('messenger.transport.default_decoder');
-        }
-
         $this->registerReceivers($container);
         $this->registerSenders($container);
         $this->registerHandlers($container);

Tests/Transport/Serialization/SerializerTest.php

@@ -44,4 +44,21 @@ public function testEncodedIsHavingTheBodyAndTypeHeader()
         $this->assertArrayHasKey('type', $encoded['headers']);
         $this->assertEquals(DummyMessage::class, $encoded['headers']['type']);
     }
+
+    public function testUsesTheCustomFormatAndContext()
+    {
+        $message = new DummyMessage('Foo');
+
+        $serializer = $this->getMockBuilder(SerializerComponent\SerializerInterface::class)->getMock();
+        $serializer->expects($this->once())->method('serialize')->with($message, 'csv', array('foo' => 'bar'))->willReturn('Yay');
+        $serializer->expects($this->once())->method('deserialize')->with('Yay', DummyMessage::class, 'csv', array('foo' => 'bar'))->willReturn($message);
+
+        $encoder = new Serializer($serializer, 'csv', array('foo' => 'bar'));
+
+        $encoded = $encoder->encode($message);
+        $decoded = $encoder->decode($encoded);
+
+        $this->assertSame('Yay', $encoded['body']);
+        $this->assertSame($message, $decoded);
+    }
 }

Transport/Serialization/Serializer.php

@@ -20,11 +20,13 @@ class Serializer implements DecoderInterface, EncoderInterface
 {
     private $serializer;
     private $format;
+    private $context;
 
-    public function __construct(SerializerInterface $serializer, string $format = 'json')
+    public function __construct(SerializerInterface $serializer, string $format = 'json', array $context = array())
     {
         $this->serializer = $serializer;
         $this->format = $format;
+        $this->context = $context;
     }
 
     /**
@@ -40,7 +42,7 @@ public function decode(array $encodedMessage)
             throw new \InvalidArgumentException('Encoded message does not have a `type` header.');
         }
 
-        return $this->serializer->deserialize($encodedMessage['body'], $encodedMessage['headers']['type'], $this->format);
+        return $this->serializer->deserialize($encodedMessage['body'], $encodedMessage['headers']['type'], $this->format, $this->context);
     }
 
     /**
@@ -49,7 +51,7 @@ public function decode(array $encodedMessage)
     public function encode($message): array
     {
         return array(
-            'body' => $this->serializer->serialize($message, $this->format),
+            'body' => $this->serializer->serialize($message, $this->format, $this->context),
             'headers' => array('type' => \get_class($message)),
         );
     }