[BUGFIX] Cascading removal of subscriptions (#271)

When a subscriber or a subscriber list is removed, all associated
subscriptions need to be removed as well.

Author: oliverklee

CHANGELOG.md

@@ -20,6 +20,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ### Removed
 
 ### Fixed
+- Remove associated subscriptions when a subscriber list or subscriber is removed (#271)
 - Always truncate the DB tables after an integration test (#259)
 - Adapt the system tests to possible HTTP errors (#256)
 

src/Domain/Model/Messaging/SubscriberList.php

@@ -106,7 +106,11 @@ class SubscriberList implements Identity, CreationDate, ModificationDate
 
     /**
      * @var Collection
-     * @OneToMany(targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription", mappedBy="subscriberList")
+     * @OneToMany(
+     *     targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription",
+     *     mappedBy="subscriberList",
+     *     cascade={"remove"}
+     * )
      */
     private $subscriptions = null;
 

src/Domain/Model/Subscription/Subscriber.php

@@ -107,7 +107,11 @@ class Subscriber implements Identity, CreationDate, ModificationDate
 
     /**
      * @var Collection
-     * @OneToMany(targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription", mappedBy="subscriber")
+     * @OneToMany(
+     *     targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription",
+     *     mappedBy="subscriber",
+     *     cascade={"remove"}
+     *  )
      */
     private $subscriptions = null;
 

tests/Integration/Domain/Repository/Messaging/SubscriberListRepositoryTest.php

@@ -10,6 +10,7 @@
 use PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository;
 use PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\PhpList4\Domain\Repository\Subscription\SubscriptionRepository;
 use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
 use PHPUnit\Framework\TestCase;
@@ -59,13 +60,19 @@ class SubscriberListRepositoryTest extends TestCase
      */
     private $subscriberRepository = null;
 
+    /**
+     * @var SubscriptionRepository
+     */
+    private $subscriptionRepository = null;
+
     protected function setUp()
     {
         $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(SubscriberListRepository::class);
         $this->administratorRepository = $this->container->get(AdministratorRepository::class);
         $this->subscriberRepository = $this->container->get(SubscriberRepository::class);
+        $this->subscriptionRepository = $this->container->get(SubscriptionRepository::class);
     }
 
     /**
@@ -256,4 +263,31 @@ public function findsAssociatedSubscribers()
         static::assertTrue($subscribers->contains($expectedSubscriber));
         static::assertFalse($subscribers->contains($unexpectedSubscriber));
     }
+
+    /**
+     * @test
+     */
+    public function removeAlsoRemovesAssociatedSubscriptions()
+    {
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIPTION_TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $initialNumberOfSubscriptions = count($this->subscriptionRepository->findAll());
+
+        /** @var SubscriberList $model */
+        $id = 2;
+        $model = $this->subject->find($id);
+
+        $numberOfAssociatedSubscriptions = count($model->getSubscriptions());
+        static::assertGreaterThan(0, $numberOfAssociatedSubscriptions);
+
+        $this->entityManager->remove($model);
+        $this->entityManager->flush();
+
+        $newNumberOfSubscriptions = count($this->subscriptionRepository->findAll());
+        $numberOfRemovedSubscriptions = $initialNumberOfSubscriptions - $newNumberOfSubscriptions;
+        static::assertSame($numberOfAssociatedSubscriptions, $newNumberOfSubscriptions);
+    }
 }

tests/Integration/Domain/Repository/Subscription/SubscriberRepositoryTest.php

@@ -8,6 +8,7 @@
 use PhpList\PhpList4\Domain\Model\Subscription\Subscription;
 use PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository;
 use PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\PhpList4\Domain\Repository\Subscription\SubscriptionRepository;
 use PhpList\PhpList4\TestingSupport\Traits\DatabaseTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
 use PHPUnit\Framework\TestCase;
@@ -52,12 +53,18 @@ class SubscriberRepositoryTest extends TestCase
      */
     private $subscriberListRepository = null;
 
+    /**
+     * @var SubscriptionRepository
+     */
+    private $subscriptionRepository = null;
+
     protected function setUp()
     {
         $this->setUpDatabaseTest();
 
         $this->subject = $this->container->get(SubscriberRepository::class);
         $this->subscriberListRepository = $this->container->get(SubscriberListRepository::class);
+        $this->subscriptionRepository = $this->container->get(SubscriptionRepository::class);
     }
 
     /**
@@ -261,4 +268,31 @@ public function findsAssociatedSubscribedLists()
         static::assertTrue($subscribedLists->contains($expectedList));
         static::assertFalse($subscribedLists->contains($unexpectedList));
     }
+
+    /**
+     * @test
+     */
+    public function removeAlsoRemovesAssociatedSubscriptions()
+    {
+        $this->getDataSet()->addTable(static::TABLE_NAME, __DIR__ . '/../Fixtures/Subscriber.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIBER_LIST_TABLE_NAME, __DIR__ . '/../Fixtures/SubscriberList.csv');
+        $this->getDataSet()->addTable(static::SUBSCRIPTION_TABLE_NAME, __DIR__ . '/../Fixtures/Subscription.csv');
+        $this->applyDatabaseChanges();
+
+        $initialNumberOfSubscriptions = count($this->subscriptionRepository->findAll());
+
+        /** @var Subscriber $model */
+        $id = 2;
+        $model = $this->subject->find($id);
+
+        $numberOfAssociatedSubscriptions = count($model->getSubscriptions());
+        static::assertGreaterThan(0, $numberOfAssociatedSubscriptions);
+
+        $this->entityManager->remove($model);
+        $this->entityManager->flush();
+
+        $newNumberOfSubscriptions = count($this->subscriptionRepository->findAll());
+        $numberOfRemovedSubscriptions = $initialNumberOfSubscriptions - $newNumberOfSubscriptions;
+        static::assertSame($numberOfAssociatedSubscriptions, $newNumberOfSubscriptions);
+    }
 }