MetadataBench.php

<?php

declare(strict_types=1);

namespace Yiisoft\Queue\Tests\Benchmark;

use Generator;
use PhpBench\Attributes\ParamProviders;
use Yiisoft\Queue\Message\IdEnvelope;
use Yiisoft\Queue\Message\Message;
use Yiisoft\Queue\Message\MessageInterface;
use Yiisoft\Queue\Middleware\FailureHandling\FailureEnvelope;

final class MetadataBench
{
    /**
     * Create metadata as an array and read its value from an array.
     */
    public function benchArrayRead(): void
    {
        $message = new Message('foo', 'bar', ['id' => 1]);
        $id = $message->getMetadata()['id'];
    }

    /**
     * Create metadata as an object and read its value immediately.
     */
    public function benchEnvelopeRead(): void
    {
        $message = new IdEnvelope(new Message('foo', 'bar'), 1);
        $id = $message->getId();
    }

    public function provideEnvelopeStackCounts(): Generator
    {
        yield 'one' => [1];
        yield 'three' => [3];
        yield 'fifteen' => [15];
    }

    /**
     * Create envelope stack with the given depth
     *
     * @psalm-param array{0: int} $params
     */
    #[ParamProviders('provideEnvelopeStackCounts')]
    public function benchEnvelopeStackCreation(array $params): void
    {
        $message = new Message('foo', 'bar');
        for ($i = 0; $i < $params[0]; $i++) {
            $message = new FailureEnvelope($message, ["fail$i" => "fail$i"]);
        }
    }

    /**
     * Create a metadata array with the given elements count
     *
     * @psalm-param array{0: int} $params
     */
    #[ParamProviders('provideEnvelopeStackCounts')]
    public function benchMetadataArrayCreation(array $params): void
    {
        $metadata = ['failure-meta' => []];
        for ($i = 0; $i < $params[0]; $i++) {
            $metadata['failure-meta']["fail$i"] = "fail$i";
        }
        $message = new Message('foo', 'bar', $metadata);
    }
}