UPSTREAM FIX

magento2-29954: Moves the UI component definition cache to the compiled config cache type

Community fix magento2-29954 merged into magento/magento2 on 2024-09-05, released in 2.4.8; applies cleanly to 27 releases from 2.4.6 to 2.4.7-p10.

Moves the UI component definition cache to the compiled config cache type edited

Pull request title: Use compiled config for generated data instead of general config
Pull request: magento/magento2#29954
Issues: #38785 pr-derived
Author: @ilnytskyi
Merged: 2024-09-05
Fixed in: 2.4.8
Reported on: —
Categories: —
Components: magento/module-ui

Labels

Area: Framework
Component: UiComponents
Priority: P3
Severity: S3
Reported on (labels): 2.4.x

Issue

Title and steps come from the upstream issue and pull request.

Description

When we used multi-container ASG we noticed that magento loads a lot of data from shared cache instance (Redis).
That during deploys of new containers leads to downtime or unstable behavior during containers swapping.
We decided to move instance-sensetive cache types such as compiled DI, events, to containers itself.
That prevents cache overriding in shared instance while old container is alive a few minutes after deploy.

...
            'compiled_config' => [
                'frontend' => 'file_cache'
            ],
...

So we checked what caches lead to such result, and moved some core classes from using shared config type to compiled_config because this data is instance-sensitive and not necessary should be shared.
This also reduses excessive network transfer and overhead of data that depended on certain version of code.

Steps to reproduce

1. Cache keys event_config_cache, ui_component_configuration_definition_data, app_action_list,plugins are stored in compiled config instance.
2. Running two servers with different code version and isolated compiled config does not lead to cache overriding or application downtime or unexpected behavior caused by using the cache from different app version.

Taken from the upstream pull request.

Code match per tag

Each tag was checked with git apply --check against that tag's files. A clean match means the change applies; it is not a test result. Tags that already contain the fix are marked.

Line	Code match per tag	Tests
2.4.6	2.4.6 clean 2.4.6-p1 clean 2.4.6-p2 clean 2.4.6-p3 clean 2.4.6-p4 clean 2.4.6-p5 clean 2.4.6-p6 clean 2.4.6-p7 clean 2.4.6-p8 clean 2.4.6-p9 clean 2.4.6-p10 clean 2.4.6-p11 clean 2.4.6-p12 clean 2.4.6-p13 clean 2.4.6-p14 clean 2.4.6-p15 clean	2.4.6: no test data 2.4.6-p1: no test data 2.4.6-p2: no test data 2.4.6-p3: no test data 2.4.6-p4: no test data 2.4.6-p5: no test data 2.4.6-p6: no test data 2.4.6-p7: no test data 2.4.6-p8: no test data 2.4.6-p9: no test data 2.4.6-p10: no test data 2.4.6-p11: no test data 2.4.6-p12: no test data 2.4.6-p13: no test data 2.4.6-p14: no test data 2.4.6-p15: no test data
2.4.7	2.4.7 clean 2.4.7-p1 clean 2.4.7-p2 clean 2.4.7-p3 clean 2.4.7-p4 clean 2.4.7-p5 clean 2.4.7-p6 clean 2.4.7-p7 clean 2.4.7-p8 clean 2.4.7-p9 clean 2.4.7-p10 clean	2.4.7: no test data 2.4.7-p1: no test data 2.4.7-p2: no test data 2.4.7-p3: no test data 2.4.7-p4: no test data 2.4.7-p5: no test data 2.4.7-p6: no test data 2.4.7-p7: no test data 2.4.7-p8: no test data 2.4.7-p9: no test data 2.4.7-p10: no test data
2.4.8	2.4.8 conflictcontains the fix 2.4.8-p1 conflictcontains the fix 2.4.8-p2 conflictcontains the fix 2.4.8-p3 conflictcontains the fix 2.4.8-p4 conflictcontains the fix 2.4.8-p5 conflictcontains the fix	2.4.8: no test data 2.4.8-p1: no test data 2.4.8-p2: no test data 2.4.8-p3: no test data 2.4.8-p4: no test data 2.4.8-p5: no test data
2.4.9	2.4.9 conflictcontains the fix	2.4.9: no test data

Triage

Model @cf/cloudflare/clef. Probability this is a bug fix: 38.0%. Probability it is security relevant: 1.0%.

Show the model's answers and probabilities

Question	Answer	Probabilities	Confidence
Change kind	refactor	refactor 47.5%, bugfix 39.4%, feature 10.6%, dependency 1.1%, tests_only 1.0%, docs_only 0.4%	27.1%
Area	framework	framework 94.9%, admin 2.3%, frontend 0.7%	88.7%
Reported version	unspecified	unspecified 19.0%, 2.4.6 2.5%, 2.4.4 2.0%	3.4%
Scope	0.79 of 2	0 44.8%, 1 31.6%, 2 23.6%	3.5%
Risk	0.69 of 2	1 47.9%, 0 41.5%, 2 10.6%	11.9%
Worth backporting	1.15 of 2	1 39.2%, 2 37.8%, 0 22.9%	2.5%

Download

For cweagans/composer-patches, choose a version below and download the bundle. Copy its magento2-29954/ folder into patches/composer/, merge composer.patches.json into composer.json, then run composer install. Test files are always removed; paths are relative to each package root, using the default -p1 level.

Bundle README (what the ZIP ships)

# magento2-29954

Community fix merged upstream into magento/magento2, adapted by magento.watch.
This is not a patch published by Adobe.

Pull request: https://github.com/magento/magento2/pull/29954
Issue: https://github.com/magento/magento2/issues/38785
Author: @ilnytskyi
Source commit: 6aa57a17977582373c8ec90ea2b25010921036e6
Modifications: test files and documentation removed, paths rewritten relative to each Composer package.
Licence: OSL-3.0 / AFL-3.0, as the original Magento Open Source code.
Maintainer: Łukasz Bajsarowicz (@lbajsarowicz)

Licence: Magento Open Source code under OSL-3.0 and AFL-3.0. The bundle carries the original author, source commit and the list of modifications.