Fix prefix error if prefix equals a php command

.codespellrc

@@ -3,4 +3,4 @@ skip=./.git
 check-hidden=
 check-filenames=
 builtin=clear,rare,informal,usage,code,names
-ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget
+ignore-words-list=master,masters,slave,slaves,whitelist,cas,exat,smove,SUGGET,sugget,ro

.coveralls.yml

@@ -0,0 +1 @@
+coverage_clover: build/logs/clover-*.xml

.editorconfig

@@ -14,7 +14,7 @@ block_comment_end = */
 [*.php]
 max_line_length = 150
 
-[*.{md,yml,yaml,neon}]
+[*.{md,yml,yaml,neon,sh}]
 indent_size = 2
 
 [tests/**.php]

.gitattributes

@@ -5,6 +5,7 @@
 /examples export-ignore
 /tests export-ignore
 /.codespellrc export-ignore linguist-language=INI
+/.coveralls.yml export-ignore
 /.editorconfig export-ignore
 /.gitattributes export-ignore
 /.gitignore export-ignore

.github/workflows/cluster/Dockerfile

@@ -0,0 +1,7 @@
+FROM redis/redis-stack-server:latest as rss
+
+COPY create_cluster.sh /create_cluster.sh
+RUN ls -R /opt/redis-stack
+RUN chmod a+x /create_cluster.sh
+
+ENTRYPOINT [ "/create_cluster.sh"]

.github/workflows/cluster/create_cluster.sh

@@ -0,0 +1,47 @@
+#! /bin/bash
+
+mkdir -p /nodes
+touch /nodes/nodemap
+if [ -z ${START_PORT} ]; then
+    START_PORT=6372
+fi
+if [ -z ${END_PORT} ]; then
+    END_PORT=6377
+fi
+if [ ! -z "$3" ]; then
+    START_PORT=$2
+    START_PORT=$3
+fi
+echo "STARTING: ${START_PORT}"
+echo "ENDING: ${END_PORT}"
+
+for PORT in `seq ${START_PORT} ${END_PORT}`; do
+  mkdir -p /nodes/$PORT
+  if [[ -e /redis.conf ]]; then
+    cp /redis.conf /nodes/$PORT/redis.conf
+  else
+    touch /nodes/$PORT/redis.conf
+  fi
+  cat << EOF >> /nodes/$PORT/redis.conf
+port ${PORT}
+cluster-enabled yes
+daemonize yes
+logfile /redis.log
+dir /nodes/$PORT
+EOF
+
+  set -x
+  /opt/redis-stack/bin/redis-server /nodes/$PORT/redis.conf
+  sleep 1
+  if [ $? -ne 0 ]; then
+    echo "Redis failed to start, exiting."
+    continue
+  fi
+  echo 127.0.0.1:$PORT >> /nodes/nodemap
+done
+if [ -z "${REDIS_PASSWORD}" ]; then
+    echo yes | /opt/redis-stack/bin/redis-cli --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
+else
+    echo yes | opt/redis-stack/bin/redis-cli -a ${REDIS_PASSWORD} --cluster create `seq -f 127.0.0.1:%g ${START_PORT} ${END_PORT}` --cluster-replicas 1
+fi
+tail -f /redis.log

.github/workflows/cluster/docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3.9"
+services:
+  cluster:
+    container_name: redis-cluster
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "6372:6372"
+      - "6373:6373"
+      - "6374:6374"
+      - "6375:6375"
+      - "6376:6376"
+      - "6377:6378"
+    volumes:
+      - "./redis.conf:/redis.conf:ro"
+

.github/workflows/cluster/redis.conf

@@ -0,0 +1,8 @@
+# Redis Cluster config file will be shared across all nodes.
+# Do not change the following configurations that are already set:
+# port, cluster-enabled, daemonize, logfile, dir
+protected-mode no
+loadmodule /opt/redis-stack/lib/redisearch.so
+loadmodule /opt/redis-stack/lib/redistimeseries.so
+loadmodule /opt/redis-stack/lib/rejson.so
+loadmodule /opt/redis-stack/lib/redisbloom.so

.github/workflows/tests.yml

@@ -65,16 +65,68 @@ jobs:
 
       - name: Run tests with coverage
         if: ${{ matrix.php == '8.1' && matrix.redis == '7' }}
-        run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml --coverage-filter ./src
+        run: vendor/bin/phpunit --coverage-clover build/logs/clover-default.xml --coverage-filter ./src
 
       - name: Run tests using Relay
         if: ${{ matrix.redis >= '6' }}
         run: vendor/bin/phpunit -c phpunit.relay.xml
 
+      - name: Run tests using Relay with coverage
+        if: ${{ matrix.php == '8.1' && matrix.redis == '7' }}
+        run: vendor/bin/phpunit -c phpunit.relay.xml --coverage-clover build/logs/clover-relay.xml --coverage-filter ./src
+
       - name: Send coverage to Coveralls
         env:
             COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ env.COVERALLS_REPO_TOKEN && matrix.php == '8.1' && matrix.redis == '7' }}
         run: |
           wget "https://github.com/php-coveralls/php-coveralls/releases/download/v2.5.3/php-coveralls.phar"
           php ./php-coveralls.phar -v
+
+  predis-cluster:
+
+    name: PHP ${{ matrix.php }} (Redis Cluster latest)
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php:
+          - '7.2'
+          - '7.3'
+          - '7.4'
+          - '8.0'
+          - '8.1'
+          - '8.2'
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Run Redis cluster
+        uses: isbang/compose-action@v1.4.1
+        with:
+          compose-file: .github/workflows/cluster/docker-compose.yml
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: relay
+          coverage: ${{ (matrix.php == '8.1') && 'xdebug' || 'none' }}
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: highest
+          composer-options: ${{ matrix.php == '8.0' && '--ignore-platform-reqs' || '' }}
+
+      - name: Run tests against cluster
+        run: |
+          sleep 5 # make sure that docker image is setup
+          vendor/bin/phpunit --group cluster
+
+      - name: Run tests against cluster using Relay
+        run: |
+          sleep 5 # make sure nodes are stable and fully joined
+          vendor/bin/phpunit -c phpunit.relay.xml --group cluster

CHANGELOG.md

@@ -1,5 +1,27 @@
 ## Changelog
 
+## v2.2.2 (2023-09-13)
+
+### Added
+- Added `client_info` client parameter
+- Added support for `CLUSTER` container command
+
+### Fixed
+- Fixed `EXPIRETIME` not using `prefix`
+- Disabled `CLIENT SETINFO` calls by default
+
+## v2.2.1 (2023-08-15)
+
+### Added
+- Added support for `WAITAOF` command (#1357)
+- Added support for `SHUTDOWN` command (#1359)
+- Added support for `FUNCTION` command (#1332)
+- Added support for new optional `PEXPIRE`, `PEXPIREAT` and `COMMAND`
+- Added missing Redis Stack commands to `KeyPrefixProcessor` (#1358)
+
+### Changed
+- Set client name and version when establishing a connection (#1347)
+
 ## v2.2.0 (2023-06-14)
 
 Predis v2.2.0 introduces official support for [Redis Stack](https://redis.io/docs/stack/) as well as a [Relay](https://github.com/cachewerk/relay) integration for substantially [faster read performance](https://github.com/predis/predis/wiki/Using-Relay).

FAQ.md

@@ -33,7 +33,7 @@ but significantly reduces bytes sent over the network and Redis memory usage.
 
 Without Relay, Predis will not serialize data and will never do that by default. The reason
 behind this decision is that serialization is usually something that developers prefer to
-customize depending on their needs and can not be easilygeneralized when using Redis because
+customize depending on their needs and can not be easily generalized when using Redis because
 of the many possible access patterns for your data. This does not mean that it is impossible
 to have such a feature since you can leverage the extensibility of this library to define
 your own serialization-aware commands. You can find more details about how to do that
@@ -90,7 +90,7 @@ Predis is fast enough when Redis is located on the same machine as PHP, more on
 [PhpRedis](https://github.com/phpredis/phpredis) (and Relay) perform significantly better when
 network I/O is involved, due to their ability to compress data by ~75%. Fewer bytes and received
 sent over the network [means faster operations](https://akalongman.medium.com/phpredis-vs-predis-comparison-on-real-production-data-a819b48cbadb),
-and potentially cost savings when network traffic isn't free (e.g. AWS Elasticache Inter-AZ transfer costs).
+and potentially cost savings when network traffic isn't free (e.g. AWS ElastiCache Inter-AZ transfer costs).
 
 ## Predis is a pure-PHP implementation: it can not be fast enough! ##
 

README.md

@@ -14,7 +14,7 @@ More details about this project can be found on the [frequently asked questions]
 
 ## Main features ##
 
-- Support for Redis from __3.0__ to __7.0__.
+- Support for Redis from __3.0__ to __7.2__.
 - Support for clustering using client-side sharding and pluggable keyspace distributors.
 - Support for [redis-cluster](http://redis.io/topics/cluster-tutorial) (Redis >= 3.0).
 - Support for master-slave replication setups and [redis-sentinel](http://redis.io/topics/sentinel).

VERSION

@@ -1 +1 @@
-2.2.0-RC1
+2.2.3-dev

examples/Commands/waitaof.php

@@ -0,0 +1,41 @@
+<?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.
+ */
+
+use Predis\Client;
+
+require __DIR__ . '/../shared.php';
+
+// Example of WAITAOF command usage:
+
+// 1. Enable appendonly mode if it's not (command works only in appendonly mode)
+$client = new Client($single_server);
+$info = $client->info();
+$enabled = false;
+
+if ($info['Persistence']['aof_enabled'] === '0') {
+    $client->config('set', 'appendonly', 'yes');
+    $enabled = true;
+}
+
+// 2. Set key value pair
+$response = $client->set('foo', 'bar');
+echo "Key-value pair set status: {$response}\n";
+
+// 3. Run WAITAOF command to make sure that all previous writes was fsynced
+$response = $client->waitaof(1, 0, 0);
+
+echo "Quantity of local instances that was fsynced - {$response[0]}, quantity of replicas - {$response[1]}";
+
+// 4. Disable appendonly mode if it was enabled during script execution
+if ($enabled) {
+    $client->config('set', 'appendonly', 'no');
+}

phpunit.relay.xml

@@ -20,10 +20,12 @@
     <groups>
         <exclude>
             <group>relay-incompatible</group>
+            <group>relay-resp3</group>
             <group>realm-webdis</group>
             <group>realm-stack</group>
             <group>ext-curl</group>
             <group>ext-phpiredis</group>
+            <group>cluster</group>
         </exclude>
     </groups>
 
@@ -38,5 +40,9 @@
         <const name="REDIS_SERVER_PORT" value="6379" />
         <const name="REDIS_SERVER_DBNUM" value="0" />
         <env name="USE_RELAY" value="true" />
+
+        <!-- Redis Cluster -->
+        <!-- Only master nodes endpoints included -->
+        <const name="REDIS_CLUSTER_ENDPOINTS" value="127.0.0.1:6372,127.0.0.1:6373,127.0.0.1:6374" />
     </php>
 </phpunit>

phpunit.xml.dist

@@ -33,6 +33,7 @@
             <group>ext-relay</group>
             <group>ext-curl</group>
             <group>ext-phpiredis</group>
+            <group>cluster</group>
             <!-- <group>connected</group> -->
             <!-- <group>disconnected</group> -->
             <!-- <group>commands</group> -->
@@ -51,5 +52,9 @@
         <const name="REDIS_SERVER_PORT" value="6379" />
         <const name="REDIS_SERVER_DBNUM" value="0" />
         <env name="USE_RELAY" value="false" />
+
+        <!-- Redis Cluster -->
+        <!-- Only master nodes endpoints included -->
+        <const name="REDIS_CLUSTER_ENDPOINTS" value="127.0.0.1:6372,127.0.0.1:6373,127.0.0.1:6374" />
     </php>
 </phpunit>

src/Client.php

@@ -53,7 +53,7 @@
  */
 class Client implements ClientInterface, IteratorAggregate
 {
-    public const VERSION = '2.2.0-RC1';
+    public const VERSION = '2.2.3-dev';
 
     /** @var OptionsInterface */
     private $options;

src/ClientContextInterface.php

@@ -39,6 +39,7 @@
 use Predis\Command\Argument\TimeSeries\RangeArguments;
 use Predis\Command\CommandInterface;
 use Predis\Command\Redis\Container\ACL;
+use Predis\Command\Redis\Container\CLUSTER;
 use Predis\Command\Redis\Container\FunctionContainer;
 use Predis\Command\Redis\Container\Json\JSONDEBUG;
 use Predis\Command\Redis\Container\Search\FTCONFIG;
@@ -304,12 +305,14 @@
  * @method $this exec()
  * @method $this multi()
  * @method $this unwatch()
+ * @method $this waitaof(int $numLocal, int $numReplicas, int $timeout)
  * @method $this watch($key)
  * @method $this eval($script, $numkeys, $keyOrArg1 = null, $keyOrArgN = null)
  * @method $this eval_ro(string $script, array $keys, ...$argument)
  * @method $this evalsha($script, $numkeys, $keyOrArg1 = null, $keyOrArgN = null)
  * @method $this evalsha_ro(string $sha1, array $keys, ...$argument)
  * @method $this script($subcommand, $argument = null)
+ * @method $this shutdown(bool $noSave = null, bool $now = false, bool $force = false, bool $abort = false)
  * @method $this auth($password)
  * @method $this echo($message)
  * @method $this ping($message = null)
@@ -338,6 +341,7 @@
  * @method $this geosearchstore(string $destination, string $source, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $storeDist = false)
  *
  * Container commands
+ * @property CLUSTER           $cluster
  * @property FunctionContainer $function
  * @property FTCONFIG          $ftconfig
  * @property FTCURSOR          $ftcursor