Support the ongoing development of Laravel.io →

A package to schedule Artisan commands at sub-minute frequencies

24 Jun, 2020 2 min read 103 views

Laravel's native scheduler allows you to schedule Artisan commands to run every minute. For a project I'm working on I needed to schedule a command to run every few seconds. I found a good solution to do this using an ReactPHP powered event loop. Because this solution could be helpful for others as well, I decided to package it up.

Using the laravel-short-schedule package, you can schedule artisan commands to run every second or even lower frequencies. In this blogpost I'd like to introduce the package.

Scheduling commands with sub-minute frequencies

If you need to execute something with a higher frequency, you should add method named shortSchedule to app\Console\Kernel and let it accept an instance of \Spatie\ShortSchedule\ShortSchedule. Inside this method you can schedule your commands. Here's an example:

// 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);
}

In addition to Artisan commands, you can also schedule bash commands.

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

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();

You can also add some constraints. Here the artisan command will only be executed every second between 09:00 and 17:00.

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

How the package works under the hood

The package uses a ReactPHP event loop to schedule commands. I have recorded a video where I explain in detail how the package works, and another video where I explain how it is tested. I'm pretty sure everyone can learn something from how the package is built.

These videos are part of the Laravel Package Training. The course will teach you how to create quality packages and contains source dives of a bunch of other packes too.

Another way seeing the videos is by becoming a sponsor of Spatie. Both videos are available on the video section at spatie.be.

Along with those two videos, I recorded a third one that shows how the package can be used. You can see that one here:

In closing

Do you want to know more about the package? Head over to the readme on GitHub. There are a few options available, that were not mentioned in this blogpost.

This package isn't the first one my team and have built. Take a look at this long list of packages we open released previously.

Last updated 4 months ago.
5
Like this article? Let the author know and give them a clap!

Other articles you might like

November 23rd 2022

Mass Assignment Vulnerabilities and Validation in Laravel

Introduction The following article is an excerpt from my ebook Battle Ready Laravel, which is a guid...

Read article
October 28th 2022

How to build your next PHP project with a touch of AI

What is AI (Artificial Intelligence)? Artificial intelligence (or AI for short) involves using comp...

Read article
October 6th 2022

Laravel Package Development with Local Composer Dependencies

Introduction If you've read any of my previous blog posts, you'll know that I like contributing to o...

Read article

We'd like to thank these amazing companies for supporting us

Your logo here?

Laravel.io

The Laravel portal for problem solving, knowledge sharing and community building.

© 2022 Laravel.io - All rights reserved.