Merge remote-tracking branch '33375/33040_newsletter_subscription_bugfix' into 247beta3_jan

Author: Indrani Sonawane

app/code/Magento/Newsletter/Controller/Subscriber/NewAction.php

@@ -4,6 +4,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Newsletter\Controller\Subscriber;
 
 use Magento\Customer\Api\AccountManagementInterface as CustomerAccountManagement;
@@ -24,6 +26,7 @@
 use Magento\Newsletter\Model\SubscriptionManagerInterface;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Newsletter\Model\Config as NewsletterConfig;
 use Magento\Newsletter\Model\SubscriberFactory;
 
 /**
@@ -43,6 +46,11 @@ class NewAction extends SubscriberController implements HttpPostActionInterface
      */
     private $emailValidator;
 
+    /**
+     * @var NewsletterConfig
+     */
+    private $newsletterConfig;
+
     /**
      * @var SubscriptionManagerInterface
      */
@@ -65,6 +73,8 @@ class NewAction extends SubscriberController implements HttpPostActionInterface
      * @param SubscriptionManagerInterface $subscriptionManager
      * @param EmailValidator|null $emailValidator
      * @param CustomerRepositoryInterface|null $customerRepository
+     * @param NewsletterConfig|null $newsletterConfig
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         Context $context,
@@ -75,13 +85,16 @@ public function __construct(
         CustomerAccountManagement $customerAccountManagement,
         SubscriptionManagerInterface $subscriptionManager,
         EmailValidator $emailValidator = null,
-        CustomerRepositoryInterface $customerRepository = null
+        CustomerRepositoryInterface $customerRepository = null,
+        NewsletterConfig $newsletterConfig = null
     ) {
         $this->customerAccountManagement = $customerAccountManagement;
         $this->subscriptionManager = $subscriptionManager;
         $this->emailValidator = $emailValidator ?: ObjectManager::getInstance()->get(EmailValidator::class);
         $this->customerRepository = $customerRepository ?: ObjectManager::getInstance()
             ->get(CustomerRepositoryInterface::class);
+        $this->newsletterConfig = $newsletterConfig?: ObjectManager::getInstance()
+            ->get(NewsletterConfig::class);
         parent::__construct(
             $context,
             $subscriberFactory,
@@ -95,8 +108,9 @@ public function __construct(
      * Validates that the email address isn't being used by a different account.
      *
      * @param string $email
-     * @throws LocalizedException
+     *
      * @return void
+     * @throws LocalizedException
      */
     protected function validateEmailAvailable($email)
     {
@@ -139,8 +153,9 @@ protected function validateGuestSubscription()
      * Validates the format of the email address
      *
      * @param string $email
-     * @throws LocalizedException
+     *
      * @return void
+     * @throws LocalizedException
      */
     protected function validateEmailFormat($email)
     {
@@ -156,7 +171,10 @@ protected function validateEmailFormat($email)
      */
     public function execute()
     {
-        if ($this->getRequest()->isPost() && $this->getRequest()->getPost('email')) {
+        if ($this->getRequest()->isPost()
+            && $this->getRequest()->getPost('email')
+            && $this->newsletterConfig->isActive()
+        ) {
             $email = (string)$this->getRequest()->getPost('email');
 
             try {
@@ -195,6 +213,7 @@ public function execute()
         $redirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
         // phpcs:ignore Magento2.Legacy.ObsoleteResponse
         $redirectUrl = $this->_redirect->getRedirectUrl();
+
         return $redirect->setUrl($redirectUrl);
     }
 
@@ -203,6 +222,7 @@ public function execute()
      *
      * @param string $email
      * @param int $websiteId
+     *
      * @return int|null
      */
     private function getCustomerId(string $email, int $websiteId): ?int
@@ -219,6 +239,7 @@ private function getCustomerId(string $email, int $websiteId): ?int
      * Get success message
      *
      * @param int $status
+     *
      * @return Phrase
      */
     private function getSuccessMessage(int $status): Phrase

dev/tests/integration/testsuite/Magento/Newsletter/Controller/Subscriber/NewActionTest.php

@@ -7,6 +7,8 @@
 
 namespace Magento\Newsletter\Controller\Subscriber;
 
+use Exception;
+use Laminas\Stdlib\Parameters;
 use Magento\Customer\Api\CustomerRepositoryInterface;
 use Magento\Customer\Model\AccountManagement;
 use Magento\Customer\Model\Session;
@@ -18,7 +20,6 @@
 use Magento\Newsletter\Model\ResourceModel\Subscriber\Grid\Collection as GridCollection;
 use Magento\Store\Model\ScopeInterface;
 use Magento\TestFramework\TestCase\AbstractController;
-use Laminas\Stdlib\Parameters;
 
 /**
  * Class checks subscription behaviour from frontend
@@ -28,6 +29,9 @@
  */
 class NewActionTest extends AbstractController
 {
+    /** @var CustomerRepositoryInterface */
+    private $customerRepository;
+
     /** @var Session */
     private $session;
 
@@ -40,9 +44,6 @@ class NewActionTest extends AbstractController
     /** @var string|null */
     private $subscriberToDelete;
 
-    /** @var CustomerRepositoryInterface */
-    private $customerRepository;
-
     /** @var Url */
     private $customerUrl;
 
@@ -88,6 +89,38 @@ public function testNewAction(string $email, string $expectedMessage): void
         $this->performAsserts($expectedMessage);
     }
 
+    /**
+     * @magentoConfigFixture newsletter/general/active 1
+     *
+     * @return void
+     */
+    public function testNewActionWithSubscriptionConfigEnabled(): void
+    {
+        $email = 'good_subscription@example.com';
+        $this->subscriberToDelete = $email;
+        $this->prepareRequest($email);
+        $this->dispatch('newsletter/subscriber/new');
+        $subscriberCollection = $this->subscriberCollectionFactory->create();
+        $subscriberCollection->addFieldToFilter('subscriber_email', $email)->setPageSize(1);
+        $this->assertEquals(1, count($subscriberCollection));
+        $this->assertEquals($email, $subscriberCollection->getFirstItem()->getEmail());
+    }
+
+    /**
+     * @magentoConfigFixture newsletter/general/active 0
+     *
+     * @return void
+     */
+    public function testNewActionWithSubscriptionConfigDisabled(): void
+    {
+        $email = 'bad_subscription@example.com';
+        $this->prepareRequest($email);
+        $this->dispatch('newsletter/subscriber/new');
+        $subscriberCollection = $this->subscriberCollectionFactory->create();
+        $subscriberCollection->addFieldToFilter('subscriber_email', $email)->setPageSize(1);
+        $this->assertEquals(0, count($subscriberCollection));
+    }
+
     /**
      * @return array
      */
@@ -272,7 +305,9 @@ private function performAsserts(string $message): void
      * Delete subscribers by email
      *
      * @param string $email
+     *
      * @return void
+     * @throws Exception
      */
     private function deleteSubscriber(string $email): void
     {