feat: support predis (#72)

* feat: support predis

* add test for bulk generate id with predis resolver

* Update composer.json

Co-authored-by: Bilge <[email protected]>

* add new phpcsfix rule "heredoc_indentation"

* chore: rename PHPREDIS -> Predis

* chore: remove predis from composer

* chore: update readme

* chore: fix test

* fix unit test ensure all cache are overdue

---------

Co-authored-by: Bilge <[email protected]>

Author: godruoyi

.github/workflows/codestyle.yml

@@ -39,6 +39,9 @@ jobs:
       - name: Install Laravel Illuminate Contracts
         run: composer require "illuminate/contracts"
 
+      - name: Install Predis Package
+        run: composer require "predis/predis:^2.0"
+
       - name: Code Style
         run: vendor/bin/pint --test --config ./pint.json
 

.github/workflows/static-analysis.yml

@@ -38,5 +38,8 @@ jobs:
           max_attempts: 3
           command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
 
+      - name: Install Predis Package
+        run: composer require "predis/predis:^2.0"
+
       - name: Execute type checking
         run: vendor/bin/phpstan

.github/workflows/test.yml

@@ -40,6 +40,9 @@ jobs:
     - name: Install Laravel Illuminate Contracts
       run: composer require "illuminate/contracts"
 
+    - name: Install Predis Package
+      run: composer require "predis/predis:^2.0"
+
     - name: PHPUnit Test
       run: vendor/bin/phpunit --display-incomplete --display-skipped --display-deprecations --display-errors --display-notices --display-warnings
       env:

README.md

@@ -46,11 +46,23 @@ Based on this, we created this package and integrated multiple sequence-number p
 * RandomSequenceResolver (Random)
 * FileLockResolver（PHP file lock `fopen/flock`, **Concurrency Safety**）
 * RedisSequenceResolver (based on redis psetex and incrby, **Concurrency Safety**)
-* LaravelSequenceResolver (based on redis psetex and incrby)
+* LaravelSequenceResolver (based on Laravel Cache [add](https://github.com/laravel/framework/blob/11.x/src/Illuminate/Contracts/Cache/Repository.php#L39) lock)
 * SwooleSequenceResolver (based on swoole_lock)
+* PredisSequenceResolver (based on redis psetex and incrby, **Concurrency Safety**)
 
 Each provider only needs to ensure that the serial number generated in the same millisecond is different. You can get a unique ID.
 
+
+> [!NOTE]  
+> If you want to use RedisSequenceResolver, please install the [redis](https://pecl.php.net/package/redis) extension:
+> pecl install redis
+> 
+> If you want to use SwooleSequenceResolver, please install the swoole extension:
+> pecl install swoole
+> 
+> If you want to use PredisSequenceResolver, please install the [predis/predis](https://github.com/predis/predis) package:
+> composer install predis/predis
+
 > **Warning**
 > The RandomSequenceResolver does not guarantee that the generated IDs are unique, If you want to generate a unique ID, please use another resolver instead.
 

composer.json

@@ -38,7 +38,7 @@
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "pint": "vendor/bin/pint"
+        "pint": "vendor/bin/pint --config pint.json"
     },
     "config": {
         "allow-plugins": {

pint.json

@@ -7,6 +7,9 @@
         "php_unit_method_casing": {
             "case": "snake_case"
         },
-        "no_superfluous_phpdoc_tags": false
+        "no_superfluous_phpdoc_tags": false,
+        "heredoc_indentation": {
+            "indentation": "start_plus_one"
+        }
     }
 }

src/FileLockResolver.php

@@ -114,7 +114,6 @@ protected function unlock($f): void
     /**
      * @param  array<int, int>  $contents
      * @param  resource  $f
-     * @return bool
      */
     public function updateContents(array $contents, $f): bool
     {

src/PredisSequenceResolver.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the godruoyi/php-snowflake.
+ *
+ * (c) Godruoyi <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
+namespace Godruoyi\Snowflake;
+
+use Predis\Client as PredisClient;
+
+class PredisSequenceResolver implements SequenceResolver
+{
+    /**
+     * The cache prefix.
+     */
+    protected string $prefix = '';
+
+    /**
+     * The default redis lua script
+     */
+    protected static string $script = <<<'LUA'
+        if redis.call('set', KEYS[1], ARGV[1], "EX", ARGV[2], "NX") then
+            return 0
+        else
+            return redis.call('incr', KEYS[1])
+        end
+        LUA;
+
+    public function __construct(protected PredisClient $predisClient)
+    {
+    }
+
+    public function sequence(int $currentTime): int
+    {
+        return $this->predisClient->eval(self::$script, 1, $this->prefix.$currentTime, '0', '10') | 0;
+    }
+
+    /**
+     * Set cache prefix.
+     */
+    public function setCachePrefix(string $prefix): self
+    {
+        $this->prefix = $prefix;
+
+        return $this;
+    }
+}

src/RedisSequenceResolver.php

@@ -22,6 +22,17 @@ class RedisSequenceResolver implements SequenceResolver
      */
     protected string $prefix = '';
 
+    /**
+     * The default redis lua script
+     */
+    protected static string $script = <<<'LUA'
+        if redis.call('set', KEYS[1], ARGV[1], "EX", ARGV[2], "NX") then
+            return 0
+        else
+            return redis.call('incr', KEYS[1])
+        end
+        LUA;
+
     /**
      * Init resolve instance, must be connected.
      *
@@ -39,16 +50,8 @@ public function __construct(protected Redis $redis)
      */
     public function sequence(int $currentTime): int
     {
-        $lua = <<<'LUA'
-if redis.call('set', KEYS[1], ARGV[1], "EX", ARGV[2], "NX") then
-    return 0
-else
-    return redis.call('incr', KEYS[1])
-end
-LUA;
-
         // 10 seconds
-        return $this->redis->eval($lua, [$this->prefix.$currentTime, '0', '10'], 1) | 0;
+        return $this->redis->eval(self::$script, [$this->prefix.$currentTime, '0', '10'], 1) | 0;
     }
 
     /**

src/Snowflake.php

@@ -38,8 +38,6 @@ class Snowflake
 
     /**
      * The Sequence Resolver instance.
-     *
-     * @var Closure|SequenceResolver|null
      */
     protected SequenceResolver|null|Closure $sequence = null;