RedisHandlerTest.php

<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Session\Handlers\Database;

use CodeIgniter\Session\Handlers\RedisHandler;
use CodeIgniter\Test\CIUnitTestCase;
use Config\Session as SessionConfig;

/**
 * @group DatabaseLive
 *
 * @requires extension redis
 *
 * @internal
 */
final class RedisHandlerTest extends CIUnitTestCase
{
    private string $sessionDriver   = RedisHandler::class;
    private string $sessionName     = 'ci_session';
    private string $sessionSavePath = 'tcp://127.0.0.1:6379';
    private string $userIpAddress   = '127.0.0.1';

    protected function getInstance($options = [])
    {
        $defaults = [
            'driver'            => $this->sessionDriver,
            'cookieName'        => $this->sessionName,
            'expiration'        => 7200,
            'savePath'          => $this->sessionSavePath,
            'matchIP'           => false,
            'timeToUpdate'      => 300,
            'regenerateDestroy' => false,
        ];
        $sessionConfig = new SessionConfig();
        $config        = array_merge($defaults, $options);

        foreach ($config as $key => $value) {
            $sessionConfig->{$key} = $value;
        }

        return new RedisHandler($sessionConfig, $this->userIpAddress);
    }

    public function testSavePathWithoutProtocol(): void
    {
        $handler = $this->getInstance(
            ['savePath' => '127.0.0.1:6379']
        );

        $savePath = $this->getPrivateProperty($handler, 'savePath');

        $this->assertSame('tcp', $savePath['protocol']);
    }

    public function testSavePathTLSAuth(): void
    {
        $handler = $this->getInstance(
            ['savePath' => 'tls://127.0.0.1:6379?auth=password']
        );

        $savePath = $this->getPrivateProperty($handler, 'savePath');

        $this->assertSame('tls', $savePath['protocol']);
        $this->assertSame('password', $savePath['password']);
    }

    public function testSavePathTCPAuth(): void
    {
        $handler = $this->getInstance(
            ['savePath' => 'tcp://127.0.0.1:6379?auth=password']
        );

        $savePath = $this->getPrivateProperty($handler, 'savePath');

        $this->assertSame('tcp', $savePath['protocol']);
        $this->assertSame('password', $savePath['password']);
    }

    public function testSavePathTimeoutFloat(): void
    {
        $handler = $this->getInstance(
            ['savePath' => 'tcp://127.0.0.1:6379?timeout=2.5']
        );

        $savePath = $this->getPrivateProperty($handler, 'savePath');

        $this->assertEqualsWithDelta(2.5, $savePath['timeout'], PHP_FLOAT_EPSILON);
    }

    public function testSavePathTimeoutInt(): void
    {
        $handler = $this->getInstance(
            ['savePath' => 'tcp://127.0.0.1:6379?timeout=10']
        );

        $savePath = $this->getPrivateProperty($handler, 'savePath');

        $this->assertEqualsWithDelta(10.0, $savePath['timeout'], PHP_FLOAT_EPSILON);
    }

    public function testOpen(): void
    {
        $handler = $this->getInstance();
        $this->assertTrue($handler->open($this->sessionSavePath, $this->sessionName));
    }

    public function testOpenWithDefaultProtocol(): void
    {
        $default = $this->sessionSavePath;

        $this->sessionSavePath = '127.0.0.1:6379';

        $handler = $this->getInstance();
        $this->assertTrue($handler->open($this->sessionSavePath, $this->sessionName));

        // Rollback to default
        $this->sessionSavePath = $default;
    }

    public function testWrite(): void
    {
        $handler = $this->getInstance();
        $handler->open($this->sessionSavePath, $this->sessionName);
        $handler->read('555556b43phsnnf8if6bo33b635e4447');

        $data = <<<'DATA'
            __ci_last_regenerate|i:1664607454;_ci_previous_url|s:32:"http://localhost:8080/index.php/";key|s:5:"value";
            DATA;
        $this->assertTrue($handler->write('555556b43phsnnf8if6bo33b635e4447', $data));

        $handler->close();
    }

    public function testReadSuccess(): void
    {
        $handler = $this->getInstance();
        $handler->open($this->sessionSavePath, $this->sessionName);

        $expected = <<<'DATA'
            __ci_last_regenerate|i:1664607454;_ci_previous_url|s:32:"http://localhost:8080/index.php/";key|s:5:"value";
            DATA;
        $this->assertSame($expected, $handler->read('555556b43phsnnf8if6bo33b635e4447'));

        $handler->close();
    }

    public function testReadFailure(): void
    {
        $handler = $this->getInstance();
        $handler->open($this->sessionSavePath, $this->sessionName);

        $this->assertSame('', $handler->read('123456b43phsnnf8if6bo33b635e4321'));

        $handler->close();
    }

    public function testGC(): void
    {
        $handler = $this->getInstance();
        $this->assertSame(1, $handler->gc(3600));
    }

    /**
     * See https://github.com/codeigniter4/CodeIgniter4/issues/7695
     */
    public function testSecondaryReadAfterClose(): void
    {
        $handler = $this->getInstance();
        $handler->open($this->sessionSavePath, $this->sessionName);

        $expected = <<<'DATA'
            __ci_last_regenerate|i:1664607454;_ci_previous_url|s:32:"http://localhost:8080/index.php/";key|s:5:"value";
            DATA;
        $this->assertSame($expected, $handler->read('555556b43phsnnf8if6bo33b635e4447'));

        $handler->close();

        $handler->open($this->sessionSavePath, $this->sessionName);

        $this->assertSame($expected, $handler->read('555556b43phsnnf8if6bo33b635e4447'));

        $handler->close();
    }
}