Follow-up to / Helper for #2407195: Move attachment processing to services and per-type response subclasses →
renderRoot() returns a 'string', but that is wrong, because this is the root of the tree and hence we must take cacheable meta data into account.
Before:
$this->renderer->renderRoot($html);
$content = $this->renderCache->getCacheableRenderArray($html);
After:
$content = $this->renderer->renderRootReplacementNeedsAName($html);
If someone still needs to use the markup directly, they can do:
print $content['#markup']
on their own risk.
renderRootReplacementNeedsAName()) and add it. Add documentation to renderRoot() about the new method as well as about the workaround above that is required for it to be cacheable.renderPlain() already to renderPlain() (i.e. simple renderables with no assets or caching requirements).renderRoot().- None
- New method returns a cacheable render array.
BETA EVAL:
It is a major bug, because if you get back a string, you expect to use that => cacheability metadata lost => security issues.
Needs work
11.0 🔥
render system
Enhances developer experience.
A change record needs to be drafted before an issue is committed. Note: Change records used to be called change notifications.
Changes an existing API or subsystem. Not backportable to earlier major versions, unless absolutely required to fix a critical bug.
Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.
There is consensus among core maintainers that this is a major issue. Only core committers should add this tag.
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
Quick idea,
would it make sense to return a markup object with cacheable metadata, instead of a render element?
$markup = $renderer->renderRoot($element);
assert($markup instanceof MarkupInterface);
assert($markup instanceof CacheableDependencyInterface);
Don't have the issues to hand but there are a couple of old and new issues this should be linked to - not duplicates just tackling the same area. We still need to do this one.