Store last update attempts locally

for all developer/users

Author: mxr576

apigee_edge.services.yml

@@ -217,3 +217,8 @@ services:
   apigee_edge.post_user_delete_action_performer:
     class: Drupal\apigee_edge\User\RemoveRelatedDeveloperAccountSynchronousPostUserDeleteActionPerformer
     arguments: ['@entity_type.manager', '@logger.channel.apigee_edge']
+
+  apigee_edge.dev_sync.last_update_tracker:
+    class: Drupal\Core\KeyValueStore\KeyValueStoreInterface
+    factory: [ '@keyvalue', 'get' ]
+    arguments: [ 'apigee_edge.dev_sync.last_update_tracker' ]

src/Job/DeveloperCreateUpdate.php

@@ -70,6 +70,11 @@ protected function executeRequest() {
       if ($result->getSuccessfullyAppliedChanges() > 0) {
         $result->getDeveloper()->save();
       }
+      // Record the sync attempt timestamp for the developer's email,
+      // regardless of whether an entity update occurred, to prevent redundant
+      // sync operations. This ensures that the developer will only be re-synced
+      // if a new relevant change is detected after this timestamp.
+      \Drupal::getContainer()->get('apigee_edge.dev_sync.last_update_tracker')->set($result->getDeveloper()->getEmail(), \Drupal::time()->getCurrentTime());
     }
     catch (\Exception $exception) {
       $message = '@operation: Skipping %mail developer. @message %function (line %line of %file). <pre>@backtrace_string</pre>';

src/Job/DeveloperSync.php

@@ -20,7 +20,10 @@
 namespace Drupal\apigee_edge\Job;
 
 use Drupal\apigee_edge\Entity\Developer;
+use Drupal\apigee_edge\Entity\DeveloperInterface;
+use Drupal\Core\KeyValueStore\KeyValueStoreInterface;
 use Drupal\user\Entity\User;
+use Drupal\user\UserInterface;
 
 /**
  * A job that synchronizes Apigee Edge developers and Drupal users.
@@ -58,6 +61,11 @@ class DeveloperSync extends EdgeJob {
    */
   protected $filter = NULL;
 
+  /**
+   * KV store tracks last update attempts for each user/developer.
+   */
+  protected KeyValueStoreInterface $lastUpdateTracker;
+
   /**
    * DeveloperSync constructor.
    *
@@ -67,6 +75,7 @@ class DeveloperSync extends EdgeJob {
   public function __construct(?string $filter) {
     parent::__construct();
     $this->filter = $filter;
+    $this->lastUpdateTracker = \Drupal::service('apigee_edge.dev_sync.last_update_tracker');
   }
 
   /**
@@ -136,6 +145,18 @@ protected function executeRequest() {
   public function execute(): bool {
     parent::execute();
 
+    $update_drupal_user = function (UserInterface $user) {
+      $update_user_job = new UserUpdate($user->getEmail());
+      $update_user_job->setTag($this->getTag());
+      $this->scheduleJob($update_user_job);
+    };
+
+    $update_developer = function (DeveloperInterface $developer) {
+      $update_developer_job = new DeveloperUpdate($developer->getEmail());
+      $update_developer_job->setTag($this->getTag());
+      $this->scheduleJob($update_developer_job);
+    };
+
     // Update Apigee Edge developers and Drupal users if needed.
     $identical_entities = array_intersect_key($this->edgeDevelopers, $this->drupalUsers);
     foreach ($identical_entities as $clean_email => $entity) {
@@ -144,20 +165,31 @@ public function execute(): bool {
       /** @var \Drupal\user\UserInterface $user */
       $user = $this->drupalUsers[$clean_email];
 
-      $last_modified_delta = $developer->getLastModifiedAt()->getTimestamp() - $user->getChangedTime();
-      // Update Drupal user because the Apigee Edge developer is the most
-      // recent.
-      if ($last_modified_delta > 0) {
-        $update_user_job = new UserUpdate($user->getEmail());
-        $update_user_job->setTag($this->getTag());
-        $this->scheduleJob($update_user_job);
+      $last_synced = $this->lastUpdateTracker->get($developer->getEmail(), 0);
+
+      if ($last_synced === 0) {
+        $last_modified_delta = $developer->getLastModifiedAt()->getTimestamp() - $user->getChangedTime();
+        if ($last_modified_delta === 0) {
+          $this->lastUpdateTracker->set($developer->getEmail(), \Drupal::time()->getCurrentTime());
+          continue;
+        }
+
+        // Update Drupal user because the Apigee Edge developer is the most
+        // recent.
+        if ($last_modified_delta > 0) {
+          $update_drupal_user($user);
+        }
+        // Update Apigee Edge developer because the Drupal user is the most
+        // recent.
+        else {
+          $update_developer($developer);
+        }
+      }
+      elseif ($last_synced < $developer->getLastModifiedAt()->getTimestamp()) {
+        $update_drupal_user($user);
       }
-      // Update Apigee Edge developer because the Drupal user is the most
-      // recent.
-      elseif ($last_modified_delta < 0) {
-        $update_developer_job = new DeveloperUpdate($developer->getEmail());
-        $update_developer_job->setTag($this->getTag());
-        $this->scheduleJob($update_developer_job);
+      elseif ($last_synced < $user->getChangedTime()) {
+        $update_developer($developer);
       }
     }
 

src/Job/UserCreateUpdate.php

@@ -75,14 +75,14 @@ protected function executeRequest() {
         // the same developer in apigee_edge_user_presave() while creating
         // Drupal user based on a developer should be avoided.
         _apigee_edge_set_sync_in_progress(TRUE);
-
-        // Synchronize user's last modified timestamp with developer's timestamp
-        // to maintain data consistency and prevent infinite sync loops where
-        // outdated timestamps cause repeated scheduling of sync operations.
-        // @see \Drupal\apigee_edge\Job\DeveloperSync::execute()
-        $result->getUser()->setChangedTime($developer->getLastModifiedAt()->getTimestamp());
         $result->getUser()->save();
       }
+
+      // Record the sync attempt timestamp for the developer's email,
+      // regardless of whether an entity update occurred, to prevent redundant
+      // sync operations. This ensures that the developer will only be re-synced
+      // if a new relevant change is detected after this timestamp.
+      \Drupal::getContainer()->get('apigee_edge.dev_sync.last_update_tracker')->set($developer->getEmail(), \Drupal::time()->getCurrentTime());
     }
     catch (\Exception $exception) {
       $message = '@operation: Skipping %mail user. @message %function (line %line of %file). <pre>@backtrace_string</pre>';
@@ -91,8 +91,8 @@ protected function executeRequest() {
         '@operation' => get_class($this),
       ];
       $context += Error::decodeException($exception);
-      // Unset backtrace, exception, severity_level as they are not shown in the log message
-      // and throws php warning in logs.
+      // Unset backtrace, exception, severity_level as they are not shown in
+      // the log message and throws php warning in logs.
       unset($context['backtrace'], $context['exception'], $context['severity_level']);
 
       $this->logger()->error($message, $context);
@@ -127,6 +127,9 @@ protected function beforeUserSave(DeveloperToUserConversionResult $result) : voi
         throw $problem;
       }
     }
+    // It's necessary because changed time is automatically updated on the
+    // UI only.
+    $result->getUser()->setChangedTime(\Drupal::time()->getCurrentTime());
   }
 
   /**

src/UserDeveloperConverter.php

@@ -182,11 +182,6 @@ public function convertDeveloper(DeveloperInterface $developer) : DeveloperToUse
       $user = $user_storage->create([
         'pass' => \Drupal::service('password_generator')->generate(),
       ]);
-      // Set user creation date to match the original developer's creation
-      // timestamp to maintain chronological consistency between related
-      // entities and prevent confusion when comparing created vs modified dates
-      // in the user interface.
-      $user->set('created', $developer->getCreatedAt()->getTimestamp());
       // Suppress invalid email validation errors.
       DeveloperEmailUniqueValidator::whitelist($developer->id());
     }