Set cache durations based on entries' expiry dates

[brandonkelly]

Description

When entries with expiry dates are fetched/referenced while element caching is active (e.g. for {% cache %} tags or GraphQL query caching), Craft will now keep track of the closest expiry date.

When cache info collection is complete, if the closest expiry date is closer to the current time than the cacheDuration config setting, the resulting cache will be set to expire on the expiry date, rather than the default cache duration.

A new craft\base\ExpirableElementInterface class has been added in case any other element types want to participate as well (e.g. Commerce products).

The old element cache tag-related methods on craft\services\Elements have been deprecated, and replaced by new “info” methods:

Deprecated Method	New Method
getIsCollectingCacheTags()	getIsCollectingCacheInfo()
startCollectingCacheTags()	startCollectingCacheInfo()
stopCollectingCacheTags()	stopCollectingCacheInfo()

Note
stopCollectingCacheInfo()’s return data is different from stopCollectingCacheTags(). If no cache tags were registered while the element cache collection was active, it will return [null, null]. Otherwise it will return an array that contains a TagDependency object and either an integer or null, which represents the max recommended cache duration if known.

If any plugins are using element caching for their own purposes, they’re encouraged to start calling the new craft\services\Elements methods whenever they’re comfortable requiring craftcms/cms: ^4.3.0 or later.

Related

• Make expiryDate bust cache #8525

[linear]

DEV-988 Set cache durations based on entries’ expiry dates