fix(db): Auto-unlock mailman sync after 23h

This commit introduces a 23-hour time limit on mailman sync locks. If the mailman sync is running for >23 hours without refreshing its lock, it is presumed to have failed.

Author: rinkp

.env.dist

@@ -96,3 +96,7 @@ PHP_IDE_CONFIG=serverName=database.gewis.nl
 # Demo mode credentials (this will prepopulate the credential fields with these values)
 DEMO_CREDENTIALS_USERNAME=admin
 DEMO_CREDENTIALS_PASSWORD=gewisdbgewis
+
+# Timezone (incl Postfix)
+TZ=Europe/Amsterdam
+PGTZ=Europe/Amsterdam

module/Database/migrations/Version20260211203320.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Database\Migrations;
+
+use DateTime;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * phpcs:disable Generic.Files.LineLength.TooLong
+ * phpcs:disable SlevomatCodingStandard.Functions.RequireMultiLineCall.RequiredMultiLineCall
+ */
+final class Version20260211203320 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Change config item for mailman sync to date value';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('UPDATE configitem SET valuebool = null, valuedate = updatedat + interval \'23h\' * valuebool::int WHERE key = \'locked\' AND namespace = \'database_mailman\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('UPDATE configitem SET valuebool = valuedate > \'' . (new DateTime())->format('Y-m-d H:i:s') . '\', valuedate = null WHERE key = \'locked\' AND namespace = \'database_mailman\'');
+    }
+}

module/Database/src/Service/Mailman.php

@@ -130,20 +130,29 @@ private function performMailmanRequest(
      * Acquire sync lock.
      *
      * To ensure that the sync between GEWISDB and Mailman is as clean as possible, we need to acquire a global lock on
-     * the mail list administration. This will prevent (if properly implemented and used) the secretary from modifying
-     * any mailing list memberships.
+     * the mail list administration. This will prevent (if properly implemented and used) concurrent syncs from running.
      */
-    private function acquireSyncLock(int $retries = 3): void
-    {
+    private function acquireSyncLock(
+        int $retries = 3,
+        bool $renew = false,
+    ): void {
         if (0 === $retries) {
             throw new RuntimeException('Unable to acquire sync lock for Mailman sync: timeout.');
         }
 
-        if ($this->isSyncLocked()) {
+        if ($this->isSyncLocked() && !$renew) {
             throw new RuntimeException('Unable to acquire sync lock for Mailman sync: locked by other process.');
         }
 
-        $this->configService->setConfig(ConfigNamespaces::DatabaseMailman, 'locked', true);
+        if (!$this->isSyncLocked() && $renew) {
+            throw new RuntimeException('Unable to renew sync lock for Mailman sync: currently unlocked.');
+        }
+
+        $this->configService->setConfig(
+            ConfigNamespaces::DatabaseMailman,
+            'locked',
+            (new DateTime())->modify('+23 hours'),
+        );
 
         if ($this->isSyncLocked()) {
             return;
@@ -159,15 +168,15 @@ private function acquireSyncLock(int $retries = 3): void
      */
     private function releaseSyncLock(): void
     {
-        $this->configService->setConfig(ConfigNamespaces::DatabaseMailman, 'locked', false);
+        $this->configService->setConfig(ConfigNamespaces::DatabaseMailman, 'locked', new DateTime());
     }
 
     /**
      * Get state of sync lock.
      */
     public function isSyncLocked(): bool
     {
-        return $this->configService->getConfig(ConfigNamespaces::DatabaseMailman, 'locked', false);
+        return $this->configService->getConfig(ConfigNamespaces::DatabaseMailman, 'locked') > new DateTime();
     }
 
     /**
@@ -185,6 +194,7 @@ public function syncMembership(
         $lists = $this->mailingListMapper->findAll();
 
         foreach ($lists as $list) {
+            $this->acquireSyncLock(renew: true);
             $this->syncMembershipSingle($list, $output, $dryRun);
         }