8000 Add deleteWhen for throttle exceptions job middleware by moshe-autoleadstar · Pull Request #55718 · laravel/framework · GitHub
[go: up one dir, main page]

Skip to content

Add deleteWhen for throttle exceptions job middleware #55718

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.

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
merged 7 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions src/Illuminate/Queue/Middleware/ThrottlesExceptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ class ThrottlesExceptions
*/
protected $whenCallback;

/**
* The callbacks that determine if the job should be deleted.
*
* @var callable[]
*/
protected array $deleteWhenCallbacks = [];

/**
* The prefix of the rate limiter key.
*
Expand Down Expand Up @@ -111,6 +118,10 @@ public function handle($job, $next)
report($throwable);
}

if ($this->shouldDelete($throwable)) {
return $job->delete();
}

$this->limiter->hit($jobKey, $this->decaySeconds);

return $job->release($this->retryAfterMinutes * 60);
Expand All @@ -130,6 +141,38 @@ public function when(callable $callback)
return $this;
}

/**
* Add a callback that should determine if the job should be deleted.
*
* @param callable|string $callback
* @return $this
*/
public function deleteWhen(callable|string $callback)
{
$this->deleteWhenCallbacks[] = is_string($callback)
? fn (Throwable $e) => $e instanceof $callback
: $callback;

return $this;
}

/**
* Run the skip / delete callbacks to determine if the job should be deleted for the given exception.
*
* @param Throwable $throwable
* @return bool
*/
protected function shouldDelete(Throwable $throwable): bool
{
foreach ($this->deleteWhenCallbacks as $callback) {
if (call_user_func($callback, $throwable)) {
return true;
}
}

return false;
}

/**
* Set the prefix of the rate limiter key.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ public function handle($job, $next)
report($throwable);
}

if ($this->shouldDelete($throwable)) {
return $job->delete();
}

$this->limiter->acquire();

return $job->release($this->retryAfterMinutes * 60);
Expand Down
45 changes: 45 additions & 0 deletions tests/Integration/Queue/ThrottlesExceptionsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ public function testCircuitResetsAfterSuccess()
$this->assertJobWasReleasedWithDelay(CircuitBreakerTestJob::class);
}

public function testCircuitCanSkipJob()
{
$this->assertJobWasDeleted(CircuitBreakerSkipJob::class);
}

protected function assertJobWasReleasedImmediately($class)
{
$class::$handled = false;
Expand Down Expand Up @@ -82,6 +87,27 @@ protected function assertJobWasReleasedWithDelay($class)
$this->assertFalse($class::$handled);
}

protected function assertJobWasDeleted($class)
{
$class::$handled = false;
$instance = new CallQueuedHandler(new Dispatcher($this->app), $this->app);

$job = m::mock(Job::class);

$job->shouldReceive('hasFailed')->once()->andReturn(false);
$job->shouldReceive('delete')->once();
$job->shouldReceive('isDeleted')->andReturn(true);
$job->shouldReceive('isReleased')->twice()->andReturn(false);
$job->shouldReceive('isDeletedOrReleased')->once()->andReturn(true);
$job->shouldReceive('uuid')->andReturn('simple-test-uuid');

$instance->call($job, [
'command' => serialize($command = new $class),
]);

$this->assertTrue($class::$handled);
}

protected function assertJobRanSuccessfully($class)
{
$class::$handled = false;
Expand Down Expand Up @@ -314,6 +340,25 @@ public function middleware()
}
}

class CircuitBreakerSkipJob
{
use InteractsWithQueue, Queueable;

public static $handled = false;

public function handle()
{
static::$handled = true;

throw new Exception;
}

public function middleware()
{
return [(new ThrottlesExceptions(2, 10 * 60))->deleteWhen(Exception::class)];
}
}

class CircuitBreakerSuccessfulJob
{
use InteractsWithQueue, Queueable;
Expand Down
0