8000 [Messenger] Remove Envelope::wrap · symfony/symfony@b3a6768 · GitHub
[go: up one dir, main page]

Skip to content

Commit b3a6768

Browse files
committed
[Messenger] Remove Envelope::wrap
1 parent a2d7960 commit b3a6768

18 files changed

+45
-68
lines changed

src/Symfony/Component/Messenger/Envelope.php

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,6 @@ public function __construct($message, array $items = array())
3535
}
3636
}
3737

38-
/**
39-
* Wrap a message into an envelope if not already wrapped.
40-
*
41-
* @param Envelope|object $message
42-
*/
43-
public static function wrap($message): self
44-
{
45-
return $message instanceof self ? $message : new self($message);
46-
}
47-
4838
/**
4939
* @return Envelope a new Envelope instance with additional item
5040
*/

src/Symfony/Component/Messenger/MessageBus.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function dispatch($message)
4444
throw new InvalidArgumentException(sprintf('Invalid type for message argument. Expected object, but got "%s".', \gettype($message)));
4545
}
4646

47-
return \call_user_func($this->callableForNextMiddleware(0), Envelope::wrap($message));
47+
return \call_user_func($this->callableForNextMiddleware(0), $message instanceof Envelope ? $message : new Envelope($message));
4848
}
4949

5050
private function callableForNextMiddleware(int $index): callable

