Migration_20221028_105818_App.php
3 years ago
Migration_20230109_144830.php
3 years ago
Migration_20230131_121621.php
3 years ago
Migration_20230419_080000.php
3 years ago
Migration_20230425_211517.php
3 years ago
Migration_20230712_180341.php
3 years ago
Migration_20230803_200413_App.php
2 years ago
Migration_20230825_093531_App.php
1 year ago
Migration_20231128_120355_App.php
1 year ago
Migration_20240202_130053_App.php
2 years ago
Migration_20240207_105912_App.php
1 year ago
Migration_20240322_110443_App.php
2 years ago
Migration_20240730_212419_App.php
2 years ago
Migration_20241015_105511_App.php
1 year ago
Migration_20241128_114257_App.php
1 year ago
Migration_20250120_094614_App.php
1 year ago
Migration_20250501_114655_App.php
11 months ago
Migration_20260421_155908_App.php
3 months ago
Migration_20260515_120000_App.php
3 months ago
Migration_20260623_120000_App.php
1 month ago
Migration_20260805_120000_App.php
1 week ago
index.php
3 years ago
Migration_20240207_105912_App.php
206 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Migrations\App; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Doctrine\WPDB\Connection; |
| 9 | use MailPoet\Entities\NewsletterEntity; |
| 10 | use MailPoet\Entities\ScheduledTaskEntity; |
| 11 | use MailPoet\Entities\ScheduledTaskSubscriberEntity; |
| 12 | use MailPoet\Entities\SendingQueueEntity; |
| 13 | use MailPoet\Entities\StatisticsNewsletterEntity; |
| 14 | use MailPoet\Migrator\AppMigration; |
| 15 | use MailPoetVendor\Doctrine\DBAL\ArrayParameterType; |
| 16 | |
| 17 | /** |
| 18 | * We've had a set of bugs where campaign type newsletters (see NewsletterEntity::CAMPAIGN_TYPES), |
| 19 | * such as post notifications, were getting stuck in the following state: |
| 20 | * - The newsletter was in the "sending" state. |
| 21 | * - The task failed to complete and ended up in the "invalid" state. |
| 22 | * |
| 23 | * This migration completes tasks that sent out all emails |
| 24 | * and pauses those that have unprocessed subscribers. |
| 25 | */ |
| 26 | class Migration_20240207_105912_App extends AppMigration { |
| 27 | public function run(): void { |
| 28 | $this->pauseInvalidTasksWithUnprocessedSubscribers(); |
| 29 | $this->completeInvalidTasksWithAllSubscribersProcessed(); |
| 30 | $this->backfillMissingDataForMigratedNewsletters(); |
| 31 | } |
| 32 | |
| 33 | private function pauseInvalidTasksWithUnprocessedSubscribers(): void { |
| 34 | $ids = $this->entityManager->createQueryBuilder() |
| 35 | ->select('DISTINCT t.id') |
| 36 | ->from(ScheduledTaskEntity::class, 't') |
| 37 | ->join('t.subscribers', 's', 'WITH', 's.processed = :unprocessed') |
| 38 | ->join('t.sendingQueue', 'q') |
| 39 | ->join('q.newsletter', 'n') |
| 40 | ->where('t.deletedAt IS NULL') |
| 41 | ->andWhere('t.status = :invalid') |
| 42 | ->andWhere('n.deletedAt IS NULL') |
| 43 | ->andWhere('n.status = :sending') |
| 44 | ->andWhere('n.type IN (:campaignTypes)') |
| 45 | ->setParameter('unprocessed', ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED) |
| 46 | ->setParameter('invalid', ScheduledTaskEntity::STATUS_INVALID) |
| 47 | ->setParameter('sending', NewsletterEntity::STATUS_SENDING) |
| 48 | ->setParameter('campaignTypes', NewsletterEntity::CAMPAIGN_TYPES) |
| 49 | ->getQuery() |
| 50 | ->getSingleColumnResult(); |
| 51 | |
| 52 | $this->entityManager->createQueryBuilder() |
| 53 | ->update(ScheduledTaskEntity::class, 't') |
| 54 | ->set('t.status', ':paused') |
| 55 | ->where('t.id IN (:ids)') |
| 56 | ->setParameter('paused', ScheduledTaskEntity::STATUS_PAUSED) |
| 57 | ->setParameter('ids', $ids) |
| 58 | ->getQuery() |
| 59 | ->execute(); |
| 60 | } |
| 61 | |
| 62 | private function completeInvalidTasksWithAllSubscribersProcessed(): void { |
| 63 | $ids = $this->entityManager->createQueryBuilder() |
| 64 | ->select('DISTINCT t.id, n.id AS nid, t.updatedAt') |
| 65 | ->from(ScheduledTaskEntity::class, 't') |
| 66 | ->leftJoin('t.subscribers', 's', 'WITH', 's.processed = :unprocessed') |
| 67 | ->join('t.sendingQueue', 'q') |
| 68 | ->join('q.newsletter', 'n') |
| 69 | ->where('t.deletedAt IS NULL') |
| 70 | ->andWhere('t.status = :invalid') |
| 71 | ->andWhere('s.task IS NULL') |
| 72 | ->andWhere('n.deletedAt IS NULL') |
| 73 | ->andWhere('n.status = :sending') |
| 74 | ->andWhere('n.type IN (:campaignTypes)') |
| 75 | ->setParameter('unprocessed', ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED) |
| 76 | ->setParameter('invalid', ScheduledTaskEntity::STATUS_INVALID) |
| 77 | ->setParameter('sending', NewsletterEntity::STATUS_SENDING) |
| 78 | ->setParameter('campaignTypes', NewsletterEntity::CAMPAIGN_TYPES) |
| 79 | ->getQuery() |
| 80 | ->getSingleColumnResult(); |
| 81 | |
| 82 | // update sending queue counts |
| 83 | $this->entityManager->createQueryBuilder() |
| 84 | ->update(SendingQueueEntity::class, 'q') |
| 85 | ->set('q.countProcessed', 'q.countTotal') |
| 86 | ->set('q.countToProcess', 0) |
| 87 | ->where('q.task IN (:ids)') |
| 88 | ->setParameter('ids', $ids) |
| 89 | ->getQuery() |
| 90 | ->execute(); |
| 91 | |
| 92 | // complete the invalid tasks |
| 93 | $this->entityManager->createQueryBuilder() |
| 94 | ->update(ScheduledTaskEntity::class, 't') |
| 95 | ->set('t.status', ':completed') |
| 96 | ->where('t.id IN (:ids)') |
| 97 | ->setParameter('completed', ScheduledTaskEntity::STATUS_COMPLETED) |
| 98 | ->setParameter('ids', $ids) |
| 99 | ->getQuery() |
| 100 | ->execute(); |
| 101 | |
| 102 | // mark newsletters as sent, update "sentAt" (DBAL needed to be able to use JOIN) |
| 103 | $newslettersTable = $this->entityManager->getClassMetadata(NewsletterEntity::class)->getTableName(); |
| 104 | $scheduledTasksTable = $this->entityManager->getClassMetadata(ScheduledTaskEntity::class)->getTableName(); |
| 105 | $scheduledTaskSubscribersTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName(); |
| 106 | $sendingQueuesTable = $this->entityManager->getClassMetadata(SendingQueueEntity::class)->getTableName(); |
| 107 | |
| 108 | // Temporarily skip the query in WP Playground. |
| 109 | // UPDATE with JOIN is not yet supported by the SQLite integration. |
| 110 | if (Connection::isSQLite()) { |
| 111 | return; |
| 112 | } |
| 113 | $this->entityManager->getConnection()->executeStatement( |
| 114 | " |
| 115 | UPDATE $newslettersTable n |
| 116 | JOIN $sendingQueuesTable q ON n.id = q.newsletter_id |
| 117 | JOIN $scheduledTasksTable t ON q.task_id = t.id |
| 118 | SET |
| 119 | n.status = :sent, |
| 120 | n.sent_at = COALESCE( |
| 121 | ( |
| 122 | -- use 'updated_at' of processed subscriber with the highest ID ('MAX(subscriber_id)' can use index) |
| 123 | SELECT updated_at FROM $scheduledTaskSubscribersTable WHERE task_id = t.id AND subscriber_id = ( |
| 124 | SELECT MAX(subscriber_id) FROM $scheduledTaskSubscribersTable WHERE task_id = t.id |
| 125 | ) |
| 126 | ), |
| 127 | t.updated_at |
| 128 | ) |
| 129 | WHERE t.id IN (:ids) |
| 130 | ", |
| 131 | ['sent' => NewsletterEntity::STATUS_SENT, 'ids' => $ids], |
| 132 | ['ids' => ArrayParameterType::INTEGER] |
| 133 | ); |
| 134 | } |
| 135 | |
| 136 | private function backfillMissingDataForMigratedNewsletters(): void { |
| 137 | // In https://mailpoet.atlassian.net/browse/MAILPOET-5886 we fixed missing "sent" status |
| 138 | // by https://github.com/mailpoet/mailpoet/pull/5416, but didn't backfill missing data. |
| 139 | |
| 140 | // get affected newsletter IDs |
| 141 | $ids = $this->entityManager->createQueryBuilder() |
| 142 | ->select('n.id') |
| 143 | ->from(NewsletterEntity::class, 'n') |
| 144 | ->where('n.status = :sent') |
| 145 | ->andWhere('n.sentAt IS NULL') |
| 146 | ->setParameter('sent', NewsletterEntity::STATUS_SENT) |
| 147 | ->getQuery() |
| 148 | ->getSingleColumnResult(); |
| 149 | |
| 150 | // get missing newsletter statistics IDs |
| 151 | $data = $this->entityManager->createQueryBuilder() |
| 152 | ->select('IDENTITY(q.newsletter) AS nid, q.id AS qid, IDENTITY(s.subscriber) AS sid, s.updatedAt AS sentAt') |
| 153 | ->from(SendingQueueEntity::class, 'q') |
| 154 | ->join('q.task', 't') |
| 155 | ->join('t.subscribers', 's') |
| 156 | ->leftJoin(StatisticsNewsletterEntity::class, 'ns', 'WITH', 'ns.queue = q AND ns.subscriber = s.subscriber') |
| 157 | ->where('q.newsletter IN (:ids)') |
| 158 | ->andWhere('ns.id IS NULL') |
| 159 | ->andWhere('s.processed = :processed') |
| 160 | ->setParameter('ids', $ids) |
| 161 | ->setParameter('processed', ScheduledTaskSubscriberEntity::STATUS_PROCESSED) |
| 162 | ->getQuery() |
| 163 | ->getResult(); |
| 164 | |
| 165 | // insert missing newsletter statistics |
| 166 | $newsletterStatisticsTable = $this->entityManager->getClassMetadata(StatisticsNewsletterEntity::class)->getTableName(); |
| 167 | foreach ($data as $row) { |
| 168 | $this->entityManager->getConnection()->executeStatement(" |
| 169 | INSERT IGNORE INTO $newsletterStatisticsTable (newsletter_id, queue_id, subscriber_id, sent_at) |
| 170 | VALUES (?, ?, ?, ?) |
| 171 | ", [$row['nid'], $row['qid'], $row['sid'], $row['sentAt']->format('Y-m-d H:i:s')]); |
| 172 | } |
| 173 | |
| 174 | // add missing "sentAt" (DBAL needed to be able to use JOIN) |
| 175 | $newslettersTable = $this->entityManager->getClassMetadata(NewsletterEntity::class)->getTableName(); |
| 176 | $scheduledTasksTable = $this->entityManager->getClassMetadata(ScheduledTaskEntity::class)->getTableName(); |
| 177 | $scheduledTaskSubscribersTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName(); |
| 178 | $sendingQueuesTable = $this->entityManager->getClassMetadata(SendingQueueEntity::class)->getTableName(); |
| 179 | |
| 180 | // Temporarily skip the query in WP Playground. |
| 181 | // UPDATE with JOIN is not yet supported by the SQLite integration. |
| 182 | if (Connection::isSQLite()) { |
| 183 | return; |
| 184 | } |
| 185 | $this->entityManager->getConnection()->executeStatement( |
| 186 | " |
| 187 | UPDATE $newslettersTable n |
| 188 | JOIN $sendingQueuesTable q ON n.id = q.newsletter_id |
| 189 | JOIN $scheduledTasksTable t ON q.task_id = t.id |
| 190 | SET n.sent_at = COALESCE( |
| 191 | ( |
| 192 | -- use 'updated_at' of processed subscriber with the highest ID ('MAX(subscriber_id)' can use index) |
| 193 | SELECT updated_at FROM $scheduledTaskSubscribersTable WHERE task_id = t.id AND subscriber_id = ( |
| 194 | SELECT MAX(subscriber_id) FROM $scheduledTaskSubscribersTable WHERE task_id = t.id |
| 195 | ) |
| 196 | ), |
| 197 | t.updated_at |
| 198 | ) |
| 199 | WHERE q.newsletter_id IN (:ids) |
| 200 | ", |
| 201 | ['ids' => $ids], |
| 202 | ['ids' => ArrayParameterType::INTEGER] |
| 203 | ); |
| 204 | } |
| 205 | } |
| 206 |