queue/tests/Unit/Message/JsonMessageSerializerTest.php at 75d600aaeb9460daa1d08bcb49500cb15b96014c · yiisoft/queue · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Tests\Unit\Message;

use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use Yiisoft\Queue\Message\EnvelopeInterface;
use Yiisoft\Queue\Message\IdEnvelope;
use Yiisoft\Queue\Message\JsonMessageSerializer;
use Yiisoft\Queue\Message\Message;
use Yiisoft\Queue\Message\MessageInterface;

/**
 * Testing message serialization options
 */
final class JsonMessageSerializerTest extends TestCase
{
    /**
     * @dataProvider dataUnsupportedPayloadFormat
     */
    public function testPayloadFormat(mixed $payload): void
    {
        $serializer = $this->createSerializer();

        $this->expectExceptionMessage(sprintf('Payload must be array. Got %s.', get_debug_type($payload)));
        $this->expectException(InvalidArgumentException::class);
        $serializer->unserialize(json_encode($payload));
    }

    public static function dataUnsupportedPayloadFormat(): iterable
    {
        yield 'string' => [''];
        yield 'number' => [1];
        yield 'boolean' => [true];
        yield 'null' => [null];
    }

    /**
     * @dataProvider dataUnsupportedMetadataFormat
     */
    public function testMetadataFormat(mixed $meta): void
    {
        $payload = ['data' => 'test', 'meta' => $meta];
        $serializer = $this->createSerializer();

        $this->expectExceptionMessage(sprintf('Metadata must be array. Got %s.', get_debug_type($meta)));
        $this->expectException(InvalidArgumentException::class);
        $serializer->unserialize(json_encode($payload));
    }

    public static function dataUnsupportedMetadataFormat(): iterable
    {
        yield 'string' => [''];
        yield 'number' => [1];
        yield 'boolean' => [true];
    }

    public function testUnserializeFromData(): void
    {
        $payload = ['data' => 'test'];
        $serializer = $this->createSerializer();

        $message = $serializer->unserialize(json_encode($payload));

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

    public function testUnserializeWithMetadata(): void
    {
        $payload = ['data' => 'test', 'meta' => ['int' => 1, 'str' => 'string', 'bool' => true]];
        $serializer = $this->createSerializer();

        $message = $serializer->unserialize(json_encode($payload));

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

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

        $message = $serializer->unserialize(json_encode($payload));

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

        $this->assertInstanceOf(IdEnvelope::class, $message);
        $this->assertNull($message->getId());
        $this->assertInstanceOf(Message::class, $message->getMessage());
    }

    public function testSerialize(): void
    {
        $message = new Message('handler', 'test');

        $serializer = $this->createSerializer();

        $json = $serializer->serialize($message);

        $this->assertEquals(
            '{"name":"handler","data":"test","meta":[]}',
            $json,
        );
    }

    public function testSerializeEnvelopeStack(): void
    {
        $message = new Message('handler', 'test');
        $message = new IdEnvelope($message, 'test-id');

        $serializer = $this->createSerializer();

        $json = $serializer->serialize($message);

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

        $message = $serializer->unserialize($json);

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

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

    private function createSerializer(): JsonMessageSerializer
    {
        return new JsonMessageSerializer();
    }
}