ENGCOM-6945: Add afterGetList method in CustomerRepository plugin to retrieve is_s… #25311

 - Merge Pull Request #25311 from enriquei4/magento2:feature/getlist-plugin-customerRepository
 - Merged commits:
   1. b2d553a
   2. 8f5bfad
   3. 8b33f69
   4. d867655
   5. c9f9d71
   6. 5020752

Author: magento-engcom-team

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

@@ -17,6 +17,7 @@
 use Magento\Newsletter\Model\SubscriptionManagerInterface;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Framework\Api\SearchResults;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -233,6 +234,27 @@ public function afterGetById(CustomerRepositoryInterface $subject, CustomerInter
         return $customer;
     }
 
+    /**
+     * Add subscription status to customer list
+     *
+     * @param CustomerRepositoryInterface $subject
+     * @param SearchResults $searchResults
+     * @return SearchResults
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterGetList(CustomerRepositoryInterface $subject, SearchResults $searchResults): SearchResults
+    {
+        foreach ($searchResults->getItems() as $customer) {
+            /** @var CustomerExtensionInterface $extensionAttributes */
+            $extensionAttributes = $customer->getExtensionAttributes();
+
+            $isSubscribed = (int) $extensionAttributes->getIsSubscribed() === Subscriber::STATUS_SUBSCRIBED ?: false;
+            $extensionAttributes->setIsSubscribed($isSubscribed);
+        }
+
+        return $searchResults;
+    }
+
     /**
      * Set Is Subscribed extension attribute
      *

app/code/Magento/Newsletter/etc/extension_attributes.xml

@@ -8,6 +8,10 @@
 
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
     <extension_attributes for="Magento\Customer\Api\Data\CustomerInterface">
-        <attribute code="is_subscribed" type="boolean" />
+        <attribute code="is_subscribed" type="boolean" >
+            <join reference_table="newsletter_subscriber" reference_field="customer_id" join_on_field="entity_id">
+                <field>subscriber_status</field>
+            </join>
+        </attribute>
     </extension_attributes>
 </config>

dev/tests/api-functional/testsuite/Magento/Customer/Api/CustomerRepositoryTest.php

@@ -8,6 +8,8 @@
 
 use Magento\Customer\Api\Data\CustomerInterface as Customer;
 use Magento\Customer\Api\Data\AddressInterface as Address;
+use Magento\Framework\Api\FilterBuilder;
+use Magento\Framework\Api\SearchCriteriaInterface;
 use Magento\Framework\Api\SortOrder;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\LocalizedException;
@@ -482,25 +484,31 @@ public function testCreateCustomerWithoutAddressRequiresException()
 
     /**
      * Test with a single filter
+     *
+     * @param bool $subscribeStatus
+     * @return void
+     *
+     * @dataProvider subscriptionDataProvider
      */
-    public function testSearchCustomers()
+    public function testSearchCustomers(bool $subscribeStatus): void
     {
-        $builder = Bootstrap::getObjectManager()->create(\Magento\Framework\Api\FilterBuilder::class);
-        $customerData = $this->_createCustomer();
+        $builder = Bootstrap::getObjectManager()->create(FilterBuilder::class);
+        $subscribeData = $this->buildSubscriptionData($subscribeStatus);
+        $customerData = $this->_createCustomer($subscribeData);
         $filter = $builder
             ->setField(Customer::EMAIL)
             ->setValue($customerData[Customer::EMAIL])
             ->create();
         $this->searchCriteriaBuilder->addFilters([$filter]);
         $searchData = $this->dataObjectProcessor->buildOutputDataArray(
             $this->searchCriteriaBuilder->create(),
-            \Magento\Framework\Api\SearchCriteriaInterface::class
+            SearchCriteriaInterface::class
         );
         $requestData = ['searchCriteria' => $searchData];
         $serviceInfo = [
             'rest' => [
                 'resourcePath' => self::RESOURCE_PATH . '/search' . '?' . http_build_query($requestData),
-                'httpMethod' => \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET,
+                'httpMethod' => Request::HTTP_METHOD_GET,
             ],
             'soap' => [
                 'service' => self::SERVICE_NAME,
@@ -511,6 +519,35 @@ public function testSearchCustomers()
         $searchResults = $this->_webApiCall($serviceInfo, $requestData);
         $this->assertEquals(1, $searchResults['total_count']);
         $this->assertEquals($customerData[Customer::ID], $searchResults['items'][0][Customer::ID]);
+        $this->assertEquals($subscribeStatus, $searchResults['items'][0]['extension_attributes']['is_subscribed']);
+    }
+
+    /**
+     * Build subscription extension attributes data
+     *
+     * @param bool $status
+     * @return array
+     */
+    private function buildSubscriptionData(bool $status): array
+    {
+        return [
+            'extension_attributes' => [
+                'is_subscribed' => $status,
+            ],
+        ];
+    }
+
+    /**
+     * Subscription customer data provider
+     *
+     * @return array
+     */
+    public function subscriptionDataProvider(): array
+    {
+        return [
+            'subscribed user' => [true],
+            'not subscribed user' => [false],
+        ];
     }
 
     /**
@@ -857,11 +894,12 @@ protected function _getCustomerData($customerId)
     }
 
     /**
+     * @param array|null $additionalData
      * @return array|bool|float|int|string
      */
-    protected function _createCustomer()
+    protected function _createCustomer(?array $additionalData = [])
     {
-        $customerData = $this->customerHelper->createSampleCustomer();
+        $customerData = $this->customerHelper->createSampleCustomer($additionalData);
         $this->currentCustomerId[] = $customerData['id'];
         return $customerData;
     }