Fix and refactor ViewInBrowserRendererTest

[MAILPOET-2430]
This commit is contained in:
Jan Jakeš
2020-02-06 15:14:17 +01:00
committed by Jack Kitterhing
parent ce21cc2085
commit 4c4a0e4caa

View File

@@ -9,7 +9,6 @@ use MailPoet\Models\ScheduledTask;
use MailPoet\Models\SendingQueue; use MailPoet\Models\SendingQueue;
use MailPoet\Models\Subscriber; use MailPoet\Models\Subscriber;
use MailPoet\Newsletter\Links\Links; use MailPoet\Newsletter\Links\Links;
use MailPoet\Newsletter\ViewInBrowserRenderer;
use MailPoet\Router\Router; use MailPoet\Router\Router;
use MailPoet\Settings\SettingsController; use MailPoet\Settings\SettingsController;
use MailPoet\Tasks\Sending as SendingTask; use MailPoet\Tasks\Sending as SendingTask;
@@ -17,65 +16,75 @@ use MailPoet\WP\Emoji;
use MailPoetVendor\Idiorm\ORM; use MailPoetVendor\Idiorm\ORM;
class ViewInBrowserRendererTest extends \MailPoetTest { class ViewInBrowserRendererTest extends \MailPoetTest {
public $queueRenderedNewsletterWithTracking; /** @var SettingsController */
public $queueRenderedNewsletterWithoutTracking; private $settings;
public $newsletterLink2;
public $newsletterLink1; /** @var ViewInBrowserRenderer */
public $queue; private $viewInBrowserRenderer;
public $subscriber;
public $viewInBrowser; /** @var Newsletter */
public $emoji;
public $newsletter; public $newsletter;
/** @var SendingTask */
private $sendingTask;
/** @var Subscriber */
private $subscriber;
/** @var mixed[] */
private $queueRenderedNewsletterWithTracking;
/** @var mixed[] */
private $queueRenderedNewsletterWithoutTracking;
public function _before() { public function _before() {
parent::_before(); $newsletterData = [
$this->newsletter = 'body' => json_decode(
[ '{
'body' => json_decode( "content": {
'{ "type": "container",
"content": { "orientation": "vertical",
"type": "container", "styles": {
"orientation": "vertical", "block": {
"styles": { "backgroundColor": "transparent"
"block": { }
"backgroundColor": "transparent" },
} "blocks": [
}, {
"blocks": [ "type": "container",
{ "orientation": "horizontal",
"type": "container", "styles": {
"orientation": "horizontal", "block": {
"styles": { "backgroundColor": "transparent"
"block": { }
"backgroundColor": "transparent" },
} "blocks": [
}, {
"blocks": [ "type": "container",
{ "orientation": "vertical",
"type": "container", "styles": {
"orientation": "vertical", "block": {
"styles": { "backgroundColor": "transparent"
"block": { }
"backgroundColor": "transparent" },
} "blocks": [
}, {
"blocks": [ "type": "text",
{ "text": "<p>Rendered newsletter. Hello, [subscriber:firstname | default:reader]. <a href=\"[link:newsletter_view_in_browser_url]\">Unsubscribe</a> or visit <a href=\"http://google.com\">Google</a></p>"
"type": "text", }
"text": "<p>Rendered newsletter. Hello, [subscriber:firstname | default:reader]. <a href=\"[link:newsletter_view_in_browser_url]\">Unsubscribe</a> or visit <a href=\"http://google.com\">Google</a></p>" ]
} }
] ]
} }
] ]
} }
] }', true),
} 'id' => 1,
}', true), 'subject' => 'Some subject',
'id' => 1, 'preheader' => 'Some preheader',
'subject' => 'Some subject', 'type' => 'standard',
'preheader' => 'Some preheader', 'status' => 'active',
'type' => 'standard', ];
'status' => 'active',
];
$this->queueRenderedNewsletterWithoutTracking = [ $this->queueRenderedNewsletterWithoutTracking = [
'html' => '<p>Newsletter from queue. Hello, [subscriber:firstname | default:reader]. <a href="[link:newsletter_view_in_browser_url]">Unsubscribe</a> or visit <a href="http://google.com">Google</a></p>', 'html' => '<p>Newsletter from queue. Hello, [subscriber:firstname | default:reader]. <a href="[link:newsletter_view_in_browser_url]">Unsubscribe</a> or visit <a href="http://google.com">Google</a></p>',
'text' => 'test', 'text' => 'test',
@@ -84,102 +93,105 @@ class ViewInBrowserRendererTest extends \MailPoetTest {
'html' => '<p>Newsletter from queue. Hello, [subscriber:firstname | default:reader]. <a href="' . Links::DATA_TAG_CLICK . '-90e56">Unsubscribe</a> or visit <a href="' . Links::DATA_TAG_CLICK . '-i1893">Google</a><img alt="" class="" src="' . Links::DATA_TAG_OPEN . '"></p>', 'html' => '<p>Newsletter from queue. Hello, [subscriber:firstname | default:reader]. <a href="' . Links::DATA_TAG_CLICK . '-90e56">Unsubscribe</a> or visit <a href="' . Links::DATA_TAG_CLICK . '-i1893">Google</a><img alt="" class="" src="' . Links::DATA_TAG_OPEN . '"></p>',
'text' => 'test', 'text' => 'test',
]; ];
$this->emoji = new Emoji();
$this->viewInBrowser = new ViewInBrowserRenderer($this->emoji, false);
// create newsletter // create newsletter
$newsletter = Newsletter::create(); $newsletter = Newsletter::create();
$newsletter->hydrate($this->newsletter); $newsletter->hydrate($newsletterData);
$this->newsletter = $newsletter->save(); $this->newsletter = $newsletter->save();
// create subscriber // create subscriber
$subscriber = Subscriber::create(); $subscriber = Subscriber::create();
$subscriber->email = 'test@example.com'; $subscriber->email = 'test@example.com';
$subscriber->firstName = 'First'; $subscriber->firstName = 'First';
$subscriber->lastName = 'Last'; $subscriber->lastName = 'Last';
$this->subscriber = $subscriber->save(); $this->subscriber = $subscriber->save();
// create queue // create queue
$queue = SendingTask::create(); $queue = SendingTask::create();
$queue->newsletterId = $newsletter->id; $queue->newsletterId = $newsletter->id;
$queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithoutTracking; $queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithoutTracking;
$queue->setSubscribers([$subscriber->id]); $queue->setSubscribers([$subscriber->id]);
$this->queue = $queue->save(); $this->sendingTask = $queue->save();
// create newsletter link associations // create newsletter link associations
$newsletterLink1 = NewsletterLink::create(); $newsletterLink1 = NewsletterLink::create();
$newsletterLink1->hash = '90e56'; $newsletterLink1->hash = '90e56';
$newsletterLink1->url = '[link:newsletter_view_in_browser_url]'; $newsletterLink1->url = '[link:newsletter_view_in_browser_url]';
$newsletterLink1->newsletterId = $this->newsletter->id; $newsletterLink1->newsletterId = $this->newsletter->id;
$newsletterLink1->queueId = $this->queue->id; $newsletterLink1->queueId = $this->sendingTask->id;
$this->newsletterLink1 = $newsletterLink1->save(); $newsletterLink1->save();
$newsletterLink2 = NewsletterLink::create(); $newsletterLink2 = NewsletterLink::create();
$newsletterLink2->hash = 'i1893'; $newsletterLink2->hash = 'i1893';
$newsletterLink2->url = 'http://google.com'; $newsletterLink2->url = 'http://google.com';
$newsletterLink2->newsletterId = $this->newsletter->id; $newsletterLink2->newsletterId = $this->newsletter->id;
$newsletterLink2->queueId = $this->queue->id; $newsletterLink2->queueId = $this->sendingTask->id;
$this->newsletterLink2 = $newsletterLink2->save(); $newsletterLink2->save();
$this->settings = $this->diContainer->get(SettingsController::class);
$this->viewInBrowserRenderer = $this->diContainer->get(ViewInBrowserRenderer::class);
} }
public function testItRendersNewsletter() { public function testItRendersNewsletter() {
$renderedBody = $this->viewInBrowser->renderNewsletter( $renderedBody = $this->viewInBrowserRenderer->render(
$preview = false,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$queue = false, $queue = null
$preview = false
); );
expect($renderedBody)->regExp('/Rendered newsletter/'); expect($renderedBody)->regExp('/Rendered newsletter/');
} }
public function testItReusesRenderedNewsletterBodyWhenQueueExists() { public function testItReusesRenderedNewsletterBodyWhenQueueExists() {
$emoji = $this->make( $emoji = $this->make(Emoji::class, [
Emoji::class, 'decodeEmojisInBody' => Expected::once(function ($params) {
['decodeEmojisInBody' => Expected::once(function ($params) {
return $params; return $params;
})] }),
); ]);
$viewInBrowser = new ViewInBrowserRenderer($emoji, false); $this->settings->set('tracking.enabled', false);
$renderedBody = $viewInBrowser->renderNewsletter( $viewInBrowser = new ViewInBrowserRenderer($emoji, $this->diContainer->get(SettingsController::class));
$renderedBody = $viewInBrowser->render(
$preview = false,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$this->queue, $this->sendingTask->queue()
$preview = false
); );
expect($renderedBody)->regExp('/Newsletter from queue/'); expect($renderedBody)->regExp('/Newsletter from queue/');
} }
public function testItConvertsShortcodes() { public function testItConvertsShortcodes() {
$settings = SettingsController::getInstance(); $this->settings->set('tracking.enabled', false);
$settings->set('tracking.enabled', false); $renderedBody = $this->viewInBrowserRenderer->render(
$renderedBody = $this->viewInBrowser->renderNewsletter( $preview = false,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$this->queue, $this->sendingTask->queue()
$preview = false
); );
expect($renderedBody)->contains('Hello, First'); expect($renderedBody)->contains('Hello, First');
expect($renderedBody)->contains(Router::NAME . '&endpoint=view_in_browser'); expect($renderedBody)->contains(Router::NAME . '&endpoint=view_in_browser');
} }
public function testItRewritesLinksToRouterEndpointWhenTrackingIsEnabled() { public function testItRewritesLinksToRouterEndpointWhenTrackingIsEnabled() {
$settings = SettingsController::getInstance(); $this->settings->set('tracking.enabled', true);
$settings->set('tracking.enabled', true); $queue = $this->sendingTask->queue();
$viewInBrowser = new ViewInBrowserRenderer($this->emoji, true);
$queue = $this->queue;
$queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking; $queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking;
$renderedBody = $viewInBrowser->renderNewsletter( $renderedBody = $this->viewInBrowserRenderer->render(
$preview = false,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$queue, $queue
$preview = false
); );
expect($renderedBody)->contains(Router::NAME . '&endpoint=track'); expect($renderedBody)->contains(Router::NAME . '&endpoint=track');
} }
public function testItConvertsHashedLinksToUrlsWhenPreviewIsEnabledAndNewsletterWasSent() { public function testItConvertsHashedLinksToUrlsWhenPreviewIsEnabledAndNewsletterWasSent() {
$queue = $this->queue; $queue = $this->sendingTask->queue();
$queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking; $queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking;
$renderedBody = $this->viewInBrowser->renderNewsletter( $renderedBody = $this->viewInBrowserRenderer->render(
$preview = true,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$queue, $queue
$preview = true
); );
// hashed link should be replaced with a URL // hashed link should be replaced with a URL
expect($renderedBody)->notContains('[mailpoet_click_data]'); expect($renderedBody)->notContains('[mailpoet_click_data]');
@@ -187,13 +199,13 @@ class ViewInBrowserRendererTest extends \MailPoetTest {
} }
public function testRemovesOpenTrackingTagWhenPreviewIsEnabledAndNewsletterWasSent() { public function testRemovesOpenTrackingTagWhenPreviewIsEnabledAndNewsletterWasSent() {
$queue = $this->queue; $queue = $this->sendingTask->queue();
$queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking; $queue->newsletterRenderedBody = $this->queueRenderedNewsletterWithTracking;
$renderedBody = $this->viewInBrowser->renderNewsletter( $renderedBody = $this->viewInBrowserRenderer->render(
$preview = true,
$this->newsletter, $this->newsletter,
$this->subscriber, $this->subscriber,
$queue, $queue
$preview = true
); );
// open tracking data tag should be removed // open tracking data tag should be removed
expect($renderedBody)->notContains('[mailpoet_open_data]'); expect($renderedBody)->notContains('[mailpoet_open_data]');