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

Refactor tracking into doctrine

Browse Source 
[MAILPOET-2993]
This commit is contained in:
Pavel Dohnal
2020-11-02 08:45:47 +01:00
committed by Veljko V
parent 4134e6e882
commit 7d538abad8
7 changed files with 183 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/Newsletter/Shortcodes/Categories/Link.php
View File

@ -2,6 +2,7 @@
namespace MailPoet\Newsletter\Shortcodes\Categories;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Newsletter\Url as NewsletterUrl;
use MailPoet\Settings\SettingsController;
use MailPoet\Subscription\SubscriptionUrlFactory;
@ -128,6 +129,9 @@ class Link {
if ($queue instanceof Sending) {
return (int)$queue->id;
}
if ($queue instanceof SendingQueueEntity) {
return $queue->getId();
}
return null;
}
}

2
lib/Newsletter/Shortcodes/Shortcodes.php
View File

@ -5,11 +5,11 @@ namespace MailPoet\Newsletter\Shortcodes;
use MailPoet\WP\Functions as WPFunctions;
class Shortcodes {
const SHORTCODE_CATEGORY_NAMESPACE = 'MailPoet\Newsletter\Shortcodes\Categories\\';
public $newsletter;
public $subscriber;
public $queue;
public $wpUserPreview;
const SHORTCODE_CATEGORY_NAMESPACE = 'MailPoet\Newsletter\Shortcodes\Categories\\';
public function __construct(
$newsletter = false,

60
lib/Router/Endpoints/Track.php
View File

@ -3,15 +3,16 @@
namespace MailPoet\Router\Endpoints;
use MailPoet\Config\AccessControl;
use MailPoet\Models\Newsletter;
use MailPoet\Models\NewsletterLink;
use MailPoet\Cron\Workers\StatsNotifications\NewsletterLinkRepository;
use MailPoet\Models\SendingQueue;
use MailPoet\Models\Subscriber;
use MailPoet\Newsletter\Links\Links;
use MailPoet\Newsletter\NewslettersRepository;
use MailPoet\Newsletter\Sending\SendingQueuesRepository;
use MailPoet\Statistics\Track\Clicks;
use MailPoet\Statistics\Track\Opens;
use MailPoet\Subscribers\LinkTokens;
use MailPoet\Tasks\Sending as SendingTask;
use MailPoet\Subscribers\SubscribersRepository;
use MailPoet\WP\Functions as WPFunctions;
class Track {
@ -35,10 +36,34 @@ class Track {
/** @var LinkTokens */
private $linkTokens;
public function __construct(Clicks $clicks, Opens $opens, LinkTokens $linkTokens) {
/** @var SendingQueuesRepository */
private $sendingQueuesRepository;
/** @var SubscribersRepository */
private $subscribersRepository;
/** @var NewslettersRepository */
private $newslettersRepository;
/** @var NewsletterLinkRepository */
private $newsletterLinkRepository;
public function __construct(
Clicks $clicks,
Opens $opens,
SendingQueuesRepository $sendingQueuesRepository,
SubscribersRepository $subscribersRepository,
NewslettersRepository $newslettersRepository,
NewsletterLinkRepository $newsletterLinkRepository,
LinkTokens $linkTokens
) {
$this->clicks = $clicks;
$this->opens = $opens;
$this->linkTokens = $linkTokens;
$this->sendingQueuesRepository = $sendingQueuesRepository;
$this->subscribersRepository = $subscribersRepository;
$this->newslettersRepository = $newslettersRepository;
$this->newsletterLinkRepository = $newsletterLinkRepository;
}
public function click($data) {
@ -57,34 +82,33 @@ class Track {
) {
return false;
}
$data->queue = SendingQueue::findOne($data->queue_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
if ($data->queue instanceof SendingQueue) {
$data->queue = SendingTask::createFromQueue($data->queue);
}
$data->subscriber = Subscriber::findOne($data->subscriber_id) ?: null; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$data->newsletter = (!empty($data->queue->newsletter_id)) ? // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
Newsletter::findOne($data->queue->newsletter_id) : // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
false;
$data->queue = $this->sendingQueuesRepository->findOneById($data->queue_id);// phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$data->subscriber = $this->subscribersRepository->findOneById($data->subscriber_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$data->newsletter = $this->newslettersRepository->findOneById($data->newsletter_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
if (!empty($data->link_hash)) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$data->link = NewsletterLink::where('hash', $data->link_hash) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
->where('queue_id', $data->queue_id) // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
->findOne();
$data->link = $this->newsletterLinkRepository->findOneBy([
'hash' => $data->link_hash, // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
'queue' => $data->queue_id, // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
]);
}
return $this->_validateTrackData($data);
}
public function _validateTrackData($data) {
if (!$data->subscriber || !$data->queue || !$data->newsletter) return false;
$subscriberTokenMatch = $this->linkTokens->verifyToken($data->subscriber, $data->subscriber_token); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
$subscriberModel = Subscriber::findOne($data->subscriber->getId());
$subscriberTokenMatch = $this->linkTokens->verifyToken($subscriberModel, $data->subscriber_token); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
if (!$subscriberTokenMatch) {
$this->terminate(403);
}
// return if this is a WP user previewing the newsletter
if ($data->subscriber->isWPUser() && $data->preview) {
if ($subscriberModel->isWPUser() && $data->preview) {
return $data;
}
// check if the newsletter was sent to the subscriber
return ($data->queue->isSubscriberProcessed($data->subscriber->id)) ?
$queue = SendingQueue::findOne($data->queue_id); // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
if (!$queue instanceof SendingQueue) return false;
return ($queue->isSubscriberProcessed($data->subscriber->getId())) ?
$data :
false;
}

28
lib/Statistics/Track/Clicks.php
View File

@ -2,6 +2,10 @@
namespace MailPoet\Statistics\Track;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\NewsletterLinkEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Models\StatisticsClicks;
use MailPoet\Newsletter\Shortcodes\Categories\Link;
use MailPoet\Newsletter\Shortcodes\Shortcodes;
@ -35,19 +39,23 @@ class Clicks {
if (!$data || empty($data->link)) {
return $this->abort();
}
/** @var SubscriberEntity $subscriber */
$subscriber = $data->subscriber;
/** @var SendingQueueEntity $queue */
$queue = $data->queue;
/** @var NewsletterEntity $newsletter */
$newsletter = $data->newsletter;
/** @var NewsletterLinkEntity $link */
$link = $data->link;
$wpUserPreview = ($data->preview && $subscriber->isWPUser());
$wpUserPreview = ($data->preview && ($subscriber->getWpUserId() > 0));
// log statistics only if the action did not come from
// a WP user previewing the newsletter
if (!$wpUserPreview) {
$statisticsClicks = StatisticsClicks::createOrUpdateClickCount(
$link->id,
$subscriber->id,
$newsletter->id,
$queue->id
$link->getId(),
$subscriber->getId(),
$newsletter->getId(),
$queue->getId()
);
$this->sendRevenueCookie($statisticsClicks);
$this->sendAbandonedCartCookie($subscriber);
@ -55,7 +63,7 @@ class Clicks {
$openEvent = new Opens();
$openEvent->track($data, $displayImage = false);
}
$url = $this->processUrl($link->url, $newsletter, $subscriber, $queue, $wpUserPreview);
$url = $this->processUrl($link->getUrl(), $newsletter, $subscriber, $queue, $wpUserPreview);
$this->redirectToUrl($url);
}
@ -90,7 +98,13 @@ class Clicks {
}
}
public function processUrl($url, $newsletter, $subscriber, $queue, $wpUserPreview) {
public function processUrl(
string $url,
NewsletterEntity $newsletter,
SubscriberEntity $subscriber,
SendingQueueEntity $queue,
bool $wpUserPreview
) {
if (preg_match('/\[link:(?P<action>.*?)\]/', $url, $shortcode)) {
if (!$shortcode['action']) $this->abort();
$url = Link::processShortcodeAction(

14
lib/Statistics/Track/Opens.php
View File

@ -2,6 +2,9 @@
namespace MailPoet\Statistics\Track;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Models\StatisticsOpens;
class Opens {
@ -9,17 +12,20 @@ class Opens {
if (!$data) {
return $this->returnResponse($displayImage);
}
/** @var SubscriberEntity $subscriber */
$subscriber = $data->subscriber;
/** @var SendingQueueEntity $queue */
$queue = $data->queue;
/** @var NewsletterEntity $newsletter */
$newsletter = $data->newsletter;
$wpUserPreview = ($data->preview && $subscriber->isWPUser());
$wpUserPreview = ($data->preview && ($subscriber->getWpUserId() > 0));
// log statistics only if the action did not come from
// a WP user previewing the newsletter
if (!$wpUserPreview) {
StatisticsOpens::getOrCreate(
$subscriber->id,
$newsletter->id,
$queue->id
$subscriber->getId(),
$newsletter->getId(),
$queue->getId()
);
}
return $this->returnResponse($displayImage);

102
tests/integration/Router/Endpoints/TrackTest.php
View File

@ -3,20 +3,19 @@
namespace MailPoet\Test\Router\Endpoints;
use Codeception\Stub;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\NewsletterLinkEntity;
use MailPoet\Entities\ScheduledTaskEntity;
use MailPoet\Entities\ScheduledTaskSubscriberEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Models\Newsletter;
use MailPoet\Models\NewsletterLink;
use MailPoet\Models\ScheduledTask;
use MailPoet\Models\ScheduledTaskSubscriber;
use MailPoet\Models\SendingQueue;
use MailPoet\Models\Subscriber;
use MailPoet\Router\Endpoints\Track;
use MailPoet\Settings\SettingsController;
use MailPoet\Statistics\Track\Clicks;
use MailPoet\Statistics\Track\Opens;
use MailPoet\Subscribers\LinkTokens;
use MailPoet\Tasks\Sending as SendingTask;
use MailPoet\Util\Cookies;
use MailPoetVendor\Idiorm\ORM;
class TrackTest extends \MailPoetTest {
public $track;
@ -29,40 +28,48 @@ class TrackTest extends \MailPoetTest {
public function _before() {
parent::_before();
// create newsletter
$newsletter = Newsletter::create();
$newsletter->type = 'type';
$this->newsletter = $newsletter->save();
$newsletter = new NewsletterEntity();
$newsletter->setType('type');
$newsletter->setSubject('Subject');
$this->newsletter = $newsletter;
$this->entityManager->persist($newsletter);
// create subscriber
$subscriber = Subscriber::create();
$subscriber->email = 'test@example.com';
$subscriber->firstName = 'First';
$subscriber->lastName = 'Last';
$this->subscriber = $subscriber->save();
$subscriber = new SubscriberEntity();
$subscriber->setEmail('test@example.com');
$subscriber->setFirstName('First');
$subscriber->setLastName('Last');
$subscriber->setLinkToken('token');
$this->subscriber = $subscriber;
$this->entityManager->persist($subscriber);
// create queue
$queue = SendingTask::create();
$queue->newsletterId = $newsletter->id;
$queue->setSubscribers([$subscriber->id]);
$queue->updateProcessedSubscribers([$subscriber->id]);
$this->queue = $queue->save();
$task = new ScheduledTaskEntity();
$task->setType('sending');
$this->entityManager->persist($task);
$queue = new SendingQueueEntity();
$queue->setTask($task);
$queue->setNewsletter($newsletter);
$this->queue = $queue;
$this->entityManager->persist($queue);
// create link
$link = NewsletterLink::create();
$link->hash = 'hash';
$link->url = 'url';
$link->newsletterId = $newsletter->id;
$link->queueId = $queue->id;
$this->link = $link->save();
$link = new NewsletterLinkEntity($newsletter, $queue, 'url', 'hash');
$this->link = $link;
$this->entityManager->persist($link);
$this->entityManager->flush();
$subscriberModel = Subscriber::findOne($subscriber->getId());
$linkTokens = new LinkTokens;
// build track data
$this->trackData = [
'queue_id' => $queue->id,
'subscriber_id' => $subscriber->id,
'newsletter_id' => $newsletter->id,
'subscriber_token' => $linkTokens->getToken($subscriber),
'link_hash' => $link->hash,
'queue_id' => $queue->getId(),
'subscriber_id' => $subscriber->getId(),
'newsletter_id' => $newsletter->getId(),
'subscriber_token' => $linkTokens->getToken($subscriberModel),
'link_hash' => $link->getHash(),
'preview' => false,
];
$queue = SendingTask::createFromQueue(SendingQueue::findOne($queue->getId()));
$queue->updateProcessedSubscribers([$subscriberModel->id]);
// instantiate class
$this->track = new Track(new Clicks(SettingsController::getInstance(), new Cookies()), new Opens(), new LinkTokens());
$this->track = $this->diContainer->get(Track::class);
}
public function testItReturnsFalseWhenTrackDataIsMissing() {
@ -89,7 +96,8 @@ class TrackTest extends \MailPoetTest {
'newsletter' => $this->newsletter,
]
);
$data->subscriber->email = 'random@email.com';
$data->subscriber->setEmail('random@email.com');
$this->entityManager->flush();
$track = Stub::make(Track::class, [
'linkTokens' => new LinkTokens,
'terminate' => function($code) {
@ -106,9 +114,17 @@ class TrackTest extends \MailPoetTest {
'queue' => $this->queue,
'subscriber' => $this->subscriber,
'newsletter' => $this->newsletter,
'subscriber_token' => $this->subscriber->getLinkToken(),
]
);
$data->subscriber->id = 99;
$subscriber = new SubscriberEntity();
$subscriber->setEmail('test1@example.com');
$subscriber->setFirstName('First');
$subscriber->setLastName('Last');
$subscriber->setLinkToken($this->subscriber->getLinkToken());
$this->entityManager->persist($subscriber);
$this->entityManager->flush();
$data->subscriber->setId($subscriber->getId());
expect($this->track->_validateTrackData($data))->false();
}
@ -121,7 +137,8 @@ class TrackTest extends \MailPoetTest {
'newsletter' => $this->newsletter,
]
);
$data->subscriber->wp_user_id = 99;
$this->subscriber->setWpUserId(99);
$this->entityManager->flush();
$data->preview = true;
expect($this->track->_validateTrackData($data))->equals($data);
}
@ -138,7 +155,7 @@ class TrackTest extends \MailPoetTest {
$data = $this->trackData;
$data['newsletter_id'] = false;
$processedData = $this->track->_processTrackData($data);
expect($processedData->newsletter->id)->equals($this->newsletter->id);
expect($processedData->newsletter->getId())->equals($this->newsletter->getId());
}
public function testItProcessesTrackData() {
@ -179,12 +196,11 @@ class TrackTest extends \MailPoetTest {
}
public function _after() {
ORM::raw_execute('TRUNCATE ' . Newsletter::$_table);
ORM::raw_execute('TRUNCATE ' . Subscriber::$_table);
ORM::raw_execute('TRUNCATE ' . NewsletterLink::$_table);
ORM::raw_execute('TRUNCATE ' . ScheduledTask::$_table);
ORM::raw_execute('TRUNCATE ' . ScheduledTaskSubscriber::$_table);
ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
$this->truncateEntity(NewsletterEntity::class);
$this->truncateEntity(SubscriberEntity::class);
$this->truncateEntity(NewsletterLinkEntity::class);
$this->truncateEntity(ScheduledTaskEntity::class);
$this->truncateEntity(ScheduledTaskSubscriberEntity::class);
$this->truncateEntity(SendingQueueEntity::class);
}
}

80
tests/integration/Statistics/Track/ClicksTest.php
View File

@ -4,9 +4,13 @@ namespace MailPoet\Test\Statistics\Track;
use Codeception\Stub;
use Codeception\Stub\Expected;
use MailPoet\Models\Newsletter;
use MailPoet\Models\NewsletterLink;
use MailPoet\Models\ScheduledTask;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\NewsletterLinkEntity;
use MailPoet\Entities\ScheduledTaskEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\StatisticsClickEntity;
use MailPoet\Entities\StatisticsOpenEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Models\SendingQueue;
use MailPoet\Models\StatisticsClicks;
use MailPoet\Models\StatisticsOpens;
@ -16,7 +20,6 @@ use MailPoet\Statistics\Track\Clicks;
use MailPoet\Subscribers\LinkTokens;
use MailPoet\Tasks\Sending as SendingTask;
use MailPoet\Util\Cookies;
use MailPoetVendor\Idiorm\ORM;
class ClicksTest extends \MailPoetTest {
public $trackData;
@ -32,40 +35,48 @@ class ClicksTest extends \MailPoetTest {
public function _before() {
parent::_before();
$this->cleanup();
// create newsletter
$newsletter = Newsletter::create();
$newsletter->type = 'type';
$newsletter->subject = 'Subject';
$this->newsletter = $newsletter->save();
$newsletter = new NewsletterEntity();
$newsletter->setType('type');
$newsletter->setSubject('Subject');
$this->newsletter = $newsletter;
$this->entityManager->persist($newsletter);
// create subscriber
$subscriber = Subscriber::create();
$subscriber->email = 'test@example.com';
$subscriber->firstName = 'First';
$subscriber->lastName = 'Last';
$this->subscriber = $subscriber->save();
$subscriber = new SubscriberEntity();
$subscriber->setEmail('test@example.com');
$subscriber->setFirstName('First');
$subscriber->setLastName('Last');
$this->subscriber = $subscriber;
$this->entityManager->persist($subscriber);
// create queue
$queue = SendingTask::create();
$queue->newsletterId = $newsletter->id;
$queue->setSubscribers([$subscriber->id]);
$queue->updateProcessedSubscribers([$subscriber->id]);
$this->queue = $queue->save();
$task = new ScheduledTaskEntity();
$task->setType('sending');
$this->entityManager->persist($task);
$queue = new SendingQueueEntity();
$queue->setTask($task);
$queue->setNewsletter($newsletter);
$this->queue = $queue;
$this->entityManager->persist($queue);
// create link
$link = NewsletterLink::create();
$link->hash = 'hash';
$link->url = 'url';
$link->newsletterId = $newsletter->id;
$link->queueId = $queue->id;
$this->link = $link->save();
$link = new NewsletterLinkEntity($newsletter, $queue, 'url', 'hash');
$this->link = $link;
$this->entityManager->persist($link);
$this->entityManager->flush();
$subscriberModel = Subscriber::findOne($subscriber->getId());
$linkTokens = new LinkTokens;
// build track data
$this->trackData = (object)[
'queue' => $queue,
'subscriber' => $subscriber,
'newsletter' => $newsletter,
'subscriber_token' => $linkTokens->getToken($subscriber),
'subscriber_token' => $linkTokens->getToken($subscriberModel),
'link' => $link,
'preview' => false,
];
$queue = SendingTask::createFromQueue(SendingQueue::findOne($queue->getId()));
$queue->updateProcessedSubscribers([$subscriberModel->id]);
// instantiate class
$this->settingsController = Stub::makeEmpty(SettingsController::class, [
'get' => false,
@ -88,7 +99,8 @@ class ClicksTest extends \MailPoetTest {
public function testItDoesNotTrackEventsFromWpUserWhenPreviewIsEnabled() {
$data = $this->trackData;
$data->subscriber->wp_user_id = 99;
$this->subscriber->setWpUserId(99);
$this->entityManager->flush();
$data->preview = true;
$clicks = Stub::construct($this->clicks, [$this->settingsController, new Cookies()], [
'redirectToUrl' => null,
@ -183,13 +195,13 @@ class ClicksTest extends \MailPoetTest {
expect($link)->equals('http://example.com/?email=test@example.com&newsletter_subject=Subject');
}
public function _after() {
ORM::raw_execute('TRUNCATE ' . Newsletter::$_table);
ORM::raw_execute('TRUNCATE ' . Subscriber::$_table);
ORM::raw_execute('TRUNCATE ' . NewsletterLink::$_table);
ORM::raw_execute('TRUNCATE ' . ScheduledTask::$_table);
ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
ORM::raw_execute('TRUNCATE ' . StatisticsOpens::$_table);
ORM::raw_execute('TRUNCATE ' . StatisticsClicks::$_table);
public function cleanup() {
$this->truncateEntity(NewsletterEntity::class);
$this->truncateEntity(SubscriberEntity::class);
$this->truncateEntity(NewsletterLinkEntity::class);
$this->truncateEntity(ScheduledTaskEntity::class);
$this->truncateEntity(SendingQueueEntity::class);
$this->truncateEntity(StatisticsOpenEntity::class);
$this->truncateEntity(StatisticsClickEntity::class);
}
}