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

[steven-hoffman-jomashop]

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.

• ProductGql's CollectionPostProcessor calls isLoaded and if not loaded calls load. Then it calls addMediaGalleryData. (If needed).
• Product Collection's addMediaGalleryData calls if (!$this->getSize()) { on a collection that is loaded already. At this point we can call count. (Or just check the empty on the getItems).

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.
• [X] 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]]

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:

• @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]]

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: :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-November]

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.

[steven-hoffman-jomashop]

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 isLoadedtrue, 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]

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.

[github-jira-sync-bot]

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

[m2-assistant[bot]]

:white_check_mark: 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]

:x: You don't have permission to export this issue.