diff --git a/composer.json b/composer.json index 7846b83f..fd3e594f 100644 --- a/composer.json +++ b/composer.json @@ -40,6 +40,7 @@ "psr/container": "^1.0 || ^2.0", "psr/log": "^2.0 || ^3.0", "symfony/console": "^5.4 || ^6.0 || ^7.0", + "yiisoft/arrays": "^3.1", "yiisoft/definitions": "^3.3.1", "yiisoft/factory": "^1.3", "yiisoft/friendly-exception": "^1.0", diff --git a/phpbench.json b/phpbench.json index 95a469d4..04436028 100644 --- a/phpbench.json +++ b/phpbench.json @@ -2,7 +2,7 @@ "$schema":"./vendor/phpbench/phpbench/phpbench.schema.json", "runner.bootstrap": "vendor/autoload.php", "runner.path": "tests/Benchmark", - "runner.revs": 1000, + "runner.revs": 100000, "runner.iterations": 5, "runner.warmup": 5 } diff --git a/src/Message/Envelope.php b/src/Message/Envelope.php new file mode 100644 index 00000000..a39668d6 --- /dev/null +++ b/src/Message/Envelope.php @@ -0,0 +1,63 @@ +message; + } + + public function getHandlerName(): string + { + return $this->message->getHandlerName(); + } + + public function getData(): mixed + { + return $this->message->getData(); + } + + public function getMetadata(): array + { + if ($this->metadata === null) { + $messageMeta = $this->message->getMetadata(); + + $stack = $messageMeta[EnvelopeInterface::ENVELOPE_STACK_KEY] ?? []; + if (!is_array($stack)) { + $stack = []; + } + + $this->metadata = array_merge( + $messageMeta, + [ + EnvelopeInterface::ENVELOPE_STACK_KEY => array_merge( + $stack, + [static::class], + ), + ], + $this->getEnvelopeMetadata(), + ); + } + + return $this->metadata; + } + + abstract protected function getEnvelopeMetadata(): array; +} diff --git a/src/Message/EnvelopeInterface.php b/src/Message/EnvelopeInterface.php index 7c58daa1..612fe368 100644 --- a/src/Message/EnvelopeInterface.php +++ b/src/Message/EnvelopeInterface.php @@ -12,9 +12,7 @@ interface EnvelopeInterface extends MessageInterface /** @psalm-suppress MissingClassConstType */ public const ENVELOPE_STACK_KEY = 'envelopes'; - public static function fromMessage(MessageInterface $message): self; + public static function fromMessage(MessageInterface $message): static; public function getMessage(): MessageInterface; - - public function withMessage(MessageInterface $message): self; } diff --git a/src/Message/EnvelopeTrait.php b/src/Message/EnvelopeTrait.php deleted file mode 100644 index f5dc1257..00000000 --- a/src/Message/EnvelopeTrait.php +++ /dev/null @@ -1,62 +0,0 @@ -message; - } - - public function withMessage(MessageInterface $message): self - { - $instance = clone $this; - $instance->message = $message; - - return $instance; - } - - public function getHandlerName(): string - { - return $this->message->getHandlerName(); - } - - public function getData(): mixed - { - return $this->message->getData(); - } - - public function getMetadata(): array - { - return array_merge( - $this->message->getMetadata(), - [ - EnvelopeInterface::ENVELOPE_STACK_KEY => array_merge( - $this->message->getMetadata()[EnvelopeInterface::ENVELOPE_STACK_KEY] ?? [], - [self::class], - ), - ], - $this->getEnvelopeMetadata(), - ); - } - - public function getEnvelopeMetadata(): array - { - return []; - } -} diff --git a/src/Message/IdEnvelope.php b/src/Message/IdEnvelope.php index 3a941114..8033a988 100644 --- a/src/Message/IdEnvelope.php +++ b/src/Message/IdEnvelope.php @@ -5,49 +5,42 @@ namespace Yiisoft\Queue\Message; /** - * ID envelope allows identifying a message. + * ID envelope allows to identify a message. */ -final class IdEnvelope implements EnvelopeInterface +final class IdEnvelope extends Envelope { - use EnvelopeTrait; - public const MESSAGE_ID_KEY = 'yii-message-id'; public function __construct( - MessageInterface $message, - private readonly string|int|null $id = null, + protected MessageInterface $message, + private readonly string|int|null $id, ) { - $this->message = $message; } - public static function fromMessage(MessageInterface $message): self + public static function fromMessage(MessageInterface $message): static { - return new self($message, self::getIdFromMessage($message)); + /** @var mixed $rawId */ + $rawId = $message->getMetadata()[self::MESSAGE_ID_KEY] ?? null; + + /** @var int|string|null $id */ + $id = match (true) { + $rawId === null => null, // don't remove this branch: it's important for compute speed + is_string($rawId) => $rawId, + is_int($rawId) => $rawId, + is_object($rawId) && method_exists($rawId, '__toString') => (string)$rawId, + default => null, + }; + + return new self($message, $id); } public function getId(): string|int|null { - return $this->id ?? self::getIdFromMessage($this->message); + return $this->id; } - private function getEnvelopeMetadata(): array + protected function getEnvelopeMetadata(): array { return [self::MESSAGE_ID_KEY => $this->getId()]; } - - private static function getIdFromMessage(MessageInterface $message): string|int|null - { - $id = $message->getMetadata()[self::MESSAGE_ID_KEY] ?? null; - if ($id instanceof \Stringable) { - $id = (string) $id; - } - - // We don't throw an error as this value could come from external sources, - // and we should process the message either way - if (!is_string($id) && !is_int($id)) { - return null; - } - - return $id; - } } diff --git a/src/Message/Message.php b/src/Message/Message.php index bcc35211..fda3f1a6 100644 --- a/src/Message/Message.php +++ b/src/Message/Message.php @@ -7,6 +7,7 @@ final class Message implements MessageInterface { /** + * @param string $handlerName A name of a handler which should handle this message. * @param mixed $data Message data, encodable by a queue adapter * @param array $metadata Message metadata, encodable by a queue adapter */ @@ -36,12 +37,4 @@ public function getMetadata(): array { return $this->metadata; } - - public function withMetadata(array $metadata): self - { - $instance = clone $this; - $instance->metadata = $metadata; - - return $instance; - } } diff --git a/src/Message/MessageInterface.php b/src/Message/MessageInterface.php index ea3b1882..a7367248 100644 --- a/src/Message/MessageInterface.php +++ b/src/Message/MessageInterface.php @@ -10,22 +10,16 @@ public static function fromData(string $handlerName, mixed $data, array $metadat /** * Returns handler name. - * - * @return string */ public function getHandlerName(): string; /** * Returns payload data. - * - * @return mixed */ public function getData(): mixed; /** * Returns message metadata: timings, attempts count, metrics, etc. - * - * @return array */ public function getMetadata(): array; } diff --git a/src/Middleware/FailureHandling/FailureEnvelope.php b/src/Middleware/FailureHandling/FailureEnvelope.php index 9c0ecf7f..4d795588 100644 --- a/src/Middleware/FailureHandling/FailureEnvelope.php +++ b/src/Middleware/FailureHandling/FailureEnvelope.php @@ -4,35 +4,33 @@ namespace Yiisoft\Queue\Middleware\FailureHandling; -use Yiisoft\Queue\Message\EnvelopeInterface; -use Yiisoft\Queue\Message\EnvelopeTrait; +use Yiisoft\Arrays\ArrayHelper; +use Yiisoft\Queue\Message\Envelope; use Yiisoft\Queue\Message\MessageInterface; -final class FailureEnvelope implements EnvelopeInterface +final class FailureEnvelope extends Envelope { - use EnvelopeTrait { - getMetadata as getMetadataParent; - } - public const FAILURE_META_KEY = 'failure-meta'; public function __construct( - MessageInterface $message, - private readonly array $meta = [], + protected MessageInterface $message, + private readonly array $metadata = [], ) { - $this->message = $message; } - public static function fromMessage(MessageInterface $message): self + public static function fromMessage(MessageInterface $message): static { - return new self($message, $message->getMetadata()[self::FAILURE_META_KEY] ?? []); + /** @var array $metadata */ + $metadata = $message->getMetadata()[self::FAILURE_META_KEY] ?? []; + + return new self($message, $metadata); } - public function getMetadata(): array + protected function getEnvelopeMetadata(): array { - $meta = $this->getMetadataParent(); - $meta[self::FAILURE_META_KEY] = array_merge($meta[self::FAILURE_META_KEY] ?? [], $this->meta); + /** @var array $metadata */ + $metadata = $this->message->getMetadata()[self::FAILURE_META_KEY] ?? []; - return $meta; + return [self::FAILURE_META_KEY => ArrayHelper::merge($metadata, $this->metadata)]; } } diff --git a/tests/App/DummyEnvelope.php b/tests/App/DummyEnvelope.php index 65c6162f..dc1d1f7d 100644 --- a/tests/App/DummyEnvelope.php +++ b/tests/App/DummyEnvelope.php @@ -4,19 +4,18 @@ namespace Yiisoft\Queue\Tests\App; -use Yiisoft\Queue\Message\EnvelopeInterface; -use Yiisoft\Queue\Message\EnvelopeTrait; +use Yiisoft\Queue\Message\Envelope; use Yiisoft\Queue\Message\MessageInterface; -final class DummyEnvelope implements EnvelopeInterface +final class DummyEnvelope extends Envelope { - use EnvelopeTrait; - - public static function fromMessage(MessageInterface $message): self + public static function fromMessage(MessageInterface $message): static { - $instance = new self(); - $instance->message = $message; + return new self($message); + } - return $instance; + protected function getEnvelopeMetadata(): array + { + return []; } } diff --git a/tests/Unit/Message/EnvelopeTraitTest.php b/tests/Unit/Message/EnvelopeTraitTest.php index 5dd5c4a6..6ae7f085 100644 --- a/tests/Unit/Message/EnvelopeTraitTest.php +++ b/tests/Unit/Message/EnvelopeTraitTest.php @@ -5,16 +5,10 @@ namespace Yiisoft\Queue\Tests\Unit\Message; use PHPUnit\Framework\TestCase; -use Yiisoft\Queue\Message\Message; use Yiisoft\Queue\Tests\App\DummyEnvelope; final class EnvelopeTraitTest extends TestCase { - private function createTestEnvelope(): DummyEnvelope - { - return new DummyEnvelope(); - } - public function testFromData(): void { $handlerName = 'test-handler'; @@ -29,21 +23,4 @@ public function testFromData(): void $this->assertArrayHasKey('meta', $envelope->getMetadata()); $this->assertSame('data', $envelope->getMetadata()['meta']); } - - public function testWithMessage(): void - { - $originalMessage = new Message('original-handler', 'original-data'); - $newMessage = new Message('new-handler', 'new-data'); - - $envelope = $this->createTestEnvelope(); - $envelope = $envelope->withMessage($originalMessage); - - $this->assertSame($originalMessage, $envelope->getMessage()); - - $newEnvelope = $envelope->withMessage($newMessage); - - $this->assertNotSame($envelope, $newEnvelope); - $this->assertSame($newMessage, $newEnvelope->getMessage()); - $this->assertSame($originalMessage, $envelope->getMessage()); - } } diff --git a/tests/Unit/Message/IdEnvelopeTest.php b/tests/Unit/Message/IdEnvelopeTest.php index 8e866056..b66e958d 100644 --- a/tests/Unit/Message/IdEnvelopeTest.php +++ b/tests/Unit/Message/IdEnvelopeTest.php @@ -92,9 +92,6 @@ public function testFromData(): void $data = ['key' => 'value']; $metadata = ['meta' => 'data', IdEnvelope::MESSAGE_ID_KEY => 'test-id']; - /** - * @var IdEnvelope $envelope - */ $envelope = IdEnvelope::fromData($handlerName, $data, $metadata); $this->assertInstanceOf(IdEnvelope::class, $envelope); diff --git a/tests/Unit/Message/JsonMessageSerializerTest.php b/tests/Unit/Message/JsonMessageSerializerTest.php index 8101c24c..46617994 100644 --- a/tests/Unit/Message/JsonMessageSerializerTest.php +++ b/tests/Unit/Message/JsonMessageSerializerTest.php @@ -215,7 +215,7 @@ public function testRestoreOriginalMessageClass(): void public function testRestoreOriginalMessageClassWithEnvelope(): void { - $message = new IdEnvelope(new TestMessage()); + $message = new IdEnvelope(new TestMessage(), 1); $serializer = $this->createSerializer(); $serializer->unserialize($serializer->serialize($message));