tag v1.1.7

For some reason Xdebug causes a seg fault under PHP 8 on Travis CI.

.travis.yml

@@ -9,6 +9,7 @@ branches:
 before_install:
   - docker run -d --rm -p 127.0.0.1:6379:6379 redis:3
 before_script:
+  - phpenv config-rm xdebug.ini
   - composer self-update
   - composer install --no-interaction --prefer-source --dev
 script:
@@ -30,6 +31,7 @@ matrix:
     - php: 7.2
     - php: 7.3
     - php: 7.4
-    - php: nightly # PHP 8.0.0-dev
+    - php: 8.0
+    - php: nightly
   allow_failures:
     - php: nightly

CHANGELOG.md

@@ -1,7 +1,26 @@
+v1.1.7 (2021-04-04)
+================================================================================
+
+- __FIX__: with the phpiredis-based connection backends, failed pipelines led to
+spurious responses returned after reconnecting to Redis because the underlying
+reader was not properly reset by discarding buffered replies after disconnecting
+(ISSUE #363).
+- __FIX__: removed `cweagans/composer-patches` dev dependency and apply patches
+using `post-update-cmd` script.
+
+
+v1.1.6 (2020-09-11)
+================================================================================
+
+- __FIX__: reverted support for sentinels authentication implemented in v1.1.5
+as it was bugged (see ISSUE #658), sorry for the trouble. This is now postponed
+as it requires a more thorough investigation.
+
+
 v1.1.5 (2020-09-10)
 ================================================================================
 
-- __FIX__: authentication for sentinels is now supported, previously it was not
+- __FIX__:~~authentication for sentinels is now supported, previously it was not
 possible to specify a `password` for sentinels as its value was stripped during
 initialization because sentinels did not support authentication until Redis 5.
 **Please note** that with the current implementation each sentinel must have
@@ -9,7 +28,7 @@ its own `password` parameter set in the parameters list despite this password is
 the same for all sentinels (read how `requirepass` works on the Redis docs). In
 this case you should avoid using the global `parameters` client option used to
 set default parameters for every connection created by Predis as this would end
-up using the same password even when connecting to actual Redis nodes.
+up using the same password even when connecting to actual Redis nodes.~~
 
 - __FIX__: the username is now correctly retrieved from the userinfo fragment of
 the URI when using the "redis" scheme and a "username:password" pair is present.

VERSION

@@ -1 +1 @@
-1.1.6
+1.1.7

composer.json

@@ -31,8 +31,7 @@
         "php": ">=5.3.9"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4.8",
-        "cweagans/composer-patches": "^1.6"
+        "phpunit/phpunit": "~4.8"
     },
     "suggest": {
         "ext-phpiredis": "Allows faster serialization and deserialization of the Redis protocol",
@@ -43,16 +42,7 @@
             "Predis\\": "src/"
         }
     },
-    "extra": {
- 		"composer-exit-on-patch-failure": true,
- 		"patches": {
- 			"phpunit/phpunit-mock-objects": {
- 				"Fix PHP 7 and 8 compatibility": "./tests/phpunit_mock_objects.patch"
- 			},
- 			"phpunit/phpunit": {
- 				"Fix PHP 7 compatibility": "./tests/phpunit_php7.patch",
- 				"Fix PHP 8 compatibility": "./tests/phpunit_php8.patch"
- 			}
- 		}
- 	}
+    "scripts": {
+        "post-update-cmd": "@php -f tests/apply-patches.php"
+    }
 }

package.ini

@@ -10,8 +10,8 @@ name        = "Predis"
 desc        = "Flexible and feature-complete Redis client for PHP and HHVM"
 homepage    = "http://github.com/nrk/predis"
 license     = "MIT"
-version     = "1.1.6"
-stability   = "devel"
+version     = "1.1.7"
+stability   = "stable"
 channel     = "pear.nrk.io"
 
 author      = "Daniele Alessandri \"nrk\" <suppakilla@gmail.com>"

phpunit.xml.travisci

@@ -36,10 +36,6 @@
         </whitelist>
     </filter>
 
-    <logging>
-        <log type="coverage-text" target="php://stdout" />
-    </logging>
-
     <php>
         <!-- Redis -->
         <const name="REDIS_SERVER_VERSION" value="3.2" />

src/Client.php

