Merge pull request #4 from iksaku/enhancement/support-connection-prefix

enhancement: Support Redis Connection prefixes

.github/workflows/run-tests.yml

@@ -15,8 +15,11 @@ jobs:
                 os: [ ubuntu-latest ]
                 php: [ 8.3, 8.2, 8.1 ]
                 laravel: [ 11.*, 10.*, 9.* ]
+                redis-client: [ phpredis, predis ]
                 dependency-version: [ prefer-stable ]
                 include:
+                    -   redis-client: phpredis
+                        php-extensions: redis
                     -   laravel: 11.*
                         testbench: 9.*
                     -   laravel: 10.*
@@ -36,7 +39,7 @@ jobs:
                     - 6379:6379
                 options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
 
-        name: ${{ matrix.os }} - P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
+        name: ${{ matrix.os }} - P${{ matrix.php }} - L${{ matrix.laravel }} (${{ matrix.redis-client }}) - ${{ matrix.dependency-version }}
 
         steps:
             -   name: Checkout code
@@ -52,6 +55,7 @@ jobs:
                 uses: shivammathur/setup-php@v2
                 with:
                     php-version: ${{ matrix.php }}
+                    extensions: ${{ matrix.php-extensions }}
 
             -   name: Install dependencies
                 run: |
@@ -60,3 +64,5 @@ jobs:
 
             -   name: Execute tests
                 run: vendor/bin/pest
+                env:
+                    REDIS_CLIENT: ${{ matrix.redis-client }}

.gitignore

@@ -1,6 +1,7 @@
 vendor
 composer.lock
 psalm.phar
+.idea
 .php_cs.cache
 .phpunit.result.cache
 .php-cs-fixer.cache

README.md

@@ -38,7 +38,7 @@ ActiveRedis provides you simple and efficient way to interact with Redis hashes
 ## Requirements
 
 - PHP >= 8.1
-- Predis >= 2.0
+- Redis >= 3.0
 - Laravel >= 9.0
 
 ## Installation

composer.json

@@ -29,7 +29,6 @@
     "minimum-stability": "stable",
     "require": {
         "php": ">=8.1",
-        "predis/predis": "^2.0",
         "illuminate/support": "^9.0|^10.0|^11.0",
         "illuminate/contracts": "^9.0|^10.0|^11.0",
         "illuminate/collections": "^9.0|^10.0|^11.0"
@@ -38,6 +37,7 @@
         "brick/math": "For decimal cast support"
     },
     "require-dev": {
+        "predis/predis": "^2.0",
         "laravel/pint": "^1.17",
         "pestphp/pest": "^1.0|^2.0|^3.0",
         "orchestra/testbench": "^7.0|^8.0|^9.0"

src/Repositories/RedisRepository.php

@@ -5,6 +5,9 @@
 use Closure;
 use Generator;
 use Illuminate\Contracts\Redis\Connection;
+use Illuminate\Redis\Connections\PhpRedisConnection;
+use Illuminate\Redis\Connections\PredisConnection;
+use Illuminate\Support\Str;
 
 class RedisRepository implements Repository
 {
@@ -28,24 +31,55 @@ public function exists(string $hash): bool
      */
     public function chunk(string $pattern, int $count): Generator
     {
-        $cursor = null;
+        [$cursor, $prefix] = array_values($this->getScanParameters());
 
         do {
             [$cursor, $keys] = $this->redis->scan($cursor, [
-                'match' => $pattern,
+                'match' => $prefix.$pattern,
                 'count' => $count,
             ]);
 
             if (is_null($keys)) {
                 return;
             }
 
-            if (! empty($keys)) {
+            if (empty($keys)) {
+                continue;
+            }
+
+            if (empty($prefix)) {
                 yield $keys;
+
+                continue;
             }
+
+            yield array_map(function (string $key) use ($prefix) {
+                return Str::after($key, $prefix);
+            }, $keys);
         } while ($cursor !== '0');
     }
 
+    /**
+     * Get the scan parameters for the Redis connection.
+     */
+    protected function getScanParameters(): array
+    {
+        return match (true) {
+            $this->redis instanceof PhpRedisConnection => [
+                'cursor' => null,
+                'prefix' => $this->redis->getOption($this->redis->client()::OPT_PREFIX),
+            ],
+            $this->redis instanceof PredisConnection => [
+                'cursor' => 0,
+                'prefix' => $this->redis->getOptions()->prefix->getPrefix(),
+            ],
+            default => [
+                'cursor' => null,
+                'prefix' => null,
+            ]
+        };
+    }
+
     /**
      * Set the hash field's value.
      */

tests/ModelQueryTest.php

@@ -19,6 +19,19 @@
     expect($found->getKey())->toBe($model->getKey());
 });
 
+it('queries existing attributes', function () {
+    $model = ModelStub::create([
+        'name' => 'John Doe'
+    ]);
+
+    $found = ModelStub::find($model->getKey());
+
+    expect($found)->is($model)->toBeTrue();
+    expect($found->getKey())->toBe($model->getKey());
+
+    expect($found->name)->toBe($model->name);
+});
+
 it('returns null when finding by null or empty key', function (?string $key) {
     ModelStub::create();
 

tests/TestCase.php

@@ -14,12 +14,4 @@ protected function getPackageProviders($app): array
     {
         return [ActiveRedisServiceProvider::class];
     }
-
-    /**
-     * Define environment setup.
-     */
-    protected function defineEnvironment($app): void
-    {
-        $app['config']->set('database.redis.options.prefix', null);
-    }
 }