piratepoet/tests/acceptance/ManageSubscriptionLinkCest.php

<?php

namespace MailPoet\Test\Acceptance;

use Codeception\Util\Locator;
use MailPoet\Test\DataFactories\Settings;
use PHPUnit\Framework\Exception;

class ManageSubscriptionLinkCest {

  /** @var Settings */
  private $settings;

  /** @var string */
  private $newsletterTitle;

  public function __construct() {
    $this->newsletterTitle = 'Subscription links Email ' . \MailPoet\Util\Security::generateRandomString();
  }

  public function _before() {
    $this->settings = new Settings();
    $this->settings
      ->withConfirmationEmailEnabled()
      ->withCronTriggerMethod('WordPress');
  }

  public function manageSubscriptionLink(\AcceptanceTester $i) {
    $i->wantTo('Verify that "manage subscription" link works and subscriber status can be updated');
    $this->sendEmail($i);
    $i->amOnMailboxAppPage();
    $i->click(Locator::contains('span.subject', $this->newsletterTitle));
    $i->switchToIframe('#preview-html');
    $i->waitForElementChange(
        \Codeception\Util\Locator::contains('a', 'Manage your subscription'), function ($el) {
            return $el->getAttribute('target') === "_blank";
        }, 100
    );
    $i->click('Manage your subscription');
    $i->switchToNextTab();
    $i->waitForText('Manage your subscription');
    $successMessage = 'Your preferences have been saved.';
    $i->dontSee($successMessage);

    $formStatusElement = '[data-automation-id="form_status"]';

    // set status to unsubscribed
    $approximateSaveButtonHeight = 50; // Used for scroll offset to ensure that button is not hidden above the top fold
    $i->selectOption($formStatusElement, 'Unsubscribed');
    $i->scrollTo('[data-automation-id="subscribe-submit-button"]', 0, -$approximateSaveButtonHeight);
    $i->click('Save');
    $i->waitForElement($formStatusElement);
    $i->seeOptionIsSelected($formStatusElement, 'Unsubscribed');
    $i->see($successMessage);

    // change status back to subscribed
    $i->selectOption($formStatusElement, 'Subscribed');
    $i->scrollTo('[data-automation-id="subscribe-submit-button"]', 0, -$approximateSaveButtonHeight);
    $i->click('Save');
    $i->waitForElement($formStatusElement);
    $i->seeOptionIsSelected($formStatusElement, 'Subscribed');
    $i->seeNoJSErrors();
  }

  public function unsubscribeLinksWithLinkTracking(\AcceptanceTester $i) {
    $i->wantTo('Verify that "unsubscribe" links works with tracking enabled');
    $this->settings->withTrackingEnabled();
    $this->verifyUnsubscribeLinks($i);
  }

  public function unsubscribeLinksWithoutLinkTracking(\AcceptanceTester $i) {
    $i->wantTo('Verify that "unsubscribe" links works with tracking disabled');
    $this->settings->withTrackingDisabled();
    $this->verifyUnsubscribeLinks($i);
  }

  private function verifyUnsubscribeLinks(\AcceptanceTester $i) {
    $this->sendEmail($i);
    $formStatusElement = '[data-automation-id="form_status"]';
    $i->wantTo('Verify that "Unsubscribe List" header link works and subscriber status is set to unsubscribed instantly');
    $i->amOnMailboxAppPage();
    $i->click(Locator::contains('span.subject', $this->newsletterTitle));
    $i->click('#show-headers');
    $i->waitForText('List-Unsubscribe');
    $link = $i->grabTextFrom('//div[@class="row headers"]//th[text()="List-Unsubscribe"]/following-sibling::td');
    $link = trim($link, '<>');
    $i->amOnUrl($link);
    $i->waitForText('You are now unsubscribed');
    $i->click('Manage your subscription');
    $i->seeOptionIsSelected($formStatusElement, 'Unsubscribed');

    // Re-subscribe to test the link in newsletter body
    $i->selectOption($formStatusElement, 'Subscribed');
    $approximateSaveButtonHeight = 50; // Used for scroll offset to ensure that button is not hidden above the top fold
    $i->scrollTo('[data-automation-id="subscribe-submit-button"]', 0, -$approximateSaveButtonHeight);
    $i->click('Save');
    $i->waitForElement($formStatusElement);
    $i->seeOptionIsSelected($formStatusElement, 'Subscribed');

    $i->wantTo('Verify that "unsubscribe" link works and subscriber can confirm switching status to unsubscribed');
    $i->amOnMailboxAppPage();
    $i->click(Locator::contains('span.subject', $this->newsletterTitle));
    $i->switchToIframe('#preview-html');
    $i->waitForElementChange(
        \Codeception\Util\Locator::contains('a', 'Unsubscribe'), function ($el) {
            return $el->getAttribute('target') === "_blank";
        }, 100
    );
    $i->click('Unsubscribe');
    $i->switchToNextTab();
    $confirmUnsubscribe = 'Yes, unsubscribe me';
    $i->waitForText($confirmUnsubscribe);
    $i->click($confirmUnsubscribe, '.mailpoet_confirm_unsubscribe');
    $i->waitForText('You are now unsubscribed');
    $i->click('Manage your subscription');
    $i->seeOptionIsSelected($formStatusElement, 'Unsubscribed');
    $i->seeNoJSErrors();
  }

  private function sendEmail(\AcceptanceTester $i) {
    $segmentName = $i->createListWithSubscriber();

    $i->login();
    $i->amOnMailpoetPage('Emails');

    // step 1 - select type
    $i->click('[data-automation-id="create_standard"]');

    // step 2 - select template
    $firstTemplateElement = $i->checkTemplateIsPresent(0);
    $i->click($firstTemplateElement);

    // step 3 - design newsletter (update subject)
    $titleElement = '[data-automation-id="newsletter_title"]';
    $i->waitForElement($titleElement);
    $i->fillField($titleElement, $this->newsletterTitle);
    $i->click('Next');

    // step 4 - send
    $searchFieldElement = 'input.select2-search__field';
    $i->waitForElement($searchFieldElement);
    $i->selectOptionInSelect2($segmentName);
    $i->click('Send');

    // Reloading page is faster than waiting for regular AJAX request to refresh it
    for ($index = 0; $index < 15; $index++) {
      try {
        $i->wait(2);
        $i->reloadPage();
        $i->waitForListingItemsToLoad();
        $i->see('1 / 1');
        return;
      } catch (Exception $e) {
        continue;
      }
    }
    $i->waitForText('Sent to 1 of 1');
    $i->see('Sent to 1 of 1');
  }
}