Skip to content

Remove stack of envelope classes from message metadata #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vjik wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Remove stack of envelope classes from message metadata #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cda3cc
Stop wrapping messages in envelopes during deserialization
vjik May 21, 2026
9f263a4
Remove `Envelope::ENVELOPE_STACK_KEY`
vjik May 22, 2026
74caa6a
fix
vjik May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 1 addition & 25 deletions src/Message/Envelope.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@

namespace Yiisoft\Queue\Message;

use function is_array;

abstract class Envelope implements MessageInterface
{
/** @psalm-suppress MissingClassConstType */
final public const ENVELOPE_STACK_KEY = 'envelopes';

/**
* @psalm-var array<string, mixed>
*/
Expand All @@ -20,7 +15,7 @@ abstract class Envelope implements MessageInterface

public function __construct(MessageInterface $message, array $metadata)
{
$this->metadata = $this->prepareMetadata($message->getMetadata(), $metadata);
$this->metadata = array_merge($message->getMetadata(), $metadata);

while ($message instanceof self) {
$message = $message->getMessage();
Expand Down Expand Up @@ -54,23 +49,4 @@ final public function getMetadata(): array
{
return $this->metadata;
}

private function prepareMetadata(array $messageMeta, array $metadata): array
{
$stack = $messageMeta[self::ENVELOPE_STACK_KEY] ?? [];
if (!is_array($stack)) {
$stack = [];
}

return array_merge(
$messageMeta,
[
self::ENVELOPE_STACK_KEY => array_merge(
$stack,
[static::class],
),
],
$metadata,
);
}
}
16 changes: 1 addition & 15 deletions src/Message/JsonMessageSerializer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,6 @@ public function unserialize(string $value): MessageInterface
throw new InvalidArgumentException('Metadata must be an array. Got ' . get_debug_type($meta) . '.');
}

$envelopes = [];
if (isset($meta[Envelope::ENVELOPE_STACK_KEY]) && is_array($meta[Envelope::ENVELOPE_STACK_KEY])) {
$envelopes = $meta[Envelope::ENVELOPE_STACK_KEY];
}
$meta[Envelope::ENVELOPE_STACK_KEY] = [];

$class = $meta['message-class'] ?? Message::class;
// Don't check subclasses when it's a default class: that's faster
if ($class !== Message::class && !is_subclass_of($class, MessageInterface::class)) {
Expand All @@ -69,14 +63,6 @@ public function unserialize(string $value): MessageInterface
/**
* @var class-string<MessageInterface> $class
*/
$message = $class::fromData($type, $payload['data'] ?? null, $meta);

foreach ($envelopes as $envelope) {
if (is_string($envelope) && class_exists($envelope) && is_subclass_of($envelope, Envelope::class)) {
$message = $envelope::fromMessage($message);
}
}

return $message;
return $class::fromData($type, $payload['data'] ?? null, $meta);
}
}
18 changes: 0 additions & 18 deletions tests/Unit/EnvelopeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
namespace Yiisoft\Queue\Tests\Unit;

use PHPUnit\Framework\TestCase;
use Yiisoft\Queue\Message\Envelope;
use Yiisoft\Queue\Message\IdEnvelope;
use Yiisoft\Queue\Message\Message;

Expand All @@ -17,14 +16,6 @@ public function testEnvelopeStack(): void
$message = new IdEnvelope($message, 'test-id');

$this->assertEquals('test', $message->getMessage()->getData());

$stack = $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY];
$this->assertIsArray($stack);

$this->assertEquals([
IdEnvelope::class,
], $stack);

$this->assertEquals('test-id', $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY]);
}

Expand All @@ -36,15 +27,6 @@ public function testEnvelopeDuplicates(): void
$message = new IdEnvelope($message, 'test-id-3');

$this->assertEquals('test', $message->getMessage()->getData());

$stack = $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY];
$this->assertIsArray($stack);
$this->assertEquals([
IdEnvelope::class,
IdEnvelope::class,
IdEnvelope::class,
], $stack);

$this->assertEquals('test-id-3', $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY]);
}
}
12 changes: 0 additions & 12 deletions tests/Unit/Message/EnvelopeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
namespace Yiisoft\Queue\Tests\Unit\Message;

