Refactor notification and error handling/logging

Author: Michael-Schaer

app/Synchronizer/CrmToMailchimpSynchronizer.php

@@ -28,7 +28,7 @@
 
 class CrmToMailchimpSynchronizer
 {
-    use LogTrait;
+    use LogTrait, NotificationTrait;
 
     private const LOCK_BASE_FOLDER_NAME = 'locks';
     private const MAX_LOCK_TIME = 15 * 60; // 15 minutes
@@ -908,28 +908,6 @@ private function saveToSyncLater(int $crmId): void
         $entry->save();
     }
 
-    /**
-     * Inform data owner that he should only add contact in the crm not in mailchimp
-     *
-     * @param array $dataOwner
-     * @param array $mcData
-     */
-    private function notifyAdminInvalidEmail(array $mcData)
-    {
-        $dataOwner = $this->config->getDataOwner();
-        
-        $mailData = new \stdClass();
-        $mailData->dataOwnerName = $dataOwner['name'];
-        $mailData->contactFirstName = $mcData['merge_fields']['FNAME']; // todo: check if we cant get the field keys dynamically
-        $mailData->contactLastName = $mcData['merge_fields']['LNAME']; // todo: dito
-        $mailData->contactEmail = $mcData['email_address'];
-        $mailData->adminEmail = env('ADMIN_EMAIL');
-        $mailData->configName = $this->configName;
-        
-        Mail::to($dataOwner['email'])
-            ->send(new InvalidEmailNotification($mailData));
-    }
-    
     /**
      * Create a new database entry that marks the given record as already synced
      * for this revision so it can be skipped if the program runs twice.

app/Synchronizer/MailchimpToCrmWebhookSynchronizer.php

@@ -46,6 +46,9 @@ public function handleMailchimpUpdate(array $mcData)
 
         $this->logWebhook('debug', $callType, $mailchimpId, "Sync single record from Mailchimp to CRM.");
 
+        $crmId = null;
+        $crmData = [];
+
         switch ($callType) {
             case self::MC_SUBSCRIBE:
                 if (!$this->config->getIgnoreSubscribeThroughMailchimp()) {
@@ -123,6 +126,11 @@ public function handleMailchimpUpdate(array $mcData)
                 return;
         }
 
+        if (empty($crmId)) {
+            $this->logWebhook('info', $callType, $mailchimpId, "Cannot update member: CRM ID is missing.");
+            return;
+        }
+
         try {
             $this->crmClient->put('member/' . $crmId, $crmData);
         } catch (ClientException $e) {

app/Synchronizer/NotificationTrait.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Synchronizer;
+
+use Illuminate\Support\Facades\Mail;
+use App\Mail\InvalidEmailNotification;
+
+trait NotificationTrait
+{
+    /**
+     * Inform data owner about invalid email submission
+     *
+     * @param array $mcData
+     */
+    private function notifyAdminInvalidEmail(array $mcData): void
+    {
+        $dataOwner = $this->config->getDataOwner();
+        
+        $mailData = new \stdClass();
+        $mailData->dataOwnerName = $dataOwner['name'];
+        $mailData->contactFirstName = $mcData['merge_fields']['FNAME'] ?? '';
+        $mailData->contactLastName = $mcData['merge_fields']['LNAME'] ?? '';
+        $mailData->contactEmail = $mcData['email_address'];
+        $mailData->adminEmail = env('ADMIN_EMAIL');
+        $mailData->configName = $this->configName;
+        
+        Mail::to($dataOwner['email'])
+            ->send(new InvalidEmailNotification($mailData));
+    }
+}

app/Synchronizer/WebsiteToMailchimpSynchronizer.php

@@ -5,9 +5,19 @@
 use App\Synchronizer\Mapper\Mapper;
 use App\Http\MailChimpClient;
 use App\Synchronizer\Filter;
+use App\Exceptions\FakeEmailException;
+use App\Exceptions\InvalidEmailException;
+use App\Exceptions\AlreadyInListException;
+use App\Exceptions\CleanedEmailException;
+use App\Exceptions\UnsubscribedEmailException;
+use App\Exceptions\ArchivedException;
+use App\Exceptions\EmailComplianceException;
+use App\Exceptions\MailchimpTooManySubscriptionsException;
+use Illuminate\Support\Facades\Log;
 
 class WebsiteToMailchimpSynchronizer
 {
+    use NotificationTrait;
     /**
      * @var Config
      */
@@ -69,6 +79,7 @@ public function __construct(string $configFileName)
      * @throws \App\Exceptions\MergeFieldException
      * @throws \App\Exceptions\MailchimpTooManySubscriptionsException
      * @throws \App\Exceptions\ArchivedException
+     * @throws \App\Exceptions\CleanedEmailException
      */
     public function syncSingle(array $websiteData)
     {
@@ -99,7 +110,34 @@ public function syncSingle(array $websiteData)
         $mailchimpData['status'] = 'subscribed';
 
         // Add the subscriber to Mailchimp
-        $response = $this->mailchimpClient->putSubscriber($mailchimpData);
+        try {
+            $response = $this->mailchimpClient->putSubscriber($mailchimpData);
+        } catch (AlreadyInListException $e) {
+            Log::debug("Subscriber already in list: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (InvalidEmailException $e) {
+            Log::info("Invalid email address: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (FakeEmailException $e) {
+            $this->notifyAdminInvalidEmail($mailchimpData);
+            Log::info("Fake or invalid email detected: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (CleanedEmailException $e) {
+            Log::info("Email marked as cleaned (bounced): {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (UnsubscribedEmailException $e) {
+            Log::info("Email previously unsubscribed: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (ArchivedException $e) {
+            Log::info("Email is archived: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (EmailComplianceException $e) {
+            Log::info("Email compliance issue: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        } catch (MailchimpTooManySubscriptionsException $e) {
+            Log::info("Too many subscriptions from email: {$mailchimpData['email_address']}");
+            return ['status' => 'success'];
+        }
 
         // Add tags to new subscriber
         $tags = [$this->config->getNewTag()];