Skip to content

Commit 4172d22

Browse files
vladvildanovvladvildanov
authored
Client set name and version on connection (#1347)
* Added client metadata on server connection * Added try...catch around server exception to supress CLIENT command errors * Added exclusion for Relay connection
1 parent a3311d6 commit 4172d22

File tree

6 files changed

+110
-10
lines changed

6 files changed

+110
-10
lines changed

‎src/Connection/AbstractConnection.php

+13
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
use InvalidArgumentException;
1616
use Predis\Command\CommandInterface;
17+
use Predis\Command\RawCommand;
1718
use Predis\CommunicationException;
1819
use Predis\Protocol\ProtocolException;
1920

@@ -27,6 +28,10 @@ abstract class AbstractConnection implements NodeConnectionInterface
2728
private $cachedId;
2829

2930
protected $parameters;
31+
32+
/**
33+
* @var RawCommand[]
34+
*/
3035
protected $initCommands = [];
3136

3237
/**
@@ -101,6 +106,14 @@ public function addConnectCommand(CommandInterface $command)
101106
$this->initCommands[] = $command;
102107
}
103108

109+
/**
110+
* {@inheritdoc}
111+
*/
112+
public function getInitCommands(): array
113+
{
114+
return $this->initCommands;
115+
}
116+
104117
/**
105118
* {@inheritdoc}
106119
*/

‎src/Connection/Factory.php

+11
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
namespace Predis\Connection;
1414

1515
use InvalidArgumentException;
16+
use Predis\Client;
1617
use Predis\Command\RawCommand;
1718
use ReflectionClass;
1819
use UnexpectedValueException;
@@ -174,6 +175,16 @@ protected function prepareConnection(NodeConnectionInterface $connection)
174175
);
175176
}
176177

178+
if (!$connection instanceof RelayConnection) {
179+
$connection->addConnectCommand(
180+
new RawCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])
181+
);
182+
183+
$connection->addConnectCommand(
184+
new RawCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])
185+
);
186+
}
187+
177188
if (isset($parameters->database) && strlen($parameters->database)) {
178189
$connection->addConnectCommand(
179190
new RawCommand('SELECT', [$parameters->database])

‎src/Connection/StreamConnection.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,9 @@ public function connect()
231231
foreach ($this->initCommands as $command) {
232232
$response = $this->executeCommand($command);
233233

234-
if ($response instanceof ErrorResponseInterface) {
234+
if ($response instanceof ErrorResponseInterface && $command->getId() === 'CLIENT') {
235+
// Do nothing on CLIENT SETINFO command failure
236+
} elseif ($response instanceof ErrorResponseInterface) {
235237
$this->onConnectionError("`{$command->getId()}` failed: {$response->getMessage()}", 0);
236238
}
237239
}

‎tests/Predis/ClientTest.php

+14
Original file line numberDiff line numberDiff line change
@@ -1253,6 +1253,20 @@ public function testGetIteratorWithNonTraversableConnectionNoException(): void
12531253
$this->assertSame('127.0.0.1:6381', $iterator->key());
12541254
}
12551255

1256+
/**
1257+
* @group connected
1258+
* @requiresRedisVersion >= 7.2.0
1259+
*/
1260+
public function testSetClientInfoOnConnection(): void
1261+
{
1262+
$client = new Client($this->getParameters());
1263+
$libName = $client->client('LIST')[0]['lib-name'];
1264+
$libVer = $client->client('LIST')[0]['lib-ver'];
1265+
1266+
$this->assertSame('predis', $libName);
1267+
$this->assertSame(Client::VERSION, $libVer);
1268+
}
1269+
12561270
// ******************************************************************** //
12571271
// ---- HELPER METHODS ------------------------------------------------ //
12581272
// ******************************************************************** //

‎tests/Predis/Connection/FactoryTest.php

+50-9
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
namespace Predis\Connection;
1414

15+
use Predis\Client;
16+
use Predis\Command\RawCommand;
1517
use PredisTestCase;
1618
use ReflectionObject;
1719
use stdClass;
@@ -302,10 +304,12 @@ public function testCreateConnectionWithInitializationCommands(): void
302304
->method('getParameters')
303305
->willReturn($parameters);
304306
$connection
305-
->expects($this->exactly(2))
307+
->expects($this->exactly(4))
306308
->method('addConnectCommand')
307309
->withConsecutive(
308310
[$this->isRedisCommand('AUTH', ['foobar'])],
311+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])],
312+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])],
309313
[$this->isRedisCommand('SELECT', ['0'])]
310314
);
311315

