Skip to content

feat: added persistent config item to redis handler Session #9793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 4.7
Choose a base branch
from
Open

feat: added persistent config item to redis handler Session #9793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8923b15
feat: added persistent config item to redis handler Session
ddevsr Nov 10, 2025
02c8284
tests: persistent connection session redis
ddevsr Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions system/Session/Handlers/RedisHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,17 +142,19 @@ protected function setSavePath(): void
}
}

$password = $query['auth'] ?? null;
$database = isset($query['database']) ? (int) $query['database'] : 0;
$timeout = isset($query['timeout']) ? (float) $query['timeout'] : 0.0;
$prefix = $query['prefix'] ?? null;
$persistent = isset($query['persistent']) ? (bool) $query['persistent'] : null;
Copy link
Member

@michalsn michalsn Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do something like filter_var($query['persistent'], FILTER_VALIDATE_BOOLEAN) instead of just casting to bool? Although if we document this property, we can leave it as it is.

$password = $query['auth'] ?? null;
$database = isset($query['database']) ? (int) $query['database'] : 0;
$timeout = isset($query['timeout']) ? (float) $query['timeout'] : 0.0;
$prefix = $query['prefix'] ?? null;

$this->savePath = [
'host' => $host,
'port' => $port,
'password' => $password,
'database' => $database,
'timeout' => $timeout,
'host' => $host,
'port' => $port,
'password' => $password,
'database' => $database,
'timeout' => $timeout,
'persistent' => $persistent,
];

if ($prefix !== null) {
Expand All @@ -176,8 +178,10 @@ public function open($path, $name): bool

$redis = new Redis();

$funcConnection = isset($this->savePath['persistent']) && $this->savePath['persistent'] ? 'pconnect' : 'connect';

if (
! $redis->connect(
! $redis->{$funcConnection}(
$this->savePath['host'],
$this->savePath['port'],
$this->savePath['timeout'],
Expand Down
110 changes: 70 additions & 40 deletions tests/system/Session/Handlers/Database/RedisHandlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,81 +154,111 @@ public static function provideSetSavePath(): iterable
'w/o protocol' => [
'127.0.0.1:6379',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'tls auth' => [
'tls://127.0.0.1:6379?auth=password',
[
'host' => 'tls://127.0.0.1',
'port' => 6379,
'password' => 'password',
'database' => 0,
'timeout' => 0.0,
'host' => 'tls://127.0.0.1',
'port' => 6379,
'password' => 'password',
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'tcp auth' => [
'tcp://127.0.0.1:6379?auth=password',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => 'password',
'database' => 0,
'timeout' => 0.0,
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => 'password',
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'timeout float' => [
'tcp://127.0.0.1:6379?timeout=2.5',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 2.5,
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 2.5,
'persistent' => null,
],
],
'timeout int' => [
'tcp://127.0.0.1:6379?timeout=10',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 10.0,
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 10.0,
'persistent' => null,
],
],
'auth acl' => [
'tcp://localhost:6379?auth[user]=redis-admin&auth[pass]=admin-password',
[
'host' => 'tcp://localhost',
'port' => 6379,
'password' => ['user' => 'redis-admin', 'pass' => 'admin-password'],
'database' => 0,
'timeout' => 0.0,
'host' => 'tcp://localhost',
'port' => 6379,
'password' => ['user' => 'redis-admin', 'pass' => 'admin-password'],
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'unix domain socket' => [
'unix:///tmp/redis.sock',
[
'host' => '/tmp/redis.sock',
'port' => 0,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'host' => '/tmp/redis.sock',
'port' => 0,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'unix domain socket w/o protocol' => [
'/tmp/redis.sock',
[
'host' => '/tmp/redis.sock',
'port' => 0,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'host' => '/tmp/redis.sock',
'port' => 0,
'password' => null,
'database' => 0,
'timeout' => 0.0,
'persistent' => null,
],
],
'persistent connection' => [
'tcp://127.0.0.1:6379?timeout=10&persistent=1',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 10.0,
'persistent' => true,
],
],
'no persistent connection with have parameter' => [
'tcp://127.0.0.1:6379?timeout=10&persistent=0',
[
'host' => 'tcp://127.0.0.1',
'port' => 6379,
'password' => null,
'database' => 0,
'timeout' => 10.0,
'persistent' => false,
],
],
];
Expand Down
1 change: 1 addition & 0 deletions user_guide_src/source/changelogs/v4.7.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Libraries
- **Image:** The ``ImageMagickHandler`` has been rewritten to rely solely on the PHP ``imagick`` extension.
- **Image:** Added ``ImageMagickHandler::clearMetadata()`` method to remove image metadata for privacy protection.
- **ResponseTrait:** Added ``paginate``` method to simplify paginated API responses. See :ref:`ResponseTrait::paginate() <api_response_trait_paginate>` for details.
- **Session:** Added ``persistent`` config item to redis handler.
- **Time:** added methods ``Time::addCalendarMonths()`` and ``Time::subCalendarMonths()``

Commands
Expand Down
Loading