Merge branch 'feature/BEG-81_initial_version' of github.com:aligent/magento2-prerender-io into feature/BEG-81_initial_version

Author: jswift

Helper/Config.php

@@ -17,12 +17,18 @@ class Config
     /** @var ScopeConfigInterface  */
     private ScopeConfigInterface $scopeConfig;
 
+    /**
+     *
+     * @param ScopeConfigInterface $scopeConfig
+     */
     public function __construct(ScopeConfigInterface $scopeConfig)
     {
         $this->scopeConfig = $scopeConfig;
     }
 
     /**
+     * Return if recaching functionality is enabled or not
+     *
      * @param int|null $storeId
      * @return bool
      */
@@ -36,6 +42,8 @@ public function isRecacheEnabled(?int $storeId = null): bool
     }
 
     /**
+     * Return configured Prerender.io token for API calls
+     *
      * @param int|null $storeId
      * @return string|null
      */

Model/Api/PrerenderClient.php

@@ -27,18 +27,33 @@ class PrerenderClient implements PrerenderClientInterface
     /** @var LoggerInterface  */
     private LoggerInterface $logger;
 
+    /**
+     *
+     * @param Config $prerenderConfigHelper
+     * @param ClientInterface $client
+     * @param SerializerInterface $jsonSerializer
+     * @param LoggerInterface $logger
+     */
     public function __construct(
         Config $prerenderConfigHelper,
         ClientInterface $client,
         SerializerInterface $jsonSerializer,
         LoggerInterface $logger
     ) {
         $this->prerenderConfigHelper = $prerenderConfigHelper;
-        $this->client = $client;
         $this->jsonSerializer = $jsonSerializer;
         $this->logger = $logger;
+        $this->client = $client;
+        $this->client->addHeader('content-type', 'application/json');
     }
 
+    /**
+     * Call Prerender.io API to recache list of URLs
+     *
+     * @param array $urls
+     * @param int $storeId
+     * @return void
+     */
     public function recacheUrls(array $urls, int $storeId): void
     {
         if (!$this->prerenderConfigHelper->isRecacheEnabled($storeId)) {
@@ -50,16 +65,19 @@ public function recacheUrls(array $urls, int $storeId): void
             return;
         }
 
-        if (count($urls) > self::MAX_URLS) {
-            $batches = array_chunk($urls, self::MAX_URLS);
-            foreach ($batches as $batch) {
-                $this->sendRequest($batch, $token);
-            }
-        } else {
-            $this->sendRequest($urls, $token);
+        $batches = array_chunk($urls, self::MAX_URLS);
+        foreach ($batches as $batch) {
+            $this->sendRequest($batch, $token);
         }
     }
 
+    /**
+     * Sends a JSON POST request to Prerender.io
+     *
+     * @param array $urls
+     * @param string $token
+     * @return void
+     */
     private function sendRequest(array $urls, string $token): void
     {
         $payload = $this->jsonSerializer->serialize(
@@ -68,7 +86,6 @@ private function sendRequest(array $urls, string $token): void
                 'urls' => $urls
             ]
         );
-        $this->client->addHeader('content-type', 'application/json');
         try {
             $this->client->post(self::PRERENDER_RECACHE_URL, $payload);
         } catch (\Exception $e) {

Model/Indexer/Product/ProductIndexer.php

@@ -38,6 +38,15 @@ class ProductIndexer implements IndexerActionInterface, MviewActionInterface, Di
     /** @var int|null  */
     private ?int $batchSize;
 
+    /**
+     *
+     * @param DimensionProviderInterface $dimensionProvider
+     * @param GetUrlsForProducts $getUrlsForProducts
+     * @param PrerenderClientInterface $prerenderClient
+     * @param DeploymentConfig $deploymentConfig
+     * @param Config $prerenderConfigHelper
+     * @param int|null $batchSize
+     */
     public function __construct(
         DimensionProviderInterface $dimensionProvider,
         GetUrlsForProducts $getUrlsForProducts,
@@ -110,6 +119,10 @@ public function execute($ids): void
     }
 
     /**
+     * Execute indexing per dimension (store)
+     *
+     * @param arry $dimensions
+     * @param \Traversable $entityIds
      * @throws FileSystemException
      * @throws RuntimeException
      */

Model/Product/GetUrlsForProducts.php

@@ -22,6 +22,12 @@ class GetUrlsForProducts
     /** @var Emulation */
     private Emulation $emulation;
 
+    /**
+     *
+     * @param CollectionFactory $productCollectionFactory
+     * @param StoreManagerInterface $storeManager
+     * @param Emulation $emulation
+     */
     public function __construct(
         CollectionFactory $productCollectionFactory,
         StoreManagerInterface $storeManager,
@@ -32,6 +38,13 @@ public function __construct(
         $this->emulation = $emulation;
     }
 
+    /**
+     * Generate product URLs based on URL_REWRITE entries
+     *
+     * @param array $productIds
+     * @param int $storeId
+     * @return array
+     */
     public function execute(array $productIds, int $storeId): array
     {
         $productCollection = $this->productCollectionFactory->create();

composer.json

@@ -5,6 +5,9 @@
         "php": ">=7.4",
         "magento/framework": "*"
     },
+    "require-dev": {
+        "magento/magento-coding-standard": ">=23"
+    },
     "type": "magento2-module",
     "license": [
         "GPL-3.0-only"