GQL Custom field for ProductInterface is treated as attribute, wasting performance

adarshkhatri commented 1 month ago

Summary

Custom field for ProductInterface is treated as attribute by Magento. First it will check if this attribute exists and if it exists then it will try to load the data for a product.

This is unnecessary. This is impacting performance.

PS could be same for Category or any other types, I haven't tested it yet.

Examples

Take an example below:

interface ProductInterface {
    attribute_set_id: Int
        @doc(description: "ID of the attribute set assigned to the product")
}

In this example, Magento will do this query in the background:

INFO (6): SELECT `eav_attribute`.* FROM `eav_attribute` WHERE (`eav_attribute`.`attribute_code`='attribute_set_id') AND (entity_type_id = :entity_type_id)
INFO (6): {":entity_type_id":10}

As you can see, Magento is treating our custom field attribute_set_id as an attribute. It is checking if this attribute exists and if exists then it will try to load the data for a product.

Proposed solution

Do not treat them as attribute.

Release note

No response

Triage and priority

[ ] Severity: S0 - Affects critical data or functionality and leaves users without 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”.

m2-assistant[bot] commented 1 month ago

Hi @adarshkhatri. Thank you for your report. To speed up processing of this issue, 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. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: 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.

m2-assistant[bot] commented 1 month ago

Hi @engcom-Hotel. 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: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
[ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas 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-Hotel commented 1 month ago

Hello @adarshkhatri,

Thanks for the report and collaboration!

We have gone through the description and we can understand that you are concerned with the performance of Magento as the GQL Custom field for ProductInterface is treated as an attribute. But can you please let us know your use case in which you feel performance degradation? And the tool you used to calculate the performance.

Thanks

adarshkhatri commented 1 month ago

The performance impact would be for bigger databases/stores. When there are 100s of custom fields for the product interface, Magento is treating them as attributes. Running those 100s attribute queries (unnecessary queries) will impact the DB performance for the high visitor/transaction stores. In days like black Friday, system has to run precisely and should not lock the DB for no reason. With these queries running will definitely have the negative impact.

I don't have the number yet, I am on route to review the MySQL queries at the moment. Have been logging the queries and using NR to review them.

Should we focus on the degradation number (which will be diff for each instance), or should we discuss about the unnecessary DB impacts more?

engcom-Hotel commented 1 month ago

Hello @adarshkhatri,

Thank you for the detailed explanation.

Given the context of Magento 2, I believe it would be more beneficial to discuss the unnecessary impact on the database rather than focusing on specific degradation numbers, which can vary between instances. Understanding and addressing the root cause of these unnecessary queries will help us improve performance across all stores, especially during high-traffic periods like Black Friday.

Once you have the MySQL query logs and insights from New Relic, we can dive deeper into specific areas of improvement.

Looking forward to your findings and recommendations.

Thanks

engcom-Hotel commented 1 week ago

Dear @adarshkhatri,

We've observed that there haven't been any updates on this issue for quite some time. Therefore, we assume it's been resolved and will close it. Feel free to open a new ticket or reopen this one if you need more help.

Regards

magento / magento2