AC-8753: Coupon quantity generation checks

Author: faraz-gl

app/code/Magento/SalesRule/Controller/Adminhtml/Promo/Quote/Generate.php

@@ -3,76 +3,105 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\SalesRule\Controller\Adminhtml\Promo\Quote;
 
+use Magento\Backend\App\Action\Context;
 use Magento\Framework\App\Action\HttpPostActionInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\App\Response\Http\FileFactory;
+use Magento\Framework\Exception\InputException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filter\FilterInput;
+use Magento\Framework\Json\Helper\Data;
 use Magento\Framework\MessageQueue\PublisherInterface;
+use Magento\Framework\Registry;
+use Magento\Framework\Stdlib\DateTime\Filter\Date;
 use Magento\SalesRule\Api\Data\CouponGenerationSpecInterfaceFactory;
+use Magento\SalesRule\Controller\Adminhtml\Promo\Quote;
 use Magento\SalesRule\Model\CouponGenerator;
 use Magento\SalesRule\Model\Quote\GetCouponCodeLengthInterface;
+use Magento\SalesRule\Model\RegistryConstants;
+use Magento\SalesRule\Model\Rule;
+use Magento\Store\Model\ScopeInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Generate promo quote
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class Generate extends \Magento\SalesRule\Controller\Adminhtml\Promo\Quote implements HttpPostActionInterface
+class Generate extends Quote implements HttpPostActionInterface
 {
     /**
      * @var CouponGenerator
      */
-    private $couponGenerator;
+    private CouponGenerator $couponGenerator;
 
     /**
      * @var PublisherInterface
      */
-    private $messagePublisher;
+    private PublisherInterface $messagePublisher;
 
     /**
      * @var CouponGenerationSpecInterfaceFactory
      */
-    private $generationSpecFactory;
+    private CouponGenerationSpecInterfaceFactory $generationSpecFactory;
 
     /**
      * @var GetCouponCodeLengthInterface
      */
-    private $getCouponCodeLength;
+    private GetCouponCodeLengthInterface $getCouponCodeLength;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private ScopeConfigInterface $scopeConfig;
+
+    /**
+     * Handle coupon quantity system name
+     */
+    private const XML_COUPON_QUANTITY = 'promo/auto_generated_coupon_codes/quantity';
 
     /**
      * Generate constructor.
-     * @param \Magento\Backend\App\Action\Context $context
-     * @param \Magento\Framework\Registry $coreRegistry
-     * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
-     * @param \Magento\Framework\Stdlib\DateTime\Filter\Date $dateFilter
+     * @param Context $context
+     * @param Registry $coreRegistry
+     * @param FileFactory $fileFactory
+     * @param Date $dateFilter
      * @param CouponGenerator|null $couponGenerator
      * @param PublisherInterface|null $publisher
      * @param CouponGenerationSpecInterfaceFactory|null $generationSpecFactory
      * @param GetCouponCodeLengthInterface|null $getCouponCodeLength
+     * @param ScopeConfigInterface|null $scopeConfig
      */
     public function __construct(
-        \Magento\Backend\App\Action\Context $context,
-        \Magento\Framework\Registry $coreRegistry,
-        \Magento\Framework\App\Response\Http\FileFactory $fileFactory,
-        \Magento\Framework\Stdlib\DateTime\Filter\Date $dateFilter,
+        Context $context,
+        Registry $coreRegistry,
+        FileFactory $fileFactory,
+        Date $dateFilter,
         CouponGenerator $couponGenerator = null,
         PublisherInterface $publisher = null,
         CouponGenerationSpecInterfaceFactory $generationSpecFactory = null,
-        GetCouponCodeLengthInterface $getCouponCodeLength = null
+        GetCouponCodeLengthInterface $getCouponCodeLength = null,
+        ScopeConfigInterface $scopeConfig = null
     ) {
         parent::__construct($context, $coreRegistry, $fileFactory, $dateFilter);
         $this->couponGenerator = $couponGenerator ?:
             $this->_objectManager->get(CouponGenerator::class);
-        $this->messagePublisher = $publisher ?: \Magento\Framework\App\ObjectManager::getInstance()
+        $this->messagePublisher = $publisher ?: ObjectManager::getInstance()
             ->get(PublisherInterface::class);
         $this->generationSpecFactory = $generationSpecFactory ?:
-            \Magento\Framework\App\ObjectManager::getInstance()->get(
+            ObjectManager::getInstance()->get(
                 CouponGenerationSpecInterfaceFactory::class
             );
         $this->getCouponCodeLength = $getCouponCodeLength ?:
-            \Magento\Framework\App\ObjectManager::getInstance()->get(
+            ObjectManager::getInstance()->get(
                 GetCouponCodeLengthInterface::class
             );
+        $this->scopeConfig = $scopeConfig;
     }
 
     /**
@@ -81,7 +110,7 @@ public function __construct(
      * @return void
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
-    public function execute()
+    public function execute(): void
     {
         if (!$this->getRequest()->isAjax()) {
             $this->_forward('noroute');
@@ -90,13 +119,13 @@ public function execute()
         $result = [];
         $this->_initRule();
 
-        $rule = $this->_coreRegistry->registry(\Magento\SalesRule\Model\RegistryConstants::CURRENT_SALES_RULE);
+        $rule = $this->_coreRegistry->registry(RegistryConstants::CURRENT_SALES_RULE);
 
         $data = $this->getRequest()->getParams();
 
         if (!$rule->getId()) {
             $result['error'] = __('Rule is not defined');
-        } elseif ((int) $rule->getCouponType() !== \Magento\SalesRule\Model\Rule::COUPON_TYPE_AUTO
+        } elseif ((int) $rule->getCouponType() !== Rule::COUPON_TYPE_AUTO
             && !$rule->getUseAutoGeneration()) {
             $result['error'] =
                 __('The rule coupon settings changed. Please save the rule before using auto-generation.');
@@ -123,7 +152,7 @@ public function execute()
                 $result['error'] = __(
                     'Something went wrong while validating coupon code length. Please review the log and try again.'
                 );
-                $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
+                $this->_objectManager->get(LoggerInterface::class)->critical($e);
             }
         } else {
             try {
@@ -132,29 +161,40 @@ public function execute()
                     $data = $inputFilter->getUnescaped();
                 }
 
-                $data['quantity'] = isset($data['qty']) ? $data['qty'] : null;
-
-                $couponSpec = $this->generationSpecFactory->create(['data' => $data]);
-
-                $this->messagePublisher->publish('sales_rule.codegenerator', $couponSpec);
-                $this->messageManager->addSuccessMessage(
-                    __('Message is added to queue, wait to get your coupons soon')
+                $data['quantity'] = $data['qty'] ?? null;
+                $couponQuantity = (int)$this->scopeConfig->getValue(
+                    self::XML_COUPON_QUANTITY,
+                    ScopeInterface::SCOPE_STORE
                 );
+                if ($data['quantity'] && $couponQuantity && $data['quantity'] > $couponQuantity) {
+                    $this->messageManager->addErrorMessage(
+                        __(
+                            'Coupon qty should be less than or equal to the coupon qty in the store configuration.'
+                        )
+                    );
+                } else {
+                    $couponSpec = $this->generationSpecFactory->create(['data' => $data]);
+
+                    $this->messagePublisher->publish('sales_rule.codegenerator', $couponSpec);
+                    $this->messageManager->addSuccessMessage(
+                        __('Message is added to queue, wait to get your coupons soon')
+                    );
+                }
                 $this->_view->getLayout()->initMessages();
                 $result['messages'] = $this->_view->getLayout()->getMessagesBlock()->getGroupedHtml();
-            } catch (\Magento\Framework\Exception\InputException $inputException) {
+            } catch (InputException $inputException) {
                 $result['error'] = __('Invalid data provided');
-            } catch (\Magento\Framework\Exception\LocalizedException $e) {
+            } catch (LocalizedException $e) {
                 $result['error'] = $e->getMessage();
             } catch (\Exception $e) {
                 $result['error'] = __(
                     'Something went wrong while generating coupons. Please review the log and try again.'
                 );
-                $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
+                $this->_objectManager->get(LoggerInterface::class)->critical($e);
             }
         }
         $this->getResponse()->representJson(
-            $this->_objectManager->get(\Magento\Framework\Json\Helper\Data::class)->jsonEncode($result)
+            $this->_objectManager->get(Data::class)->jsonEncode($result)
         );
     }
 }