Skip to content

Conversation

igorwulff
Copy link
Contributor

@igorwulff igorwulff commented Jul 30, 2025

This function call is relatively expensive when $elements has the full layout in it. Especially the PageCache module is calling this function a lot from the following places:

  • Magento\PageCache\Model\Layout\LayoutPlugin
  • Magento\PageCache\Observer\ProcessLayoutRenderElement

On my local machine I've seen the impact to be anywhere between 20-40 milliseconds, when the page has been loaded a few times to warm up cache (config, block, layout, etc...), but FPC is circumvented.

We could also opt to move this to the PageCache module, but I think it is ok to optimize this within the Layout class within the framework.

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Cache the results of isCacheable calls to improve performance #40156: Cache the results of isCacheable calls to improve performance

This function call is relatively expensive when $elements has the full layout in it. Especially the PageCache module is calling this function a lot from the following places:
- Magento\PageCache\Model\Layout\LayoutPlugin
- Magento\PageCache\Observer\ProcessLayoutRenderElement

On my local machine I've seen the impact to be anywhere between 20-40 milliseconds, when the page has been loaded a few times to warm up cache (config, block, layout, etc...), but FPC is circumvented. 

We could also opt to move this to the PageCache module, but I think it is ok to optimize this within the Layout class within the framework.
Copy link

m2-assistant bot commented Jul 30, 2025

Hi @igorwulff. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@igorwulff
Copy link
Contributor Author

@magento run all tests

Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ The change looks good to me.

The method you're improving, originally did not look like a good example of code, however.

I was considering whether ?bool wouldn't be better than bool|null but there's no functional difference. I'm personally more towards ?bool

if ($blockName !== false && $this->structure->hasElement($blockName)) {
$cacheable = false;
break;
if (!isset($this->isCacheableCache)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not using use comparator here? $this->isCacheableCache === null
We are sure that isCacheableCache property exists, so we can avoid this check

@ArjenMiedema
Copy link

Just tried this patch and when you have all caches enabled, it will broke my customer account pages and checkout pages, since it won't be able to properly fetch the customer's ID. Could also be my installation, but reverting this patch did solve the issues.

@github-project-automation github-project-automation bot moved this to Pending Review in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel moved this from Pending Review to Changes Requested in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel added Priority: P3 May be fixed according to the position in the backlog. and removed Progress: pending review labels Aug 5, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Changes Requested to Pending Review in Pull Requests Dashboard Aug 5, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Pending Review to Review in Progress in Pull Requests Dashboard Aug 5, 2025
@engcom-Hotel engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Aug 7, 2025
@engcom-Charlie engcom-Charlie added the Project: Community Picked PRs upvoted by the community label Aug 12, 2025
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this to Changes Requested in Community Dashboard Aug 12, 2025
@engcom-Charlie engcom-Charlie self-assigned this Aug 25, 2025
@engcom-Charlie
Copy link
Contributor

@magento create issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: P3 May be fixed according to the position in the backlog. Progress: needs update Project: Community Picked PRs upvoted by the community
Projects
Status: Changes Requested
Development

Successfully merging this pull request may close these issues.

[Issue] Cache the results of isCacheable calls to improve performance
6 participants