Skip to content

Commit f3a0bff

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-8817: Removed caching subscription status from plugin #32254
- Merge Pull Request #32254 from engcom-Charlie/magento2:19345 - Merged commits: 1. c2b038e 2. 8a90819 3. 6df702e 4. c6e170e 5. b1f9f8e 6. a82f3e9
2 parents a4071d4 + a82f3e9 commit f3a0bff

File tree

5 files changed

+117
-32
lines changed

5 files changed

+117
-32
lines changed

‎app/code/Magento/Newsletter/Model/CustomerSubscriberCache.php

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Newsletter\Model;
9+
10+
/**
11+
* This service provides caching Subscriber by Customer id.
12+
*/
13+
class CustomerSubscriberCache
14+
{
15+
/**
16+
* @var array
17+
*/
18+
private $customerSubscriber = [];
19+
20+
/**
21+
* Get Subscriber from cache by Customer id.
22+
*
23+
* @param int $customerId
24+
* @return Subscriber|null
25+
*/
26+
public function getCustomerSubscriber(int $customerId): ?Subscriber
27+
{
28+
$subscriber = null;
29+
if (isset($this->customerSubscriber[$customerId])) {
30+
$subscriber = $this->customerSubscriber[$customerId];
31+
}
32+
33+
return $subscriber;
34+
}
35+
36+
/**
37+
* Set Subscriber to cache by Customer id.
38+
*
39+
* @param int $customerId
40+
* @param Subscriber|null $subscriber
41+
*/
42+
public function setCustomerSubscriber(int $customerId, ?Subscriber $subscriber): void
43+
{
44+
$this->customerSubscriber[$customerId] = $subscriber;
45+
}
46+
}

‎app/code/Magento/Newsletter/Model/Plugin/CustomerPlugin.php

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,24 @@
33
* Copyright © Magento, Inc. All rights reserved.
44
* See COPYING.txt for license details.
55
*/
6+
67
namespace Magento\Newsletter\Model\Plugin;
78

89
use Magento\Customer\Api\CustomerRepositoryInterface;
10+
use Magento\Customer\Api\Data\CustomerExtensionInterface;
911
use Magento\Customer\Api\Data\CustomerInterface;
1012
use Magento\Customer\Model\Config\Share;
1113
use Magento\Framework\Api\ExtensionAttributesFactory;
14+
use Magento\Framework\Api\SearchResults;
15+
use Magento\Framework\App\ObjectManager;
1216
use Magento\Framework\Exception\NoSuchEntityException;
13-
use Magento\Newsletter\Model\Subscriber;
17+
use Magento\Newsletter\Model\CustomerSubscriberCache;
1418
use Magento\Newsletter\Model\ResourceModel\Subscriber\CollectionFactory;
15-
use Magento\Customer\Api\Data\CustomerExtensionInterface;
19+
use Magento\Newsletter\Model\Subscriber;
1620
use Magento\Newsletter\Model\SubscriberFactory;
1721
use Magento\Newsletter\Model\SubscriptionManagerInterface;
1822
use Magento\Store\Model\Store;
1923
use Magento\Store\Model\StoreManagerInterface;
20-
use Magento\Framework\Api\SearchResults;
2124
use Psr\Log\LoggerInterface;
2225

2326
/**
@@ -52,11 +55,6 @@ class CustomerPlugin
5255
*/
5356
private $storeManager;
5457

55-
/**
56-
* @var array
57-
*/
58-
private $customerSubscriber = [];
59-
6058
/**
6159
* @var SubscriberFactory
6260
*/
@@ -67,6 +65,11 @@ class CustomerPlugin
6765
*/
6866
private $logger;
6967

