MAGETWO-71829: is_subscribed extended attribute isn't returned in REST customer calls

Author: olysenko

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

@@ -8,6 +8,10 @@
 use Magento\Customer\Api\CustomerRepositoryInterface as CustomerRepository;
 use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Newsletter\Model\SubscriberFactory;
+use Magento\Framework\Api\ExtensionAttributesFactory;
+use Magento\Newsletter\Model\ResourceModel\Subscriber;
+use Magento\Customer\Api\Data\CustomerExtensionInterface;
+use Magento\Framework\App\ObjectManager;
 
 class CustomerPlugin
 {
@@ -18,14 +22,37 @@ class CustomerPlugin
      */
     private $subscriberFactory;
 
+    /**
+     * @var ExtensionAttributesFactory
+     */
+    private $extensionFactory;
+
+    /**
+     * @var Subscriber
+     */
+    private $subscriberResource;
+
+    /**
+     * @var array
+     */
+    private $customerSubscriptionStatus = [];
+
     /**
      * Initialize dependencies.
      *
      * @param SubscriberFactory $subscriberFactory
+     * @param ExtensionAttributesFactory|null $extensionFactory
+     * @param Subscriber|null $subscriberResource
      */
-    public function __construct(SubscriberFactory $subscriberFactory)
-    {
+    public function __construct(
+        SubscriberFactory $subscriberFactory,
+        ExtensionAttributesFactory $extensionFactory = null,
+        Subscriber $subscriberResource = null
+    ) {
         $this->subscriberFactory = $subscriberFactory;
+        $this->extensionFactory = $extensionFactory
+            ?: ObjectManager::getInstance()->get(ExtensionAttributesFactory::class);
+        $this->subscriberResource = $subscriberResource ?: ObjectManager::getInstance()->get(Subscriber::class);
     }
 
     /**
@@ -41,14 +68,29 @@ public function __construct(SubscriberFactory $subscriberFactory)
      */
     public function afterSave(CustomerRepository $subject, CustomerInterface $result, CustomerInterface $customer)
     {
-        $this->subscriberFactory->create()->updateSubscription($result->getId());
-        if ($result->getId() && $customer->getExtensionAttributes()) {
-            if ($customer->getExtensionAttributes()->getIsSubscribed() === true) {
-                $this->subscriberFactory->create()->subscribeCustomerById($result->getId());
-            } elseif ($customer->getExtensionAttributes()->getIsSubscribed() === false) {
-                $this->subscriberFactory->create()->unsubscribeCustomerById($result->getId());
+        $resultId = $result->getId();
+        /** @var \Magento\Newsletter\Model\Subscriber $subscriber */
+        $subscriber = $this->subscriberFactory->create();
+        $subscriber->updateSubscription($resultId);
+        // update the result only if the original customer instance had different value.
+        $initialExtensionAttributes = $result->getExtensionAttributes();
+        if ($initialExtensionAttributes === null) {
+            /** @var CustomerExtensionInterface $initialExtensionAttributes */
+            $initialExtensionAttributes = $this->extensionFactory->create(CustomerInterface::class);
+            $result->setExtensionAttributes($initialExtensionAttributes);
+        }
+        $newExtensionAttributes = $customer->getExtensionAttributes();
+        if ($newExtensionAttributes
+            && $initialExtensionAttributes->getIsSubscribed() !== $newExtensionAttributes->getIsSubscribed()) {
+            if ($newExtensionAttributes->getIsSubscribed() === true) {
+                $subscriber->subscribeCustomerById($resultId);
+            } elseif ($newExtensionAttributes->getIsSubscribed() === false) {
+                $subscriber->unsubscribeCustomerById($resultId);
             }
         }
+        $isSubscribed = $subscriber->isSubscribed();
+        $this->customerSubscriptionStatus[$resultId] = $isSubscribed;
+        $initialExtensionAttributes->setIsSubscribed($isSubscribed);
         return $result;
     }
 
@@ -94,4 +136,49 @@ public function afterDelete(CustomerRepository $subject, $result, CustomerInterf
         }
         return $result;
     }
+
+    /**
+     * Plugin after getById customer that obtains newsletter subscription status for given customer.
+     *
+     * @param CustomerRepository $subject
+     * @param CustomerInterface $customer
+     * @return CustomerInterface
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterGetById(CustomerRepository $subject, CustomerInterface $customer)
+    {
+        $extensionAttributes = $customer->getExtensionAttributes();
+        if ($extensionAttributes === null) {
+            /** @var CustomerExtensionInterface $customerExtension */
+            $customerExtension = $this->extensionFactory->create(CustomerInterface::class);
+            $isSubscribed = $this->isSubscribed($customer);
+            $customerExtension->setIsSubscribed($isSubscribed);
+            $customer->setExtensionAttributes($customerExtension);
+            return $customer;
+        }
+        if ($extensionAttributes->getIsSubscribed() === null) {
+            $isSubscribed = $this->isSubscribed($customer);
+            $extensionAttributes->setIsSubscribed($isSubscribed);
+            $customer->setExtensionAttributes($extensionAttributes);
+            return $customer;
+        }
+        return $customer;
+    }
+
+    /**
+     * This method returns newsletters subscription status for given customer.
+     *
+     * @param CustomerInterface $customer
+     * @return mixed
+     */
+    private function isSubscribed(CustomerInterface $customer)
+    {
+        $customerId = $customer->getId();
+        if (!isset($this->customerSubscriptionStatus[$customerId])) {
+            $subscriber = $this->subscriberResource->loadByCustomerData($customer);
+            $this->customerSubscriptionStatus[$customerId] = isset($subscriber['subscriber_status'])
+                && $subscriber['subscriber_status'] == 1;
+        }
+        return $this->customerSubscriptionStatus[$customerId];
+    }
 }