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

Add new action hooks for multiple changes

Browse Source 
[MAILPOET-4727]
This commit is contained in:
Jan Lysý
2022-10-20 19:27:55 +02:00
committed by Veljko V
parent 28b91ed994
commit 2d835cdec1
3 changed files with 104 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
mailpoet/lib/Config/SubscriberChangesNotifier.php
View File

@ -8,13 +8,13 @@ use MailPoetVendor\Carbon\Carbon;
class SubscriberChangesNotifier {
/** @var array<int, Carbon> */
/** @var array<int, int> */
private $createdSubscriberIds = [];
/** @var array<int, Carbon> */
/** @var array<int, int> */
private $deletedSubscriberIds = [];
/** @var array<int, Carbon> */
/** @var array<int, int> */
private $updatedSubscriberIds = [];
/** @var WPFunctions */
@ -33,40 +33,59 @@ class SubscriberChangesNotifier {
}
private function notifyCreations(): void {
foreach ($this->createdSubscriberIds as $subscriberId => $createdAt) {
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, $subscriberId, $createdAt->getTimestamp());
if (count($this->createdSubscriberIds) === 1) {
foreach ($this->createdSubscriberIds as $subscriberId => $updatedAt) {
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, $subscriberId);
}
} elseif ($this->createdSubscriberIds) {
$minTimestamp = min($this->createdSubscriberIds);
if ($minTimestamp) {
$this->wp->doAction(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_CREATED, $minTimestamp);
}
}
}
private function notifyUpdates(): void {
foreach ($this->updatedSubscriberIds as $subscriberId => $updatedAt) {
// do not notify about changes when subscriber is new
if (isset($this->createdSubscriberIds[$subscriberId])) {
continue;
// unset updated subscribers if subscriber is created
foreach ($this->createdSubscriberIds as $subscriberId => $timestamp) {
unset($this->updatedSubscriberIds[$subscriberId]);
}
if (count($this->updatedSubscriberIds) === 1) {
foreach ($this->updatedSubscriberIds as $subscriberId => $updatedAt) {
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, $subscriberId);
}
} elseif ($this->updatedSubscriberIds) {
$minTimestamp = min($this->updatedSubscriberIds);
if ($minTimestamp) {
$this->wp->doAction(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_UPDATED, $minTimestamp);
}
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, $subscriberId, $updatedAt->getTimestamp());
}
}
private function notifyDeletes(): void {
foreach ($this->deletedSubscriberIds as $subscriberId => $deletedAt) {
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, $subscriberId, $deletedAt->getTimestamp());
if (count($this->deletedSubscriberIds) === 1) {
foreach ($this->deletedSubscriberIds as $subscriberId => $updatedAt) {
$this->wp->doAction(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, $subscriberId);
}
} elseif ($this->deletedSubscriberIds) {
$this->wp->doAction(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_DELETED, array_keys($this->deletedSubscriberIds));
}
}
public function subscriberCreated(int $subscriberId): void {
// store id as a key and timestamp change as the value
$this->createdSubscriberIds[$subscriberId] = Carbon::createFromTimestamp($this->wp->currentTime('timestamp'), 'UTC');
$this->createdSubscriberIds[$subscriberId] = $this->getTimestamp();
}
public function subscriberUpdated(int $subscriberId): void {
// store id as a key and timestamp change as the value
$this->updatedSubscriberIds[$subscriberId] = Carbon::createFromTimestamp($this->wp->currentTime('timestamp'), 'UTC');
$this->updatedSubscriberIds[$subscriberId] = $this->getTimestamp();
}
public function subscriberDeleted(int $subscriberId): void {
// store id as a key and timestamp change as the value
$this->deletedSubscriberIds[$subscriberId] = Carbon::createFromTimestamp($this->wp->currentTime('timestamp'), 'UTC');
$this->deletedSubscriberIds[$subscriberId] = $this->getTimestamp();
}
public function subscribersCreated(array $subscriberIds): void {
@ -86,4 +105,9 @@ class SubscriberChangesNotifier {
$this->subscriberDeleted($subscriberId);
}
}
private function getTimestamp(): int {
$dateTime = Carbon::createFromTimestamp($this->wp->currentTime('timestamp'), 'UTC');
return $dateTime->getTimestamp();
}
}

3
mailpoet/lib/Entities/SubscriberEntity.php
View File

