Laracon 2024 baby is born: Warmable, a cache warmer for Laravel

[henzeb]

Almost two weeks ago, @timacdonald had his talk. He showed us a technique where you 'warm up' the cache using a cron job and a simple invokable class. He was hoping someone would build something that would make this a whole lot easier.

Well, here it is.

https://packagist.org/packages/henzeb/warmable-laravel

Out of the box, it is a queueable Job. So when a default is set, it will dispatch itself as a job when the cache entry is missing. And this way scheduling it will be just like any other job. This also means you can do everything with it that you can do with a regular job. so if you want middleware, go ahead. If you want to retry, go ahead. Change connection or queue,? go ahead!

It also comes with events which you can also customize. So if you want a realtime app using Livewire/Volt/Reverb, you can build one.

Below an example of a few of its features:

use Henzeb\Warmable\Illuminate\Warmable;

class LastDaysUserStats extends Warmable
{
    protected function ttl(): Carbon
    {
        return now()->endOfDay();
    }

    protected function gracePeriod(): DateTimeInterface
    {
        return $this->ttl()->addDay();
    }

    /**
     * Warmable allows dependency injection here.
     * When using injection using the `with` method,
     * Warmable automatically creates a unique key
     * No need to create your own logic, it's unique
     * for every $id you put in there.
     */
    protected function warmable(int $id): string
    {
        sleep(1);
        return "user stats from $id";
    }
}

And in your routes file it's something like:

Route::get('/{id}', function (LastDaysUserStats $stats, int $id) {

    return  $stats->with($id)->get('No user stats yet...');
});

There is a vanilla warmable as well for users that do not use Laravel, or wish to use it in other projects. It is implementing the
PSR-16 cache interface, so you can use every caching mechanism you can think of, and if not, one can implement a wrapper, and you still can use every caching mechanism you can think of.

https://packagist.org/packages/henzeb/warmable

I hope everything is documented well, not my favorite part of developing something new. Any suggestions to make it better are welcome.