piratepoet/mailpoet/tests/integration/Segments/SegmentsRepositoryTest.php

<?php declare(strict_types = 1);

namespace MailPoet\Segments;

use MailPoet\ConflictException;
use MailPoet\Entities\DynamicSegmentFilterData;
use MailPoet\Entities\DynamicSegmentFilterEntity;
use MailPoet\Entities\NewsletterEntity;
use MailPoet\Entities\NewsletterSegmentEntity;
use MailPoet\Entities\SegmentEntity;
use MailPoet\Newsletter\Segment\NewsletterSegmentRepository;
use MailPoet\Segments\DynamicSegments\Filters\UserRole;
use MailPoet\Test\DataFactories\Newsletter as NewsletterFactory;

class SegmentsRepositoryTest extends \MailPoetTest {
  /** @var SegmentsRepository */
  private $segmentsRepository;

  /** @var NewsletterSegmentRepository */
  private $newsletterSegmentRepository;

  public function _before(): void {
    parent::_before();
    $this->segmentsRepository = $this->diContainer->get(SegmentsRepository::class);
    $this->newsletterSegmentRepository = $this->diContainer->get(NewsletterSegmentRepository::class);
  }

  public function testItCanBulkTrashDefaultSegments(): void {
    $segment1 = $this->createDefaultSegment('Segment 1');
    $segment2 = $this->createDefaultSegment('Segment 2');
    $this->entityManager->flush();
    $result = $this->segmentsRepository->bulkTrash([$segment1->getId(), $segment2->getId()]);
    $this->entityManager->refresh($segment1);
    $this->entityManager->refresh($segment2);
    verify($result)->equals(2);
    expect($segment1->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
    expect($segment2->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
  }

  public function testItCanBulkTrashDynamicSegments(): void {
    $segment1 = $this->createDynamicSegmentEntityForEditorUsers();
    $segment2 = $this->createDynamicSegmentEntityForEditorUsers();
    $this->entityManager->flush();
    $result = $this->segmentsRepository->bulkTrash([$segment1->getId(), $segment2->getId()], SegmentEntity::TYPE_DYNAMIC);
    $this->entityManager->refresh($segment1);
    $this->entityManager->refresh($segment2);
    verify($result)->equals(2);
    expect($segment1->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
    expect($segment2->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
  }

  public function testItSkipTrashingForActivelyUsedDefaultSegments(): void {
    $segment1 = $this->createDefaultSegment('Segment 1');
    $segment2 = $this->createDefaultSegment('Segment 2');
    $this->addActiveNewsletterToSegment($segment1);
    $this->entityManager->flush();
    $result = $this->segmentsRepository->bulkTrash([$segment1->getId(), $segment2->getId()]);
    $this->entityManager->refresh($segment1);
    $this->entityManager->refresh($segment2);
    verify($result)->equals(1);
    expect($segment1->getDeletedAt())->null();
    expect($segment2->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
  }

  public function testItSkipTrashingForActivelyUsedDynamicSegments(): void {
    $segment1 = $this->createDynamicSegmentEntityForEditorUsers();
    $segment2 = $this->createDynamicSegmentEntityForEditorUsers();
    $this->addActiveNewsletterToSegment($segment2);
    $this->entityManager->flush();
    $result = $this->segmentsRepository->bulkTrash([$segment1->getId(), $segment2->getId()], SegmentEntity::TYPE_DYNAMIC);
    $this->entityManager->refresh($segment1);
    $this->entityManager->refresh($segment2);
    verify($result)->equals(1);
    expect($segment1->getDeletedAt())->isInstanceOf(\DateTimeInterface::class);
    expect($segment2->getDeletedAt())->null();
  }

  public function testItReturnsCountsOfSegmentsWithMultipleFilters(): void {
    // No Segments
    $count = $this->segmentsRepository->getSegmentCountWithMultipleFilters();
    verify($count)->equals(0);

    // Two segments with one filter each
    $segment1 = $this->createDynamicSegmentEntityForEditorUsers();
    $segment2 = $this->createDynamicSegmentEntityForEditorUsers();
    $count = $this->segmentsRepository->getSegmentCountWithMultipleFilters();
    verify($count)->equals(0);

    // One segment with multiple filters
    $filterData = new DynamicSegmentFilterData(
      DynamicSegmentFilterData::TYPE_USER_ROLE,
      UserRole::TYPE,
      ['wordpressRole' => 'editor']
    );
    $dynamicFilter = new DynamicSegmentFilterEntity($segment1, $filterData);
    $this->entityManager->persist($dynamicFilter);
    $segment1->addDynamicFilter($dynamicFilter);
    $this->segmentsRepository->flush();
    $count = $this->segmentsRepository->getSegmentCountWithMultipleFilters();
    verify($count)->equals(1);

    // Both segments with multiple filters
    $filterData = new DynamicSegmentFilterData(
      DynamicSegmentFilterData::TYPE_USER_ROLE,
      UserRole::TYPE,
      ['wordpressRole' => 'editor']
    );
    $dynamicFilter = new DynamicSegmentFilterEntity($segment2, $filterData);
    $this->entityManager->persist($dynamicFilter);
    $segment1->addDynamicFilter($dynamicFilter);
    $this->segmentsRepository->flush();
    $count = $this->segmentsRepository->getSegmentCountWithMultipleFilters();
    verify($count)->equals(2);
  }

  public function testItCanCheckForUniqueNames(): void {
    $this->createDefaultSegment('Test');
    $this->segmentsRepository->flush();
    verify($this->segmentsRepository->isNameUnique('Test', null))->false();
    verify($this->segmentsRepository->isNameUnique('Unique Name', null))->true();
  }

  public function testItCanForcefullyVerifyUniquenessOfName(): void {
    $this->createDefaultSegment('Test');
    $this->segmentsRepository->flush();
    try {
      $this->segmentsRepository->verifyNameIsUnique('Unique', null);
      $this->addToAssertionCount(1);
    } catch (ConflictException $exception) {
      $this->fail();
    }
    $this->expectException(ConflictException::class);
    $this->expectExceptionMessage('Could not create new segment with name [Test] because a segment with that name already exists.');
    $this->segmentsRepository->verifyNameIsUnique('Test', null);
  }

  public function testItChecksForDuplicateNameWhenCreatingNewSegment(): void {
    $this->createDefaultSegment('Existing Segment');
    $this->segmentsRepository->flush();
    $this->expectException(ConflictException::class);
    $this->expectExceptionMessage("Could not create new segment with name [Existing Segment] because a segment with that name already exists.");
    $this->segmentsRepository->createOrUpdate('Existing Segment');
  }

  public function testItChecksForDuplicateNameWhenUpdatingExistingSegmentName(): void {
    $segment = $this->createDefaultSegment('Test');
    $this->createDefaultSegment('Existing');
    $this->segmentsRepository->flush();
    $this->expectException(ConflictException::class);
    $this->expectExceptionMessage("Could not create new segment with name [Existing] because a segment with that name already exists.");
    $this->segmentsRepository->createOrUpdate('Existing', $segment->getDescription(), $segment->getType(), [], $segment->getId());
  }

  public function testItDeletesNewsletterSegmentEntriesWhenDeletingASegment(): void {
    $segment = $this->createDefaultSegment('Test');
    $newsletterFactory = new NewsletterFactory();
    $newsletterFactory->withSegments([$segment])->create();

    $this->segmentsRepository->bulkDelete([$segment->getId()]);

    $newsletterSegments = $this->newsletterSegmentRepository->findBy(['segment' => $segment]);
    $this->assertEmpty($newsletterSegments);
  }

  private function createDefaultSegment(string $name): SegmentEntity {
    $segment = new SegmentEntity($name, SegmentEntity::TYPE_DEFAULT, 'description');
    $this->entityManager->persist($segment);
    return $segment;
  }

  private function createDynamicSegmentEntityForEditorUsers(): SegmentEntity {
    $segment = new SegmentEntity('Segment' . rand(0, 10000), SegmentEntity::TYPE_DYNAMIC, 'Segment description');
    $filterData = new DynamicSegmentFilterData(
      DynamicSegmentFilterData::TYPE_USER_ROLE,
      UserRole::TYPE,
      ['wordpressRole' => 'editor']
    );
    $dynamicFilter = new DynamicSegmentFilterEntity($segment, $filterData);
    $segment->getDynamicFilters()->add($dynamicFilter);
    $this->entityManager->persist($segment);
    $this->entityManager->persist($dynamicFilter);
    return $segment;
  }

  private function addActiveNewsletterToSegment(SegmentEntity $segmentEntity): void {
    $newsletter = new NewsletterEntity();
    $newsletter->setSubject('Subject');
    $newsletter->setType(NewsletterEntity::TYPE_NOTIFICATION);
    $newsletter->setStatus(NewsletterEntity::STATUS_ACTIVE);
    $newsletterSegment = new NewsletterSegmentEntity($newsletter, $segmentEntity);
    $this->entityManager->persist($newsletter);
    $this->entityManager->persist($newsletterSegment);
  }
}