Add cron for deleting old offers mapping (#93)

Co-authored-by: Maksymilian Strzyżewski <m.strzyzewski@macopedia.pl>

Author: mstrzyzewski

Console/Command/CleanOffersMapping.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macopedia\Allegro\Console\Command;
+
+use Macopedia\Allegro\Model\Api\ClientException;
+use Macopedia\Allegro\Model\OffersMapping;
+use Magento\Framework\App\Area;
+use Magento\Framework\App\State;
+use Magento\Framework\Exception\LocalizedException;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * CleanOffersMapping command class
+ */
+class CleanOffersMapping extends Command
+{
+    /** @var State */
+    protected $state;
+
+    /** @var OffersMapping */
+    protected $offersMapping;
+
+    /**
+     * CleanOffersMapping constructor.
+     * @param State $state
+     * @param OffersMapping $offersMapping
+     * @param string|null $name
+     */
+    public function __construct(
+        State $state,
+        OffersMapping $offersMapping,
+        string $name = null
+    ) {
+        parent::__construct($name);
+        $this->state = $state;
+        $this->offersMapping = $offersMapping;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function configure()
+    {
+        $this->setName('macopedia:allegro:clean-offers-mapping');
+        $this->setDescription("Clean old offers mapping");
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int|void
+     * @throws LocalizedException
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        try {
+            $this->state->getAreaCode();
+        } catch (LocalizedException $exception) {
+            $this->state->setAreaCode(Area::AREA_GLOBAL);
+        }
+
+        try {
+            $this->offersMapping->clean();
+        } catch (ClientException $e) {
+            $output->writeln('Error occurred while trying to clean old offers mapping');
+            $output->writeln($e->getMessage());
+        }
+    }
+}

Cron/CleanOffersMapping.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Macopedia\Allegro\Cron;
+
+use Macopedia\Allegro\Logger\Logger;
+use Macopedia\Allegro\Model\Api\ClientException;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Macopedia\Allegro\Model\OffersMapping;
+
+class CleanOffersMapping
+{
+    const OFFERS_MAPPING_CRON_CONFIG_KEY = 'allegro/order/offers_mapping_cron_enabled';
+
+    /** @var Logger */
+    protected $logger;
+
+    /** @var ScopeConfigInterface */
+    protected $scopeConfig;
+
+    /** @var OffersMapping */
+    protected $offersMapping;
+
+    /**
+     * @param Logger $logger
+     * @param ScopeConfigInterface $scopeConfig
+     * @param OffersMapping $offersMapping
+     */
+    public function __construct(
+        Logger $logger,
+        ScopeConfigInterface $scopeConfig,
+        OffersMapping $offersMapping
+    ) {
+        $this->logger = $logger;
+        $this->scopeConfig = $scopeConfig;
+        $this->offersMapping = $offersMapping;
+    }
+
+    public function execute()
+    {
+        if ($this->scopeConfig->getValue(self::OFFERS_MAPPING_CRON_CONFIG_KEY)) {
+            $this->logger->addInfo("Cronjob clean offers mapping is executed.");
+            try {
+                $this->offersMapping->clean();
+            } catch (ClientException $e) {
+                $this->logger->error('Error while trying to clean old offers mapping: ' . $e->getMessage());
+            }
+        }
+    }
+}

Model/OffersMapping.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Macopedia\Allegro\Model;
+
+use Macopedia\Allegro\Logger\Logger;
+use Macopedia\Allegro\Model\ResourceModel\Sale\Offers;
+use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
+
+class OffersMapping
+{
+    /** @var Offers */
+    protected $offers;
+
+    /** @var Logger */
+    protected $logger;
+
+    /** @var Configuration */
+    protected $configuration;
+
+    /** @var CollectionFactory */
+    protected $productCollection;
+
+    /**
+     * OffersMapping constructor.
+     * @param Offers $offers
+     * @param Logger $logger
+     * @param Configuration $configuration
+     * @param CollectionFactory $productCollection
+     */
+    public function __construct(
+        Offers $offers,
+        Logger $logger,
+        Configuration $configuration,
+        CollectionFactory $productCollection
+    ) {
+        $this->offers = $offers;
+        $this->logger = $logger;
+        $this->configuration = $configuration;
+        $this->productCollection = $productCollection;
+    }
+
+    /**
+     * @throws Api\ClientException
+     */
+    public function clean()
+    {
+        $collection = $this->productCollection->create();
+        $collection->addAttributeToSelect('*')
+            ->addStoreFilter($this->configuration->getStoreId())
+            ->addAttributeToFilter('allegro_offer_id', ['neq' => 'NULL']);
+
+        /** @var Magento\Catalog\Model\Product $product */
+        foreach ($collection->getItems() as $product) {
+            $allegroOfferId = $product->getAllegroOfferId();
+            try {
+                $this->offers->get($allegroOfferId);
+            } catch (Api\ClientResponseException $e) {
+                if ($e->getCode() == 404) {
+                    $product->setAllegroOfferId(null);
+                    $product->save();
+                }
+            }
+        }
+    }
+}

Setup/Patch/Data/OrderStatuses.php

@@ -3,7 +3,6 @@
 
 namespace Macopedia\Allegro\Setup\Patch\Data;
 
-
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 
@@ -21,7 +20,8 @@ class OrderStatuses implements DataPatchInterface
      * OrderStatuses constructor.
      * @param ModuleDataSetupInterface $moduleDataSetup
      */
-    public function __construct(ModuleDataSetupInterface $moduleDataSetup) {
+    public function __construct(ModuleDataSetupInterface $moduleDataSetup)
+    {
         $this->moduleDataSetup = $moduleDataSetup;
     }
 

etc/adminhtml/system.xml

@@ -72,14 +72,19 @@
                     <label>Reservations enabled</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
-                <field id="reservations_cron_enabled" translate="label" type="select" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
+                <field id="reservations_cron_enabled" translate="label comment" type="select" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
                     <depends>
                         <field id="reservations_enabled">1</field>
                     </depends>
                     <label>Cron for cleaning old reservations enabled</label>
                     <comment>Cron deletes reservations older than 10 days</comment>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
+                <field id="offers_mapping_cron_enabled" translate="label comment" type="select" sortOrder="31" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Cron for cleaning old offers mapping enabled</label>
+                    <comment>Cron removes Allegro offer ID from product when offer no longer exists</comment>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
                 <field id="store" translate="label" type="select" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Store to create new orders</label>
                     <source_model>Magento\Store\Model\System\Store</source_model>

etc/crontab.xml

@@ -13,5 +13,8 @@
         <job instance="Macopedia\Allegro\Cron\CleanReservations" method="execute" name="macopedia_allegro_clean_reservations">
             <schedule>0 12 * * *</schedule>
         </job>
+        <job instance="Macopedia\Allegro\Cron\CleanOffersMapping" method="execute" name="macopedia_allegro_clean_offers_mapping">
+            <schedule>0 10 * * *</schedule>
+        </job>
     </group>
 </config>

etc/di.xml

@@ -84,6 +84,7 @@
                 <item name="OrdersImport" xsi:type="object">Macopedia\Allegro\Console\Command\ImportOrders</item>
                 <item name="OrderImport" xsi:type="object">Macopedia\Allegro\Console\Command\ImportOrder</item>
                 <item name="OrdersWithErrorsImport" xsi:type="object">Macopedia\Allegro\Console\Command\ImportOrdersWithErrors</item>
+                <item name="CleanOffersMapping" xsi:type="object">Macopedia\Allegro\Console\Command\CleanOffersMapping</item>
             </argument>
         </arguments>
     </type>

i18n/pl_PL.csv

@@ -181,3 +181,5 @@
 "Cron deletes reservations older than 10 days","Cron usuwa rezerwacje starsze niż 10 dni"
 "Allegro underpayment","Allegro niedopłata"
 "Allegro overpayment","Allegro nadpłata"
+"Cron removes Allegro offer ID from product when offer no longer exists","Cron usuwa z produktu ID oferty na Allegro jeśli oferta już nie istnieje"
+"Cron for cleaning old offers mapping enabled","Cron do czyszczenia starych mapowań ofert"