piratepoet/mailpoet/tests/integration/Statistics/Track/WooCommercePurchasesTest.php

<?php

namespace MailPoet\Test\Statistics\Track;

use DateTime;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\NewsletterLinkEntity;
use MailPoet\Entities\ScheduledTaskEntity;
use MailPoet\Entities\ScheduledTaskSubscriberEntity;
use MailPoet\Entities\SendingQueueEntity;
use MailPoet\Entities\StatisticsClickEntity;
use MailPoet\Entities\StatisticsWooCommercePurchaseEntity;
use MailPoet\Entities\SubscriberEntity;
use MailPoet\Statistics\StatisticsClicksRepository;
use MailPoet\Statistics\StatisticsWooCommercePurchasesRepository;
use MailPoet\Statistics\Track\SubscriberHandler;
use MailPoet\Statistics\Track\WooCommercePurchases;
use MailPoet\Subscribers\SubscribersRepository;
use MailPoet\Util\Cookies;
use MailPoet\WooCommerce\Helper as WooCommerceHelper;
use PHPUnit\Framework\MockObject\MockObject;
use WC_Order;

/**
 * @group woo
 */
class WooCommercePurchasesTest extends \MailPoetTest {
  /** @var SubscriberEntity */
  private $subscriber;

  /** @var NewsletterEntity */
  private $newsletter;

  /** @var SendingQueueEntity */
  private $queue;

  /** @var NewsletterLinkEntity */
  private $link;

  /** @var Cookies */
  private $cookies;

  /** @var StatisticsWooCommercePurchasesRepository */
  private $statisticsWooCommercePurchasesRepository;

