diff --git a/composer.json b/composer.json index 664f5853..69c724cc 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", + "yiisoft/arrays": "^3.1", "yiisoft/definitions": "^1.0|^2.0|^3.0", "yiisoft/friendly-exception": "^1.0", "yiisoft/injector": "^1.0" diff --git a/phpbench.json b/phpbench.json index 04436028..9c76ae2e 100644 --- a/phpbench.json +++ b/phpbench.json @@ -4,5 +4,6 @@ "runner.path": "tests/Benchmark", "runner.revs": 100000, "runner.iterations": 5, - "runner.warmup": 5 + "runner.warmup": 5, + "runner.retry_threshold": 5 } diff --git a/src/Message/AbstractEnvelope.php b/src/Message/AbstractEnvelope.php new file mode 100644 index 00000000..a84c96bb --- /dev/null +++ b/src/Message/AbstractEnvelope.php @@ -0,0 +1,74 @@ +metadata = $message->getMetadata(); + $envelopes = [static::class]; + while ($message instanceof EnvelopeInterface) { + if ($message::class !== static::class) { + $envelopes = [$message::class]; + } + + $message = $message->getMessage(); + } + $this->message = $message; + + if (isset($this->metadata[EnvelopeInterface::ENVELOPE_STACK_KEY]) && is_array($this->metadata[EnvelopeInterface::ENVELOPE_STACK_KEY])) { + $this->metadata[EnvelopeInterface::ENVELOPE_STACK_KEY] = array_merge( + $envelopes, + array_filter( + $this->metadata[EnvelopeInterface::ENVELOPE_STACK_KEY], + static fn (string $envelope): bool => !in_array($envelope, $envelopes), + ), + ); + } else { + $this->metadata[EnvelopeInterface::ENVELOPE_STACK_KEY] = [static::class]; + } + } + + public function getMessage(): MessageInterface + { + return $this->message; + } + + public function getHandlerName(): string + { + return $this->message->getHandlerName(); + } + + public function getData(): mixed + { + return $this->message->getData(); + } + + public function getMetadata(): array + { + return ArrayHelper::merge( + $this->metadata, + $this->getEnvelopeMetadata(), + ); + } + + public static function fromData(string $handlerName, mixed $data, array $metadata = []): MessageInterface + { + return static::fromMessage(Message::fromData($handlerName, $data, $metadata)); + } + + /** + * Metadata of the envelope + * + * @return array + */ + abstract protected function getEnvelopeMetadata(): array; +} diff --git a/src/Message/EnvelopeInterface.php b/src/Message/EnvelopeInterface.php index 7c58daa1..72d8cced 100644 --- a/src/Message/EnvelopeInterface.php +++ b/src/Message/EnvelopeInterface.php @@ -15,6 +15,4 @@ interface EnvelopeInterface extends MessageInterface public static function fromMessage(MessageInterface $message): self; 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 e8d19d65..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(), - [ - self::ENVELOPE_STACK_KEY => array_merge( - $this->message->getMetadata()[self::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 bbf0d67f..f00daf2d 100644 --- a/src/Message/IdEnvelope.php +++ b/src/Message/IdEnvelope.php @@ -7,16 +7,15 @@ /** * ID envelope allows to identify a message. */ -final class IdEnvelope implements EnvelopeInterface +final class IdEnvelope extends AbstractEnvelope { - use EnvelopeTrait; - public const MESSAGE_ID_KEY = 'yii-message-id'; public function __construct( - private MessageInterface $message, - private string|int|null $id = null, + MessageInterface $message, + private readonly string|int|null $id = null, ) { + parent::__construct($message); } public static function fromMessage(MessageInterface $message): self @@ -24,17 +23,12 @@ public static function fromMessage(MessageInterface $message): self return new self($message, $message->getMetadata()[self::MESSAGE_ID_KEY] ?? null); } - public function setId(string|int|null $id): void - { - $this->id = $id; - } - public function getId(): string|int|null { - return $this->id ?? $this->message->getMetadata()[self::MESSAGE_ID_KEY] ?? null; + return $this->id ?? $this->metadata[self::MESSAGE_ID_KEY] ?? null; } - private function getEnvelopeMetadata(): array + protected function getEnvelopeMetadata(): array { return [self::MESSAGE_ID_KEY => $this->getId()]; } diff --git a/src/Message/Message.php b/src/Message/Message.php index ab85d069..4f153767 100644 --- a/src/Message/Message.php +++ b/src/Message/Message.php @@ -7,9 +7,9 @@ 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 - * @param string|null $id Message id */ public function __construct( private string $handlerName, @@ -37,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 0f6a62e9..97e194d6 100644 --- a/src/Middleware/FailureHandling/FailureEnvelope.php +++ b/src/Middleware/FailureHandling/FailureEnvelope.php @@ -4,20 +4,19 @@ namespace Yiisoft\Queue\Middleware\FailureHandling; -use Yiisoft\Queue\Message\EnvelopeInterface; -use Yiisoft\Queue\Message\EnvelopeTrait; +use Yiisoft\Arrays\ArrayHelper; +use Yiisoft\Queue\Message\AbstractEnvelope; use Yiisoft\Queue\Message\MessageInterface; -final class FailureEnvelope implements EnvelopeInterface +final class FailureEnvelope extends AbstractEnvelope { - use EnvelopeTrait; - public const FAILURE_META_KEY = 'failure-meta'; public function __construct( - private MessageInterface $message, - private array $meta = [], + MessageInterface $message, + private readonly array $failureMeta = [], ) { + parent::__construct($message); } public static function fromMessage(MessageInterface $message): self @@ -25,11 +24,8 @@ public static function fromMessage(MessageInterface $message): self return new self($message, $message->getMetadata()[self::FAILURE_META_KEY] ?? []); } - public function getMetadata(): array + protected function getEnvelopeMetadata(): array { - $meta = $this->message->getMetadata(); - $meta[self::FAILURE_META_KEY] = array_merge($meta[self::FAILURE_META_KEY] ?? [], $this->meta); - - return $meta; + return [self::FAILURE_META_KEY => ArrayHelper::merge($this->metadata[self::FAILURE_META_KEY] ?? [], $this->failureMeta)]; } } diff --git a/tests/Unit/EnvelopeTest.php b/tests/Unit/EnvelopeTest.php index d7e4650e..12b26a14 100644 --- a/tests/Unit/EnvelopeTest.php +++ b/tests/Unit/EnvelopeTest.php @@ -39,11 +39,7 @@ public function testEnvelopeDuplicates(): void $stack = $message->getMetadata()[EnvelopeInterface::ENVELOPE_STACK_KEY]; $this->assertIsArray($stack); - $this->assertEquals([ - IdEnvelope::class, - IdEnvelope::class, - IdEnvelope::class, - ], $stack); + $this->assertEquals([IdEnvelope::class], $stack); $this->assertEquals('test-id-3', $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY]); } diff --git a/tests/Unit/Message/JsonMessageSerializerTest.php b/tests/Unit/Message/JsonMessageSerializerTest.php index 18bc5ed9..b52a2c3b 100644 --- a/tests/Unit/Message/JsonMessageSerializerTest.php +++ b/tests/Unit/Message/JsonMessageSerializerTest.php @@ -79,7 +79,10 @@ public function testUnserializeWithMetadata(): void $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()); + $this->assertEquals( + ['int' => 1, 'str' => 'string', 'bool' => true, EnvelopeInterface::ENVELOPE_STACK_KEY => []], + $message->getMetadata() + ); } public function testUnserializeEnvelopeStack(): void diff --git a/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php b/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php index 665c6bea..5af29c58 100644 --- a/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php +++ b/tests/Unit/Middleware/FailureHandling/Implementation/SendAgainMiddlewareTest.php @@ -31,7 +31,7 @@ class SendAgainMiddlewareTest extends TestCase public static function queueSendingStrategyProvider(): array { return [ - /*[ + [ SendAgainMiddleware::class, true, [], @@ -42,7 +42,7 @@ public static function queueSendingStrategyProvider(): array true, [SendAgainMiddleware::META_KEY_RESEND . '-' => 1], [SendAgainMiddleware::META_KEY_RESEND . '-' => 2], - ],*/ + ], [ SendAgainMiddleware::class, false, @@ -151,9 +151,6 @@ public function testQueueSendingStrategies( $this->expectExceptionMessage('testException'); } - $metaInitial = [FailureEnvelope::FAILURE_META_KEY => $metaInitial]; - $metaResult = [FailureEnvelope::FAILURE_META_KEY => $metaResult]; - $handler = $this->getHandler($metaResult, $suites); $queue = $this->getPreparedQueue($metaResult, $suites); @@ -162,7 +159,7 @@ public function testQueueSendingStrategies( new Message( 'test', null, - $metaInitial + [FailureEnvelope::FAILURE_META_KEY => $metaInitial], ), new Exception('testException'), $queue @@ -194,7 +191,7 @@ private function getHandler(array $metaResult, bool $suites): MessageFailureHand $pipelineAssertion = static function (FailureHandlingRequest $request) use ( $metaResult ): FailureHandlingRequest { - Assert::assertEquals($metaResult, $request->getMessage()->getMetadata()); + Assert::assertEquals($metaResult, $request->getMessage()->getMetadata()[FailureEnvelope::FAILURE_META_KEY] ?? []); throw $request->getException(); }; @@ -209,7 +206,7 @@ private function getHandler(array $metaResult, bool $suites): MessageFailureHand private function getPreparedQueue(array $metaResult, bool $suites): QueueInterface { $queueAssertion = static function (MessageInterface $message) use ($metaResult): MessageInterface { - Assert::assertEquals($metaResult, $message->getMetadata()); + Assert::assertEquals($metaResult, $message->getMetadata()[FailureEnvelope::FAILURE_META_KEY] ?? []); return $message; }; diff --git a/tests/Unit/QueueTest.php b/tests/Unit/QueueTest.php index 7a477e66..d140bcd1 100644 --- a/tests/Unit/QueueTest.php +++ b/tests/Unit/QueueTest.php @@ -130,6 +130,10 @@ public function testAdapterNotConfiguredExceptionForRun(): void public function testRunWithSignalLoop(): void { + if (!extension_loaded('pcntl')) { + self::markTestSkipped('PCNTL support required'); + } + $this->loop = new SignalLoop(); $queue = $this ->getQueue()