piratepoet/tests/unit/Newsletter/ViewInBrowserTest.php

<?php

use MailPoet\Models\Newsletter;
use MailPoet\Models\NewsletterLink;
use MailPoet\Models\SendingQueue;
use MailPoet\Models\Setting;
use MailPoet\Models\Subscriber;
use MailPoet\Newsletter\Links\Links;
use MailPoet\Newsletter\ViewInBrowser;
use MailPoet\Router\Router;

class ViewInBrowserTest extends MailPoetTest {
  function __construct() {
    parent::__construct();
    $this->newsletter =
      array(
        'body' => json_decode(
          '{
          "content": {
            "type": "container",
            "orientation": "vertical",
            "styles": {
              "block": {
                "backgroundColor": "transparent"
              }
            },
            "blocks": [
              {
                "type": "container",
                "orientation": "horizontal",
                "styles": {
                  "block": {
                    "backgroundColor": "transparent"
                  }
                },
                "blocks": [
                  {
                    "type": "container",
                    "orientation": "vertical",
                    "styles": {
                      "block": {
                        "backgroundColor": "transparent"
                      }
                    },
                    "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>"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }', true),
        'id' => 1,
        'subject' => 'Some subject',
        'preheader' => 'Some preheader',
        'type' => 'standard',
        'status' => 'active'
      );
    $this->queue_rendered_newsletter_without_tracking = array(
      '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>'
    );
    $this->queue_rendered_newsletter_with_tracking = array(
      '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>'
    );
  }

  function _before() {
    // create newsletter
    $newsletter = Newsletter::create();
    $newsletter->hydrate($this->newsletter);
    $this->newsletter = $newsletter->save();
    // create subscriber
    $subscriber = Subscriber::create();
    $subscriber->email = 'test@example.com';
    $subscriber->first_name = 'First';
    $subscriber->last_name = 'Last';
    $this->subscriber = $subscriber->save();
    // create queue
    $queue = SendingQueue::create();
    $queue->newsletter_id = $newsletter->id;
    $queue->newsletter_rendered_body = $this->queue_rendered_newsletter_without_tracking;
    $queue->subscribers = array('processed' => array($subscriber->id));
    $this->queue = $queue->save();
    // create newsletter link associations
    $newsletter_link_1 = NewsletterLink::create();
    $newsletter_link_1->hash = '90e56';
    $newsletter_link_1->url = '[link:newsletter_view_in_browser_url]';
    $newsletter_link_1->newsletter_id = $this->newsletter->id;
    $newsletter_link_1->queue_id = $this->queue->id;
    $this->newsletter_link_1 = $newsletter_link_1->save();
    $newsletter_link_2 = NewsletterLink::create();
    $newsletter_link_2->hash = 'i1893';
    $newsletter_link_2->url = 'http://google.com';
    $newsletter_link_2->newsletter_id = $this->newsletter->id;
    $newsletter_link_2->queue_id = $this->queue->id;
    $this->newsletter_link_2 = $newsletter_link_2->save();
  }

  function testItRendersNewsletter() {
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $queue = false,
      $preview = false
    );
    expect($rendered_body)->regExp('/Rendered newsletter/');
  }

  function testItReusesRenderedNewsletterBodyWhenQueueExists() {
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $this->queue,
      $preview = false
    );
    expect($rendered_body)->regExp('/Newsletter from queue/');
  }

  function testItConvertsShortcodes() {
    Setting::setValue('tracking.enabled', false);
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $this->queue,
      $preview = false
    );
    expect($rendered_body)->contains('Hello, First');
    expect($rendered_body)->contains(Router::NAME . '&endpoint=view_in_browser');
  }

  function testItRewritesLinksToRouterEndpointWhenTrackingIsEnabled() {
    Setting::setValue('tracking.enabled', true);
    $queue = $this->queue;
    $queue->newsletter_rendered_body = $this->queue_rendered_newsletter_with_tracking;
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $queue,
      $preview = false
    );
    expect($rendered_body)->contains(Router::NAME . '&endpoint=track');
  }

  function testItConvertsHashedLinksToUrlsWhenPreviewIsEnabledAndNewsletterWasSent() {
    $queue = $this->queue;
    $queue->newsletter_rendered_body = $this->queue_rendered_newsletter_with_tracking;
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $queue,
      $preview = true
    );
    // hashed link should be replaced with a URL
    expect($rendered_body)->notContains('[mailpoet_click_data]');
    expect($rendered_body)->contains('<a href="http://google.com">');
  }

  function testReplacesLinkShortcodesWithUrlHashWhenPreviewIsEnabledAndNewsletterWasSent() {
    $queue = $this->queue;
    $queue->newsletter_rendered_body = $this->queue_rendered_newsletter_with_tracking;
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $queue,
      $preview = true
    );
    // link shortcodes should be replaced with a hash (#)
    expect($rendered_body)->notContains('[mailpoet_click_data]');
    expect($rendered_body)->contains('<a href="#">');
  }

  function testRemovesOpenTrackingTagWhenPreviewIsEnabledAndNewsletterWasSent() {
    $queue = $this->queue;
    $queue->newsletter_rendered_body = $this->queue_rendered_newsletter_with_tracking;
    $rendered_body = ViewInBrowser::renderNewsletter(
      $this->newsletter,
      $this->subscriber,
      $queue,
      $preview = true
    );
    // open tracking data tag should be removed
    expect($rendered_body)->notContains('[mailpoet_open_data]');
    expect($rendered_body)->contains('<img alt="" class="" src="">');
  }

  function _after() {
    ORM::raw_execute('TRUNCATE ' . Newsletter::$_table);
    ORM::raw_execute('TRUNCATE ' . NewsletterLink::$_table);
    ORM::raw_execute('TRUNCATE ' . Subscriber::$_table);
    ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
  }
}