stuartcusackie/statamic-cache-requester

Artisan commands that queue up entry and glide urls for retrieval, which engages the caches and makes first time loads much quicker.

Maintainers

Details

github.com/stuartcusackie/statamic-cache-requester

Source

Issues

Installs: 157

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 1

Forks: 0

Open Issues: 1

1.1.2 2023-11-03 14:10 UTC

Requires

MIT 611a93b1da7441d5d17979e64a1dd518e745faae

This package is auto-updated.

Last update: 2024-05-03 15:33:32 UTC

README

Artisan commands that queue up entry and glide urls for retrieval, which engages the caches and makes first time loads much quicker. Note that this package provides no benefict to Statamic applications that save cached images, i.e. cache => true.

This package can do a few things:

  1. Queue up all entry urls for retrieval which automatically engages the static cache, making first time loads quicker. UPDATE: Statamic actually has a built in function for this which should be preferable - static:warm
  2. Search for all image and picture sources within your entries and queue them up for a separate retrieval to initiate Glide generation. This means that all images and responsive variants will be pre-generated for your first visitor. This is particularly useful when you have lots of responsive image variants or if you are using Spatie's Statamic Responsive Images package. It can help to avoid server crashes for image heavy websites where Glide has a lot of processing to perform.
  3. Listens for EntrySaved events and automatically queues the entry's url for image requests.

CAUTION: Glide image manipulation can take a lot of work, especially when using responsive image variants and jpeg fallbacks. For example, a site using Spatie's responsive images addon could have 10 sizes and 2 formats per image. If this site has 1000 images then 20,000 variants will need to be manipulated by Glide. Keep an eye on your CPU usage, especially if using a hosting server that limits CPU (e.g. AWS-EC2).

Installation

composer require stuartcusackie/statamic-cache-requester

php please vendor:publish --tag=statamic-cache-requester-config

Check the config file for special features such as queue configuration and lightbox image request generation.

Commands

php artisan requester:entries

If you are using Static caching then it's a good idea to add this command to your deploy script (e.g. Forge). Deployments clear the static cache so this will rebuild it for all entries afterwards. 

php artisan requester:images

You will usually only run this command once on initial deployment of the site, or after any major restructuring of asset filenames and folders. I do not recommend adding this to your deployment script as images rarely change. 

php artisan requester:clear

Clears the configured queue. Be careful if using the default queue or a shared queue as all jobs will be removed.

Queues

This package utilises a Redis queue called cacherequester. You can configure the package to use whatever queue and connection that you prefer but it's probably best not to use a shared queue or the default queue.

The queue can be ran manually with this command:

php artisan queue:work redis --queue=cacherequester

I recommend using a Laravel Forge worker, or something similar, as workers are prone to exit prematurely when using the command line.

Todo

  • Add terms to entry requests
  • Add multisite functionality
  • Experiment with EntryCreated events to process images