lock add heartbeat param

src/lock/src/Annotation/Blockable.php

@@ -22,7 +22,8 @@ public function __construct(
         public ?string $value = null,
         public int $seconds = 0,
         public int $ttl = 0,
-        public string $driver = 'default'
+        public string $driver = 'default',
+        public int $heartbeat = 0
     ) {
     }
 }

src/lock/src/Annotation/BlockableAspect.php

@@ -39,7 +39,7 @@ public function process(ProceedingJoinPoint $proceedingJoinPoint)
 
         $key = StringHelper::format($annotation->prefix, $arguments, $annotation->value);
 
-        return $this->lockFactory->make($key, $annotation->ttl, driver: $annotation->driver)
+        return $this->lockFactory->make($key, $annotation->ttl, driver: $annotation->driver, heartbeat: $annotation->heartbeat)
             ->block($annotation->seconds, fn () => $proceedingJoinPoint->process());
     }
 }

src/lock/src/Annotation/Lock.php

@@ -21,7 +21,8 @@ public function __construct(
         public string $name,
         public int $seconds = 0,
         public ?string $owner = null,
-        public string $driver = 'default'
+        public string $driver = 'default',
+        public int $heartbeat = 0
     ) {
     }
 }

src/lock/src/Driver/AbstractLock.php

@@ -11,10 +11,17 @@
 
 namespace FriendsOfHyperf\Lock\Driver;
 
+use FriendsOfHyperf\Lock\Exception\HeartbeatException;
 use FriendsOfHyperf\Lock\Exception\LockTimeoutException;
+use Hyperf\Context\ApplicationContext;
+use Hyperf\Contract\StdoutLoggerInterface;
+use Hyperf\Coordinator\Constants;
+use Hyperf\Coordinator\CoordinatorManager;
+use Hyperf\Coroutine\Coroutine;
 use Hyperf\Stringable\Str;
 use Hyperf\Support\Traits\InteractsWithTime;
 use Override;
+use Throwable;
 
 use function Hyperf\Support\now;
 
@@ -32,12 +39,18 @@ abstract class AbstractLock implements LockInterface
      */
     protected int $sleepMilliseconds = 250;
 
+    protected int $heartbeat = 0;
+
     /**
      * Create a new lock instance.
      */
-    public function __construct(protected string $name, protected int $seconds, ?string $owner = null)
+    public function __construct(protected string $name, protected int $seconds, ?string $owner = null, int $heartbeat = 0)
     {
         $this->owner = $owner ?? Str::random();
+        $this->heartbeat = $heartbeat;
+        if ($seconds > 0 && $heartbeat > 0 && $seconds <= $heartbeat) {
+            throw new HeartbeatException('Heartbeat must be less than lock seconds.');
+        }
     }
 
     /**
@@ -131,6 +144,8 @@ public function isOwnedBy($owner): bool
         return $this->getCurrentOwner() === $owner;
     }
 
+    abstract protected function delayExpiration(): bool;
+
     /**
      * Returns the owner value written into the driver for this lock.
      */
@@ -143,4 +158,35 @@ protected function isOwnedByCurrentProcess(): bool
     {
         return $this->isOwnedBy($this->owner);
     }
+
+    protected function heartbeat(): bool
+    {
+        if ($this->heartbeat <= 0 || $this->seconds <= 0 || ! Coroutine::inCoroutine()) {
+            return true;
+        }
+        Coroutine::create(function () {
+            while (true) {
+                if (CoordinatorManager::until(Constants::WORKER_EXIT)->yield($this->heartbeat)) {
+                    break;
+                }
+                if ($this->heartbeat == 0) {
+                    return;
+                }
+                if (! $this->isOwnedByCurrentProcess()) {
+                    return;
+                }
+                try {
+                    $this->delayExpiration();
+                } catch (Throwable $throwable) {
+                    ApplicationContext::getContainer()->get(StdoutLoggerInterface::class)?->warning($throwable);
+                }
+            }
+        });
+        return true;
+    }
+
+    protected function stopHeartbeat(): void
+    {
+        $this->heartbeat = 0;
+    }
 }

src/lock/src/Driver/CacheLock.php

@@ -26,9 +26,9 @@ class CacheLock extends AbstractLock
     /**
      * Create a new lock instance.
      */
-    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [])
+    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [], int $heartbeat = 0)
     {
-        parent::__construct($name, $seconds, $owner);
+        parent::__construct($name, $seconds, $owner, $heartbeat);
 
         $container = ApplicationContext::getContainer();
         $cacheManager = $container->get(CacheManager::class);
@@ -46,7 +46,7 @@ public function acquire(): bool
             return false;
         }
 