  public function _before() {
    parent::_before();
    $this->cleanup();

    $this->subscriber = $this->createSubscriber('test@example.com');
    $this->newsletter = $this->createNewsletter();
    $this->queue = $this->createQueue($this->newsletter, $this->subscriber);
    $this->link = $this->createLink($this->newsletter, $this->queue);
    $this->statisticsWooCommercePurchasesRepository = $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class);
    $this->cookies = new Cookies();
  }

  public function testItDoesNotTrackPaymentForWrongSubscriber() {
    $click = $this->createClick($this->link, $this->subscriber, 3);

    // create 'wrong_click' for different subscriber that is newer than the correct 'click'
    $wrongSubscriber = $this->createSubscriber('wrong.subscriber@example.com');
    $wrongClick = $this->createClick($this->link, $wrongSubscriber, 1);
    $this->entityManager->flush();

    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(1);
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click->getId());
  }

  public function testItTracksPayment() {
    $click = $this->createClick($this->link, $this->subscriber);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(1);
    $newsletter = $purchaseStats[0]->getNewsletter();
    $subscriber = $purchaseStats[0]->getSubscriber();
    $queue = $purchaseStats[0]->getQueue();
    assert($newsletter instanceof NewsletterEntity);
    assert($subscriber instanceof SubscriberEntity);
    assert($queue instanceof SendingQueueEntity);
    expect($newsletter->getId())->equals($this->newsletter->getId());
    expect($subscriber->getId())->equals($this->subscriber->getId());
    expect($queue->getId())->equals($this->queue->getId());
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click->getId());
    expect($purchaseStats[0]->getOrderId())->equals($orderMock->get_id());
    expect($purchaseStats[0]->getOrderCurrency())->equals($orderMock->get_currency());
    expect($purchaseStats[0]->getOrderPriceTotal())->equals($orderMock->get_total());
  }

  public function testItTracksPaymentForMultipleNewsletters() {
    $click1 = $this->createClick($this->link, $this->subscriber);

    // create click in other newsletter
    $newsletter = $this->createNewsletter();
    $queue = $this->createQueue($newsletter, $this->subscriber);
    $link = $this->createLink($newsletter, $queue);
    $click2 = $this->createClick($link, $this->subscriber, 1);
    $this->entityManager->flush();

    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(2);

    $stats1 = $this->statisticsWooCommercePurchasesRepository->findOneBy(['newsletter' => $this->newsletter]);
    assert($stats1 instanceof StatisticsWooCommercePurchaseEntity);
    $subscriber = $stats1->getSubscriber();
    $queue = $stats1->getQueue();
    $click = $stats1->getClick();
    assert($subscriber instanceof SubscriberEntity);
    assert($queue instanceof SendingQueueEntity);
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click1->getId());
    expect($subscriber->getId())->equals($this->subscriber->getId());
    expect($queue->getId())->equals($this->queue->getId());

    $stats2 = $this->statisticsWooCommercePurchasesRepository->findOneBy(['newsletter' => $newsletter]);
    assert($stats2 instanceof StatisticsWooCommercePurchaseEntity);
    $subscriber = $stats2->getSubscriber();
    $queue = $stats2->getQueue();
    $click = $stats2->getClick();
    assert($subscriber instanceof SubscriberEntity);
    assert($queue instanceof SendingQueueEntity);
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click2->getId());
    expect($subscriber->getId())->equals($this->subscriber->getId());
    expect($queue->getId())->equals($queue->getId());
  }

  public function testItTracksPaymentForMultipleOrders() {
    $this->createClick($this->link, $this->subscriber);
    $this->entityManager->flush();

    // first order
    $orderMock = $this->createOrderMock($this->subscriber->getEmail(), 10.0, 123);
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());

    // second order
    $orderMock = $this->createOrderMock($this->subscriber->getEmail(), 20.0, 456);
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());

    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(2);
  }

  public function testItTracksPaymentOnlyForLatestClick() {
    $this->createClick($this->link, $this->subscriber, 3);
    $this->createClick($this->link, $this->subscriber, 5);
    $latestClick = $this->createClick($this->link, $this->subscriber, 1);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());

    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([], ['createdAt' => 'desc']);
    expect(count($purchaseStats))->equals(1);
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($latestClick->getId());
  }

  public function testItTracksPaymentOnlyOnce() {
    $this->createClick($this->link, $this->subscriber);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(1);
  }

  public function testItTracksPaymentOnlyOnceWhenNewClickAppears() {
    $this->createClick($this->link, $this->subscriber, 5);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());

    $this->createClick($this->link, $this->subscriber, 1);
    $this->entityManager->flush();
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(1);
  }

  public function testItDoesNotTrackPaymentWhenClickTooOld() {
    $this->createClick($this->link, $this->subscriber, 20);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(0);
  }

  public function testItDoesNotTrackPaymentForDifferentEmail() {
    $this->createClick($this->link, $this->subscriber);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock('different.email@example.com');
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(0);
  }

  public function testItDoesNotTrackPaymentWhenClickNewerThanOrder() {
    $this->createClick($this->link, $this->subscriber, 0);
    $this->entityManager->flush();
    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    expect(count($this->statisticsWooCommercePurchasesRepository->findBy([])))->equals(0);
  }

  public function testItTracksPaymentForCorrectClickWhenClickNewerThanOrderExists() {
    $click = $this->createClick($this->link, $this->subscriber, 5);
    $this->createClick($this->link, $this->subscriber, 0); // wrong click, should not be tracked
    $this->entityManager->flush();

    $orderMock = $this->createOrderMock($this->subscriber->getEmail());
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect($purchaseStats)->count(1);
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click->getId());
  }

  public function testItTracksByCookie() {
    $orderEmail = 'order.email@example.com';
    $cookieEmail = 'cookie.email@example.com';
    $this->createSubscriber($orderEmail);
    $cookieEmailSubscriber = $this->createSubscriber($cookieEmail);

    $click = $this->createClick($this->link, $cookieEmailSubscriber);
    $this->entityManager->flush();
    $_COOKIE['mailpoet_revenue_tracking'] = json_encode([
      'statistics_clicks' => $click->getId(),
      'created_at' => time(),
    ]);

    $orderMock = $this->createOrderMock($orderEmail);
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(1);
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($click->getId());
  }

  public function testItDoesNotTrackByCookieWhenTrackedByOrder() {
    $orderEmail = 'order.email@example.com';
    $cookieEmail = 'cookie.email@example.com';
    $orderEmailSubscriber = $this->createSubscriber($orderEmail);
    $cookieEmailSubscriber = $this->createSubscriber($cookieEmail);

    // both clicks are in the same newsletter
    $orderEmailClick = $this->createClick($this->link, $orderEmailSubscriber);
    $cookieEmailClick = $this->createClick($this->link, $cookieEmailSubscriber);

    $_COOKIE['mailpoet_revenue_tracking'] = json_encode([
      'statistics_clicks' => $cookieEmailClick->getId(),
      'created_at' => time(),
    ]);
    $this->entityManager->flush();

    $orderMock = $this->createOrderMock($orderEmail);
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(1);
    $click = $purchaseStats[0]->getClick();
    assert($click instanceof StatisticsClickEntity);
    expect($click->getId())->equals($orderEmailClick->getId());
  }

  public function testItTracksByBothOrderAndCookieForDifferentNewsletters() {
    $orderEmail = 'order.email@example.com';
    $cookieEmail = 'cookie.email@example.com';
    $orderEmailSubscriber = $this->createSubscriber($orderEmail);
    $cookieEmailSubscriber = $this->createSubscriber($cookieEmail);

    // click by order email subscriber
    $orderEmailClick = $this->createClick($this->link, $orderEmailSubscriber);

    // click by cookie email subscriber in a different newsletter
    $newsletter = $this->createNewsletter();
    $queue = $this->createQueue($newsletter, $this->subscriber);
    $link = $this->createLink($newsletter, $queue);
    $cookieEmailClick = $this->createClick($link, $cookieEmailSubscriber);

    $this->entityManager->flush();
    $_COOKIE['mailpoet_revenue_tracking'] = json_encode([
      'statistics_clicks' => $cookieEmailClick->getId(),
      'created_at' => time(),
    ]);

    $orderMock = $this->createOrderMock($orderEmail);
    $woocommercePurchases = new WooCommercePurchases(
      $this->createWooCommerceHelperMock($orderMock),
      $this->diContainer->get(StatisticsWooCommercePurchasesRepository::class),
      $this->diContainer->get(StatisticsClicksRepository::class),
      $this->diContainer->get(SubscribersRepository::class),
      $this->cookies,
      $this->diContainer->get(SubscriberHandler::class)
    );
    $woocommercePurchases->trackPurchase($orderMock->get_id());
    $purchaseStats = $this->statisticsWooCommercePurchasesRepository->findBy([]);
    expect(count($purchaseStats))->equals(2);
    foreach ($purchaseStats as $stats) {
      $click = $stats->getClick();
      assert($click instanceof StatisticsClickEntity);
      $statsNewsletter = $stats->getNewsletter();
      assert($statsNewsletter instanceof NewsletterEntity);
      if ($click->getId() === $orderEmailClick->getId()) {
        expect($statsNewsletter->getId())->equals($this->newsletter->getId());
      } else {
        expect($click->getId())->equals($cookieEmailClick->getId());
        expect($statsNewsletter->getId())->equals($newsletter->getId());
      }
    }
  }

  private function createNewsletter(): NewsletterEntity {
    $newsletter = new NewsletterEntity();
    $newsletter->setType(NewsletterEntity::TYPE_STANDARD);
    $newsletter->setSubject('Subject');
    $this->entityManager->persist($newsletter);
    return $newsletter;
  }

  private function createQueue(NewsletterEntity $newsletter, SubscriberEntity $subscriber): SendingQueueEntity {
    $task = new ScheduledTaskEntity();
    $this->entityManager->persist($task);
    $queue = new SendingQueueEntity();
    $this->entityManager->persist($queue);
    $queue->setNewsletter($newsletter);
    $queue->setSubscribers((string)$subscriber->getId());
    $queue->setTask($task);
    $sendingTaskSubscriber = new ScheduledTaskSubscriberEntity($task, $subscriber, 1);
    $this->entityManager->persist($sendingTaskSubscriber);
    return $queue;
  }

  private function createSubscriber($email): SubscriberEntity {
    $subscriber = new SubscriberEntity();
    $this->entityManager->persist($subscriber);
    $subscriber->setEmail($email);
    $subscriber->setFirstName('First');
    $subscriber->setLastName('Last');
    return $subscriber;
  }

  private function createLink(NewsletterEntity $newsletter, SendingQueueEntity $queue): NewsletterLinkEntity {
    $link = new NewsletterLinkEntity($newsletter, $queue, 'url', 'hash');
    $this->entityManager->persist($link);
    return $link;
  }

  private function createClick(NewsletterLinkEntity $link, SubscriberEntity $subscriber, $createdDaysAgo = 5): StatisticsClickEntity {
    $newsletter = $link->getNewsletter();
    $queue = $link->getQueue();
    assert($newsletter instanceof NewsletterEntity);
    assert($queue instanceof SendingQueueEntity);
    $click = new StatisticsClickEntity($newsletter, $queue, $subscriber, $link, 1);
    $this->entityManager->persist($click);

    $timestamp = new DateTime("-$createdDaysAgo days");
    $click->setCreatedAt($timestamp);
    $click->setUpdatedAt($timestamp);
    return $click;
  }

  private function createWooCommerceHelperMock(MockObject $orderMock) {
    $mock = $this->createMock(WooCommerceHelper::class);
    $mock->method('wcGetOrder')->willReturn($orderMock);
    return $mock;
  }

  private function createOrderMock($email, $totalPrice = 15.0, $id = 123) {
    // WC_Order class needs to be mocked without default 'disallowMockingUnknownTypes'
    // since WooCommerce may not be active (would result in error mocking undefined class)
    $mock = $this->getMockBuilder(WC_Order::class)
      ->disableOriginalConstructor()
      ->disableOriginalClone()
      ->disableArgumentCloning()
      ->setMethods(['get_id', 'get_date_created', 'get_billing_email', 'get_total', 'get_currency'])
      ->getMock();

    $mock->method('get_id')->willReturn($id);
    $mock->method('get_date_created')->willReturn(new DateTime());
    $mock->method('get_billing_email')->willReturn($email);
    $mock->method('get_total')->willReturn((string)$totalPrice);
    $mock->method('get_currency')->willReturn('EUR');
    return $mock;
  }

  private function cleanup() {
    $this->truncateEntity(NewsletterEntity::class);
    $this->truncateEntity(SubscriberEntity::class);
    $this->truncateEntity(SendingQueueEntity::class);
    $this->truncateEntity(StatisticsClickEntity::class);
    $this->truncateEntity(StatisticsWooCommercePurchaseEntity::class);
    $this->truncateEntity(ScheduledTaskSubscriberEntity::class);
  }
}