Performance - Loading attribute options from DB #36174

Nuranto · 2022-09-21T19:07:27Z

Summary (*)

When using $product->getAttributeText('some_attribute_using_table_source'), this is executed :

public function getAttributeText($attributeCode)
    {
        return $this->getResource()->getAttribute($attributeCode)->getSource()->getOptionText(
            $this->getData($attributeCode)
        );
    }

And getOptionText get its data from database.

The issue is that if we call getAttributeText() several times, a call to database will occur every time. I know query cache will help, but this is still DB calls, so DB load (with networks time for each request, etc..) which is not negligible with high loads.

Examples (*)

$productFactory = \Magento\Framework\App\ObjectManager::getInstance()->get(\Magento\Catalog\Model\ProductFactory::class);
$product = $productFactory->create()->load(21673);
var_dump($product->getData('color'));
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";
$time = microtime(true);
$product->getAttributeText('color');
echo (microtime(true)-$time) . "<br>";

results as

0.0025439262390137
0.00037407875061035
0.00033903121948242
0.0003349781036377
0.00032901763916016
0.00039505958557129
0.00045204162597656

So 2ms for the first request, and then 0.3-0.4ms thanks to query cache. And that's on my local environment, without any network and load involved.

Let's say you're displaying 4 attributes on a product list page, with 50 products per page, that's (assuming each product has different attribute values, so without any query cache) : 50*4*2ms = 400ms and 200 DB calls.

Proposed solution

With a simple cache with class variables, we get this result :

0.0021991729736328
1.6927719116211E-5
6.9141387939453E-6
5.9604644775391E-6
7.1525573730469E-6
5.9604644775391E-6
5.0067901611328E-6

I'm not sure which way is the best for caching. Probably caching the whole table with both backend cache (like redis) and class-cache (class static variable) would be the best way to limit DB calls.

Something like this (pseudo-code just to show the idea) :

public function getOptionText($value) {
     if(self::$cache[attributeCode][$value] ?? false) {
           return self::$cache[attributeCode][$value];
      }
     $options = $this->cache->load(attributeCode-storeId-options);
     if($options) {
        self::$cache[attributeCode] = options;
        return $options[value];
     }
     $options = loadOptions();
     self::$cache[attributeCode] = $options;
    $this->cache->save(attributeCode-storeId-options, $options);
    return $options
}

Please provide Severity assessment for the Issue as Reporter. This information will help during Confirmation and Issue triage processes.

Severity: S0 - Affects critical data or functionality and leaves users with no workaround.
Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

The text was updated successfully, but these errors were encountered:

m2-assistant · 2022-09-21T19:07:29Z

Hi @Nuranto. Thank you for your report.
To speed up processing of this issue, make sure that you provided the following information:

Summary of the issue
Information on your environment
Steps to reproduce
Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

Join Magento Community Engineering Slack and ask your questions in #github channel.

⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

m2-assistant · 2022-10-18T09:54:32Z

Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
5. Add label Issue: Confirmed once verification is complete.
6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November · 2022-10-18T10:18:20Z

Confirming this issue as execution of getAttributeText() several times would lead to performance issues with high DB loads.

github-jira-sync-bot · 2022-10-18T10:19:35Z

✅ Jira issue https://jira.corp.adobe.com/browse/AC-6856 is successfully created for this GitHub issue.

m2-assistant · 2022-10-18T10:19:38Z

✅ Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

monteshot · 2022-11-11T07:49:39Z

@magento I am working on this

jg-development · 2024-11-22T20:52:35Z

any updates? we found out this problem is related to most of our performance problems.

anthony-blackbird · 2024-12-13T11:05:03Z

@jg-development

Hi, I'm starting a PR here: #39476

We are having this performance issue too on website with many attributes options and products.
I have reduced from 117 calls to 22 calls on my category pages and about 100ms.
It will really depend on how much you use getAttributeText actually.

Before:

After:

anthony-blackbird · 2024-12-13T11:08:32Z

@magento I am working on this

m2-assistant · 2024-12-13T11:08:36Z

Hi @anthony-blackbird! 👋
Thank you for collaboration. Only members of Community Contributors Team are allowed to be assigned to the issue. Please use @magento add to contributors team command to join Contributors team.

