Skip to content

perf: opcache-friendly compiled config for routes.xml#40690

Open
lbajsarowicz wants to merge 2 commits intomagento:2.4-developfrom
lbajsarowicz:perf/compiled-config-routes
Open

perf: opcache-friendly compiled config for routes.xml#40690
lbajsarowicz wants to merge 2 commits intomagento:2.4-developfrom
lbajsarowicz:perf/compiled-config-routes

Conversation

@lbajsarowicz
Copy link
Copy Markdown
Contributor

Summary

  • Extends compiled config pattern to Magento\Framework\App\Route\Config
  • Route configuration is immutable after deployment and loaded on every request
  • Eliminates cache backend round-trip and json_decode() overhead
  • 3 new unit tests covering compiled/fallback/backward-compat paths

Performance Impact

Exact numbers with Blackfire and PHP SPX profiling will be provided in a follow-up comment.

Dependencies

Depends on #40689 (base class changes for compiled config support).

⭐ Support my work

Do you like the fix? Remember to react with "👍🏻" to get it merged faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.

Learn more at https://github.com/sponsors/lbajsarowicz

…configs

XML configurations that are immutable after deployment (events.xml, etc.)
are currently stored in the cache backend as JSON strings and decoded via
json_decode() on every request. This adds an optional compile-on-first-access
mechanism that writes config arrays to PHP files in generated/metadata/,
which PHP opcache can cache as bytecode — eliminating both the cache backend
round-trip and the JSON decode overhead.

The implementation modifies Config\Data and Config\Data\Scoped base classes
to accept an optional ConfigWriterInterface dependency. When injected:
- First checks for a compiled PHP file via include() (opcache-friendly)
- Falls back to existing cache/reader behavior on miss
- Writes the compiled PHP file atomically (temp + rename) for next request
- Properly invalidates compiled files on reset()/cache clean

Event configuration (events.xml) is enabled as the first consumer via DI.
This pattern can be extended to other immutable configs (routes, webapi, acl)
in follow-up PRs.

Backward compatible: no behavior change when ConfigWriterInterface is not
injected (default). Compiled files live alongside existing DI compiled config
in generated/metadata/ and follow the same lifecycle.
@m2-assistant
Copy link
Copy Markdown

m2-assistant bot commented Apr 10, 2026

Hi @lbajsarowicz. 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.

@lbajsarowicz
Copy link
Copy Markdown
Contributor Author

@magento run all tests

- Extract anonymous test doubles into named classes to fix PHPMD
  UnusedLocalVariable false positives in anonymous class methods
- Add phpcs:disable for useless override warning in Event\Config\Data
  (constructor provides default cacheId, matching existing pattern in
  Catalog\Attribute\Config\Data)
- All PHPCS errors/warnings and PHPMD violations resolved
@lbajsarowicz
Copy link
Copy Markdown
Contributor Author

@magento run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant