Skip to content

Add In-Memory Locking #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
onairmarc merged 6 commits into from
Jan 17, 2026
Merged

Add In-Memory Locking #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9e89286
Add Lock class for managing named locks with timeout support
onairmarc Jan 17, 2026
96519fd
Add LockTimeoutException for handling lock acquisition timeouts
onairmarc Jan 17, 2026
430e41c
Rectifying
Jan 17, 2026
4d947b7
Ignore Rector Commit in Git Blame
Jan 17, 2026
529667d
Dusting
Jan 17, 2026
42d75ad
Ignore Duster Commit in Git Blame
Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .git-blame-ignore-revs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,5 @@ bb927a60f808d44d10b6ffbd796982a3e5022c44
33a2233c7f0bfab90033796d51cbb722e2b5340e
d0097bd14bf964bf4c283d07432ca52bfefa6391
0dc3de71ae8b40a7050bd1a106d31c216b9fc7d3
430e41cb40dcd692360456fdd390c898bba8bd97
529667d80354f37d222563c9b37cff8b2e9cc3e5
23 changes: 23 additions & 0 deletions src/Exceptions/LockTimeoutException.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

/*
* Copyright (c) 2026. Encore Digital Group.
* All Rights Reserved.
*/

namespace EncoreDigitalGroup\StdLib\Exceptions;

use EncoreDigitalGroup\StdLib\Objects\Filesystem\ExitCode;
use Throwable;

class LockTimeoutException extends BaseException
{
public function __construct(string $lockName, int $timeout, ?Throwable $previous = null)
{
parent::__construct(
"Failed to acquire lock '{$lockName}' within {$timeout} second(s)",
ExitCode::GENERAL_ERROR,
$previous
);
}
}
65 changes: 65 additions & 0 deletions src/Objects/Support/Lock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<?php

/*
* Copyright (c) 2026. Encore Digital Group.
* All Rights Reserved.
*/

namespace EncoreDigitalGroup\StdLib\Objects\Support;

use Closure;
use EncoreDigitalGroup\StdLib\Exceptions\LockTimeoutException;
use Illuminate\Support\Sleep;

class Lock
{
/** @var array<string, bool> */
private static array $locks = [];

/**
* Execute a callback while holding a named lock
*
* @template T
*
* @param string $name The name of the lock to acquire
* @param int $timeout Maximum number of seconds to wait for the lock
* @param Closure(): T $callback The callback to execute while holding the lock
* @return T
*/
public static function block(string $name, int $timeout, Closure $callback): mixed
{
self::acquire($name, $timeout);

try {
return $callback();
} finally {
self::release($name);
}
}

private static function acquire(string $name, int $timeout): void
{
$attempts = 0;

while (self::isLocked($name) && $attempts < $timeout) {
Sleep::for(1)->seconds();
$attempts++;
}

if (self::isLocked($name)) {
throw new LockTimeoutException($name, $timeout);
}

self::$locks[$name] = true;
}

private static function release(string $name): void
{
unset(self::$locks[$name]);
}

private static function isLocked(string $name): bool
{
return self::$locks[$name] ?? false;
}
}