LinkCollection loses cacheability metadata when adding a link using \Drupal\jsonapi\JsonApiResource\LinkCollection::withLink()
Adding a new link actually creates a new collection. If we added any cacheability metadata to the collection, that will be lost on the returned new collection.
pseudo code
$link1 = new Link(cache_tag_1)
$link2 = new Link(cache_tag_2)
$collection = new LinkCollection([cache_tag_1]);
$collection->addCacheTags([cache_tag_A, cache_tag_B]);
$collection = $collection->withLink($link2);
// $collection should have cache_tag_1, cache_tag_2, cache_tag_A, cache_tag_B but only keeps cache_tag_1, cache_tag_2
Similar to
public function withLink(string $key, ResourceLink $new_link): ResourceLinkCollection {
$merged = $this->links;
if (isset($merged[$key])) {
if (ResourceLink::compare($merged[$key], $new_link) === 0) {
$merged[$key] = ResourceLink::merge($merged[$key], $new_link);
}
}
else {
$merged[$key] = $new_link;
}
$collection = new static($merged);
// We need to keep existing cache metadata added to the collection object
// for e.g. absent links.
$collection->addCacheTags($this->getCacheTags())
->addCacheContexts($this->getCacheContexts())
->mergeCacheMaxAge($this->getCacheMaxAge());
return $collection;
}
MR + tests.
None.
None.
None.
None.
None.
Active
11.0 🔥
jsonapi.module
Oopsie.
ResourceLinkCollection is not cacheable.
tldr: Coming from 📌 Disallow deleting an XB-enabled content entity if it's currently the homepage Active where we are using similar code to jsonapi for resource links + collection, but we are adding cacheability there, which is not a feature in jsonapi. I thought we were replicating a bug from jsonapi, while we were introducing a bugged feature 🥸