Batch static cache purge tags

[timkelty]

Collect static-cache purge tags until the request ends so file-heavy operations send a single gateway request instead of one request per file, while preserving explicit purgeTags() behavior. Fire the purge event once per send, defer overflow-tag handling until send time, and include saved-element fetch URLs when revalidation is needed.

[Copilot]

Pull request overview

This PR batches static-cache purge tags and associated element context until the end of the request, reducing gateway calls during file-heavy operations while firing the purge event once per batch.

Changes:

• Collect purge tags (and elements/fetch URLs) across operations and send them once via a single sendPurgeTagsRequest() call.
• Update PurgeEvent to carry elements (array) instead of a single element, and adjust docs/tests accordingly.
• Update CDN invalidation to enqueue purge tags (addPurgeTags) rather than triggering an immediate purge per file.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/unit/StaticCacheTest.php	Updates unit tests to reflect batched sending and PurgeEvent::$elements.
src/StaticCache.php	Implements purge batching, defers overflow handling until send time, and triggers the purge event once per batch.
src/fs/Fs.php	Switches CDN invalidation to enqueue purge tags for batching.
src/events/PurgeEvent.php	Changes event payload from element to elements array.
README.md	Updates documentation for the new batched purge event semantics and elements payload.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

src/StaticCache.php:121

• The pending purge buffers (tagsToPurge, elementsToPurge, fetchUrls) are never cleared after the end-of-request send attempt. In long-running processes (e.g. queue daemon/worker), the StaticCache component can live across multiple requests/jobs, so this can cause stale tags/elements/URLs to be included in later purges and retain element objects in memory longer than necessary. Consider clearing these collections in a finally block after attempting to send (whether it succeeds, fails, or is canceled by the event).

        Craft::$app->onAfterRequest(function() {
            if ($this->tagsToPurge->isNotEmpty()) {
                try {
                    $this->sendPurgeTagsRequest(
                        $this->tagsToPurge,

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

README.md:226

• The README says the before-purge event fires only for the “collected batch”, but sendPurgeTagsRequest() triggers StaticCache::EVENT_BEFORE_PURGE for any purge operation (including direct purgeTags() calls). It’s also worth calling out here that the event no longer includes element context.

The `StaticCache::EVENT_BEFORE_PURGE` event fires immediately before each tag purge, including the collected end-of-request batch. Listeners can modify its `tags` or cancel the purge.

src/events/PurgeEvent.php:14

• The PR description mentions firing the purge event with its associated elements, but this PR removes element context from PurgeEvent entirely. If that’s intentional, the PR description should be updated to match the new API/behavior; otherwise, consider reintroducing element information in the event payload.

class PurgeEvent extends CancelableEvent
{
    /**
     * @var StaticCacheTag[] The static cache tags being purged.
     */
    public array $tags = [];
}

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.