SIP-30 - added MIX_HEARTBEAT_ENABLED to disable the heartbeat

 - possibility to set a specific key used for the lackable_id per model

Author: red-freak

README.md

@@ -130,6 +130,7 @@ The more advanced approach is to handle the locks via a heartbeat. This only wor
 | `HEARTBEAT_LOCK_DURATION` | 70 | The time in seconds a model is locked. |
 | `MIX_HEARTBEAT_REFRESH` | 60 | The time in seconds between the heartbeats. Should be a multiple of the `MIX_HEARTBEAT_STATUS`-interval. |
 | `MIX_HEARTBEAT_STATUS` | 30 | The time in seconds between the heartbeats for status-request (index-Listener). |
+| `MIX_HEARTBEAT_ENABLED` | true | Activates or deactivates the heartbeats. |
 
 ### config
 Beside the environment variables, there is a `middleware` key to determine the middleware(s) used by the heartbeat-route. Default it's set to `api`.

resources/js/heartbeat-manager.js

@@ -38,6 +38,8 @@ const HeartbeatManager = {
 	},
 
 	triggerBeat(scheduleBeat = true) {
+		if (process.env.MIX_HEARTBEAT_ENABLED !== 'true') return;
+
 		this.beat.counter = 1;
 		if (scheduleBeat) {
 			clearTimeout(this.beat.handle);

src/Http/Controllers/Api/Dtos/Heartbeat.php

@@ -102,7 +102,7 @@ public function modelStates()
 		return $this->lockables()->map(function($lockable) {
 			/** @var Model&IsLockable $lockable */
 			return [
-				'lockable_id' => $lockable->getKey(),
+				'lockable_id' => $lockable->{$lockable::lockableIdField()},
 				'lockable_type' => $lockable::class,
 				'locked_at' => $lockable->locked_at,
 				'locked_by' => $lockable->locked_by,

src/Http/Controllers/Api/Dtos/HeartbeatCollection.php

@@ -44,12 +44,12 @@ public function lockables(string $modelClass, array $ids): Collection
 		if ($modelCollection = data_get($this->models, $modelClass)) {
 			$emptyModel = new $modelClass();
 			/** @var \Illuminate\Database\Eloquent\Collection $models */
-			$models = $modelCollection->whereIn($emptyModel->getKeyName(), $ids);
+			$models = $modelCollection->whereIn($modelClass::$lockableIdField, $ids);
 
 			if ($models->count()) return $models;
 		}
 
-		return $modelClass::find($ids);
+		return $modelClass::whereIn($modelClass::$lockableIdField, $ids)->get();
 	}
 
 	/**
@@ -77,7 +77,7 @@ public function handle(): self
 		 * @var  array $ids
 		 */
 		foreach($modelsToFetch as $modelClass => $ids) {
-			$this->models[$modelClass] = $modelClass::find($ids);
+			$this->models[$modelClass] = $modelClass::whereIn($modelClass::$idField, $ids)->get();
 		}
 
 		// handle the tasks

src/Models/Concerns/IsLockable.php

@@ -32,6 +32,13 @@ public function initializeIsLockable()
 		$this->appends[] = 'locked_at';
 	}
 
+	public static function lockableIdField(): string
+	{
+		if (property_exists(self::class, 'lockableIdField')) return self::lockableIdField;
+
+		return 'id';
+	}
+
 	/**
 	 * Locks model.
 	 *
@@ -129,7 +136,7 @@ public function isLockedBy(Authenticatable|string|int|null $user = null, bool $s
 
 		return (string) $this->releaseLockIfExpired($saveOnRelease)->locked_by === (string) $userId;
 	}
-	
+
 	public function isLockedByUser(): BelongsTo
 	{
 		$emptyUser = new (config('auth.providers.users.model',  User::class))();
@@ -202,4 +209,4 @@ protected function releaseLockIfExpired(bool $saveOnRelease = false): self
 
 		return $this;
 	}
-}
+}