use PHPUnit\Framework\TestCase;
use Yiisoft\Queue\Message\Envelope;
use Yiisoft\Queue\Tests\App\DummyEnvelope;
use Yiisoft\Queue\Message\Message;

final class EnvelopeTest extends TestCase
{
Expand All @@ -25,14 +23,4 @@ public function testFromData(): void
$this->assertArrayHasKey('meta', $envelope->getMetadata());
$this->assertSame('data', $envelope->getMetadata()['meta']);
}

public function testNonArrayStackIsNormalized(): void
{
$base = new Message('handler', 'data', [Envelope::ENVELOPE_STACK_KEY => 'oops']);
$wrapped = new DummyEnvelope($base);

$meta = $wrapped->getMetadata();
self::assertIsArray($meta[Envelope::ENVELOPE_STACK_KEY]);
self::assertSame([DummyEnvelope::class], $meta[Envelope::ENVELOPE_STACK_KEY]);
}
}
45 changes: 4 additions & 41 deletions tests/Unit/Message/JsonMessageSerializerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
use InvalidArgumentException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Yiisoft\Queue\Message\Envelope;
use Yiisoft\Queue\Message\IdEnvelope;
use Yiisoft\Queue\Message\JsonMessageSerializer;
use Yiisoft\Queue\Message\Message;
Expand Down Expand Up @@ -115,7 +114,7 @@ public function testUnserializeFromData(): void
$message = $serializer->unserialize(json_encode($payload, JSON_THROW_ON_ERROR));

$this->assertEquals($payload['data'], $message->getData());
$this->assertEquals([Envelope::ENVELOPE_STACK_KEY => []], $message->getMetadata());
$this->assertEquals([], $message->getMetadata());
}

public function testUnserializeWithMetadata(): void
Expand All @@ -126,31 +125,7 @@ public function testUnserializeWithMetadata(): void
$message = $serializer->unserialize(json_encode($payload, JSON_THROW_ON_ERROR));

$this->assertEquals($payload['data'], $message->getData());
$this->assertEquals(['int' => 1, 'str' => 'string', 'bool' => true, Envelope::ENVELOPE_STACK_KEY => []], $message->getMetadata());
}

public function testUnserializeEnvelopeStack(): void
{
$payload = [
'type' => 'handler',
'data' => 'test',
'meta' => [
Envelope::ENVELOPE_STACK_KEY => [
IdEnvelope::class,
],
],
];
$serializer = $this->createSerializer();

/** @var IdEnvelope $message */
$message = $serializer->unserialize(json_encode($payload, JSON_THROW_ON_ERROR));

$this->assertEquals($payload['data'], $message->getData());
$this->assertEquals([IdEnvelope::class], $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY]);

$this->assertInstanceOf(IdEnvelope::class, $message);
$this->assertNull($message->getId());
$this->assertInstanceOf(Message::class, $message->getMessage());
$this->assertEquals(['int' => 1, 'str' => 'string', 'bool' => true], $message->getMetadata());
}

public function testSerialize(): void
Expand Down Expand Up @@ -178,32 +153,20 @@ public function testSerializeEnvelopeStack(): void

$this->assertEquals(
sprintf(
'{"type":"handler","data":"test","meta":{"envelopes":["%s"],"%s":"test-id","message-class":"%s"}}',
str_replace('\\', '\\\\', IdEnvelope::class),
'{"type":"handler","data":"test","meta":{"%s":"test-id","message-class":"%s"}}',
IdEnvelope::MESSAGE_ID_KEY,
str_replace('\\', '\\\\', Message::class),
),
$json,
);

/** @var IdEnvelope $message */
$message = $serializer->unserialize($json);

$this->assertInstanceOf(IdEnvelope::class, $message);
$this->assertEquals('test-id', $message->getId());
$this->assertInstanceOf(Message::class, $message);
$this->assertEquals([
Envelope::ENVELOPE_STACK_KEY => [
IdEnvelope::class,
],
IdEnvelope::MESSAGE_ID_KEY => 'test-id',
'message-class' => Message::class,
], $message->getMetadata());

$this->assertEquals([
Envelope::ENVELOPE_STACK_KEY => [],
IdEnvelope::MESSAGE_ID_KEY => 'test-id',
'message-class' => Message::class,
], $message->getMessage()->getMetadata());
}

public function testRestoreOriginalMessageClass(): void
Expand Down
Loading