Skip to content

Set TTL #328

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
rmcdaniel merged 2 commits into from
Feb 20, 2026
+116 −13
Merged

Set TTL #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0964473
Set TTL
rmcdaniel Feb 19, 2026
909827a
More TTL
rmcdaniel Feb 20, 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
7 changes: 6 additions & 1 deletion src/Exception.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,12 @@ public function handle()
public function middleware()
{
return [
new WithoutOverlappingMiddleware($this->storedWorkflow->id, WithoutOverlappingMiddleware::ACTIVITY),
new WithoutOverlappingMiddleware(
$this->storedWorkflow->id,
WithoutOverlappingMiddleware::ACTIVITY,
0,
15
),
];
}
}
15 changes: 12 additions & 3 deletions src/Middleware/WithoutOverlappingMiddleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ public function lock($job)
$locked = $this->compareAndSet(
$this->getActivitySemaphoreKey(),
$activitySemaphores,
array_merge($activitySemaphores, [$job->key])
array_merge($activitySemaphores, [$job->key]),
$this->expiresAfter
);
if ($locked) {
if ($this->expiresAfter) {
Expand Down Expand Up @@ -177,7 +178,13 @@ private function unlockActivity($job): bool
$remaining = array_values(
array_diff($this->cache->get($this->getActivitySemaphoreKey(), []), [$job->key])
);
$this->cache->put($this->getActivitySemaphoreKey(), $remaining);
if ($remaining === []) {
$this->cache->forget($this->getActivitySemaphoreKey());
} elseif ($this->expiresAfter) {
$this->cache->put($this->getActivitySemaphoreKey(), $remaining, $this->expiresAfter);
} else {
$this->cache->put($this->getActivitySemaphoreKey(), $remaining);
}
$this->cache->forget($job->key);

foreach ($remaining as $semaphore) {
Expand Down Expand Up @@ -210,7 +217,9 @@ private function compareAndSet($key, $expectedValue, $newValue, $expiresAfter =
$currentValue = is_int($expectedValue) ? (int) $currentValue : $currentValue;

if ($currentValue === $expectedValue) {
if ($expiresAfter) {
if ($newValue === 0 || $newValue === []) {
$this->cache->forget($key);
} elseif ($expiresAfter) {
$this->cache->put($key, $newValue, $expiresAfter);
} else {
$this->cache->put($key, $newValue);
Expand Down
7 changes: 6 additions & 1 deletion src/Signal.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ public function __construct(
public function middleware()
{
return [
new WithoutOverlappingMiddleware($this->storedWorkflow->id, WithoutOverlappingMiddleware::WORKFLOW),
new WithoutOverlappingMiddleware(
$this->storedWorkflow->id,
WithoutOverlappingMiddleware::WORKFLOW,
0,
15
),
];
}

Expand Down
4 changes: 2 additions & 2 deletions tests/Unit/ExceptionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ public function testMiddleware(): void
));

$middleware = collect($exception->middleware())
->map(static fn ($middleware) => is_object($middleware) ? get_class($middleware) : $middleware)
->values();

$this->assertCount(1, $middleware);
$this->assertSame([WithoutOverlappingMiddleware::class], $middleware->all());
$this->assertSame(WithoutOverlappingMiddleware::class, get_class($middleware[0]));
$this->assertSame(15, $middleware[0]->expiresAfter);
}

public function testExceptionWorkflowRunning(): void
Expand Down
92 changes: 88 additions & 4 deletions tests/Unit/Middleware/WithoutOverlappingMiddlewareTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public function testAllowsOnlyOneWorkflowInstance(): void
});
});

$this->assertSame(0, Cache::get($middleware1->getWorkflowSemaphoreKey()));
$this->assertNull(Cache::get($middleware1->getWorkflowSemaphoreKey()));
$this->assertNull(Cache::get($middleware1->getActivitySemaphoreKey()));
}

Expand Down Expand Up @@ -111,7 +111,7 @@ public function testAllowsMultipleActivityInstances(): void
});

$this->assertNull(Cache::get($middleware1->getWorkflowSemaphoreKey()));
$this->assertSame(0, count(Cache::get($middleware1->getActivitySemaphoreKey())));
$this->assertSame(0, count(Cache::get($middleware1->getActivitySemaphoreKey(), [])));
}

