[6.x] Warm paginated pages with static:warm command

[duncanmcclean]

This pull request implements warming of paginated pages into the static:warm command. This will be especially useful for larger sites which have lots of pagination pages since right now, only the first page is warmed.

How it works

Under the hood, Statamic's Cache middleware checks if there's a paginator instance being "blinked". If there is, a header is added to the response containing the URL of the next paginated page.

This header then gets picked up by the static:warm command and triggers the paginated page to be warmed, which happens in a loop until there's no more paginated pages to warm.

The implementation is inspired by statamic/ssg#140.

Warning

Due to the nature of the setting, this feature will only work when 'ignore_query_strings' => false.

It will also only pick up paginated pages when the first page isn't already cached (unless you're using the background re-caching feature).

[sylvesterdamgaard]

@duncanmcclean Can we add query string sorting as well?

Take a look at the original code example i posted in the private channel.

This version takes a few more options into account:

• ignore_query_strings
• allowed_query_strings
• disallowed_query_strings

public function getUrl(Request $request)
    {
        $url = $request->getUri();

        if ($this->config('ignore_query_strings')) {
            $url = explode('?', $url)[0];
        }

        $parts = parse_url($url);

        if (isset($parts['query'])) {
            parse_str($parts['query'], $query);

            if ($this->config('sort_query_strings')) {
                $query = Arr::sort($query);
            }

            if ($allowedQueryStrings = $this->config('allowed_query_strings')) {
                $query = array_intersect_key($query, array_flip($allowedQueryStrings));
            }

            if ($disallowedQueryStrings = $this->config('disallowed_query_strings')) {
                $disallowedQueryStrings = array_flip($disallowedQueryStrings);
                $query = array_diff_key($query, $disallowedQueryStrings);
            }

            $url = $parts['scheme'] . '://' . $parts['host'] . '?'. http_build_query($query);
        }

        return $url;
    }

[duncanmcclean]

@sylvesterdamgaard I've split out the "allowed query parameters" part into a separate PR, where I've also implemented the sorting/disallowed options: #10701

[jasonvarga]

Gonna mark this as a draft. My previous review somehow got marked as resolved but I think it's still valid.

This unfortunately only works the first time.

Run php please static:warm, you'll see the paginated pages in the output.

Run it again, they won't be there.

This might not be an issue after #9396

[sdussaut]

Hi!
That would be a great thing to be able to warm paginated pages. Is there any estimated time on when this would land?
Thanks!

[duncanmcclean]

Sorry, we don't have an ETA for reviewing/merging this pull request. We'll get to it when we can.

In the meantime, you can pull this PR into your project with a composer patch.

[jasonvarga]

This needs to target master and be updated appropriately since #9396 has merged.