Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Deactivation requires 3 received emails

Browse Source 
[MAILPOET-4081]
This commit is contained in:
Brezo Cordero
2022-03-07 14:10:27 -06:00
committed by Veljko V
parent 3fca53f350
commit 11cd756e6d
2 changed files with 28 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
mailpoet/lib/Subscribers/InactiveSubscribersController.php
View File

@ -14,6 +14,8 @@ use MailPoetVendor\Doctrine\ORM\EntityManager;
class InactiveSubscribersController { class InactiveSubscribersController {
const UNOPENED_EMAILS_THRESHOLD = 3;
private $inactiveTaskIdsTableCreated = false; private $inactiveTaskIdsTableCreated = false;
/** @var SettingsRepository */ /** @var SettingsRepository */
@ -30,9 +32,9 @@ class InactiveSubscribersController {
$this->entityManager = $entityManager; $this->entityManager = $entityManager;
} }
public function markInactiveSubscribers(int $daysToInactive, int $batchSize, ?int $startId = null) { public function markInactiveSubscribers(int $daysToInactive, int $batchSize, ?int $startId = null, ?int $unopenedEmails = self::UNOPENED_EMAILS_THRESHOLD) {
$thresholdDate = $this->getThresholdDate($daysToInactive); $thresholdDate = $this->getThresholdDate($daysToInactive);
return $this->deactivateSubscribers($thresholdDate, $batchSize, $startId); return $this->deactivateSubscribers($thresholdDate, $batchSize, $startId, $unopenedEmails);
} }
public function markActiveSubscribers(int $daysToInactive, int $batchSize): int { public function markActiveSubscribers(int $daysToInactive, int $batchSize): int {
@ -59,7 +61,7 @@ class InactiveSubscribersController {
/** /**
* @return int|bool * @return int|bool
*/ */
private function deactivateSubscribers(Carbon $thresholdDate, int $batchSize, ?int $startId = null) { private function deactivateSubscribers(Carbon $thresholdDate, int $batchSize, ?int $startId = null, ?int $unopenedEmails = self::UNOPENED_EMAILS_THRESHOLD) {
$subscribersTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName(); $subscribersTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName();
$scheduledTasksTable = $this->entityManager->getClassMetadata(ScheduledTaskEntity::class)->getTableName(); $scheduledTasksTable = $this->entityManager->getClassMetadata(ScheduledTaskEntity::class)->getTableName();
$scheduledTaskSubscribersTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName(); $scheduledTaskSubscribersTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName();
@ -96,26 +98,29 @@ class InactiveSubscribersController {
$this->inactiveTaskIdsTableCreated = true; $this->inactiveTaskIdsTableCreated = true;
} }
// Select subscribers who received a recent tracked email but didn't open it // Select subscribers who received at least a number of tracked emails but didn't open any
$startId = (int)$startId; $startId = (int)$startId;
$endId = $startId + $batchSize; $endId = $startId + $batchSize;
$inactiveSubscriberIdsTmpTable = 'inactive_subscriber_ids'; $inactiveSubscriberIdsTmpTable = 'inactive_subscriber_ids';
$connection->executeQuery(" $connection->executeQuery("
CREATE TEMPORARY TABLE IF NOT EXISTS {$inactiveSubscriberIdsTmpTable} CREATE TEMPORARY TABLE IF NOT EXISTS {$inactiveSubscriberIdsTmpTable}
(UNIQUE subscriber_id (id)) (UNIQUE subscriber_id (id))
SELECT DISTINCT s.id FROM {$subscribersTable} as s SELECT s.id FROM {$subscribersTable} as s
JOIN {$scheduledTaskSubscribersTable} as sts USE INDEX (subscriber_id) ON s.id = sts.subscriber_id JOIN {$scheduledTaskSubscribersTable} as sts USE INDEX (subscriber_id) ON s.id = sts.subscriber_id
JOIN {$inactiveTaskIdsTable} task_ids ON task_ids.id = sts.task_id JOIN {$inactiveTaskIdsTable} task_ids ON task_ids.id = sts.task_id
WHERE s.last_subscribed_at < :thresholdDate WHERE s.last_subscribed_at < :thresholdDate
AND s.status = :status AND s.status = :status
AND s.id >= :startId AND s.id >= :startId
AND s.id < :endId AND s.id < :endId
GROUP BY s.id
HAVING count(s.id) >= :unopenedEmailsThreshold
", ",
[ [
'thresholdDate' => $thresholdDateIso, 'thresholdDate' => $thresholdDateIso,
'status' => SubscriberEntity::STATUS_SUBSCRIBED, 'status' => SubscriberEntity::STATUS_SUBSCRIBED,
'startId' => $startId, 'startId' => $startId,
'endId' => $endId, 'endId' => $endId,
'unopenedEmailsThreshold' => $unopenedEmails,
]); ]);
$result = $connection->executeQuery(" $result = $connection->executeQuery("

29
mailpoet/tests/integration/Subscribers/InactiveSubscribersControllerTest.php
View File

@ -28,6 +28,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
const INACTIVITY_DAYS_THRESHOLD = 5; const INACTIVITY_DAYS_THRESHOLD = 5;
const PROCESS_BATCH_SIZE = 100; const PROCESS_BATCH_SIZE = 100;
const UNOPENED_EMAILS_THRESHOLD = 1;
public function _before() { public function _before() {
$this->controller = new InactiveSubscribersController( $this->controller = new InactiveSubscribersController(
@ -51,23 +52,29 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
parent::_before(); parent::_before();
} }
public function testItDeactivatesOldSubscribersWithUnopenedEmail(): void { public function testItDeactivatesOldSubscribersOnlyWhenUnopenedEmailsReachDefaultThreshold(): void {
// Create three completed sending tasks
[$task] = $this->createCompletedSendingTaskWithOneOpen(3); [$task] = $this->createCompletedSendingTaskWithOneOpen(3);
[$task2] = $this->createCompletedSendingTaskWithOneOpen(3);
[$task3] = $this->createCompletedSendingTaskWithOneOpen(3);
$subscriber1 = $this->createSubscriber('s1@email.com', 10); $subscriber1 = $this->createSubscriber('s1@email.com', 10);
$this->addSubscriberToTask($subscriber1, $task); $this->addSubscriberToTask($subscriber1, $task);
$this->addSubscriberToTask($subscriber1, $task2);
$this->addSubscriberToTask($subscriber1, $task3);
$subscriber2 = $this->createSubscriber('s2@email.com', 10); $subscriber2 = $this->createSubscriber('s2@email.com', 10);
$this->addSubscriberToTask($subscriber2, $task); $this->addSubscriberToTask($subscriber2, $task);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE);
expect($result)->equals(2); expect($result)->equals(1);
$this->entityManager->clear(); $this->entityManager->clear();
$subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId()); $subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId());
$subscriber2 = $this->subscribersRepository->findOneById($subscriber2->getId()); $subscriber2 = $this->subscribersRepository->findOneById($subscriber2->getId());
assert($subscriber1 instanceof SubscriberEntity); assert($subscriber1 instanceof SubscriberEntity);
assert($subscriber2 instanceof SubscriberEntity); assert($subscriber2 instanceof SubscriberEntity);
expect($subscriber1->getStatus())->equals(SubscriberEntity::STATUS_INACTIVE); expect($subscriber1->getStatus())->equals(SubscriberEntity::STATUS_INACTIVE);
expect($subscriber2->getStatus())->equals(SubscriberEntity::STATUS_INACTIVE); expect($subscriber2->getStatus())->equals(SubscriberEntity::STATUS_SUBSCRIBED);
} }
public function testItDeactivatesLimitedAmountOfSubscribers(): void { public function testItDeactivatesLimitedAmountOfSubscribers(): void {
@ -79,7 +86,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
$this->addSubscriberToTask($subscriber2, $task); $this->addSubscriberToTask($subscriber2, $task);
$batchSize = 1; $batchSize = 1;
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, $batchSize, $subscriber1->getId()); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, $batchSize, $subscriber1->getId(), self::UNOPENED_EMAILS_THRESHOLD);
$this->entityManager->clear(); $this->entityManager->clear();
expect($result)->equals(1); expect($result)->equals(1);
$subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId()); $subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId());
@ -89,7 +96,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
expect($subscriber1->getStatus() === SubscriberEntity::STATUS_INACTIVE || $subscriber2->getStatus() === SubscriberEntity::STATUS_INACTIVE)->true(); expect($subscriber1->getStatus() === SubscriberEntity::STATUS_INACTIVE || $subscriber2->getStatus() === SubscriberEntity::STATUS_INACTIVE)->true();
expect($subscriber1->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED || $subscriber2->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED)->true(); expect($subscriber1->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED || $subscriber2->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED)->true();
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, $batchSize, $subscriber2->getId()); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, $batchSize, $subscriber2->getId(), self::UNOPENED_EMAILS_THRESHOLD);
$this->entityManager->clear(); $this->entityManager->clear();
expect($result)->equals(1); expect($result)->equals(1);
$subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId()); $subscriber1 = $this->subscribersRepository->findOneById($subscriber1->getId());
@ -106,7 +113,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
$subscriber = $this->createSubscriber('s1@email.com', 3); $subscriber = $this->createSubscriber('s1@email.com', 3);
$this->addSubscriberToTask($subscriber, $task); $this->addSubscriberToTask($subscriber, $task);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);
@ -122,7 +129,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
$this->entityManager->flush(); $this->entityManager->flush();
$this->addSubscriberToTask($subscriber, $task); $this->addSubscriberToTask($subscriber, $task);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);
@ -132,7 +139,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
public function testItDoesNotDeactivateSubscriberWithoutSentEmail(): void { public function testItDoesNotDeactivateSubscriberWithoutSentEmail(): void {
$this->createCompletedSendingTaskWithOneOpen(3); $this->createCompletedSendingTaskWithOneOpen(3);
$subscriber = $this->createSubscriber('s1@email.com', 10); $subscriber = $this->createSubscriber('s1@email.com', 10);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);
@ -146,7 +153,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
$this->addEmailOpenedRecord($subscriber, $queue, 2); $this->addEmailOpenedRecord($subscriber, $queue, 2);
[$task2] = $this->createCompletedSendingTaskWithOneOpen(2); [$task2] = $this->createCompletedSendingTaskWithOneOpen(2);
$this->addSubscriberToTask($subscriber, $task2); $this->addSubscriberToTask($subscriber, $task2);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);
@ -157,7 +164,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
[$task] = $this->createCompletedSendingTaskWithOneOpen(0); [$task] = $this->createCompletedSendingTaskWithOneOpen(0);
$subscriber = $this->createSubscriber('s1@email.com', 10); $subscriber = $this->createSubscriber('s1@email.com', 10);
$this->addSubscriberToTask($subscriber, $task); $this->addSubscriberToTask($subscriber, $task);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);
@ -172,7 +179,7 @@ class InactiveSubscribersControllerTest extends \MailPoetTest {
$subscriber = $this->createSubscriber('s1@email.com', 10); $subscriber = $this->createSubscriber('s1@email.com', 10);
$this->addSubscriberToTask($subscriber, $task); $this->addSubscriberToTask($subscriber, $task);
$result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE); $result = $this->controller->markInactiveSubscribers(self::INACTIVITY_DAYS_THRESHOLD, self::PROCESS_BATCH_SIZE, null, self::UNOPENED_EMAILS_THRESHOLD);
expect($result)->equals(0); expect($result)->equals(0);
$subscriber = $this->subscribersRepository->findOneById($subscriber->getId()); $subscriber = $this->subscribersRepository->findOneById($subscriber->getId());
assert($subscriber instanceof SubscriberEntity); assert($subscriber instanceof SubscriberEntity);