src/Symfony/Component/Messenger/Tests/Asynchronous/Middleware/SendMessageMiddlewareTest.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class SendMessageMiddlewareTest extends TestCase
2525
{
2626
public function testItSendsTheMessageToAssignedSender()
2727
{
28-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
28+
$envelope = new Envelope(new DummyMessage('Hey'));
2929
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
3030
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
3131

@@ -39,7 +39,7 @@ public function testItSendsTheMessageToAssignedSender()
3939

4040
public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageClass()
4141
{
42-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
42+
$envelope = new Envelope(new DummyMessage('Hey'));
4343
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
4444
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
4545

@@ -55,7 +55,7 @@ public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageClass()
5555

5656
public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageParentClass()
5757
{
58-
$envelope = Envelope::wrap(new ChildDummyMessage('Hey'));
58+
$envelope = (new Envelope(new ChildDummyMessage('Hey')));
5959
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
6060
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
6161

@@ -71,7 +71,7 @@ public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageParentClass()
7171

7272
public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageInterface()
7373
{
74-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
74+
$envelope = new Envelope(new DummyMessage('Hey'));
7575
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
7676
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
7777

@@ -87,7 +87,7 @@ public function testItAlsoCallsTheNextMiddlewareBasedOnTheMessageInterface()
8787

8888
public function testItAlsoCallsTheNextMiddlewareBasedOnWildcard()
8989
{
90-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
90+
$envelope = new Envelope(new DummyMessage('Hey'));
9191
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
9292
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
9393

@@ -103,7 +103,7 @@ public function testItAlsoCallsTheNextMiddlewareBasedOnWildcard()
103103

104104
public function testItCallsTheNextMiddlewareWhenNoSenderForThisMessage()
105105
{
106-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
106+
$envelope = new Envelope(new DummyMessage('Hey'));
107107
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
108108

109109
$middleware = new SendMessageMiddleware(new InMemorySenderLocator(null));
@@ -115,7 +115,7 @@ public function testItCallsTheNextMiddlewareWhenNoSenderForThisMessage()
115115

116116
public function testItSkipsReceivedMessages()
117117
{
118-
$envelope = Envelope::wrap(new DummyMessage('Hey'))->with(new ReceivedMessage());
118+
$envelope = (new Envelope(new DummyMessage('Hey')))->with(new ReceivedMessage());
119119

120120
$sender = $this->getMockBuilder(SenderInterface::class)->getMock();
121121
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));

src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ class DummyReceiver implements ReceiverInterface
554554
public function receive(callable $handler): void
555555
{
556556
for ($i = 0; $i < 3; ++$i) {
557-
$handler(Envelope::wrap(new DummyMessage("Dummy $i")));
557+
$handler(new Envelope(new DummyMessage("Dummy $i")));
558558
}
559559
}
560560

src/Symfony/Component/Messenger/Tests/EnvelopeTest.php

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,37 +33,24 @@ public function testConstruct()
3333
$this->assertSame($receivedConfig, $configs[ReceivedMessage::class]);
3434
}
3535

36-
public function testWrap()
37-
{
38-
$first = Envelope::wrap($dummy = new DummyMessage('dummy'));
39-
40-
$this->assertInstanceOf(Envelope::class, $first);
41-
$this->assertSame($dummy, $first->getMessage());
42-
43-
$envelope = Envelope::wrap($first);
44-
$this->assertSame($first, $envelope);
45-
}
46-
4736
public function testWithReturnsNewInstance()
4837
{
49-
$envelope = Envelope::wrap($dummy = new DummyMessage('dummy'));
38+
$envelope = new Envelope(new DummyMessage('dummy'));
5039

5140
$this->assertNotSame($envelope, $envelope->with(new ReceivedMessage()));
5241
}
5342

5443
public function testGet()
5544
{
56-
$envelope = Envelope::wrap($dummy = new DummyMessage('dummy'))
57-
->with($config = new ReceivedMessage())
58-
;
45+
$envelope = (new Envelope(new DummyMessage('dummy')))->with($config = new ReceivedMessage());
5946

6047
$this->assertSame($config, $envelope->get(ReceivedMessage::class));
6148
$this->assertNull($envelope->get(ValidationConfiguration::class));
6249
}
6350

6451
public function testAll()
6552
{
66-
$envelope = Envelope::wrap($dummy = new DummyMessage('dummy'))
53+
$envelope = (new Envelope(new DummyMessage('dummy')))
10000
6754
->with($receivedConfig = new ReceivedMessage())
6855
->with($validationConfig = new ValidationConfiguration(array('foo')))
6956
;

src/Symfony/Component/Messenger/Tests/MessageBusTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function testItDispatchInvalidMessageType()
4141
public function testItCallsMiddlewareAndChainTheReturnValue()
4242
{
4343
$message = new DummyMessage('Hello');
44-
$envelope = Envelope::wrap($message);
44+
$envelope = new Envelope($message);
4545
$responseFromDepthMiddleware = 1234;
4646

4747
$firstMiddleware = $this->getMockBuilder(MiddlewareInterface::class)->getMock();

src/Symfony/Component/Messenger/Tests/Middleware/AllowNoHandlerMiddlewareTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class AllowNoHandlerMiddlewareTest extends TestCase
2121
{
2222
public function testItCallsNextMiddlewareAndReturnsItsResult()
2323
{
24-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
24+
$envelope = new Envelope(new DummyMessage('Hey'));
2525

2626
$next = $this->createPartialMock(\stdClass::class, array('__invoke'));
2727
$next->expects($this->once())->method('__invoke')->with($envelope)->willReturn('Foo');
@@ -37,7 +37,7 @@ public function testItCatchesTheNoHandlerException()
3737

3838
$middleware = new AllowNoHandlerMiddleware();
3939

40-
$this->assertNull($middleware->handle(Envelope::wrap(new DummyMessage('Hey')), $next));
40+
$this->assertNull($middleware->handle(new Envelope(new DummyMessage('Hey')), $next));
4141
}
4242

4343
/**
@@ -50,6 +50,6 @@ public function testItDoesNotCatchOtherExceptions()
5050
$next->expects($this->once())->method('__invoke')->will($this->throwException(new \RuntimeException('Something went wrong.')));
5151

5252
$middleware = new AllowNoHandlerMiddleware();
53-
$middleware->handle(Envelope::wrap(new DummyMessage('Hey')), $next);
53+
$middleware->handle(new Envelope(new DummyMessage('Hey')), $next);
5454
}
5555
}

src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class HandleMessageMiddlewareTest extends TestCase
2121
{
2222
public function testItCallsTheHandlerAndNextMiddleware()
2323
{
24-
$envelope = Envelope::wrap($message = new DummyMessage('Hey'));
24+
$envelope = new Envelope($message = new DummyMessage('Hey'));
2525

2626
$handler = $this->createPartialMock(\stdClass::class, array('__invoke'));
2727
$handler->method('__invoke')->willReturn('Hello');

src/Symfony/Component/Messenger/Tests/Middleware/LoggingMiddlewareTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class LoggingMiddlewareTest extends TestCase
2121
{
2222
public function testDebugLogAndNextMiddleware()
2323
{
24-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
24+
$envelope = new Envelope(new DummyMessage('Hey'));
2525

2626
$logger = $this->createMock(LoggerInterface::class);
2727
$logger
@@ -46,7 +46,7 @@ public function testDebugLogAndNextMiddleware()
4646
*/
4747
public function testWarningLogOnException()
4848
{
49-
$envelope = Envelope::wrap(new DummyMessage('Hey'));
49+
$envelope = new Envelope(new DummyMessage('Hey'));
5050

5151
$logger = $this->createMock(LoggerInterface::class);
5252
$logger

src/Symfony/Component/Messenger/Tests/Middleware/ValidationMiddlewareTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class ValidationMiddlewareTest extends TestCase
2323
{
2424
public function testValidateAndNextMiddleware()
2525
{
26-
$envelope = Envelope::wrap($message = new DummyMessage('Hey'));
26+
$envelope = new Envelope($message = new DummyMessage('Hey'));
2727

2828
$validator = $this->createMock(ValidatorInterface::class);
2929
$validator
@@ -47,7 +47,7 @@ public function testValidateAndNextMiddleware()
4747

4848
public function testValidateWithConfigurationAndNextMiddleware()
4949
{
50-
$envelope = Envelope::wrap($message = new DummyMessage('Hey'))->with(new ValidationConfiguration($groups = array('Default', 'Extra')));
50+
$envelope = (new Envelope($message = new DummyMessage('Hey')))->with(new ValidationConfiguration($groups = array('Default', 'Extra')));
5151

5252
$validator = $this->createMock(ValidatorInterface::class);
5353
$validator
@@ -75,7 +75,7 @@ public function testValidateWithConfigurationAndNextMiddleware()
7575
*/
7676
public function testValidationFailedException()
7777
{
78-
$envelope = Envelope::wrap($message = new DummyMessage('Hey'));
78+
$envelope = new Envelope($message = new DummyMessage('Hey'));
7979

8080
$violationList = $this->createMock(ConstraintViolationListInterface::class);
8181
$violationList

src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function testItTracesResult()
3939

4040
public function testItTracesResultWithEnvelope()
4141
{
42-
$envelope = Envelope::wrap($message = new DummyMessage('Hello'))->with($envelopeItem = new AnEnvelopeItem());
42+
$envelope = (new Envelope($message = new DummyMessage('Hello')))->with($envelopeItem = new AnEnvelopeItem());
4343

4444
$bus = $this->getMockBuilder(MessageBusInterface::class)->getMock();
4545
$bus->expects($this->once())->method('dispatch')->with($envelope)->willReturn($result = array('foo' => 'bar'));

src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/AmqpExtIntegrationTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ public function testItSendsAndReceivesMessages()
5151
$sender = new AmqpSender($serializer, $connection);
5252
$receiver = new AmqpReceiver($serializer, $connection);
5353

54-
$sender->send($first = Envelope::wrap(new DummyMessage('First')));
55-
$sender->send($second = Envelope::wrap(new DummyMessage('Second')));
54+
$sender->send($first = new Envelope(new DummyMessage('First')));
55+
$sender->send($second = new Envelope(new DummyMessage('Second')));
5656

5757
$receivedMessages = 0;
5858
$receiver->receive(function (?Envelope $envelope) use ($receiver, &$receivedMessages, $first, $second) {
@@ -75,7 +75,7 @@ public function testItReceivesSignals()
7575
$connection->queue()->purge();
7676

7777
$sender = new AmqpSender($serializer, $connection);
78-
$sender->send(Envelope::wrap(new DummyMessage('Hello')));
78+
$sender->send(new Envelope(new DummyMessage('Hello')));
7979

8080
$amqpReadTimeout = 30;
8181
$dsn = getenv('MESSENGER_AMQP_DSN').'?read_timeout='.$amqpReadTimeout;

src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/AmqpSenderTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class AmqpSenderTest extends TestCase
2525
{
2626
public function testItSendsTheEncodedMessage()
2727
{
28-
$envelope = Envelope::wrap(new DummyMessage('Oy'));
28+
$envelope = new Envelope(new DummyMessage('Oy'));
2929
$encoded = array('body' => '...', 'headers' => array('type' => DummyMessage::class));
3030

3131
$encoder = $this->getMockBuilder(EncoderInterface::class)->getMock();

src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/AmqpTransportTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public function testReceivesMessages()
4646
$amqpEnvelope->method('getBody')->willReturn('body');
4747
$amqpEnvelope->method('getHeaders')->willReturn(array('my' => 'header'));
4848

49-
$decoder->method('decode')->with(array('body' => 'body', 'headers' => array('my' => 'header')))->willReturn(Envelope::wrap($decodedMessage));
49+
$decoder->method('decode')->with(array('body' => 'body', 'headers' => array('my' => 'header')))->willReturn(new Envelope($decodedMessage));
5050
$connection->method('get')->willReturn($amqpEnvelope);
5151

5252
$transport->receive(function (Envelope $envelope) use ($transport, $decodedMessage) {

src/Symfony/Component/Messenger/Tests/Transport/Enhancers/StopWhenMemoryUsageIsExceededReceiverTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class StopWhenMemoryUsageIsExceededReceiverTest extends TestCase
2626
public function testReceiverStopsWhenMemoryLimitExceeded(int $memoryUsage, int $memoryLimit, bool $shouldStop)
2727
{
2828
$callable = function ($handler) {
29-
$handler(Envelope::wrap(new DummyMessage('API')));
29+
$handler(new Envelope(new DummyMessage('API')));
3030
};
3131

3232
$decoratedReceiver = $this->getMockBuilder(CallbackReceiver::class)
@@ -59,7 +59,7 @@ public function memoryProvider()
5959
public function testReceiverLogsMemoryExceededWhenLoggerIsGiven()
6060
{
6161
$callable = function ($handler) {
62-
$handler(Envelope::wrap(new DummyMessage('API')));
62+
$handler(new Envelope(new DummyMessage('API')));
6363
};
6464

6565
$decoratedReceiver = $this->getMockBuilder(CallbackReceiver::class)

src/Symfony/Component/Messenger/Tests/Transport/Enhancers/StopWhenMessageCountIsExceededReceiverTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ class StopWhenMessageCountIsExceededReceiverTest extends TestCase
2626
public function testReceiverStopsWhenMaximumCountExceeded($max, $shouldStop)
2727
{
2828
$callable = function ($handler) {
29-
$handler(Envelope::wrap(new DummyMessage('First message')));
30-
$handler(Envelope::wrap(new DummyMessage('Second message')));
31-
$handler(Envelope::wrap(new DummyMessage('Third message')));
29+
$handler(new Envelope(new DummyMessage('First message')));
30+
$handler(new Envelope(new DummyMessage('Second message')));
31+
$handler(new Envelope(new DummyMessage('Third message')));
3232
};
3333

3434
$decoratedReceiver = $this->getMockBuilder(CallbackReceiver::class)
@@ -79,7 +79,7 @@ public function testReceiverDoesntIncreaseItsCounterWhenReceiveNullMessage()
7979
public function testReceiverLogsMaximumCountExceededWhenLoggerIsGiven()
8080
{
8181
$callable = function ($handler) {
82-
$handler(Envelope::wrap(new DummyMessage('First message')));
82+
$handler(new Envelope(new DummyMessage('First message')));
8383
};
8484

8585
$decoratedReceiver = $this->getMockBuilder(CallbackReceiver::class)

src/Symfony/Component/Messenger/Tests/Transport/Serialization/SerializerTest.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public function testEncodedIsDecodable()
2929
new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
3030
);
3131

32-
$envelope = Envelope::wrap(new DummyMessage('Hello'));
32+
$envelope = new Envelope(new DummyMessage('Hello'));
3333

3434
$this->assertEquals($envelope, $serializer->decode($serializer->encode($envelope)));
3535
}
@@ -40,7 +40,7 @@ public function testEncodedWithConfigurationIsDecodable()
4040
new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
4141
);
4242

43-
$envelope = Envelope::wrap(new DummyMessage('Hello'))
43+
$envelope = (new Envelope(new DummyMessage('Hello')))
4444
->with(new SerializerConfiguration(array(ObjectNormalizer::GROUPS => array('foo'))))
4545
->with(new ValidationConfiguration(array('foo', 'bar')))
4646
;
@@ -54,7 +54,7 @@ public function testEncodedIsHavingTheBodyAndTypeHeader()
5454
new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
5555
);
5656

57-
$encoded = $serializer->encode(Envelope::wrap(new DummyMessage('Hello')));
57+
$encoded = $serializer->encode(new Envelope(new DummyMessage('Hello')));
5858

5959
$this->assertArrayHasKey('body', $encoded);
6060
$this->assertArrayHasKey('headers', $encoded);
@@ -73,7 +73,7 @@ public function testUsesTheCustomFormatAndContext()
7373

7474
$encoder = new Serializer($serializer, 'csv', array('foo' => 'bar'));
7575

76-
$encoded = $encoder->encode(Envelope::wrap($message));
76+
$encoded = $encoder->encode((new Envelope($message)));
7777
$decoded = $encoder->decode($encoded);
7878

7979
$this->assertSame('Yay', $encoded['body']);
@@ -86,7 +86,7 @@ public function testEncodedWithSerializationConfiguration()
8686
new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
8787
);
8888

89-
$envelope = Envelope::wrap(new DummyMessage('Hello'))
89+
$envelope = (new Envelope(new DummyMessage('Hello')))
9090
->with(new SerializerConfiguration(array(ObjectNormalizer::GROUPS => array('foo'))))
9191
->with(new ValidationConfiguration(array('foo', 'bar')))
9292
;

src/Symfony/Component/Messenger/Tests/WorkerTest.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,22 @@ public function testWorkerDispatchTheReceivedMessage()
2727
$ipaMessage = new DummyMessage('IPA');
2828

2929
$receiver = new CallbackReceiver(function ($handler) use ($apiMessage, $ipaMessage) {
30-
$handler(Envelope::wrap($apiMessage));
31-
$handler(Envelope::wrap($ipaMessage));
30+
$handler(new Envelope($apiMessage));
31+
$handler(new Envelope($ipaMessage));
3232
});
3333

3434
$bus = $this->getMockBuilder(MessageBusInterface::class)->getMock();
3535

36-
$bus->expects($this->at(0))->method('dispatch')->with(Envelope::wrap($apiMessage)->with(new ReceivedMessage()));
37-
$bus->expects($this->at(1))->method('dispatch')->with(Envelope::wrap($ipaMessage)->with(new ReceivedMessage()));
36+
$bus->expects($this->at(0))->method('dispatch')->with((new Envelope($apiMessage))->with(new ReceivedMessage()));
37+
$bus->expects($this->at(1))->method('dispatch')->with((new Envelope($ipaMessage))->with(new ReceivedMessage()));
3838

3939
$worker = new Worker($receiver, $bus);
4040
$worker->run();
4141
}
4242

4343
public function testWorkerDoesNotWrapMessagesAlreadyWrappedWithReceivedMessage()
4444
{
45-
$envelop = Envelope::wrap(new DummyMessage('API'))->with(new ReceivedMessage());
45+
$envelop = (new Envelope(new DummyMessage('API')))->with(new ReceivedMessage());
4646
$receiver = new CallbackReceiver(function ($handler) use ($envelop) {
4747
$handler($envelop);
4848
});
@@ -59,7 +59,7 @@ public function testWorkerIsThrowingExceptionsBackToGenerators()
5959
{
6060
$receiver = new CallbackReceiver(function ($handler) {
6161
try {
62-
$handler(Envelope::wrap(new DummyMessage('Hello')));
62+
$handler(new Envelope(new DummyMessage('Hello')));
6363

6464
$this->assertTrue(false, 'This should not be called because the exception is sent back to the generator.');
6565
} catch (\InvalidArgumentException $e) {

0 commit comments

Comments
 (0)
0