predis/tests/Predis/Command/Redis/XACKDEL_Test.php

<?php

/*
 * This file is part of the Predis package.
 *
 * (c) 2009-2020 Daniele Alessandri
 * (c) 2021-2025 Till Krüss
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Predis\Command\Redis;

use Predis\Command\PrefixableCommand;

/**
 * @group commands
 * @group realm-stream
 */
class XACKDEL_Test extends PredisCommandTestCase
{
    /**
     * {@inheritdoc}
     */
    protected function getExpectedCommand(): string
    {
        return 'Predis\Command\Redis\XACKDEL';
    }

    /**
     * {@inheritdoc}
     */
    protected function getExpectedId(): string
    {
        return 'XACKDEL';
    }

    /**
     * @group disconnected
     */
    public function testFilterArgumentsWithKEEPREF(): void
    {
        $arguments = ['stream', 'group1', 'KEEPREF', ['id1', 'id2']];
        $expected = ['stream', 'group1', 'KEEPREF', 'IDS', '2', 'id1', 'id2'];

        $command = $this->getCommand();
        $command->setArguments($arguments);

        $this->assertSame($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testFilterArgumentsWithDELREF(): void
    {
        $arguments = ['stream', 'group1', 'DELREF', ['id1', 'id2', 'id3']];
        $expected = ['stream', 'group1', 'DELREF', 'IDS', '3', 'id1', 'id2', 'id3'];

        $command = $this->getCommand();
        $command->setArguments($arguments);

        $this->assertSame($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testFilterArgumentsWithACKED(): void
    {
        $arguments = ['stream', 'group1', 'ACKED', ['id1']];
        $expected = ['stream', 'group1', 'ACKED', 'IDS', '1', 'id1'];

        $command = $this->getCommand();
        $command->setArguments($arguments);

        $this->assertSame($expected, $command->getArguments());
    }

    /**
     * @group disconnected
     */
    public function testParseResponse(): void
    {
        $this->assertSame([1, 2, -1], $this->getCommand()->parseResponse([1, 2, -1]));
    }

    /**
     * @group disconnected
     */
    public function testPrefixKeys(): void
    {
        /** @var PrefixableCommand $command */
        $command = $this->getCommand();
        $actualArguments = ['stream', 'group1', 'DELREF', ['id1', 'id2']];
        $prefix = 'prefix:';
        $expectedArguments = ['prefix:stream', 'group1', 'DELREF', 'IDS', '2', 'id1', 'id2'];

        $command->setArguments($actualArguments);
        $command->prefixKeys($prefix);

        $this->assertSame($expectedArguments, $command->getArguments());
    }

    /**
     * @group connected
     * @requiresRedisVersion >= 8.2.0
     */
    public function testAcknowledgesAndDeletesSpecifiedMembers(): void
    {
        $redis = $this->getClient();

        $redis->xadd('teststream', ['key0' => 'val0'], '0-1');
        $redis->xadd('teststream', ['key1' => 'val1'], '1-1');
        $redis->xadd('teststream', ['key2' => 'val2'], '2-1');

        $redis->xgroup->create('teststream', 'testgroup', '0');

        $redis->xreadgroup('testgroup', 'consumer1', 2, null, false, 'teststream', '>');

        $result = $redis->xackdel('teststream', 'testgroup', 'KEEPREF', ['0-1', '1-1']);

        $this->assertIsArray($result);
        $this->assertCount(2, $result);

        $redis->xadd('teststream', ['key3' => 'val3'], '3-1');
        $redis->xreadgroup('testgroup', 'consumer1', 1, null, false, 'teststream', '>');
        $result2 = $redis->xackdel('teststream', 'testgroup', 'KEEPREF', ['3-1']);

        $this->assertIsArray($result2);
        $this->assertCount(1, $result2);
    }
}