From fa48596e90c35246692b532095444bb18e23896a Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Thu, 18 Jun 2026 21:06:45 +0300 Subject: [PATCH 1/2] Rename in code "metadata" to "meta" --- src/Message/DelayEnvelope.php | 4 +- src/Message/Envelope.php | 26 +++++------ src/Message/IdEnvelope.php | 4 +- src/Message/Message.php | 10 ++--- src/Message/MessageInterface.php | 12 ++--- src/Message/Serializer/MessageSerializer.php | 10 ++--- .../FailureHandling/FailureEnvelope.php | 32 +++++++------- .../ExponentialDelayMiddleware.php | 4 +- .../Implementation/SendAgainMiddleware.php | 2 +- .../{MetadataBench.php => MetaBench.php} | 16 +++---- tests/Unit/EnvelopeTest.php | 4 +- tests/Unit/Message/DelayEnvelopeTest.php | 4 +- tests/Unit/Message/IdEnvelopeTest.php | 12 ++--- .../Serializer/MessageSerializerTest.php | 14 +++--- .../FailureHandling/FailureEnvelopeTest.php | 44 +++++++++---------- .../ExponentialDelayMiddlewareTest.php | 8 ++-- .../SendAgainMiddlewareTest.php | 6 +-- .../Push/Implementation/IdMiddlewareTest.php | 12 ++--- tests/Unit/QueueTest.php | 4 +- tests/Unit/Stubs/StubWorkerTest.php | 2 +- 20 files changed, 115 insertions(+), 115 deletions(-) rename tests/Benchmark/{MetadataBench.php => MetaBench.php} (84%) diff --git a/src/Message/DelayEnvelope.php b/src/Message/DelayEnvelope.php index 6e27d579..ae10db8e 100644 --- a/src/Message/DelayEnvelope.php +++ b/src/Message/DelayEnvelope.php @@ -23,12 +23,12 @@ public function __construct(MessageInterface $message, float $delaySeconds) public static function fromMessage(MessageInterface $message): static { - $raw = $message->getMetadata()[self::META_DELAY_SECONDS] ?? null; + $raw = $message->getMeta()[self::META_DELAY_SECONDS] ?? null; return new self($message, is_array($raw) ? 0.0 : (float) $raw); } public function getDelaySeconds(): float { - return $this->metadata[self::META_DELAY_SECONDS]; + return $this->meta[self::META_DELAY_SECONDS]; } } diff --git a/src/Message/Envelope.php b/src/Message/Envelope.php index 20345ca0..a5f5726c 100644 --- a/src/Message/Envelope.php +++ b/src/Message/Envelope.php @@ -7,26 +7,26 @@ use LogicException; /** - * @template TMetadata of MessageMetadata + * @template TMeta of MessageMeta * - * @psalm-import-type MessageMetadata from MessageInterface + * @psalm-import-type MessageMeta from MessageInterface */ abstract class Envelope implements MessageInterface { /** - * @psalm-var TMetadata + * @psalm-var TMeta */ - protected readonly array $metadata; + protected readonly array $meta; private readonly MessageInterface $message; /** - * @psalm-param TMetadata $metadata + * @psalm-param TMeta $meta */ - public function __construct(MessageInterface $message, array $metadata) + public function __construct(MessageInterface $message, array $meta) { - /** @var TMetadata */ - $this->metadata = array_merge($message->getMetadata(), $metadata); + /** @var TMeta */ + $this->meta = array_merge($message->getMeta(), $meta); while ($message instanceof self) { $message = $message->getMessage(); @@ -69,15 +69,15 @@ final public function getPayload(): bool|int|float|string|array|null } /** - * @psalm-return TMetadata + * @psalm-return TMeta */ - final public function getMetadata(): array + final public function getMeta(): array { - return $this->metadata; + return $this->meta; } - final public function withMetadata(array $metadata): static + final public function withMeta(array $meta): static { - return static::fromMessage($this->message->withMetadata($metadata)); + return static::fromMessage($this->message->withMeta($meta)); } } diff --git a/src/Message/IdEnvelope.php b/src/Message/IdEnvelope.php index 24d27c36..bd5362b1 100644 --- a/src/Message/IdEnvelope.php +++ b/src/Message/IdEnvelope.php @@ -30,7 +30,7 @@ public function __construct(MessageInterface $message, string|int|null $id) public static function fromMessage(MessageInterface $message): static { - $rawId = $message->getMetadata()[self::META_ID] ?? null; + $rawId = $message->getMeta()[self::META_ID] ?? null; $id = match (true) { $rawId === null => null, // don't remove this branch: it's important for compute speed @@ -47,6 +47,6 @@ public static function fromMessage(MessageInterface $message): static */ public function getId(): string|int|null { - return $this->metadata[self::META_ID]; + return $this->meta[self::META_ID]; } } diff --git a/src/Message/Message.php b/src/Message/Message.php index fe3edfae..5f2d7d5f 100644 --- a/src/Message/Message.php +++ b/src/Message/Message.php @@ -9,17 +9,17 @@ abstract class Message implements MessageInterface /** * @psalm-var array */ - private array $metadata = []; + private array $meta = []; - final public function getMetadata(): array + final public function getMeta(): array { - return $this->metadata; + return $this->meta; } - final public function withMetadata(array $metadata): static + final public function withMeta(array $meta): static { $new = clone $this; - $new->metadata = $metadata; + $new->meta = $meta; return $new; } } diff --git a/src/Message/MessageInterface.php b/src/Message/MessageInterface.php index 6e32331f..cfb79d14 100644 --- a/src/Message/MessageInterface.php +++ b/src/Message/MessageInterface.php @@ -8,7 +8,7 @@ * Represents a queue message with a type identifier, payload data, and metadata. * * @psalm-type MessagePayload = scalar|null|array - * @psalm-type MessageMetadata = array> + * @psalm-type MessageMeta = array> */ interface MessageInterface { @@ -46,17 +46,17 @@ public function getPayload(): bool|int|float|string|array|null; * @return array Metadata containing only `null`, scalars (`bool`, `int`, * `float`, `string`), or arrays composed of the same types recursively. * - * @psalm-return MessageMetadata + * @psalm-return MessageMeta */ - public function getMetadata(): array; + public function getMeta(): array; /** * Returns a new instance with the given message metadata. * - * @param array $metadata Metadata containing only `null`, scalars (`bool`, + * @param array $meta Metadata containing only `null`, scalars (`bool`, * `int`, `float`, `string`), or arrays composed of the same types recursively. * - * @psalm-param MessageMetadata $metadata + * @psalm-param MessageMeta $meta */ - public function withMetadata(array $metadata): static; + public function withMeta(array $meta): static; } diff --git a/src/Message/Serializer/MessageSerializer.php b/src/Message/Serializer/MessageSerializer.php index 89221b40..cdb8a9d4 100644 --- a/src/Message/Serializer/MessageSerializer.php +++ b/src/Message/Serializer/MessageSerializer.php @@ -45,7 +45,7 @@ public function serialize(MessageInterface $message): string return $this->encoder->encode([ 'type' => $message->getType(), 'payload' => $message->getPayload(), - 'meta' => $message->getMetadata(), + 'meta' => $message->getMeta(), ]); } @@ -62,13 +62,13 @@ public function unserialize(string $value): MessageInterface throw new MessageSerializerException('Message type must be a string. Got ' . get_debug_type($type) . '.'); } - $metadata = $data['meta'] ?? []; - if (!is_array($metadata)) { - throw new MessageSerializerException('Metadata must be an array. Got ' . get_debug_type($metadata) . '.'); + $meta = $data['meta'] ?? []; + if (!is_array($meta)) { + throw new MessageSerializerException('Metadata must be an array. Got ' . get_debug_type($meta) . '.'); } $class = $this->resolver->resolve($type) ?? GenericMessage::class; - return $class::fromPayload($type, $data['payload'] ?? null)->withMetadata($metadata); + return $class::fromPayload($type, $data['payload'] ?? null)->withMeta($meta); } } diff --git a/src/Middleware/FailureHandling/FailureEnvelope.php b/src/Middleware/FailureHandling/FailureEnvelope.php index bfab45da..4d5064e9 100644 --- a/src/Middleware/FailureHandling/FailureEnvelope.php +++ b/src/Middleware/FailureHandling/FailureEnvelope.php @@ -21,44 +21,44 @@ final class FailureEnvelope extends Envelope { public const META_FAILURE = 'yii-failure'; - private array $failureMetadata; + private array $failureMeta; - public function __construct(MessageInterface $message, array $failureMetadata = []) + public function __construct(MessageInterface $message, array $failureMeta = []) { - $this->failureMetadata = $failureMetadata === [] - ? self::getFailureMetadataFromMessage($message) + $this->failureMeta = $failureMeta === [] + ? self::getFailureMetaFromMessage($message) : ArrayHelper::merge( - self::getFailureMetadataFromMessage($message), - $failureMetadata, + self::getFailureMetaFromMessage($message), + $failureMeta, ); parent::__construct($message, [ - self::META_FAILURE => $this->failureMetadata, + self::META_FAILURE => $this->failureMeta, ]); } - public function getFailureMetadata(): array + public function getFailureMeta(): array { - return $this->failureMetadata; + return $this->failureMeta; } - public function getFailureMetadataValue(string $key, mixed $default = null): mixed + public function getFailureMetaValue(string $key, mixed $default = null): mixed { - return $this->failureMetadata[$key] ?? $default; + return $this->failureMeta[$key] ?? $default; } public static function fromMessage(MessageInterface $message): static { return new self( $message, - self::getFailureMetadataFromMessage($message), + self::getFailureMetaFromMessage($message), ); } - private static function getFailureMetadataFromMessage(MessageInterface $message): array + private static function getFailureMetaFromMessage(MessageInterface $message): array { - $metadata = $message->getMetadata(); - if (array_key_exists(self::META_FAILURE, $metadata)) { - $result = $metadata[self::META_FAILURE]; + $meta = $message->getMeta(); + if (array_key_exists(self::META_FAILURE, $meta)) { + $result = $meta[self::META_FAILURE]; return is_array($result) ? $result : []; } return []; diff --git a/src/Middleware/FailureHandling/Implementation/ExponentialDelayMiddleware.php b/src/Middleware/FailureHandling/Implementation/ExponentialDelayMiddleware.php index ea065014..7ab5bc64 100644 --- a/src/Middleware/FailureHandling/Implementation/ExponentialDelayMiddleware.php +++ b/src/Middleware/FailureHandling/Implementation/ExponentialDelayMiddleware.php @@ -88,13 +88,13 @@ private function createNewMeta(MessageInterface $message): array private function getAttempts(MessageInterface $message): int { return (int) FailureEnvelope::fromMessage($message) - ->getFailureMetadataValue(self::META_KEY_ATTEMPTS . "-$this->id", 0); + ->getFailureMetaValue(self::META_KEY_ATTEMPTS . "-$this->id", 0); } private function getDelay(MessageInterface $message): float { $delayOriginal = (float) FailureEnvelope::fromMessage($message) - ->getFailureMetadataValue(self::META_KEY_DELAY . "-$this->id", 0); + ->getFailureMetaValue(self::META_KEY_DELAY . "-$this->id", 0); if ($delayOriginal <= 0) { $delayOriginal = $this->delayInitial; diff --git a/src/Middleware/FailureHandling/Implementation/SendAgainMiddleware.php b/src/Middleware/FailureHandling/Implementation/SendAgainMiddleware.php index 99635d1f..f3bf6736 100644 --- a/src/Middleware/FailureHandling/Implementation/SendAgainMiddleware.php +++ b/src/Middleware/FailureHandling/Implementation/SendAgainMiddleware.php @@ -63,7 +63,7 @@ private function createMeta(MessageInterface $message): array private function getAttempts(MessageInterface $message): int { - $result = FailureEnvelope::fromMessage($message)->getFailureMetadataValue($this->getMetaKey(), 0); + $result = FailureEnvelope::fromMessage($message)->getFailureMetaValue($this->getMetaKey(), 0); if ($result < 0) { $result = 0; } diff --git a/tests/Benchmark/MetadataBench.php b/tests/Benchmark/MetaBench.php similarity index 84% rename from tests/Benchmark/MetadataBench.php rename to tests/Benchmark/MetaBench.php index 7ed5f86c..560901d2 100644 --- a/tests/Benchmark/MetadataBench.php +++ b/tests/Benchmark/MetaBench.php @@ -11,15 +11,15 @@ use Yiisoft\Queue\Message\MessageInterface; use Yiisoft\Queue\Middleware\FailureHandling\FailureEnvelope; -final class MetadataBench +final class MetaBench { /** * Create metadata as an array and read its value from an array. */ public function benchArrayRead(): void { - $message = (new GenericMessage('foo', 'bar'))->withMetadata(['id' => 1]); - $id = $message->getMetadata()['id']; + $message = (new GenericMessage('foo', 'bar'))->withMeta(['id' => 1]); + $id = $message->getMeta()['id']; } /** @@ -36,7 +36,7 @@ public function benchEnvelopeRead(): void */ public function benchEnvelopeReadRestored(): void { - $message = IdEnvelope::fromMessage((new GenericMessage('foo', 'bar'))->withMetadata(['id' => 1])); + $message = IdEnvelope::fromMessage((new GenericMessage('foo', 'bar'))->withMeta(['id' => 1])); $id = $message->getId(); } @@ -91,12 +91,12 @@ public function benchEnvelopeStackCreation(array $params): void * @psalm-param array{0: int} $params */ #[ParamProviders('provideEnvelopeStackCounts')] - public function benchMetadataArrayCreation(array $params): void + public function benchMetaArrayCreation(array $params): void { - $metadata = [FailureEnvelope::META_FAILURE => []]; + $meta = [FailureEnvelope::META_FAILURE => []]; for ($i = 0; $i < $params[0]; $i++) { - $metadata[FailureEnvelope::META_FAILURE]["fail$i"] = "fail$i"; + $meta[FailureEnvelope::META_FAILURE]["fail$i"] = "fail$i"; } - $message = (new GenericMessage('foo', 'bar'))->withMetadata($metadata); + $message = (new GenericMessage('foo', 'bar'))->withMeta($meta); } } diff --git a/tests/Unit/EnvelopeTest.php b/tests/Unit/EnvelopeTest.php index 1775f60f..5e308c13 100644 --- a/tests/Unit/EnvelopeTest.php +++ b/tests/Unit/EnvelopeTest.php @@ -16,7 +16,7 @@ public function testEnvelopeStack(): void $message = new IdEnvelope($message, 'test-id'); $this->assertEquals('test', $message->getMessage()->getPayload()); - $this->assertEquals('test-id', $message->getMetadata()[IdEnvelope::META_ID]); + $this->assertEquals('test-id', $message->getMeta()[IdEnvelope::META_ID]); } public function testEnvelopeDuplicates(): void @@ -27,6 +27,6 @@ public function testEnvelopeDuplicates(): void $message = new IdEnvelope($message, 'test-id-3'); $this->assertEquals('test', $message->getMessage()->getPayload()); - $this->assertEquals('test-id-3', $message->getMetadata()[IdEnvelope::META_ID]); + $this->assertEquals('test-id-3', $message->getMeta()[IdEnvelope::META_ID]); } } diff --git a/tests/Unit/Message/DelayEnvelopeTest.php b/tests/Unit/Message/DelayEnvelopeTest.php index 0ce2c799..2184548d 100644 --- a/tests/Unit/Message/DelayEnvelopeTest.php +++ b/tests/Unit/Message/DelayEnvelopeTest.php @@ -21,7 +21,7 @@ public function testDelayEnvelope(): void self::assertSame(300.5, $delayEnvelope->getDelaySeconds()); self::assertSame( [DelayEnvelope::META_DELAY_SECONDS => 300.5], - $delayEnvelope->getMetadata(), + $delayEnvelope->getMeta(), ); } @@ -29,7 +29,7 @@ public function testFromMessage(): void { $delayEnvelope = DelayEnvelope::fromMessage( (new GenericMessage('test', ['data' => 'value'])) - ->withMetadata([DelayEnvelope::META_DELAY_SECONDS => 150]), + ->withMeta([DelayEnvelope::META_DELAY_SECONDS => 150]), ); self::assertSame(150.0, $delayEnvelope->getDelaySeconds()); diff --git a/tests/Unit/Message/IdEnvelopeTest.php b/tests/Unit/Message/IdEnvelopeTest.php index 4c67c029..5f9797d3 100644 --- a/tests/Unit/Message/IdEnvelopeTest.php +++ b/tests/Unit/Message/IdEnvelopeTest.php @@ -60,20 +60,20 @@ public function testFromMessageWithInvalidIdType(): void $this->assertNull($message->getId()); } - public function testGetEnvelopeMetadata(): void + public function testGetEnvelopeMeta(): void { $id = 'test-id'; $message = $this->createMessage(); $envelope = new IdEnvelope($message, $id); - $metadata = $envelope->getMetadata(); + $meta = $envelope->getMeta(); - $this->assertArrayHasKey(IdEnvelope::META_ID, $metadata); - $this->assertSame($id, $metadata[IdEnvelope::META_ID]); + $this->assertArrayHasKey(IdEnvelope::META_ID, $meta); + $this->assertSame($id, $meta[IdEnvelope::META_ID]); } - private function createMessage(array $metadata = []): MessageInterface + private function createMessage(array $meta = []): MessageInterface { - return (new GenericMessage('test-handler', ['test-data']))->withMetadata($metadata); + return (new GenericMessage('test-handler', ['test-data']))->withMeta($meta); } } diff --git a/tests/Unit/Message/Serializer/MessageSerializerTest.php b/tests/Unit/Message/Serializer/MessageSerializerTest.php index 1213ee4d..9913d76c 100644 --- a/tests/Unit/Message/Serializer/MessageSerializerTest.php +++ b/tests/Unit/Message/Serializer/MessageSerializerTest.php @@ -49,15 +49,15 @@ public function testUnsupportedType(mixed $type): void #[TestWith([''])] #[TestWith([1])] #[TestWith([true])] - public function testUnsupportedMetadata(mixed $metadata): void + public function testUnsupportedMeta(mixed $meta): void { $value = json_encode( - ['type' => 'test', 'payload' => 'test', 'meta' => $metadata], + ['type' => 'test', 'payload' => 'test', 'meta' => $meta], JSON_THROW_ON_ERROR, ); $this->expectException(MessageSerializerException::class); - $this->expectExceptionMessage(sprintf('Metadata must be an array. Got %s.', get_debug_type($metadata))); + $this->expectExceptionMessage(sprintf('Metadata must be an array. Got %s.', get_debug_type($meta))); $this->createSerializer()->unserialize($value); } @@ -81,17 +81,17 @@ public function testUnserializeFromPayload(): void $message = $this->createSerializer()->unserialize(json_encode($payload, JSON_THROW_ON_ERROR)); $this->assertEquals($payload['payload'], $message->getPayload()); - $this->assertEquals([], $message->getMetadata()); + $this->assertEquals([], $message->getMeta()); } - public function testUnserializeWithMetadata(): void + public function testUnserializeWithMeta(): void { $payload = ['type' => 'handler', 'payload' => 'test', 'meta' => ['int' => 1, 'str' => 'string', 'bool' => true]]; $message = $this->createSerializer()->unserialize(json_encode($payload, JSON_THROW_ON_ERROR)); $this->assertEquals($payload['payload'], $message->getPayload()); - $this->assertEquals(['int' => 1, 'str' => 'string', 'bool' => true], $message->getMetadata()); + $this->assertEquals(['int' => 1, 'str' => 'string', 'bool' => true], $message->getMeta()); } public function testSerialize(): void @@ -123,7 +123,7 @@ public function testSerializeEnvelopeStack(): void $this->assertInstanceOf(GenericMessage::class, $restored); $this->assertEquals([ IdEnvelope::META_ID => 'test-id', - ], $restored->getMetadata()); + ], $restored->getMeta()); } public function testRestoreOriginalMessageClass(): void diff --git a/tests/Unit/Middleware/FailureHandling/FailureEnvelopeTest.php b/tests/Unit/Middleware/FailureHandling/FailureEnvelopeTest.php index 32e2edbb..a5217acc 100644 --- a/tests/Unit/Middleware/FailureHandling/FailureEnvelopeTest.php +++ b/tests/Unit/Middleware/FailureHandling/FailureEnvelopeTest.php @@ -14,51 +14,51 @@ final class FailureEnvelopeTest extends TestCase public function testConstructor(): void { $message = $this->createMessage(); - $metadata = ['attempt' => 1, 'error' => 'Test error']; + $meta = ['attempt' => 1, 'error' => 'Test error']; - $envelope = new FailureEnvelope($message, $metadata); + $envelope = new FailureEnvelope($message, $meta); $this->assertSame($message, $envelope->getMessage()); - $this->assertArrayHasKey(FailureEnvelope::META_FAILURE, $envelope->getMetadata()); - $this->assertSame($metadata, $envelope->getMetadata()[FailureEnvelope::META_FAILURE]); + $this->assertArrayHasKey(FailureEnvelope::META_FAILURE, $envelope->getMeta()); + $this->assertSame($meta, $envelope->getMeta()[FailureEnvelope::META_FAILURE]); } - public function testFromMessageWithExistingMetadata(): void + public function testFromMessageWithExistingMeta(): void { - $existingMetadata = ['attempt' => 1]; - $message = $this->createMessage([FailureEnvelope::META_FAILURE => $existingMetadata]); + $existingMeta = ['attempt' => 1]; + $message = $this->createMessage([FailureEnvelope::META_FAILURE => $existingMeta]); $envelope = FailureEnvelope::fromMessage($message); - $this->assertSame($existingMetadata, $envelope->getMetadata()[FailureEnvelope::META_FAILURE]); + $this->assertSame($existingMeta, $envelope->getMeta()[FailureEnvelope::META_FAILURE]); } - public function testFromMessageWithoutMetadata(): void + public function testFromMessageWithoutMeta(): void { $message = $this->createMessage(); $envelope = FailureEnvelope::fromMessage($message); - $this->assertArrayHasKey(FailureEnvelope::META_FAILURE, $envelope->getMetadata()); - $this->assertSame([], $envelope->getMetadata()[FailureEnvelope::META_FAILURE]); + $this->assertArrayHasKey(FailureEnvelope::META_FAILURE, $envelope->getMeta()); + $this->assertSame([], $envelope->getMeta()[FailureEnvelope::META_FAILURE]); } - public function testMetadataMerging(): void + public function testMetaMerging(): void { - $existingMetadata = ['attempt' => 1, 'firstError' => 'First error']; - $message = $this->createMessage([FailureEnvelope::META_FAILURE => $existingMetadata]); - $newMetadata = ['attempt' => 2, 'lastError' => 'Last error']; + $existingMeta = ['attempt' => 1, 'firstError' => 'First error']; + $message = $this->createMessage([FailureEnvelope::META_FAILURE => $existingMeta]); + $newMeta = ['attempt' => 2, 'lastError' => 'Last error']; - $envelope = new FailureEnvelope($message, $newMetadata); + $envelope = new FailureEnvelope($message, $newMeta); - $mergedMetadata = $envelope->getMetadata()[FailureEnvelope::META_FAILURE]; - $this->assertSame(2, $mergedMetadata['attempt']); - $this->assertSame('First error', $mergedMetadata['firstError']); - $this->assertSame('Last error', $mergedMetadata['lastError']); + $mergedMeta = $envelope->getMeta()[FailureEnvelope::META_FAILURE]; + $this->assertSame(2, $mergedMeta['attempt']); + $this->assertSame('First error', $mergedMeta['firstError']); + $this->assertSame('Last error', $mergedMeta['lastError']); } - private function createMessage(array $metadata = []): MessageInterface + private function createMessage(array $meta = []): MessageInterface { - return (new GenericMessage('test-handler', ['test-data']))->withMetadata($metadata); + return (new GenericMessage('test-handler', ['test-data']))->withMeta($meta); } } diff --git a/tests/Unit/Middleware/FailureHandling/Implementation/ExponentialDelayMiddlewareTest.php b/tests/Unit/Middleware/FailureHandling/Implementation/ExponentialDelayMiddlewareTest.php index adcd413e..14695389 100644 --- a/tests/Unit/Middleware/FailureHandling/Implementation/ExponentialDelayMiddlewareTest.php +++ b/tests/Unit/Middleware/FailureHandling/Implementation/ExponentialDelayMiddlewareTest.php @@ -149,10 +149,10 @@ public function testPipelineSuccess(): void self::assertNotEquals($request, $result); $message = $result->getMessage(); - self::assertArrayHasKey(FailureEnvelope::META_FAILURE, $message->getMetadata()); - self::assertArrayHasKey(DelayEnvelope::META_DELAY_SECONDS, $message->getMetadata()); + self::assertArrayHasKey(FailureEnvelope::META_FAILURE, $message->getMeta()); + self::assertArrayHasKey(DelayEnvelope::META_DELAY_SECONDS, $message->getMeta()); - $meta = $message->getMetadata()[FailureEnvelope::META_FAILURE]; + $meta = $message->getMeta()[FailureEnvelope::META_FAILURE]; self::assertArrayHasKey(ExponentialDelayMiddleware::META_KEY_ATTEMPTS . '-test', $meta); self::assertArrayHasKey(ExponentialDelayMiddleware::META_KEY_DELAY . '-test', $meta); } @@ -165,7 +165,7 @@ public function testPipelineFailure(): void $message = (new GenericMessage( 'test', null, - ))->withMetadata([FailureEnvelope::META_FAILURE => [ExponentialDelayMiddleware::META_KEY_ATTEMPTS . '-test' => 2]]); + ))->withMeta([FailureEnvelope::META_FAILURE => [ExponentialDelayMiddleware::META_KEY_ATTEMPTS . '-test' => 2]]); $queue = $this->createMock(QueueInterface::class); $middleware = new ExponentialDelayMiddleware( 'test', diff --git a/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php b/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php index 594b6982..ffabed6b 100644 --- a/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php +++ b/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php @@ -158,7 +158,7 @@ public function testQueueSendingStrategies( (new GenericMessage( 'test', null, - ))->withMetadata([FailureEnvelope::META_FAILURE => $metaInitial]), + ))->withMeta([FailureEnvelope::META_FAILURE => $metaInitial]), new Exception('testException'), $queue, ); @@ -188,7 +188,7 @@ private function getHandler(array $metaResult, bool $suites): FailureHandlerInte $pipelineAssertion = static function (FailureHandlingRequest $request) use ( $metaResult ): FailureHandlingRequest { - Assert::assertEquals($metaResult, $request->getMessage()->getMetadata()[FailureEnvelope::META_FAILURE] ?? []); + Assert::assertEquals($metaResult, $request->getMessage()->getMeta()[FailureEnvelope::META_FAILURE] ?? []); throw $request->getException(); }; @@ -203,7 +203,7 @@ private function getHandler(array $metaResult, bool $suites): FailureHandlerInte private function getPreparedQueue(array $metaResult, bool $suites): QueueInterface { $queueAssertion = static function (MessageInterface $message) use ($metaResult): MessageInterface { - Assert::assertEquals($metaResult, $message->getMetadata()[FailureEnvelope::META_FAILURE] ?? []); + Assert::assertEquals($metaResult, $message->getMeta()[FailureEnvelope::META_FAILURE] ?? []); return $message; }; diff --git a/tests/Unit/Middleware/Push/Implementation/IdMiddlewareTest.php b/tests/Unit/Middleware/Push/Implementation/IdMiddlewareTest.php index 650a2589..d3ffb71f 100644 --- a/tests/Unit/Middleware/Push/Implementation/IdMiddlewareTest.php +++ b/tests/Unit/Middleware/Push/Implementation/IdMiddlewareTest.php @@ -14,7 +14,7 @@ final class IdMiddlewareTest extends TestCase { public function testWithId(): void { - $message = (new GenericMessage('test', null))->withMetadata([IdEnvelope::META_ID => 'test-id']); + $message = (new GenericMessage('test', null))->withMeta([IdEnvelope::META_ID => 'test-id']); $handler = $this->createMock(PushHandlerInterface::class); $handler->expects($this->once()) @@ -26,7 +26,7 @@ public function testWithId(): void $this->assertSame($message, $result); $this->assertNotInstanceOf(IdEnvelope::class, $result); - $this->assertEquals('test-id', $result->getMetadata()[IdEnvelope::META_ID]); + $this->assertEquals('test-id', $result->getMeta()[IdEnvelope::META_ID]); $this->assertSame($message->getPayload(), $result->getPayload()); $this->assertSame($message->getType(), $result->getType()); } @@ -45,14 +45,14 @@ public function testWithoutId(): void $this->assertInstanceOf(IdEnvelope::class, $result); $this->assertNotSame($message, $result); - $this->assertNotEmpty($result->getMetadata()[IdEnvelope::META_ID] ?? null); + $this->assertNotEmpty($result->getMeta()[IdEnvelope::META_ID] ?? null); $this->assertSame($message->getPayload(), $result->getPayload()); $this->assertSame($message->getType(), $result->getType()); } public function testWithEmptyId(): void { - $message = (new GenericMessage('test', null))->withMetadata([IdEnvelope::META_ID => '']); + $message = (new GenericMessage('test', null))->withMeta([IdEnvelope::META_ID => '']); $handler = $this->createMock(PushHandlerInterface::class); $handler->expects($this->once()) @@ -64,8 +64,8 @@ public function testWithEmptyId(): void $this->assertInstanceOf(IdEnvelope::class, $result); $this->assertNotSame($message, $result); - $this->assertNotEmpty($result->getMetadata()[IdEnvelope::META_ID] ?? null); - $this->assertNotSame('', $result->getMetadata()[IdEnvelope::META_ID]); + $this->assertNotEmpty($result->getMeta()[IdEnvelope::META_ID] ?? null); + $this->assertNotSame('', $result->getMeta()[IdEnvelope::META_ID]); $this->assertSame($message->getPayload(), $result->getPayload()); $this->assertSame($message->getType(), $result->getType()); } diff --git a/tests/Unit/QueueTest.php b/tests/Unit/QueueTest.php index 4cccc86e..254c8076 100644 --- a/tests/Unit/QueueTest.php +++ b/tests/Unit/QueueTest.php @@ -109,9 +109,9 @@ public function testStatusWithAdapter(): void $queue = $this->createQueue(new InMemoryAdapter()); $envelope = $queue->push(new GenericMessage('simple', null)); - self::assertArrayHasKey(IdEnvelope::META_ID, $envelope->getMetadata()); + self::assertArrayHasKey(IdEnvelope::META_ID, $envelope->getMeta()); /** @var int|string $id */ - $id = $envelope->getMetadata()[IdEnvelope::META_ID]; + $id = $envelope->getMeta()[IdEnvelope::META_ID]; self::assertSame(MessageStatus::WAITING, $queue->status($id)); diff --git a/tests/Unit/Stubs/StubWorkerTest.php b/tests/Unit/Stubs/StubWorkerTest.php index 959660ee..21d5c608 100644 --- a/tests/Unit/Stubs/StubWorkerTest.php +++ b/tests/Unit/Stubs/StubWorkerTest.php @@ -22,6 +22,6 @@ public function testBase(): void $this->assertSame($sourceMessage, $message); $this->assertSame('test', $message->getType()); $this->assertSame(42, $message->getPayload()); - $this->assertSame([], $message->getMetadata()); + $this->assertSame([], $message->getMeta()); } } From dade7728be29e906cd713e374a75aece0ffd031a Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Thu, 18 Jun 2026 21:14:35 +0300 Subject: [PATCH 2/2] fix psalm --- stubs/DummyEnvelope.php | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/stubs/DummyEnvelope.php b/stubs/DummyEnvelope.php index 02ec2384..98b69e42 100644 --- a/stubs/DummyEnvelope.php +++ b/stubs/DummyEnvelope.php @@ -10,9 +10,7 @@ /** * Dummy envelope stub for testing purposes. * - * @extends Envelope - * - * @psalm-import-type MessageMetadata from MessageInterface + * @extends Envelope> */ final class DummyEnvelope extends Envelope {