ecomdev/magento2-product-data-preloader

Magento 2 Product Data Pre-Loader FTW

1.1.1 2023-02-06 20:10 UTC

Requires

• php: ~7.2|~8.0
• magento/framework: *
• magento/module-catalog: ~103.0|~104.0
• magento/module-customer: ~102.0|~103.0
• magento/module-quote: ~101.0

Requires (Dev)

• ecomdev/magento2-test-essentials: dev-main
• phpstan/phpstan: ^0.12.86
• phpunit/phpunit: ~9.5
• squizlabs/php_codesniffer: ^3.6.0

MIT

README

Magento platform code and third-party extensions in a lot of cases produce redundant database queries on product collections load.

This module provides an easy way to pre-load data for product collections like prices, stock data, and many more by using different types of load types. Right now it supports 3 types of loaded product collections:

• list Products that are using price index in selection, so it is safe to use stale index data for data loader
• cart Products that are used to calculate customers shopping cart and require accurate data to be loaded from database
• other Products that are not falling into any of the above categories

In order to pre-load data for a product collection, you need to implement EcomDev\ProductDataPreLoader\DataService\DataLoader interface with such methods:

• isApplicable(string $type): bool method that is used to decide if your loader compatible with specific product collection type.
• load(ScopeFilter $filter, ProductWrapper[] $products): array method that preloads data into LoadService that can be used later to access data by your loader id.

Custom loaders should be added to LoadService object via DI configuration like this:

<type name="EcomDev\ProductDataPreLoader\DataService\LoadService">
    <arguments>
        <argument name="loaders" xsi:type="array">
            <item name="my_custom_loader" xsi:type="object">My\Module\Loader\MyCustomLoader</item>
        </argument>
    </arguments>
</type>

Installation

Given EOL of Composer 1 all new packagist packages are not published for some time. So best way to keep your install up-to-date is to use Composer 2.0.

composer require ecomdev/magento2-product-data-preloader

Usage Example

This sample module implements optimistic preloader for configurable product data without taking into account simple product status for:

• Price of configurable product on product list
• Stock availability from MSI for configurable product
• Minimal tier price across simple products for configurable