-        return $this->store->set($this->name, $this->owner, $this->seconds);
+        return $this->store->set($this->name, $this->owner, $this->seconds) && $this->heartbeat();
     }
 
     /**
@@ -56,6 +56,7 @@ public function acquire(): bool
     public function release(): bool
     {
         if ($this->isOwnedByCurrentProcess()) {
+            $this->stopHeartbeat();
             return $this->store->delete($this->name);
         }
 
@@ -68,9 +69,19 @@ public function release(): bool
     #[Override]
     public function forceRelease(): void
     {
+        $this->stopHeartbeat();
         $this->store->delete($this->name);
     }
 
+    #[Override]
+    protected function delayExpiration(): bool
+    {
+        if ($this->seconds > 0) {
+            return $this->store->set($this->name, $this->owner, $this->seconds);
+        }
+        return true;
+    }
+
     /**
      * Returns the owner value written into the driver for this lock.
      * @return string

src/lock/src/Driver/CoroutineLock.php

@@ -43,12 +43,13 @@ public function __construct(
         string $name,
         int $seconds,
         ?string $owner = null,
-        array $constructor = []
+        array $constructor = [],
+        int $heartbeat = 0
     ) {
         $constructor = array_merge(['prefix' => ''], $constructor);
         $name = $constructor['prefix'] . $name;
 
-        parent::__construct($name, $seconds, $owner);
+        parent::__construct($name, $seconds, $owner, $heartbeat);
 
         self::$owners ??= new WeakMap();
         self::$timers ??= new WeakMap();
@@ -113,6 +114,13 @@ public function forceRelease(): void
         $chan->close();
     }
 
+    #[Override]
+    protected function delayExpiration(): bool
+    {
+        // Not supported
+        return false;
+    }
+
     /**
      * Returns the owner value written into the driver for this lock.
      * @return string

src/lock/src/Driver/DatabaseLock.php

@@ -28,9 +28,9 @@ class DatabaseLock extends AbstractLock
     /**
      * Create a new lock instance.
      */
-    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [])
+    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [], int $heartbeat = 0)
     {
-        parent::__construct($name, $seconds, $owner);
+        parent::__construct($name, $seconds, $owner, $heartbeat);
 
         $constructor = array_merge(['pool' => 'default', 'table' => 'locks', 'prefix' => ''], $constructor);
         if ($constructor['prefix']) {
@@ -67,7 +67,7 @@ public function acquire(): bool
 
             $acquired = $updated >= 1;
         }
-
+        $acquired && $this->heartbeat();
         return $acquired;
     }
 
@@ -78,6 +78,7 @@ public function acquire(): bool
     public function release(): bool
     {
         if ($this->isOwnedByCurrentProcess()) {
+            $this->stopHeartbeat();
             $this->connection->table($this->table)
                 ->where('key', $this->name)
                 ->where('owner', $this->owner)
@@ -95,11 +96,29 @@ public function release(): bool
     #[Override]
     public function forceRelease(): void
     {
+        $this->stopHeartbeat();
         $this->connection->table($this->table)
             ->where('key', $this->name)
             ->delete();
     }
 
+    #[Override]
+    protected function delayExpiration(): bool
+    {
+        if ($this->seconds > 0) {
+            $updated = $this->connection->table($this->table)
+                ->where('key', $this->name)
+                ->where(fn ($query) => $query->where('owner', $this->owner)->orWhere('expiration', '<=', time()))
+                ->update([
+                    'owner' => $this->owner,
+                    'expiration' => $this->expiresAt(),
+                ]);
+
+            return $updated >= 1;
+        }
+        return true;
+    }
+
     /**
      * Get the UNIX timestamp indicating when the lock should expire.
      */

src/lock/src/Driver/FileSystemLock.php

@@ -26,9 +26,9 @@ class FileSystemLock extends AbstractLock
     /**
      * Create a new lock instance.
      */
-    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [])
+    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [], int $heartbeat = 0)
     {
-        parent::__construct($name, $seconds, $owner);
+        parent::__construct($name, $seconds, $owner, $heartbeat);
 
         $constructor = array_merge(['config' => ['prefix' => 'lock:']], $constructor);
         $this->store = make(FileSystemDriver::class, $constructor);
@@ -44,7 +44,7 @@ public function acquire(): bool
             return false;
         }
 
