Skip to content

fix redis unux socket dsn parse #504

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

Merged
SonyPradana merged 3 commits into from
Apr 26, 2026
Merged

fix redis unux socket dsn parse #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08de6c4
fix redis fail to detect unix socket DSN
SonyPradana Apr 22, 2026
f021e2e
add test and add more cover dsn pasre host
SonyPradana Apr 22, 2026
f49ae7f
formatting
SonyPradana Apr 22, 2026
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
12 changes: 8 additions & 4 deletions src/System/Redis/RedisConnector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function connect(array $config): object
$redis,
'connect',
[$host, 0, $timeout, $persistent_id, $retry_interval],
$persistent
$persistent,
);
} else {
$this->establishConnection(
Expand All @@ -63,7 +63,7 @@ public function connect(array $config): object
$persistent_id,
$retry_interval,
],
$persistent
$persistent,
);
}

Expand Down Expand Up @@ -104,6 +104,10 @@ public function connect(array $config): object
*/
protected function parseDsn(string $dsn): array
{
if (str_starts_with($dsn, 'redis:///')) {
return ['unix_socket' => substr($dsn, 8)];
}

$parsed = parse_url($dsn);

if (false === $parsed || ($parsed['scheme'] ?? '') !== 'redis') {
Expand All @@ -112,13 +116,13 @@ protected function parseDsn(string $dsn): array

$config = [];

if (isset($parsed['path']) && str_starts_with($parsed['path'], '/') && !isset($parsed['host'])) {
if (isset($parsed['path']) && str_starts_with($parsed['path'], '/') && empty($parsed['host'])) {
$config['unix_socket'] = $parsed['path'];

return $config;
}

if (isset($parsed['host'])) {
if (false === empty($parsed['host'])) {
$config['host'] = $parsed['host'];
}

Expand Down
321 changes: 321 additions & 0 deletions tests/Redis/RedisConnectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,321 @@
<?php

declare(strict_types=1);

namespace System\Text\Redis;

use PHPUnit\Framework\TestCase;
use System\Redis\RedisConnector;

class RedisConnectorTest extends TestCase
{
/**
* @test
*
* @dataProvider dsnProvider
*/
public function itCanParseRedisDsn(string $dsn, array $expected)
{
$connector = new RedisConnector();

$parseDsn = function (string $dsn) {
return $this->parseDsn($dsn);
};

$config = $parseDsn->call($connector, $dsn);

$this->assertEquals($expected, $config);
}

public static function dsnProvider(): array
{
return [
'basic' => [
'redis://127.0.0.1:6379',
[
'host' => '127.0.0.1',
'port' => 6379,
],
],
'with password' => [
'redis://:password@127.0.0.1:6379',
[
'host' => '127.0.0.1',
'port' => 6379,
'password' => 'password',
],
],
'with database' => [
'redis://127.0.0.1:6379/2',
[
'host' => '127.0.0.1',
'port' => 6379,
'database' => 2,
],
],
'with password and database' => [
'redis://:secret@localhost:6379/1',
[
'host' => 'localhost',
'port' => 6379,
'password' => 'secret',
'database' => 1,
],
],
'unix socket' => [
'redis:///var/run/redis.sock',
[
'unix_socket' => '/var/run/redis.sock',
],
],
'unix socket single slash' => [
'redis:/var/run/redis.sock',
[
'unix_socket' => '/var/run/redis.sock',
],
],
'host only' => [
'redis://localhost',
[
'host' => 'localhost',
],
],
'with trailing slash' => [
'redis://localhost:6379/',
[
'host' => 'localhost',
'port' => 6379,
],
],
];
}

/**
* @test
*/
public function itThrowsExceptionForInvalidDsnScheme()
{
$connector = new RedisConnector();

$parseDsn = function (string $dsn) {
return $this->parseDsn($dsn);
};

$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid Redis DSN: http://127.0.0.1');

$parseDsn->call($connector, 'http://127.0.0.1');
}

/**
* @test
*/
public function itThrowsExceptionForMalformedDsn()
{
$connector = new RedisConnector();

$parseDsn = function (string $dsn) {
return $this->parseDsn($dsn);
};

$this->expectException(\InvalidArgumentException::class);

$parseDsn->call($connector, 'redis://:6379:invalid');
}

/**
* @test
*/
public function itCanConnectWithDsnConfig()
{
$connector = new class extends RedisConnector {
public $establishConnectionCalled = false;
public $parameters = [];
public $method = '';

protected function establishConnection($redis, string $method, array $parameters, bool $persistent): void
{
$this->establishConnectionCalled = true;
$this->method = $method;
$this->parameters = $parameters;
}
};

$config = [
'dsn' => 'redis://:secret@localhost:6379/2',
'timeout' => 2.5,
];

// We use a real \Redis object but we don't connect it.
// Some methods might throw if not connected, but select/auth usually just return false or throw \RedisException
// if the extension is strictly checking connection state.
try {
$redis = $connector->connect($config);
$this->assertInstanceOf(\Redis::class, $redis);
} catch (\RedisException $e) {
// If it throws RedisException because of select/auth on non-connected redis,
// we at least verified it reached that point.
$this->assertStringContainsString('Could not connect to Redis', $e->getMessage());
}

$this->assertTrue($connector->establishConnectionCalled);
$this->assertEquals('localhost', $connector->parameters[0]);
$this->assertEquals(6379, $connector->parameters[1]);
$this->assertEquals(2.5, $connector->parameters[2]);
}

/**
* @test
*/
public function itCanConnectWithArrayConfig()
{
$connector = new class extends RedisConnector {
public $establishConnectionCalled = false;
public $parameters = [];

protected function establishConnection($redis, string $method, array $parameters, bool $persistent): void
{
$this->establishConnectionCalled = true;
$this->parameters = $parameters;
}
};

$config = [
'host' => '127.0.0.1',
'port' => 6380,
'timeout' => 1.0,
];

try {
$redis = $connector->connect($config);
$this->assertInstanceOf(\Redis::class, $redis);
} catch (\RedisException $e) {
$this->assertStringContainsString('Could not connect to Redis', $e->getMessage());
}

$this->assertTrue($connector->establishConnectionCalled);
$this->assertEquals('127.0.0.1', $connector->parameters[0]);
$this->assertEquals(6380, $connector->parameters[1]);
}

/**
* @test
*/
public function itCanConnectViaUnixSocket()
{
$connector = new class extends RedisConnector {
public $establishConnectionCalled = false;
public $parameters = [];

protected function establishConnection($redis, string $method, array $parameters, bool $persistent): void
{
$this->establishConnectionCalled = true;
$this->parameters = $parameters;
}
};

$config = [
'unix_socket' => '/tmp/redis.sock',
];

try {
$redis = $connector->connect($config);
$this->assertInstanceOf(\Redis::class, $redis);
} catch (\RedisException $e) {
$this->assertStringContainsString('Could not connect to Redis', $e->getMessage());
}

$this->assertTrue($connector->establishConnectionCalled);
$this->assertEquals('/tmp/redis.sock', $connector->parameters[0]);
$this->assertEquals(0, $connector->parameters[1]);
}

/**
* @test
*/
public function itCanHandlePersistentConnection()
{
$connector = new class extends RedisConnector {
public $method = '';
public $persistent = false;
public $parameters = [];

protected function establishConnection($redis, string $method, array $parameters, bool $persistent): void
{
$this->method = $method;
$this->persistent = $persistent;
$this->parameters = $parameters;
}
};

$config = [
'host' => '127.0.0.1',
'persistent' => true,
'persistent_id' => 'my-id',
];

$connector->connect($config);

$this->assertTrue($connector->persistent);
$this->assertEquals('my-id', $connector->parameters[3]);
}

/**
* @test
*/
public function itCanSetReadTimeout()
{
// This test is a bit tricky as it calls setOption on real Redis object.
// But we can check if it runs without crashing.
$connector = new class extends RedisConnector {
protected function establishConnection($redis, string $method, array $parameters, bool $persistent): void
{
// Don't connect
}
};

$config = [
'host' => '127.0.0.1',
'read_timeout' => 5.0,
];

try {
$redis = $connector->connect($config);
$this->assertInstanceOf(\Redis::class, $redis);
} catch (\RedisException $e) {
$this->assertStringContainsString('Could not connect to Redis', $e->getMessage());
}
}

/**
* @test
*/
public function itCallsEstablishConnectionWithCorrectMethod()
{
$connector = new RedisConnector();

$establishConnection = function ($redis, $method, $parameters, $persistent) {
$this->establishConnection($redis, $method, $parameters, $persistent);
};

$redis = $this->getMockBuilder('Redis')
->onlyMethods(['connect', 'pconnect'])
->getMock();

$redis->expects($this->once())
->method('connect')
->with('127.0.0.1', 6379);

$establishConnection->call($connector, $redis, 'any', ['127.0.0.1', 6379], false);

$redis2 = $this->getMockBuilder('Redis')
->onlyMethods(['connect', 'pconnect'])
->getMock();

$redis2->expects($this->once())
->method('pconnect')
->with('127.0.0.1', 6379);

$establishConnection->call($connector, $redis2, 'any', ['127.0.0.1', 6379], true);
}
}
Loading