@ -25,6 +25,9 @@ class SubscriberEntity {
public const HOOK_SUBSCRIBER_CREATED = 'mailpoet_subscriber_created';
public const HOOK_SUBSCRIBER_DELETED = 'mailpoet_subscriber_deleted';
public const HOOK_SUBSCRIBER_UPDATED = 'mailpoet_subscriber_updated';
public const HOOK_MULTIPLE_SUBSCRIBERS_CREATED = 'mailpoet_multiple_subscribers_created';
public const HOOK_MULTIPLE_SUBSCRIBERS_DELETED = 'mailpoet_multiple_subscribers_deleted';
public const HOOK_MULTIPLE_SUBSCRIBERS_UPDATED = 'mailpoet_multiple_subscribers_updated';
// statuses
const STATUS_BOUNCED = 'bounced';

88
mailpoet/tests/unit/Config/SubscriberChangesNotifierTest.php
View File

@ -16,55 +16,91 @@ class SubscriberChangesNotifierTest extends \MailPoetUnitTest {
$this->wpFunctions = $this->createMock(WPFunctions::class);
}
public function testItNotifyCreatedSubscriberIds(): void {
public function testItNotifyCreatedSubscriberId(): void {
$this->wpFunctions->method('currentTime')
->willReturn(1234);
$this->wpFunctions->expects($this->at(2))
$this->wpFunctions->expects($this->at(1))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 6, 1234)
->willReturn(true);
$this->wpFunctions->expects($this->at(3))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 10, 1234)
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 6)
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
$notifier->subscriberCreated(6);
$notifier->subscriberCreated(10);
$notifier->notify();
}
public function testItNotifyUpdatedSubscriberIds(): void {
$this->wpFunctions->method('currentTime')
->willReturn(4567);
public function testItNotifyMultipleSubscribersCreated(): void {
$this->wpFunctions->expects($this->at(0))
->method('currentTime')
->willReturn(1234);
$this->wpFunctions->expects($this->at(1))
->method('currentTime')
->willReturn(3456);
$this->wpFunctions->expects($this->at(2))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, 2, 4567)
->with(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_CREATED, 1234)
->willReturn(true);
$this->wpFunctions->expects($this->at(3))
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
$notifier->subscriberCreated(4);
$notifier->subscriberCreated(6);
$notifier->notify();
}
public function testItNotifyUpdatedSubscriberId(): void {
$this->wpFunctions->method('currentTime')
->willReturn(4567);
$this->wpFunctions->expects($this->at(1))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, 11, 4567)
->with(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, 2)
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
$notifier->subscriberUpdated(2);
$notifier->subscriberUpdated(11);
$notifier->notify();
}
public function testItNotifyDeletedSubscriberIds(): void {
$this->wpFunctions->method('currentTime')
->willReturn(3456);
public function testItNotifyMultipleSubscribersUpdated(): void {
$this->wpFunctions->expects($this->at(0))
->method('currentTime')
->willReturn(12345);
$this->wpFunctions->expects($this->at(1))
->method('currentTime')
->willReturn(1234);
$this->wpFunctions->expects($this->at(2))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, 1, 3456)
->with(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_UPDATED, 1234)
->willReturn(true);
$this->wpFunctions->expects($this->at(3))
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
$notifier->subscriberUpdated(2);
$notifier->subscriberUpdated(41);
$notifier->notify();
}
public function testItNotifyDeletedSubscriberId(): void {
$this->wpFunctions->method('currentTime')
->willReturn(3456);
$this->wpFunctions->expects($this->at(1))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, 12, 3456)
->with(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, 1)
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
$notifier->subscriberDeleted(1);
$notifier->notify();
}
public function testItNotifyMultipleSubscribersDeleted(): void {
$this->wpFunctions->expects($this->at(0))
->method('currentTime')
->willReturn(3456);
$this->wpFunctions->expects($this->at(1))
->method('currentTime')
->willReturn(98712);
$this->wpFunctions->expects($this->at(2))
->method('doAction')
->with(SubscriberEntity::HOOK_MULTIPLE_SUBSCRIBERS_DELETED, [1, 12])
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
@ -78,17 +114,17 @@ class SubscriberChangesNotifierTest extends \MailPoetUnitTest {
->willReturn(12345);
$this->wpFunctions->expects($this->at(3))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 1, 12345)
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 1)
->willReturn(true);
$this->wpFunctions->expects($this->at(4))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, 3, 12345)
->with(SubscriberEntity::HOOK_SUBSCRIBER_UPDATED, 3)
->willReturn(true);
$this->wpFunctions->expects($this->at(5))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, 5, 12345)
->with(SubscriberEntity::HOOK_SUBSCRIBER_DELETED, 5)
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);
@ -103,7 +139,7 @@ class SubscriberChangesNotifierTest extends \MailPoetUnitTest {
->willReturn(1235);
$this->wpFunctions->expects($this->at(2))
->method('doAction')
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 11, 1235)
->with(SubscriberEntity::HOOK_SUBSCRIBER_CREATED, 11)
->willReturn(true);
$notifier = new SubscriberChangesNotifier($this->wpFunctions);