-        return $this->store->set($this->name, $this->owner, $this->seconds) == true;
+        return $this->store->set($this->name, $this->owner, $this->seconds) == true && $this->heartbeat();
     }
 
     /**
@@ -54,6 +54,7 @@ public function acquire(): bool
     public function release(): bool
     {
         if ($this->isOwnedByCurrentProcess()) {
+            $this->stopHeartbeat();
             return $this->store->delete($this->name);
         }
 
@@ -66,9 +67,19 @@ public function release(): bool
     #[Override]
     public function forceRelease(): void
     {
+        $this->stopHeartbeat();
         $this->store->delete($this->name);
     }
 
+    #[Override]
+    protected function delayExpiration(): bool
+    {
+        if ($this->seconds > 0) {
+            return $this->store->set($this->name, $this->owner, $this->seconds);
+        }
+        return true;
+    }
+
     /**
      * Returns the owner value written into the driver for this lock.
      * @return string

src/lock/src/Driver/RedisLock.php

@@ -28,9 +28,9 @@ class RedisLock extends AbstractLock
     /**
      * Create a new lock instance.
      */
-    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [])
+    public function __construct(string $name, int $seconds, ?string $owner = null, array $constructor = [], int $heartbeat = 0)
     {
-        parent::__construct($name, $seconds, $owner);
+        parent::__construct($name, $seconds, $owner, $heartbeat);
 
         $constructor = array_merge(['pool' => 'default', 'prefix' => ''], $constructor);
         if ($constructor['prefix']) {
@@ -46,7 +46,7 @@ public function __construct(string $name, int $seconds, ?string $owner = null, a
     public function acquire(): bool
     {
         if ($this->seconds > 0) {
-            return $this->store->set($this->name, $this->owner, ['NX', 'EX' => $this->seconds]) == true;
+            return $this->store->set($this->name, $this->owner, ['NX', 'EX' => $this->seconds]) == true && $this->heartbeat();
         }
 
         return $this->store->setNX($this->name, $this->owner) === true;
@@ -58,6 +58,7 @@ public function acquire(): bool
     #[Override]
     public function release(): bool
     {
+        $this->stopHeartbeat();
         return (bool) $this->store->eval(LuaScripts::releaseLock(), [$this->name, $this->owner], 1);
     }
 
@@ -67,9 +68,19 @@ public function release(): bool
     #[Override]
     public function forceRelease(): void
     {
+        $this->stopHeartbeat();
         $this->store->del($this->name);
     }
 
+    #[Override]
+    protected function delayExpiration(): bool
+    {
+        if ($this->seconds > 0) {
+            return $this->store->set($this->name, $this->owner, ['EX' => $this->seconds]);
+        }
+        return true;
+    }
+
     /**
      * Returns the owner value written into the driver for this lock.
      * @return string

src/lock/src/Exception/HeartbeatException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of friendsofhyperf/components.
+ *
+ * @link     https://github.com/friendsofhyperf/components
+ * @document https://github.com/friendsofhyperf/components/blob/main/README.md
+ * @contact  huangdijia@gmail.com
+ */
+
+namespace FriendsOfHyperf\Lock\Exception;
+
+use Exception;
+
+class HeartbeatException extends Exception
+{
+}

src/lock/src/Functions.php

@@ -17,13 +17,13 @@
 /**
  * @return ($name is null ? LockFactory : LockInterface)
  */
-function lock(?string $name = null, int $seconds = 0, ?string $owner = null, string $driver = 'default'): LockFactory|LockInterface
+function lock(?string $name = null, int $seconds = 0, ?string $owner = null, string $driver = 'default', int $heartbeat = 0): LockFactory|LockInterface
 {
     $factory = ApplicationContext::getContainer()->get(LockFactory::class);
 
     if (is_null($name)) {
         return $factory;
     }
 
-    return $factory->make($name, $seconds, $owner, $driver);
+    return $factory->make($name, $seconds, $owner, $driver, $heartbeat);
 }

src/lock/src/Listener/RegisterPropertyHandlerListener.php

@@ -48,8 +48,9 @@ public function process(object $event): void
                 $seconds = (int) $annotation->seconds;
                 $owner = $annotation->owner;
                 $driver = $annotation->driver;
+                $heartbeat = $annotation->heartbeat;
 
-                $reflectionProperty->setValue($object, $this->lockFactory->make($name, $seconds, $owner, $driver));
+                $reflectionProperty->setValue($object, $this->lockFactory->make($name, $seconds, $owner, $driver, $heartbeat));
             }
         });
     }