Laravel Idea for PhpStorm - Full-featured IDE for productive artisans!

Laravel Debounce

Last updated on by

Laravel Debounce image

Laravel Debounce is a package created by Zakaria Aktouf which is designed to prevent the repeated execution of specific actions within a defined timeframe. It is particularly useful in situations where an action (e.g., sending a notification, running a command, or job dispatch) might be triggered multiple times unintentionally. The package ensures that only the first invocation of the action within a specified period is executed, effectively debouncing the action.

To install this package use composer:

composer require zackaj/laravel-debounce

You can then start debouncing existing jobs, notifications and commands using the Debounce Facade without any additional setup. For example:

use Zackaj\LaravelDebounce\Facades\Debounce;
 
Debounce::job(
job: new GenerateTranscript(),
delay: 5, // in seconds
uniqueKey: auth()->user()->id, // debounce per Job class name + uniqueKey
sync: false, // Optional, job will be fired to the queue
);
 
Debounce::notification(
notifiables: auth()->user(),
notification: new TranscriptProcessed(),
delay: 5,
uniqueKey: auth()->user()->id,
sendNow: false,
);

Alternatively, you can debounce directly from the job, notification or command instances without using a facade.

(new GenerateTranscript())->debounce(...);
 
(new TranscriptProcessed())->debounce(...);

You can also generate debounceables using Artisan make commands. For example:

php artisan make:debounce-job GenerateTranscript
php artisan make:debounce-notification TranscriptProcessed

which for a Job would generate something like:

<?php
 
namespace App\Jobs;
 
use Carbon\Carbon;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Queue\Queueable;
use Zackaj\LaravelDebounce\DebounceJob;
 
class GenerateTranscript extends DebounceJob implements ShouldQueue
{
use Queueable;
 
/**
* Create a new job instance.
*/
public function __construct()
{
//
}
 
/**
* Execute the job.
*/
public function handle(): void
{
// $this->getReport()->occurrences;
}
 
public function before(): void
{
//run before dispatching the job
}
public function after(): void
{
//run after dispatching the job
}
 
public function getLastActivityTimestamp(): ?Carbon
{
//manually set the last activity to debounce from
return null;
}
}

Other Key Features

  • Report Tracking with information like the ip address and authenticated user per request
  • before/after Hooks allow you to run some code before and/or after firing the debounceables
  • Debounce from custom timestamp
  • Integrates with Laravel Telescope so you can see the debouncer live in the queues tab and to debug any failures
  • Debounce commands from the CLI using the debounce:command Artisan command. e.g. php artisan debounce:command {delay} {uniqueKey} {signature*}

Learn more about this package and view the source code on Github.

Yannick Lyn Fatt photo

Research Assistant at Laravel News and Full stack web developer.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Laravel Idea for PhpStorm logo

Laravel Idea for PhpStorm

Ultimate PhpStorm plugin for Laravel developers, delivering lightning-fast code completion, intelligent navigation, and powerful generation tools to supercharge productivity.

Laravel Idea for PhpStorm
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Handling Request Data Presence in Laravel image

Handling Request Data Presence in Laravel

Read article
First Factor One-Time Passwords for Laravel with OTPZ image

First Factor One-Time Passwords for Laravel with OTPZ

Read article
Managing Request Host Information in Laravel image

Managing Request Host Information in Laravel

Read article
Tim Leland: URL Shorteners, browser extensions, and more image

Tim Leland: URL Shorteners, browser extensions, and more

Read article
HTTP Method Verification in Laravel image

HTTP Method Verification in Laravel

Read article
Packistry is a Self-hosted Composer Repository Made with Laravel image

Packistry is a Self-hosted Composer Repository Made with Laravel

Read article