Mailchimp sync improvements: don't delete email addresses which exist in other subscribed customer objects.

This helps for some edge cases.

Author: mmoser

src/Newsletter/ProviderHandler/Mailchimp.php

@@ -16,6 +16,7 @@
 namespace CustomerManagementFrameworkBundle\Newsletter\ProviderHandler;
 
 use CustomerManagementFrameworkBundle\ActivityManager\ActivityManagerInterface;
+use CustomerManagementFrameworkBundle\CustomerProvider\CustomerProviderInterface;
 use CustomerManagementFrameworkBundle\DataTransformer\Cleanup\Email;
 use CustomerManagementFrameworkBundle\DataTransformer\DataTransformerInterface;
 use CustomerManagementFrameworkBundle\Model\Activity\MailchimpStatusChangeActivity;
@@ -759,4 +760,36 @@ public function didMergeFieldDataChange($pimcoreField, $pimcoreData, $mailchimpI
 
         return $this->fieldTransformers[$pimcoreField]->didMergeFieldDataChange($pimcoreData, $mailchimpImportData);
     }
+
+    /**
+     * @param $email
+     * @param int|false $customerId
+     * @return bool
+     */
+    public function doesOtherSubscribedCustomerWithEmailExist($email, $customerId = false)
+    {
+
+        if(!$email) {
+            return false;
+        }
+        /**
+         * @var CustomerProviderInterface $customerProvider
+         */
+        $customerProvider = \Pimcore::getContainer()->get(CustomerProviderInterface::class);
+        $list = $customerProvider->getList();
+        if($customerId) {
+            $list->setCondition('trim(lower(email)) = ? and o_id != ?', [trim(strtolower($email)), $customerId]);
+        } else {
+            $list->setCondition('trim(lower(email)) = ?', [trim(strtolower($email))]);
+        }
+
+
+        foreach($list as $_customer) {
+            if(in_array($this->getMailchimpStatus($_customer), array(self::STATUS_PENDING, self::STATUS_SUBSCRIBED))) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/Newsletter/ProviderHandler/Mailchimp/CustomerExporter/BatchExporter.php

@@ -197,6 +197,20 @@ protected function createBatchUpdateOperation(Batch $batch, CustomerInterface $c
      */
     protected function createBatchDeleteOperation(Batch $batch, NewsletterQueueItemInterface $item, Mailchimp $mailchimpProviderHandler)
     {
+        if($mailchimpProviderHandler->doesOtherSubscribedCustomerWithEmailExist($item->getEmail(), $item->getCustomerId())) {
+
+            $this->getLogger()->info(
+                sprintf(
+                    '[MailChimp][CUSTOMER %s][%s] Deletion skipped as another subscribed customer with the same email exists.',
+                    $item->getCustomerId(),
+                    $mailchimpProviderHandler->getShortcut()
+                )
+            );
+
+            $item->setSuccessfullyProcessed(true);
+            return;
+        }
+
         $exportService = $this->exportService;
         $apiClient = $this->apiClient;
 
@@ -360,13 +374,16 @@ protected function processSuccessfullItem(Mailchimp $mailchimpProviderHandler, N
 
         /** @var MailchimpAwareCustomerInterface|ElementInterface $customer */
         $customer = $item->getCustomer();
-        $entry = $mailchimpProviderHandler->buildEntry($customer);
-        $remoteId = $apiClient->subscriberHash($entry['email_address']);
+
 
         $operation = $item->getOverruledOperation() ?: $item->getOperation();
 
         // add note
         if ($operation == NewsletterQueueInterface::OPERATION_UPDATE) {
+
+            $entry = $mailchimpProviderHandler->buildEntry($customer);
+            $remoteId = $apiClient->subscriberHash($entry['email_address']);
+
             $exportService
                 ->createExportNote($customer, $mailchimpProviderHandler->getListId(), $remoteId, null, 'Mailchimp Export [' . $mailchimpProviderHandler->getShortcut() . ']', ['exportdataMd5' => $exportService->getMd5($entry)])
                 ->save();
@@ -383,6 +400,9 @@ protected function processSuccessfullItem(Mailchimp $mailchimpProviderHandler, N
                 ]
             );
         } elseif ($customer) {
+            $entry = $mailchimpProviderHandler->buildEntry($customer);
+            $remoteId = $apiClient->subscriberHash($entry['email_address']);
+
             $exportService
                 ->createExportNote($customer, $mailchimpProviderHandler->getListId(), $remoteId, null, 'Mailchimp Deletion [' . $mailchimpProviderHandler->getShortcut() . ']')
                 ->save();
@@ -400,9 +420,14 @@ protected function processSuccessfullItem(Mailchimp $mailchimpProviderHandler, N
             );
         }
 
-        $status = isset($entry['status']) ? $entry['status'] : $entry['status_if_new'];
-        $mailchimpProviderHandler->updateMailchimpStatus($customer, $status);
+        if($customer) {
+
+            $entry = $mailchimpProviderHandler->buildEntry($customer);
 
+            $status = isset($entry['status']) ? $entry['status'] : $entry['status_if_new'];
+            $mailchimpProviderHandler->updateMailchimpStatus($customer, $status);
+
+        }
         $item->setSuccessfullyProcessed(true);
     }
 

src/Newsletter/ProviderHandler/Mailchimp/CustomerExporter/SingleExporter.php

@@ -221,6 +221,19 @@ protected function delete(MailchimpAwareCustomerInterface $customer, NewsletterQ
         $exportService = $this->exportService;
         $apiClient = $this->apiClient;
 
+        if($mailchimpProviderHandler->doesOtherSubscribedCustomerWithEmailExist($customer->getEmail(), $customer->getId())) {
+            $this->getLogger()->debug(
+                sprintf(
+                    '[MailChimp][CUSTOMER %s][%s] Skip deletion of customer as another subscribed customer with email %s exists.',
+                    $customer->getId(),
+                    $mailchimpProviderHandler->getShortcut(),
+                    $customer->getEmail()
+                )
+            );
+            $item->setSuccessfullyProcessed(true);
+            return;
+        }
+
         // entry to send to API
         $entry = $mailchimpProviderHandler->buildEntry($customer);
         $remoteId = $this->apiClient->subscriberHash($item->getEmail());
@@ -297,6 +310,19 @@ protected function processDeleteQueueItem(NewsletterQueueItemInterface $item, Ma
         $exportService = $this->exportService;
         $apiClient = $this->apiClient;
 
+        if($mailchimpProviderHandler->doesOtherSubscribedCustomerWithEmailExist($item->getEmail(), $item->getCustomerId())) {
+            $this->getLogger()->info(
+                sprintf(
+                    '[MailChimp][CUSTOMER %s][%s] Deletion skipped as another subscribed customer with the same email exists.',
+                    $item->getCustomerId(),
+                    $mailchimpProviderHandler->getShortcut()
+                )
+            );
+
+            $item->setSuccessfullyProcessed(true);
+            return;
+        }
+
         // entry to send to API
         $remoteId = $this->apiClient->subscriberHash($item->getEmail());