Widget cache error

[twslade]

Steps to reproduce

1. Install Magento from develop branch.
2. Add two widgets of type 'Catalog Product List' to the 'CMS homepage' at location content.bottom with different titles, but the same conditions. For example, condition could be product price is greater than 0
3. Refresh cache and visit homepage

Expected result

1. Two widgets appear on homepage with the same products, but different titles.

Actual result

1. First widget loaded shows twice depending on sort order
2. See: Magento\CatalogWidget\Block\Product\ProductList::getCacheKeyInfo which doesn't take into consideration the widget_id.

    /**
     * Get key pieces for caching block content
     *
     * @return array
     */
    public function getCacheKeyInfo()
    {
        $conditions = $this->getData('conditions')
            ? $this->getData('conditions')
            : $this->getData('conditions_encoded');

        return [
            'CATALOG_PRODUCTS_LIST_WIDGET',
            $this->_storeManager->getStore()->getId(),
            $this->_design->getDesignTheme()->getId(),
            $this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_GROUP),
            intval($this->getRequest()->getParam(self::PAGE_VAR_NAME, 1)),
            $this->getProductsPerPage(),
            $conditions
        ];
    }

[oserediuk]

Hello @twslade! Thank you for the report! We have created issue in our bugtracker system MAGETWO-54008 . It will be fixed as soon as possible.

[mcspronko]

Hi @oserediuk

Do you have any update for timeframe of the MAGETWO-54008 issue?

Thanks

[oserediuk]

Hi @mcspronko ! Nope

[mcspronko]

Hi @pboisvert

Are there any deadlines for this issue?

Thanks,
Max

[loekderooij]

This is not caused by the cache key. The rule property is a shared object. This can be solved by defining the rule argument in the constructor as not shared in di.xml.

<type name="Magento\CatalogWidget\Block\Product\ProductsList">
    <arguments>
        <argument name="rule" xsi:type="object" shared="false">Magento\CatalogWidget\Model\Rule</argument>
    </arguments>
</type>

[pinicio]

@LuckyLoek solution doesn't seem to work for me. If someone found a solution to this bug and share it, it would be greatly appreciated.

[twslade]

@pinicio I think @LuckyLoek misunderstood the problem. The issue is that the widget_id isn't stored within the cache key.

I fixed it by adding the widget ID to the \Magento\CatalogWidget\Block\Product\ProductsList::getCacheKeyInfo function in the return. See below. I only came across this scenario because I was making lots of widgets that were the same conditions for mocking client data during a project.

    public function getCacheKeyInfo()
    {
        $conditions = $this->getData('conditions')
            ? $this->getData('conditions')
            : $this->getData('conditions_encoded');

        return [
            'CATALOG_PRODUCTS_LIST_WIDGET',
            $this->_storeManager->getStore()->getId(),
            $this->_design->getDesignTheme()->getId(),
            $this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_GROUP),
            intval($this->getRequest()->getParam($this->getData('page_var_name'), 1)),
            $this->getProductsPerPage(),
            $conditions . $this->getData('id'),
            serialize($this->getRequest()->getParams())
        ];
    }

[loekderooij]

@twslade, I didn't misunderstand the problem as I had exactly the same problem. The situations might still be different however.

I had unique conditions and therefor a unique cache key for each widget. Still this didn't produce the result I expected. I can't test right now but I guess it depends on the widget settings. I think both solutions should be considered depending on the situation.

[twslade]

@LuckyLoek The reason I thought you misunderstood the problem is because I had no context into how you came across the bug/solution you provided. As described above, my conditions were the same in both widgets, so the same products were assigned to each widget. The titles were different even though the frontend showed the same block each time, because they had identical cache keys.

I noticed that you said above that the issue doesn't have to do with cache key, but instead the shared rules. Can you give details on steps to reproduce and expected/actual results?

[loekderooij]

@twslade, it was also too easy from my side to assume the problem as described was exactly the same as mine. I will provide details to reproduce as soon as I find some time on my hands.