anthony-blackbird · 2024-12-13T11:09:04Z

@magento add to contributors team

m2-assistant · 2024-12-13T11:09:08Z

Hi @anthony-blackbird! 👋
Thank you for joining. Please accept team invitation 👉 here 👈 and add your comment one more time.

anthony-blackbird · 2024-12-13T11:10:09Z

@magento I am working on this

anthony-blackbird · 2024-12-16T14:31:56Z

While the PR is processed, I suggest this package I developed, compatible with Magento 2.4.x.

It also introduces a cache layer for these specific options loaded. I might add it to my PR if Magento Team is interested too. More details on the readme : https://github.com/blackbird-agency/magento-eav-optimize

Nuranto added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Sep 21, 2022

m2-community-project bot added the Issue: ready for confirmation label Sep 21, 2022

engcom-Hotel added the Reported on 2.4.x Indicates original Magento version for the Issue report. label Sep 23, 2022

engcom-November self-assigned this Oct 18, 2022

engcom-November added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Component: Code Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework labels Oct 18, 2022

m2-community-project bot removed the Issue: ready for confirmation label Oct 18, 2022

m2-assistant bot unassigned engcom-November Oct 18, 2022

engcom-November added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 18, 2022

m2-community-project bot added the Progress: ready for dev label Oct 18, 2022

m2-assistant bot assigned monteshot Nov 11, 2022

m2-community-project bot added Progress: dev in progress and removed Progress: ready for dev labels Nov 11, 2022

monteshot removed their assignment Nov 11, 2022

m2-community-project bot added Progress: ready for dev and removed Progress: dev in progress labels Nov 11, 2022

engcom-Hotel added this to High Priority Backlog Aug 19, 2024

engcom-Hotel moved this to Ready for Development in High Priority Backlog Aug 19, 2024

anthony-blackbird linked a pull request Dec 13, 2024 that will close this issue

Performance - Optimize getSpecificOptions triggered by all getAttributeText calls #39476

Open

4 tasks

m2-community-project bot added Progress: PR in progress and removed Progress: ready for dev labels Dec 13, 2024

m2-assistant bot assigned anthony-blackbird Dec 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Performance - Loading attribute options from DB #36174

Performance - Loading attribute options from DB #36174

Nuranto commented Sep 21, 2022 •

edited

Loading

m2-assistant bot commented Sep 21, 2022

m2-assistant bot commented Oct 18, 2022

engcom-November commented Oct 18, 2022

github-jira-sync-bot commented Oct 18, 2022

m2-assistant bot commented Oct 18, 2022

monteshot commented Nov 11, 2022

jg-development commented Nov 22, 2024

anthony-blackbird commented Dec 13, 2024 •

edited

Loading

anthony-blackbird commented Dec 13, 2024

m2-assistant bot commented Dec 13, 2024

anthony-blackbird commented Dec 13, 2024

m2-assistant bot commented Dec 13, 2024

anthony-blackbird commented Dec 13, 2024

anthony-blackbird commented Dec 16, 2024

Performance - Loading attribute options from DB #36174

Performance - Loading attribute options from DB #36174

Comments

Nuranto commented Sep 21, 2022 • edited Loading

Summary (*)

Examples (*)

Proposed solution

m2-assistant bot commented Sep 21, 2022

m2-assistant bot commented Oct 18, 2022

engcom-November commented Oct 18, 2022

github-jira-sync-bot commented Oct 18, 2022

m2-assistant bot commented Oct 18, 2022

monteshot commented Nov 11, 2022

jg-development commented Nov 22, 2024

anthony-blackbird commented Dec 13, 2024 • edited Loading

anthony-blackbird commented Dec 13, 2024

m2-assistant bot commented Dec 13, 2024

anthony-blackbird commented Dec 13, 2024

m2-assistant bot commented Dec 13, 2024

anthony-blackbird commented Dec 13, 2024

anthony-blackbird commented Dec 16, 2024

Nuranto commented Sep 21, 2022 •

edited

Loading

anthony-blackbird commented Dec 13, 2024 •

edited

Loading