Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Product Collection - addMediaGalleryData calls getSize when the collection maybe or will be loaded (Can use count to avoid an extra DB query) #39111

Open
1 of 5 tasks
steven-hoffman-jomashop opened this issue Aug 26, 2024 · 9 comments · May be fixed by #39681
Open
1 of 5 tasks

Product Collection - addMediaGalleryData calls getSize when the collection maybe or will be loaded (Can use count to avoid an extra DB query) #39111

steven-hoffman-jomashop opened this issue Aug 26, 2024 · 9 comments · May be fixed by #39681
Assignees
@Himsoft
Labels
Area: Product Component: MediaGallery Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@steven-hoffman-jomashop
Copy link

Preconditions and environment

  • Present on 2.4-develop
    • Likely present on most previous M2 versions

The call to getSize is clearly un-needed for the GQL code path for products.

It should be safe to add a if($this->isLoaded()) prior to calling getSize, and if loaded, call count instead of getSize.
(It should also be safe to just use the count/empty of getItems, (As getItems calls load), but calling isLoaded and using count should be safe and would mitigate this specific issue).

Steps to reproduce

  1. Enable dev query log
  2. This should be reproducible by calling the products GQL call with the media_gallery/media_gallery_entries field selected.
  3. The count call should be in the query log, traced to addMediaGalleryData

Expected result

getSize is not called on a loaded product collection. (When the non-paginated count is not needed).

Actual result

getSize is called on a loaded paginated collection to check if it has data.

Additional information

No response

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 M2 Assistant
Copy link

m2-assistant bot commented Aug 26, 2024

Hi @steven-hoffman-jomashop. 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:

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.

@github-project-automation github-project-automation bot moved this to Ready for Confirmation in Issue Confirmation and Triage Board Aug 26, 2024
@engcom-Bravo engcom-Bravo added Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it Reported on 2.4.x Indicates original Magento version for the Issue report. labels Aug 27, 2024
@engcom-November engcom-November self-assigned this Sep 3, 2024
@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Sep 3, 2024

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).
  • 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-November
Copy link
Contributor

Hello @steven-hoffman-jomashop,

Thank you for the report and collaboration!

I agree that if the collection is already loaded we should call count, but addMediaGalleryData function has been called in other classes which does not specify if the collection is loaded or not, can you make sure that this will not cause problems in these classes.

@engcom-November engcom-November added Issue: needs update Additional information is require, waiting for response and removed Issue: ready for confirmation labels Sep 3, 2024
@engcom-November engcom-November moved this from Ready for Confirmation to Needs Update in Issue Confirmation and Triage Board Sep 3, 2024
@steven-hoffman-jomashop
Copy link
Author

Hi @engcom-November,

... addMediaGalleryData function has been called in other classes which does not specify if the collection is loaded or not, ... this will not cause problems ...

Please see above.

It should be safe to add a if($this->isLoaded()) prior to calling getSize, and if loaded, call count instead of getSize. ...

In summary: Those other uses, where the category is not yet loaded, will return false for isLoaded, and thus addMediaGalleryData can call getSize for that code path; (and if isLoaded true, it can call count). This avoid the issue of the other code paths and speeds up the code paths where the collection is loaded.

@engcom-November
Copy link
Contributor

Hello @steven-hoffman-jomashop,

I agree with this, since there is a if clause it won't effect other implementation, hence confirming the issue.

Thank you.

@engcom-November engcom-November added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Component: MediaGallery Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Product and removed Issue: needs update Additional information is require, waiting for response labels Sep 19, 2024
@m2-community-project m2-community-project bot added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed and removed Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed labels Sep 19, 2024
@github-jira-sync-bot
Copy link

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

@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Sep 19, 2024

✅ 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.

@github-jira-sync-bot
Copy link

❌ You don't have permission to export this issue.

@engcom-Bravo engcom-Bravo moved this from Needs Update to Confirmed in Issue Confirmation and Triage Board Sep 23, 2024
@engcom-Hotel engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Sep 24, 2024
@Himsoft
Copy link

Himsoft commented Feb 28, 2025

@magento I am working on this

Himsoft pushed a commit to Himsoft/magento2 that referenced this issue Feb 28, 2025
magento#39111: Product Collection - addMediaGalleryData calls getSize…
072a3fe 
… when the collection maybe or will be loaded (Can use count to avoid an extra DB query)

- Fixed call count instead of getSize if collection is loaded.
@Himsoft Himsoft linked a pull request Feb 28, 2025 that will close this issue
Open
5 tasks
Himsoft pushed a commit to Himsoft/magento2 that referenced this issue Feb 28, 2025
magento#39111: Product Collection - addMediaGalleryData calls getSize…
b8c6634 
… when the collection maybe or will be loaded (Can use count to avoid an extra DB query)

- Fixed call count instead of getSize if collection is loaded.
Himsoft pushed a commit to Himsoft/magento2 that referenced this issue Feb 28, 2025
magento#39111: Product Collection - addMediaGalleryData calls getSize…
c77217f 
… when the collection maybe or will be loaded (Can use count to avoid an extra DB query)

- Fixed call count instead of getSize if collection is loaded.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Himsoft Himsoft

Labels
Area: Product Component: MediaGallery Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

magento/magento2#39111: Product Collection - addMediaGalleryData call… Himsoft/magento2
6 participants
@Himsoft @engcom-Bravo @engcom-Hotel @engcom-November @steven-hoffman-jomashop @github-jira-sync-bot