[v2.x] Relay support (#1263)

2026-10-09 05:16:32 +00:00 · 2023-05-09 10:39:00 -07:00
parent 538c65946d
commit 946c4b7bd7
130 changed files with 2037 additions and 205 deletions
@@ -0,0 +1,234 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Connection;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use Predis\Command\RawCommand;
+use Predis\Response\Error as ErrorResponse;
+
+/**
+ * @group ext-relay
+ * @requires extension relay
+ */
+class RelayConnectionTest extends PredisConnectionTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function getConnectionClass(): string
+    {
+        return RelayConnection::class;
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testThrowsExceptionOnInitializationCommandFailure(): void
+    {
+        $this->expectException('Predis\Connection\ConnectionException');
+        $this->expectExceptionMessage('`SELECT` failed: ERR invalid DB index [tcp://127.0.0.1:6379]');
+
+        $cmdSelect = RawCommand::create('SELECT', '1000');
+
+        /** @var NodeConnectionInterface|MockObject */
+        $connection = $this
+            ->getMockBuilder($this->getConnectionClass())
+            ->onlyMethods(['executeCommand', 'createResource'])
+            ->setConstructorArgs([new Parameters()])
+            ->getMock();
+        $connection
+            ->method('executeCommand')
+            ->with($cmdSelect)
+            ->willReturn(
+                new ErrorResponse('ERR invalid DB index')
+            );
+
+        $connection->method('createResource');
+
+        $connection->addConnectCommand($cmdSelect);
+        $connection->connect();
+    }
+
+    // ******************************************************************** //
+    // ---- INTEGRATION TESTS --------------------------------------------- //
+    // ******************************************************************** //
+
+    /**
+     * @group connected
+     */
+    public function testGetResourceForcesConnection(): void
+    {
+        $connection = $this->createConnection();
+
+        $this->assertFalse($connection->isConnected());
+        $connection->getResource();
+        $this->assertTrue($connection->isConnected());
+    }
+
+    /**
+     * @group connected
+     * @group slow
+     * @requires PHP 5.4
+     */
+    public function testThrowsExceptionOnReadWriteTimeout(): void
+    {
+        $this->expectException('Predis\Connection\ConnectionException');
+
+        $connection = $this->createConnectionWithParams([
+            'read_write_timeout' => 0.5,
+        ], true);
+
+        $connection->executeCommand(
+            $this->getCommandFactory()->create('brpop', ['foo', 3])
+        );
+    }
+
+    /**
+     * @medium
+     * @group connected
+     * @group relay-incompatible
+     */
+    public function testThrowsExceptionOnProtocolDesynchronizationErrors(): void
+    {
+        $this->expectException('Predis\Protocol\ProtocolException');
+
+        $connection = $this->createConnection();
+        $stream = $connection->getResource();
+
+        $connection->writeRequest($this->getCommandFactory()->create('ping'));
+        stream_socket_recvfrom($stream, 1);
+
+        $connection->read();
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     * @requires PHP 5.4
+     */
+    public function testPersistentParameterWithFalseLikeValues(): void
+    {
+        $connection1 = $this->createConnectionWithParams(['persistent' => 0]);
+        $this->assertNonPersistentConnection($connection1);
+
+        $connection2 = $this->createConnectionWithParams(['persistent' => false]);
+        $this->assertNonPersistentConnection($connection2);
+
+        $connection3 = $this->createConnectionWithParams(['persistent' => '0']);
+        $this->assertNonPersistentConnection($connection3);
+
+        $connection4 = $this->createConnectionWithParams(['persistent' => 'false']);
+        $this->assertNonPersistentConnection($connection4);
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     * @requires PHP 5.4
+     */
+    public function testPersistentParameterWithTrueLikeValues(): void
+    {
+        $connection1 = $this->createConnectionWithParams(['persistent' => 1]);
+        $this->assertPersistentConnection($connection1);
+
+        $connection2 = $this->createConnectionWithParams(['persistent' => true]);
+        $this->assertPersistentConnection($connection2);
+
+        $connection3 = $this->createConnectionWithParams(['persistent' => '1']);
+        $this->assertPersistentConnection($connection3);
+
+        $connection4 = $this->createConnectionWithParams(['persistent' => 'true']);
+        $this->assertPersistentConnection($connection4);
+
+        $connection1->disconnect();
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     * @requires PHP 5.4
+     */
+    public function testPersistentConnectionsToSameNodeShareResource(): void
+    {
+        $connection1 = $this->createConnectionWithParams(['persistent' => true]);
+        $connection2 = $this->createConnectionWithParams(['persistent' => true]);
+
+        $this->assertPersistentConnection($connection1);
+        $this->assertPersistentConnection($connection2);
+
+        $this->assertSame($connection1->getResource(), $connection2->getResource());
+
+        $connection1->disconnect();
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     * @requires PHP 5.4
+     */
+    public function testPersistentConnectionsToSameNodeDoNotShareResourceUsingDifferentPersistentID(): void
+    {
+        $connection1 = $this->createConnectionWithParams(['persistent' => 'conn1']);
+        $connection2 = $this->createConnectionWithParams(['persistent' => 'conn2']);
+
+        $this->assertPersistentConnection($connection1);
+        $this->assertPersistentConnection($connection2);
+
+        $this->assertNotSame($connection1->getResource(), $connection2->getResource());
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     */
+    public function testTcpNodelayParameterSetsContextFlagWhenTrue()
+    {
+        $connection = $this->createConnectionWithParams(['tcp_nodelay' => true]);
+        $options = stream_context_get_options($connection->getResource());
+
+        $this->assertIsArray($options);
+        $this->assertArrayHasKey('socket', $options);
+        $this->assertArrayHasKey('tcp_nodelay', $options['socket']);
+        $this->assertTrue($options['socket']['tcp_nodelay']);
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     */
+    public function testTcpNodelayParameterDoesNotSetContextFlagWhenFalse()
+    {
+        $connection = $this->createConnectionWithParams(['tcp_nodelay' => false]);
+        $options = stream_context_get_options($connection->getResource());
+
+        $this->assertIsArray($options);
+        $this->assertArrayHasKey('socket', $options);
+        $this->assertArrayHasKey('tcp_nodelay', $options['socket']);
+        $this->assertFalse($options['socket']['tcp_nodelay']);
+    }
+
+    /**
+     * @group connected
+     * @group relay-incompatible
+     */
+    public function testTcpDelayContextFlagIsNotSetByDefault()
+    {
+        $connection = $this->createConnectionWithParams([]);
+        $options = stream_context_get_options($connection->getResource());
+
+        $this->assertIsArray($options);
+        $this->assertArrayHasKey('socket', $options);
+        $this->assertArrayHasKey('tcp_nodelay', $options['socket']);
+        $this->assertFalse($options['socket']['tcp_nodelay']);
+    }
+}