@@ -331,9 +335,13 @@ public function testCreateConnectionWithPasswordAndNoUsernameAddsInitializationC
331335
$connection->expects($this->once())
332336
->method('getParameters')
333337
->will($this->returnValue($parameters));
334-
$connection->expects($this->once())
338+
$connection->expects($this->exactly(3))
335339
->method('addConnectCommand')
336-
->with($this->isRedisCommand('AUTH', ['foobar']));
340+
->withConsecutive(
341+
[$this->isRedisCommand('AUTH', ['foobar'])],
342+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])],
343+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])]
344+
);
337345

338346
$factory = new Factory();
339347

@@ -358,9 +366,13 @@ public function testCreateConnectionWithPasswordAndUsernameAddsInitializationCom
358366
$connection->expects($this->once())
359367
->method('getParameters')
360368
->will($this->returnValue($parameters));
361-
$connection->expects($this->once())
369+
$connection->expects($this->exactly(3))
362370
->method('addConnectCommand')
363-
->with($this->isRedisCommand('AUTH', ['myusername', 'foobar']));
371+
->withConsecutive(
372+
[$this->isRedisCommand('AUTH', ['myusername', 'foobar'])],
373+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])],
374+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])]
375+
);
364376

365377
$factory = new Factory();
366378

@@ -384,8 +396,12 @@ public function testCreateConnectionWithUsernameAndNoPasswordDoesNotAddInitializ
384396
$connection->expects($this->once())
385397
->method('getParameters')
386398
->will($this->returnValue($parameters));
387-
$connection->expects($this->never())
388-
->method('addConnectCommand');
399+
$connection->expects($this->exactly(2))
400+
->method('addConnectCommand')
401+
->withConsecutive(
402+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])],
403+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])]
404+
);
389405

390406
$factory = new Factory();
391407

@@ -410,8 +426,12 @@ public function testCreateConnectionWithEmptyParametersDoesNotAddInitializationC
410426
$connection->expects($this->once())
411427
->method('getParameters')
412428
->will($this->returnValue($parameters));
413-
$connection->expects($this->never())
414-
->method('addConnectCommand');
429+
$connection->expects($this->exactly(2))
430+
->method('addConnectCommand')
431+
->withConsecutive(
432+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])],
433+
[$this->isRedisCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])]
434+
);
415435

416436
$factory = new Factory();
417437

@@ -538,6 +558,27 @@ public function testDefineAndUndefineConnection(): void
538558
$factory->create('test://127.0.0.1');
539559
}
540560

561+
/**
562+
* @group disconnected
563+
* @return void
564+
*/
565+
public function testSetClientNameAndVersionOnConnection(): void
566+
{
567+
$parameters = [];
568+
569+
$factory = new Factory();
570+
$connection = $factory->create($parameters);
571+
$initCommands = $connection->getInitCommands();
572+
573+
$this->assertInstanceOf(RawCommand::class, $initCommands[0]);
574+
$this->assertSame('CLIENT', $initCommands[0]->getId());
575+
$this->assertSame(['SETINFO', 'LIB-NAME', 'predis'], $initCommands[0]->getArguments());
576+
577+
$this->assertInstanceOf(RawCommand::class, $initCommands[1]);
578+
$this->assertSame('CLIENT', $initCommands[1]->getId());
579+
$this->assertSame(['SETINFO', 'LIB-VER', Client::VERSION], $initCommands[1]->getArguments());
580+
}
581+
541582
// ******************************************************************** //
542583
// ---- HELPER METHODS ------------------------------------------------ //
543584
// ******************************************************************** //

‎tests/Predis/Connection/StreamConnectionTest.php

+19
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
namespace Predis\Connection;
1414

1515
use PHPUnit\Framework\MockObject\MockObject;
16+
use Predis\Client;
1617
use Predis\Command\RawCommand;
1718
use Predis\Response\Error as ErrorResponse;
1819

@@ -195,4 +196,22 @@ public function testTcpDelayContextFlagIsNotSetByDefault()
195196
$this->assertArrayHasKey('tcp_nodelay', $options['socket']);
196197
$this->assertFalse($options['socket']['tcp_nodelay']);
197198
}
199+
200+
/**
201+
* @group connected
202+
* @requiresRedisVersion < 7.0.0
203+
*/
204+
public function testConnectDoNotThrowsExceptionOnClientCommandError(): void
205+
{
206+
$connection = $this->createConnectionWithParams([]);
207+
$connection->addConnectCommand(
208+
new RawCommand('CLIENT', ['SETINFO', 'LIB-NAME', 'predis'])
209+
);
210+
$connection->addConnectCommand(
211+
new RawCommand('CLIENT', ['SETINFO', 'LIB-VER', Client::VERSION])
212+
);
213+
214+
$connection->connect();
215+
$this->assertTrue(true);
216+
}
198217
}

0 commit comments

Comments
 (0)