Publish product data preloader module

Author: IvanChepurnyi

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 EcomDev B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,27 @@
+# Product Data Pre-Loader
+
+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, ProductAdapter[] $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:
+
+```xml
+<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>
+```

composer.json

@@ -0,0 +1,30 @@
+{
+  "name": "ecomdev/magento2-product-data-preloader",
+  "version": "1.0.0",
+  "description": "Magento 2 Product Data Pre-Loader FTW",
+  "type": "magento2-module",
+  "require": {
+    "magento/framework": "*",
+    "magento/module-catalog": "~103.0|~104.0",
+    "magento/module-quote": "~101.0",
+    "magento/module-customer": "~102.0|~103.0",
+    "php": "~7.2"
+  },
+  "license": [
+    "MIT"
+  ],
+  "repositories": {
+    "magento": {
+      "type": "composer",
+      "url": "https://repo.magento.com/"
+    }
+  },
+  "autoload": {
+    "files": [
+        "src/registration.php"
+    ],
+    "psr-4": {
+      "EcomDev\\ProductDataPreLoader\\": "src"
+    }
+  }
+}

src/DataService/CustomerGroupProvider.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © EcomDev B.V. All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace EcomDev\ProductDataPreLoader\DataService;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Session\SessionStartChecker;
+use Magento\Customer\Model\Session;
+
+/**
+ * Customer group provider for dynamic resolution of it
+ *
+ */
+class CustomerGroupProvider
+{
+    /**
+     * Customer session instance
+     *
+     * @var Session\Proxy
+     */
+    private $customerSession;
+
+    /**
+     * Session availability checker
+     *
+     * @var SessionStartChecker
+     */
+    private $sessionChecker;
+
+    /**
+     * CustomerGroupProvider constructor.
+     *
+     * @param Session\Proxy $customerSession
+     * @param SessionStartChecker $sessionChecker
+     */
+    public function __construct(Session\Proxy $customerSession, SessionStartChecker $sessionChecker)
+    {
+        $this->customerSession = $customerSession;
+        $this->sessionChecker = $sessionChecker;
+    }
+
+    /**
+     * Return current customer group
+     *
+     * @return int
+     */
+    public function getCustomerGroupId(): int
+    {
+        if ($this->sessionChecker->check()) {
+            try {
+                return $this->customerSession->getCustomerGroupId();
+            }
+            catch (NoSuchEntityException | LocalizedException $e) {
+                return 0;
+            }
+        }
+
+        return 0;
+    }
+}

src/DataService/DataLoader.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © EcomDev B.V. All rights reserved.
+ */
+
+declare(strict_types=1);
+
+namespace EcomDev\ProductDataPreLoader\DataService;
+
+/**
+ * Interface for multiple hooks that are going to be used to preload data
+ * for product collection
+ */
+interface DataLoader
+{
+    const TYPE_CART = 'cart';
+    const TYPE_LIST = 'list';
+    const TYPE_OTHER = 'other';
+
+    /**
+     * Preloads data for a product by using product adapter
+     *
+     * Result should be keyed by ID of the supplied products.
+     *
+     * @param ScopeFilter $filter
+     * @param ProductWrapper[] $products
+     * @return array
+     */
+    public function load(ScopeFilter $filter, array $products): array;
+
+    /**
+     * Checks if the preloader is applicable for this type of data.
+     *
+     * @param string $type
+     * @return bool
+     */
+    public function isApplicable(string $type): bool;
+}

src/DataService/LoadService.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * Copyright © EcomDev B.V. All rights reserved.
+ */
+declare(strict_types=1);
+
+
+namespace EcomDev\ProductDataPreLoader\DataService;
+
+/**
+ * Load service
+ */
+class LoadService
+{
+    /**
+     * @var array
+     */
+    private $storage = [];
+
+    /**
+     * @var array
+     */
+    private $skuToId = [];
+
+    /**
+     * @var DataLoader[]
+     */
+    private $loaders;
+
+    /**
+     * PreloadStorage constructor.
+     *
+     * @param DataLoader[] $loaders
+     */
+    public function __construct(array $loaders)
+    {
+        $this->loaders = array_filter($loaders, function ($loader) {
+            return $loader instanceof DataLoader;
+        });
+    }
+
+    /**
+     * Checks if SKU is assigned
+     *
+     * @param string $sku
+     * @return int|null
+     */
+    public function skuToId(string $sku): ?int
+    {
+        return $this->skuToId[$sku] ?? null;
+    }
+
+    /**
+     * Check if there is data available for specified product
+     * and type of it
+     *
+     * @param int $productId
+     * @param string $type
+     * @return bool
+     */
+    public function has(int $productId, string $type): bool
+    {
+        return isset($this->storage[$type][$productId]);
+    }
+
+    /**
+     * Retrieves data for a product that was pre-loaded
+     *
+     * @param int $productId
+     * @param string $type
+     * @return array
+     */
+    public function get(int $productId, string $type): array
+    {
+        return $this->storage[$type][$productId] ?? [];
+    }
+
+    /**
+     * Preload data types
+     *
+     * @param string $type
+     * @param ScopeFilter $filter
+     * @param ProductWrapper[] $products
+     */
+    public function load(string $type, ScopeFilter $filter, array $products)
+    {
+        foreach ($this->loaders as $code => $loader) {
+            if (!$loader->isApplicable($type)) {
+                continue;
+            }
+
+            if (!isset($this->storage[$code])) {
+                $this->storage[$code] = [];
+            }
+
+            $productsToLoad = array_diff_key($products, $this->storage[$code]);
+            if (!$productsToLoad) {
+                continue;
+            }
+
+            $defaultData = array_fill_keys(array_keys($productsToLoad), []);
+
+            foreach ($productsToLoad as $productId => $adapter) {
+                $this->skuToId[$adapter->getSku()] = $productId;
+            }
+
+            $this->storage[$code] += $defaultData + $loader->load($filter, $productsToLoad);
+        }
+    }
+}

src/DataService/MagentoProductWrapper.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © EcomDev B.V. All rights reserved.
+ */
+declare(strict_types=1);
+
+namespace EcomDev\ProductDataPreLoader\DataService;
+
+use Magento\Catalog\Model\Product;
+
+/**
+ * Product wrapper
+ */
+class MagentoProductWrapper implements ProductWrapper
+{
+    /**
+     * @var Product
+     */
+    private $product;
+
+    /**
+     * MagentoProductWrapper constructor.
+     *
+     * @param Product $product
+     */
+    public function __construct(Product $product)
+    {
+        $this->product = $product;
+    }
+
+    /**
+     * Returns product SKU
+     *
+     * @return string
+     */
+    public function getSku(): string
+    {
+        return $this->product->getSku();
+    }
+
+    /**
+     * Returns product ID
+     *
+     * @return int
+     */
+    public function getId(): int
+    {
+        return (int)$this->product->getId();
+    }
+
+    /**
+     * Check if product is of a type
+     *
+     * @param string ...$type
+     * @return bool
+     */
+    public function isType(string ...$type): bool
+    {
+        return in_array($this->product->getTypeId(), $type, true);
+    }
+
+    /**
+     * Updates field in wrapped product
+     *
+     * @param string $fieldName
+     * @param $value
+     */
+    public function updateField(string $fieldName, $value): void
+    {
+        $this->product->setData($fieldName, $value);
+    }
+}