@@ -40,7 +40,7 @@ use Predis\Transaction\MultiExec as MultiExecTransaction;
  */
 class Client implements ClientInterface, \IteratorAggregate
 {
-    const VERSION = '1.1.6-dev';
+    const VERSION = '1.1.7';
 
     protected $connection;
     protected $options;
@@ -527,7 +527,7 @@ class Client implements ClientInterface, \IteratorAggregate
     }
 
     /**
-     * {@inheritdoc}
+     * @return \Traversable<string, static>
      */
     public function getIterator()
     {

src/Command/Processor/ProcessorChain.php

@@ -71,7 +71,7 @@ class ProcessorChain implements \ArrayAccess, ProcessorInterface
     /**
      * Returns an iterator over the list of command processor in the chain.
      *
-     * @return \ArrayIterator
+     * @return \Traversable<int, ProcessorInterface>
      */
     public function getIterator()
     {
@@ -89,7 +89,7 @@ class ProcessorChain implements \ArrayAccess, ProcessorInterface
     }
 
     /**
-     * {@inheritdoc}
+     * @return bool
      */
     public function offsetExists($index)
     {

src/Connection/Aggregate/PredisCluster.php

@@ -176,7 +176,7 @@ class PredisCluster implements ClusterInterface, \IteratorAggregate, \Countable
     }
 
     /**
-     * {@inheritdoc}
+     * @return int
      */
     public function count()
     {
@@ -184,7 +184,7 @@ class PredisCluster implements ClusterInterface, \IteratorAggregate, \Countable
     }
 
     /**
-     * {@inheritdoc}
+     * @return \Traversable<string|int, NodeConnectionInterface>
      */
     public function getIterator()
     {

src/Connection/Aggregate/RedisCluster.php

@@ -600,7 +600,7 @@ class RedisCluster implements ClusterInterface, \IteratorAggregate, \Countable
     }
 
     /**
-     * {@inheritdoc}
+     * @return int
      */
     public function count()
     {
@@ -608,7 +608,7 @@ class RedisCluster implements ClusterInterface, \IteratorAggregate, \Countable
     }
 
     /**
-     * {@inheritdoc}
+     * @return \Traversable<int, NodeConnectionInterface>
      */
     public function getIterator()
     {

src/Connection/Aggregate/SentinelReplication.php

@@ -146,14 +146,14 @@ class SentinelReplication implements ReplicationInterface
     }
 
     /**
-     * Sets the time to wait (in seconds) before fetching a new configuration
+     * Sets the time to wait (in milliseconds) before fetching a new configuration
      * from one of the sentinels.
      *
-     * @param float $seconds Time to wait before the next attempt.
+     * @param float $milliseconds Time to wait before the next attempt.
      */
-    public function setRetryWait($seconds)
+    public function setRetryWait($milliseconds)
     {
-        $this->retryWait = (float) $seconds;
+        $this->retryWait = (float) $milliseconds;
     }
 
     /**
@@ -239,12 +239,15 @@ class SentinelReplication implements ReplicationInterface
         }
 
         if (is_array($parameters)) {
-            // Password authentication is fine now that Redis Sentinel supports
-            // password-protected sentinel instances, but we must explicitly set
-            // "database" and "username" to NULL so that no augmented AUTH (ACL)
-            // and SELECT command are sent by accident to the sentinels.
+            // NOTE: sentinels do not accept AUTH and SELECT commands so we must
+            // explicitly set them to NULL to avoid problems when using default
+            // parameters set via client options. Actually AUTH is supported for
+            // sentinels starting with Redis 5 but we have to differentiate from
+            // sentinels passwords and nodes passwords, this will be implemented
+            // in a later release.
             $parameters['database'] = null;
             $parameters['username'] = null;
+            $parameters['password'] = null;
 
             if (!isset($parameters['timeout'])) {
                 $parameters['timeout'] = $this->sentinelTimeout;

src/Connection/PhpiredisSocketConnection.php

@@ -66,9 +66,9 @@ class PhpiredisSocketConnection extends AbstractConnection
      */
     public function __destruct()
     {
-        phpiredis_reader_destroy($this->reader);
-
         parent::__destruct();
+
+        phpiredis_reader_destroy($this->reader);
     }
 
     /**
@@ -227,9 +227,7 @@ class PhpiredisSocketConnection extends AbstractConnection
             $protocol = SOL_TCP;
         }
 
-        $socket = @socket_create($domain, SOCK_STREAM, $protocol);
-
-        if (!is_resource($socket)) {
+        if (false === $socket = @socket_create($domain, SOCK_STREAM, $protocol)) {
             $this->emitSocketError();
         }
 
@@ -344,7 +342,9 @@ class PhpiredisSocketConnection extends AbstractConnection
     public function disconnect()
     {
         if ($this->isConnected()) {
+            phpiredis_reader_reset($this->reader);
             socket_close($this->getResource());
+
             parent::disconnect();
         }
     }

src/Connection/PhpiredisStreamConnection.php

@@ -67,9 +67,19 @@ class PhpiredisStreamConnection extends StreamConnection
      */
     public function __destruct()
     {
-        phpiredis_reader_destroy($this->reader);
-
         parent::__destruct();
+
+        phpiredis_reader_destroy($this->reader);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function disconnect()
+    {
+        phpiredis_reader_reset($this->reader);
+
+        parent::disconnect();
     }
 
     /**

tests/Predis/Command/ConnectionSelectTest.php

@@ -83,7 +83,7 @@ class ConnectionSelectTest extends PredisCommandTestCase
     /**
      * @group connected
      * @expectedException \Predis\Response\ServerException
-     * @expectedExceptionMessage ERR invalid DB index
+     * @expectedExceptionMessageRegExp /ERR (invalid DB index|value is not)/
      */
     public function testThrowsExceptionOnUnexpectedDatabaseName()
     {

tests/Predis/Command/KeyMoveTest.php

@@ -82,7 +82,7 @@ class KeyMoveTest extends PredisCommandTestCase
     /**
      * @group connected
      * @expectedException \Predis\Response\ServerException
-     * @expectedExceptionMessage ERR index out of range
+     * @expectedExceptionMessageRegEx /ERR.*out of range/
      */
     public function testThrowsExceptionOnInvalidDatabases()
     {

tests/Predis/Configuration/ReplicationOptionTest.php

@@ -66,6 +66,10 @@ class ReplicationOptionTest extends PredisTestCase
      */
     public function testDoesNotAcceptValuesThatCanBeInterpretedAsBooleanFalse($value)
     {
+        if (version_compare(PHP_VERSION, '5.4', '<')) {
+            $this->markTestSkipped('Skip test, because.');
+        }
+
         $option = new ReplicationOption();
         $options = $this->getMock('Predis\Configuration\OptionsInterface');
 

tests/Predis/Connection/Aggregate/SentinelReplicationTest.php

@@ -36,29 +36,19 @@ class SentinelReplicationTest extends PredisTestCase
     /**
      * @group disconnected
      */
-    public function testParametersForSentinelConnectionShouldUsePasswordForAuthentication()
+    public function testParametersForSentinelConnectionShouldNotUseDatabaseAndUsernameAndPassword()
     {
         $replication = $this->getReplicationConnection('svc', array(
-            'tcp://127.0.0.1:5381?alias=sentinel1&password=secret',
+            'tcp://127.0.0.1:5381?alias=sentinel1&database=1&username=myusername&password=secret',
         ));
 
         $parameters = $replication->getSentinelConnection()->getParameters()->toArray();
 
-        $this->assertArraySubset(array('password' => 'secret'), $parameters);
-    }
-
-    /**
-     * @group disconnected
-     */
-    public function testParametersForSentinelConnectionShouldNotUseDatabaseAndUsername()
-    {
-        $replication = $this->getReplicationConnection('svc', array(
-            'tcp://127.0.0.1:5381?alias=sentinel1&database=1&username=myusername',
-        ));
-
-        $parameters = $replication->getSentinelConnection()->getParameters()->toArray();
-
-        $this->assertArraySubset(array('database' => null, 'username' => null), $parameters);
+        $this->assertArraySubset(array(
+            'database' => null,
+            'username' => null,
+            'password' => null
+        ), $parameters);
     }
 
     /**

tests/Predis/Connection/PhpiredisSocketConnectionTest.php

@@ -76,6 +76,28 @@ class PhpiredisSocketConnectionTest extends PredisConnectionTestCase
     // ---- INTEGRATION TESTS --------------------------------------------- //
     // ******************************************************************** //
 
+    /**
+     * @group connected
+     */
+    public function testClearsPendingResponsesInReaderBufferOnDisconnect()
+    {
+        $profile = $this->getCurrentProfile();
+        $connection = $this->createConnection();
+
+        $cmdECHOBefore = $profile->createCommand('echo', array('BEFORE DISCONNECT'));
+        $cmdECHOAfter = $profile->createCommand('echo', array('AFTER DISCONNECT'));
+
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->readResponse($cmdECHOBefore);
+        $connection->disconnect();
+
+        $response = $connection->executeCommand($cmdECHOAfter);
+
+        $this->assertSame('AFTER DISCONNECT', $response);
+    }
+
     /**
      * @group connected
      * @expectedException \Predis\Connection\ConnectionException

tests/Predis/Connection/PhpiredisStreamConnectionTest.php

@@ -76,6 +76,28 @@ class PhpiredisStreamConnectionTest extends PredisConnectionTestCase
     // ---- INTEGRATION TESTS --------------------------------------------- //
     // ******************************************************************** //
 
+    /**
+     * @group connected
+     */
+    public function testClearsPendingResponsesInReaderBufferOnDisconnect()
+    {
+        $profile = $this->getCurrentProfile();
+        $connection = $this->createConnection();
+
+        $cmdECHOBefore = $profile->createCommand('echo', array('BEFORE DISCONNECT'));
+        $cmdECHOAfter = $profile->createCommand('echo', array('AFTER DISCONNECT'));
+
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->writeRequest($cmdECHOBefore);
+        $connection->readResponse($cmdECHOBefore);
+        $connection->disconnect();
+
+        $response = $connection->executeCommand($cmdECHOAfter);
+
+        $this->assertSame('AFTER DISCONNECT', $response);
+    }
+
     /**
      * @group connected
      * @group slow

tests/apply-patches.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Apply patches to support newer PHP versions.
+ */
+
+$patches = array(
+    'phpunit_mock_objects.patch' => 'phpunit/phpunit-mock-objects',
+    'phpunit_php7.patch' => 'phpunit/phpunit',
+    'phpunit_php8.patch' => 'phpunit/phpunit',
+);
+
+foreach ($patches as $patch => $package) {
+    chdir(__DIR__.'/../vendor/'.$package);
+    passthru(sprintf('patch -p1 -f < ../../../tests/%s', $patch));
+}