68+
/**
69+
* @var CustomerSubscriberCache
70+
*/
71+
private $customerSubscriberCache;
72+
7073
/**
7174
* @param SubscriberFactory $subscriberFactory
7275
* @param ExtensionAttributesFactory $extensionFactory
@@ -75,6 +78,7 @@ class CustomerPlugin
7578
* @param Share $shareConfig
7679
* @param StoreManagerInterface $storeManager
7780
* @param LoggerInterface $logger
81+
* @param CustomerSubscriberCache|null $customerSubscriberCache
7882
*/
7983
public function __construct(
8084
SubscriberFactory $subscriberFactory,
@@ -83,7 +87,8 @@ public function __construct(
8387
SubscriptionManagerInterface $subscriptionManager,
8488
Share $shareConfig,
8589
StoreManagerInterface $storeManager,
86-
LoggerInterface $logger
90+
LoggerInterface $logger,
91+
CustomerSubscriberCache $customerSubscriberCache = null
8792
) {
8893
$this->subscriberFactory = $subscriberFactory;
8994
$this->extensionFactory = $extensionFactory;
@@ -92,6 +97,8 @@ public function __construct(
9297
$this->shareConfig = $shareConfig;
9398
$this->storeManager = $storeManager;
9499
$this->logger = $logger;
100+
$this->customerSubscriberCache = $customerSubscriberCache
101+
?? ObjectManager::getInstance()->get(CustomerSubscriberCache::class);
95102
}
96103

97104
/**
@@ -129,10 +136,11 @@ public function afterSave(
129136
}
130137
if ($needToUpdate) {
131138
$storeId = $this->getCurrentStoreId($result);
139+
$customerId = (int)$result->getId();
132140
$subscriber = $subscribeStatus
133-
? $this->subscriptionManager->subscribeCustomer((int)$result->getId(), $storeId)
134-
: $this->subscriptionManager->unsubscribeCustomer((int)$result->getId(), $storeId);
135-
$this->customerSubscriber[(int)$result->getId()] = $subscriber;
141+
? $this->subscriptionManager->subscribeCustomer($customerId, $storeId)
142+
: $this->subscriptionManager->unsubscribeCustomer($customerId, $storeId);
143+
$this->customerSubscriberCache->setCustomerSubscriber($customerId, $subscriber);
136144
}
137145
$this->addIsSubscribedExtensionAttribute($result, $subscriber->isSubscribed());
138146

@@ -258,7 +266,7 @@ public function afterGetList(CustomerRepositoryInterface $subject, SearchResults
258266
$extensionAttributes = $customer->getExtensionAttributes();
259267
/** @var Subscriber $subscribe */
260268
$subscribe = $collection->getItemByColumnValue('subscriber_email', $customer->getEmail());
261-
$isSubscribed = $subscribe && (int) $subscribe->getStatus() === Subscriber::STATUS_SUBSCRIBED;
269+
$isSubscribed = $subscribe && (int)$subscribe->getStatus() === Subscriber::STATUS_SUBSCRIBED;
262270
$extensionAttributes->setIsSubscribed($isSubscribed);
263271
}
264272

@@ -315,22 +323,20 @@ private function deleteSubscriptionsAfterCustomerDelete(CustomerInterface $custo
315323
private function getSubscriber(CustomerInterface $customer): Subscriber
316324
{
317325
$customerId = (int)$customer->getId();
318-
if (isset($this->customerSubscriber[$customerId])) {
319-
return $this->customerSubscriber[$customerId];
320-
}
321-
322-
/** @var Subscriber $subscriber */
323-
$subscriber = $this->subscriberFactory->create();
324-
$websiteId = $this->getCurrentWebsiteId($customer);
325-
$subscriber->loadByCustomer((int)$customer->getId(), $websiteId);
326-
/**
327-
* If subscriber was't found by customer id then try to find subscriber by customer email.
328-
* It need when the customer is creating and he has already subscribed as guest by same email.
329-
*/
330-
if (!$subscriber->getId()) {
331-
$subscriber->loadBySubscriberEmail((string)$customer->getEmail(), $websiteId);
326+
$subscriber = $this->customerSubscriberCache->getCustomerSubscriber($customerId);
327+
if ($subscriber === null) {
328+
$subscriber = $this->subscriberFactory->create();
329+
$websiteId = $this->getCurrentWebsiteId($customer);
330+
$subscriber->loadByCustomer((int)$customer->getId(), $websiteId);
331+
/**
332+
* If subscriber wasn't found by customer id then try to find subscriber by customer email.
333+
* It need when the customer is creating and he has already subscribed as guest by same email.
334+
*/
335+
if (!$subscriber->getId()) {
336+
$subscriber->loadBySubscriberEmail((string)$customer->getEmail(), $websiteId);
337+
}
338+
$this->customerSubscriberCache->setCustomerSubscriber($customerId, $subscriber);
332339
}
333-
$this->customerSubscriber[$customerId] = $subscriber;
334340

335341
return $subscriber;
336342
}

‎app/code/Magento/Newsletter/Model/SubscriptionManager.php

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
use Magento\Customer\Api\CustomerRepositoryInterface;
1212
use Magento\Customer\Api\Data\CustomerInterface;
1313
use Magento\Framework\App\Config\ScopeConfigInterface;
14+
use Magento\Framework\App\ObjectManager;
1415
use Magento\Framework\Exception\MailException;
1516
use Magento\Store\Model\ScopeInterface;
1617
use Magento\Store\Model\StoreManagerInterface;
@@ -51,28 +52,37 @@ class SubscriptionManager implements SubscriptionManagerInterface
5152
*/
5253
private $customerRepository;
5354

55+
/**
56+
* @var CustomerSubscriberCache
57+
*/
58+
private $customerSubscriberCache;
59+
5460
/**
5561
* @param SubscriberFactory $subscriberFactory
5662
* @param LoggerInterface $logger
5763
* @param StoreManagerInterface $storeManager
5864
* @param ScopeConfigInterface $scopeConfig
5965
* @param AccountManagementInterface $customerAccountManagement
6066
* @param CustomerRepositoryInterface $customerRepository
67+
* @param CustomerSubscriberCache|null $customerSubscriberCache
6168
*/
6269
public function __construct(
6370
SubscriberFactory $subscriberFactory,
6471
LoggerInterface $logger,
6572
StoreManagerInterface $storeManager,
6673
ScopeConfigInterface $scopeConfig,
6774
AccountManagementInterface $customerAccountManagement,
68-
CustomerRepositoryInterface $customerRepository
75+
CustomerRepositoryInterface $customerRepository,
76+
CustomerSubscriberCache $customerSubscriberCache = null
6977
) {
7078
$this->subscriberFactory = $subscriberFactory;
7179
$this->logger = $logger;
7280
$this->storeManager = $storeManager;
7381
$this->scopeConfig = $scopeConfig;
7482
$this->customerAccountManagement = $customerAccountManagement;
7583
$this->customerRepository = $customerRepository;
84+
$this->customerSubscriberCache = $customerSubscriberCache
85+
?? ObjectManager::getInstance()->get(CustomerSubscriberCache::class);
7686
}
7787

7888
/**
@@ -209,14 +219,16 @@ private function saveSubscriber(
209219
if (!$subscriber->getId()) {
210220
$subscriber->setSubscriberConfirmCode($subscriber->randomSequence());
211221
}
222+
$customerId = (int)$customer->getId();
212223
$subscriber->setStatus($status)
213224
->setStatusChanged($statusChanged)
214-
->setCustomerId($customer->getId())
225+
->setCustomerId($customerId)
215226
->setStoreId($storeId)
216227
->setEmail($customer->getEmail())
217228
->save();
218229

219230
if ($statusChanged) {
231+
$this->customerSubscriberCache->setCustomerSubscriber($customerId, null);
220232
return true;
221233
}
222234

‎dev/tests/integration/testsuite/Magento/Newsletter/Controller/Manage/SaveTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
use Magento\Customer\Model\Session;
1313
use Magento\Framework\Data\Form\FormKey;
1414
use Magento\Framework\Message\MessageInterface;
15+
use Magento\Newsletter\Model\CustomerSubscriberCache;
1516
use Magento\Newsletter\Model\Plugin\CustomerPlugin;
1617
use Magento\TestFramework\TestCase\AbstractController;
1718

@@ -69,7 +70,6 @@ protected function tearDown(): void
6970
public function testSaveAction(bool $isSubscribed, string $expectedMessage): void
7071
{
7172
$this->loginCustomer('new_customer@example.com');
72-
$this->_objectManager->removeSharedInstance(CustomerPlugin::class);
7373
$this->dispatchSaveAction($isSubscribed);
7474
$this->assertSuccessSubscription($expectedMessage);
7575
}
@@ -112,7 +112,6 @@ public function testSubscribeWithEnabledConfirmation(): void
112112
public function testUnsubscribeSubscribedCustomer(): void
113113
{
114114
$this->loginCustomer('new_customer@example.com');
115-
$this->_objectManager->removeSharedInstance(CustomerPlugin::class);
116115
$this->dispatchSaveAction(false);
117116
$this->assertSuccessSubscription('We have removed your newsletter subscription.');
118117
}
@@ -126,6 +125,7 @@ public function testUnsubscribeSubscribedCustomer(): void
126125
private function dispatchSaveAction(bool $isSubscribed): void
127126
{
128127
$this->_objectManager->removeSharedInstance(CustomerPlugin::class);
128+
$this->_objectManager->removeSharedInstance(CustomerSubscriberCache::class);
129129
$this->getRequest()->setParam('form_key', $this->formKey->getFormKey())
130130
->setParam('is_subscribed', $isSubscribed);
131131
$this->dispatch('newsletter/manage/save');

‎dev/tests/integration/testsuite/Magento/Newsletter/Model/SubscriberTest.php

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,27 @@ public function testUnsubscribeSubscribeByCustomerId(): void
151151
);
152152
}
153153

154+
/**
155+
* Test subscribe and verify customer subscription status
156+
*
157+
* @magentoDataFixture Magento/Customer/_files/customer_sample.php
158+
*
159+
* @return void
160+
*/
161+
public function testSubscribeAndVerifyCustomerSubscriptionStatus(): void
162+
{
163+
$customer = $this->customerRepository->getById(1);
164+
$subscriptionBefore = $customer->getExtensionAttributes()
165+
->getIsSubscribed();
166+
$subscriber = $this->subscriberFactory->create();
167+
$subscriber->subscribeCustomerById($customer->getId());
168+
169+
$customer = $this->customerRepository->getById(1);
170+
171+
$this->assertFalse($subscriptionBefore);
172+
$this->assertTrue($customer->getExtensionAttributes()->getIsSubscribed());
173+
}
174+
154175
/**
155176
* @magentoConfigFixture current_store newsletter/subscription/confirm 1
156177
*

0 commit comments

Comments
 (0)