spatie / laravel-short-schedule

Schedule artisan commands to run using a sub-minute frequency

Stars
247

Schedule artisan commands to run at a sub-minute frequency

Latest Version on Packagist
Tests
Psalm
Total Downloads

Laravel's native scheduler allows you to schedule Artisan commands to run every minute.

If you need to execute something with a higher frequency, for example every second, than you've come to the right package. With laravel-short-schedule installed, you can do this:

// in app\Console\Kernel.php

protected function shortSchedule(\Spatie\ShortSchedule\ShortSchedule $shortSchedule)
{
    // this command will run every second
    $shortSchedule->command('artisan-command')->everySecond();
    
    // this command will run every 30 seconds
    $shortSchedule->command('another-artisan-command')->everySeconds(30);
    
    // this command will run every half a second
    $shortSchedule->command('another-artisan-command')->everySeconds(0.5);
}

Are you a visual learner?

In this video you'll see a demonstration of the package.

Want to know how it works under the hood? Then watch this video.

Finally, there's this video that shows how the package is tested. You'll learn how you can test ReactPHP powered loops.

These videos are also part of the Laravel Package Training.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/laravel-short-schedule

In your production environment you can start the short scheduler with this command

php artisan short-schedule:run

You should use a process monitor like Supervisor to keep this task going at all times, and to automatically start it when your server boots. Whenever you change the schedule, you should restart this command.

Lumen

Before you can run the php artisan short-schedule:run command in your Lumen project, you should make a copy of the ShortScheduleRunCommand into your app/Commands folder:

cp ./vendor/spatie/laravel-short-schedule/src/Commands/ShortScheduleRunCommand.php ./app/Console/Commands/ShortScheduleRunCommand.php

Next, edit the new ShortScheduleRunCommand.php file, and change the namespace from namespace Spatie\ShortSchedule\Commands; to namespace App\Console\Commands; and you're good to go!

Usage

In app\Console\Kernel you should add a method named shortSchedule.

// in app\Console\Kernel.php

protected function shortSchedule(\Spatie\ShortSchedule\ShortSchedule $shortSchedule)
{
    // this artisan command will run every second
    $shortSchedule->command('artisan-command')->everySecond();
}

Specify the amount of seconds

You can run an artisan command every single second like this:

$shortSchedule->command('artisan-command')->everySecond();

You can specify a specific amount of seconds using everySeconds

$shortSchedule->command('artisan-command')->everySeconds(30);

You can even schedule tasks at sub-second frequency. This task will run every half a second.

$shortSchedule->command('artisan-command')->everySeconds(0.5);

Scheduling shell commands

Use exec to schedule a bash command.

$shortSchedule->bash('bash-command')->everySecond();

Preventing overlaps

By default, a scheduled command will run, even if the previous invocation is still running.

You can prevent that by tacking on withoutOverlapping

$shortSchedule->command('artisan-command')->everySecond()->withoutOverlapping();

Between time constraints

Limit the task to run between start and end times.

$shortSchedule->command('artisan-command')->between('09:00', '17:00')->everySecond();

It is safe use overflow days. In this example the command will run on every second between 21:00 and 01:00

$shortSchedule->command('artisan-command')->between('21:00', '01:00')->everySecond();

Truth test constraints

The command will run if the given closure return a truthy value. The closure will be evaluated at the same frequency the command is scheduled. So if you schedule the command to run every second, the given closure will also run every second.

$shortSchedule->command('artisan-command')->when(fn() => rand() %2)->everySecond();

Environment constraints

The command will only run on the given environment.

$shortSchedule->command('artisan-command')->environment('production')->everySecond();

You can also pass an array:

$shortSchedule->command('artisan-command')->environment(['staging', 'production'])->everySecond();

Composite constraints

You can use all constraints mentioned above at once. The command will only execute if all the used constraints pass.

$shortSchedule
  ->command('artisan-command')
  ->between('09:00', '17:00')
  ->when($callable)
  ->everySecond();

Maintenance Mode

Commands won't run whilst Laravel is in maintenance mode. If you would like to force a command to run in maintenance mode you can use the runInMaintenanceMode method.

$shortSchedule->command('artisan-command')->everySecond()->runInMaintenanceMode();

Running Tasks On One Server

Limit commands to only run on one server at a time.

$shortSchedule->command('artisan-command')->everySecond()->onOneServer();

Events

Executing any code when responding to these events is blocking. If your code takes a long time to execute, all short scheduled jobs will be delayed. We highly recommend to put any code you wish to execute in response to these events on a queue.

Spatie\ShortSchedule\Events\ShortScheduledTaskStarting

This event will be fired right before a task will be started. It has these public properties:

  • command: the command string that will be executed
  • process: the instance of Symfony\Component\Process\Process that will be used to execute the command

Spatie\ShortSchedule\Events\ShortScheduledTaskStarted

This event will be fired right before a task has been started. It has these public properties:

  • command: the command string that is being executed
  • process: the instance of Symfony\Component\Process\Process that is executing the command

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.