Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Updated: Comment #0
Problem/Motivation
Tour module loads all tour config entities on every page and then filters them down to those required for that page. As these are relatively static objects they should be cached per page so subsequent views of the page don't require the full round trip again. This code existed in the original patch but was identified as 'premature optimisation' and subsequently removed.
Proposed resolution
Add back the per-page caching of tours and profile the performance improvement.
Remaining tasks
Write the patch
Add tests
Profile it
Review
User interface changes
None
API changes
None
Related Issues
#1744302: [meta] Resolve known performance regressions in Drupal 8
Comments
Comment #1
tim.plunkettThis would be partially mitigated by #1918768: Refactor tour module to use routes instead of paths, but still worth doing.
Comment #2
moshe weitzman CreditAttribution: moshe weitzman commentedI don't think we want to casually add more caching to app. To do so, we need benchmarks to show that Drupal is slow without the patch, and fast after it. And then we need to talk about why tour entities are special and so on.
Comment #3
larowlanThe loading isn't the concern, its loading them all, filtering to those relevant to the page and then rendering those. But yeah agreed profile first. Will need to simulate more tours though as we've still only got a few in core.
Comment #4
tim.plunkettAgreed we need profiling either way.
Tour is special because unlike other cases, we cannot use entity.query to do the filtering before loading (see the issue I liked before for why).
In most other cases, we try to pass a set of IDs to loadMultiple() first.
And yeah, also rendering.
Comment #17
quietone CreditAttribution: quietone at PreviousNext commentedThis extension is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.
This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.