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.

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

Take required product attributes into account when caching used products #32698

Conversation

Maikel-Koek
Copy link
Contributor

@Maikel-Koek Maikel-Koek commented Apr 9, 2021

Description (*)

When calling Magento\ConfigurableProduct\Model\Product\Type\Configurable::getUsedProducts() with custom required attributes after that method has already been called before, the collection doesn't load your custom defined attributes.

The caching plugin around this method, Magento\ConfigurableProduct\Model\Plugin\Frontend\UsedProductsCache::aroundGetUsedProducts() actually does take the passed required attributes into account, by generating a cache key, but once proceeded to the original method, this is lost again, when $product->getData($this->_usedProducts) already contains a product collection.

Manual testing scenarios (*)

This can be confirmed by running the added integration test without the changes I proposed, you'll see it will fail, because the meta_description attribute of the product will be null at all times.

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Take required product attributes into account when caching used products #32765: Take required product attributes into account when caching used products

@m2-assistant
Copy link

m2-assistant bot commented Apr 9, 2021

Hi @Maikel-Koek. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

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

@Maikel-Koek
Copy link
Contributor Author

@magento run all tests

$skipStockFilter was accidentally changed to true
@Maikel-Koek
Copy link
Contributor Author

@magento run Integration Tests

@Maikel-Koek
Copy link
Contributor Author

@magento run all tests

@gabrieldagama gabrieldagama added the Priority: P3 May be fixed according to the position in the backlog. label Apr 15, 2021
@gabrieldagama
Copy link
Contributor

@magento create issue

Copy link
Contributor

@Den4ik Den4ik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Maikel-Koek Thanks for you contribution.
Please look at my comments below

Comment on lines +1293 to +1305
$requiredAttributeIds = $requiredAttributeIds ?: [];
array_unshift($requiredAttributeIds, $product->getId());

$cacheKey = $this->getUsedProductsCacheKey($requiredAttributeIds);
if (!$product->hasData($this->_usedProducts) || !isset($product->getData($this->_usedProducts)[$cacheKey])) {
$collection = $this->getConfiguredUsedProductCollection($product, false, $requiredAttributeIds);
$usedProducts = array_values($collection->getItems());
$product->setData($this->_usedProducts, $usedProducts);
$usedProductsCache = $product->getData($this->_usedProducts);
$usedProductsCache[$cacheKey] = $usedProducts;
$product->setData($this->_usedProducts, $usedProductsCache);
}

return $product->getData($this->_usedProducts);
return $product->getData($this->_usedProducts)[$cacheKey];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that this method could be reverted to 2487db1b#diff-d9457baecd561c1374a935c202ad3a4ebf82a9c26b80c486dd97ac44da81d383L1245-L1257 with some changes:

  • use $this->customerSession instead of deprecated getCustomerSession()
  • add $requiredAttributeIds into loadUsedProducts call

And refactoring loadUsedProducts method

@Den4ik Den4ik added Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. Award: bug fix labels Apr 17, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 28, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
sidolov pushed a commit to sidolov/quality-patches that referenced this pull request Apr 29, 2021
@ishakhsuvarov
Copy link
Contributor

Hi

I am closing this PR for now as it seems like it has become stale and still needs work.

Please feel free to reopen if you wish to continue.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Award: bug fix Component: ConfigurableProduct Priority: P3 May be fixed according to the position in the backlog. Release Line: 2.4 Severity: S2 Major restrictions or short-term circumventions are required until a fix is available.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Take required product attributes into account when caching used products
5 participants