eva_entity_view does not return a renderable array containing cache information, so cache tags do not bubble up from View to Node

Problem/Motivation

I noticed an EVA View of related content was not updating when new nodes were added or existing nodes were edited or removed. The View was using a cache tag based caching approach, so the node_list cache context should have been invalidated whenever a node was altered.

I guessed that the View was being cached correctly, but that EVA wasn't passing the cache metadata to the node, so the page cache wasn't being invalidated when a node was altered.

Proposed resolution

Changing

$element = $view->executeDisplay($info['display']);

in eva_entity_view() to:

$element = $view->buildRenderable($info['display']);

Results in the cache metadata being included as part of the renderable array, and this fixes my issue.

Before:

After:

Relevant docs

https://api.drupal.org/api/drupal/core%21modules%21views%21src%21ViewExe...

Builds the render array outline for the given display.

This render array has a #pre_render callback which will call ::executeDisplay in order to actually execute the view and then build the final render array structure.

https://api.drupal.org/api/drupal/core%21modules%21views%21src%21ViewExe...