public function testUnknownTypeDoesNotCallNext(): void
Expand Down Expand Up @@ -290,6 +290,41 @@ public function testUnlockActivityReturnsFalseWhenOtherActivityKeyExists(): void
$this->assertSame([], Cache::get($middleware->getActivitySemaphoreKey(), []));
}

public function testUnlockActivityAppliesTtlWhenExpiresAfterIsConfigured(): void
{
$job = new \stdClass();
$job->key = 'test-activity-key';

$lock = $this->mock(Lock::class, static function (MockInterface $mock) {
$mock->shouldReceive('get')
->once()
->andReturn(true);
$mock->shouldReceive('release')
->once();
});

$cache = $this->mock(Repository::class, static function (MockInterface $mock) use ($lock, $job) {
$mock->shouldReceive('lock')
->once()
->andReturn($lock);
$mock->shouldReceive('get')
->with('laravel-workflow-overlap:1:activity', [])
->andReturn([$job->key]);
$mock->shouldReceive('forget')
->with('laravel-workflow-overlap:1:activity')
->once();
$mock->shouldReceive('forget')
->with($job->key)
->once();
});

$middleware = new WithoutOverlappingMiddleware(1, WithoutOverlappingMiddleware::ACTIVITY, 0, 60);

$result = $middleware->unlock($job);

$this->assertTrue($result);
}

public function testUnlockActivityRetriesOnLockFailure(): void
{
$job = new \stdClass();
Expand All @@ -315,8 +350,8 @@ public function testUnlockActivityRetriesOnLockFailure(): void
$mock->shouldReceive('get')
->with('laravel-workflow-overlap:1:activity', [])
->andReturn([$job->key]);
$mock->shouldReceive('put')
->with('laravel-workflow-overlap:1:activity', [])
$mock->shouldReceive('forget')
->with('laravel-workflow-overlap:1:activity')
->once();
$mock->shouldReceive('forget')
->with($job->key)
Expand Down Expand Up @@ -426,4 +461,53 @@ public function testCompareAndSetReturnsFalseOnValueMismatch(): void
$this->fail('Should not call next when CAS value mismatch');
});
}

public function testActivityLockAppliesTtlToSemaphoreKeyWhenConfigured(): void
{
$job = new \stdClass();

$lock = $this->mock(Lock::class, static function (MockInterface $mock) {
$mock->shouldReceive('get')
->once()
->andReturn(true);
$mock->shouldReceive('release')
->once();
});

$cache = $this->mock(Repository::class, static function (MockInterface $mock) use ($lock) {
$mock->shouldReceive('get')
->with('laravel-workflow-overlap:1:workflow', 0)
->once()
->andReturn(0);
$mock->shouldReceive('get')
->with('laravel-workflow-overlap:1:activity', [])
->twice()
->andReturn([], []);
$mock->shouldReceive('lock')
->with('laravel-workflow-overlap:1', 5)
->once()
->andReturn($lock);
$mock->shouldReceive('put')
->withArgs(static fn ($key, $value, $ttl): bool => $key === 'laravel-workflow-overlap:1:activity'
&& is_array($value)
&& count($value) === 1
&& $ttl === 60)
->once();
$mock->shouldReceive('put')
->withArgs(
static fn ($key, $value, $ttl): bool => str_starts_with(
$key,
'laravel-workflow-overlap:1:activity:'
)
&& $value === 1
&& $ttl === 60
)
->once();
});

$middleware = new WithoutOverlappingMiddleware(1, WithoutOverlappingMiddleware::ACTIVITY, 0, 60);

$this->assertTrue($middleware->lock($job));
$this->assertTrue(isset($job->key));
}
}
4 changes: 2 additions & 2 deletions tests/Unit/SignalTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ public function testMiddleware(): void
$signal = new Signal(new StoredWorkflow());

$middleware = collect($signal->middleware())
->map(static fn ($middleware) => is_object($middleware) ? get_class($middleware) : $middleware)
->values();

$this->assertCount(1, $middleware);
$this->assertSame([WithoutOverlappingMiddleware::class], $middleware->all());
$this->assertSame(WithoutOverlappingMiddleware::class, get_class($middleware[0]));
$this->assertSame(15, $middleware[0]->expiresAfter);
}

public function testSignalWorkflowRunning(): void
Expand Down