Refactor checking whether the channel can be deleted

phpunit.xml.dist

@@ -24,5 +24,7 @@
 
         <server name="IS_DOCTRINE_ORM_SUPPORTED" value="true" />
         <server name="ESCAPE_JSON" value="true" />
+
+        <server name="KERNEL_CLASS" value="App\Kernel" />
     </php>
 </phpunit>

src/Sylius/Bundle/ApiBundle/DataPersister/ChannelDataPersister.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\ApiBundle\DataPersister;
+
+use ApiPlatform\Core\DataPersister\ContextAwareDataPersisterInterface;
+use Sylius\Bundle\ApiBundle\Exception\ChannelCannotBeRemoved;
+use Sylius\Component\Channel\Checker\ChannelDeletionCheckerInterface;
+use Sylius\Component\Core\Model\ChannelInterface;
+
+final class ChannelDataPersister implements ContextAwareDataPersisterInterface
+{
+    public function __construct (
+        private ContextAwareDataPersisterInterface $decoratedDataPersister,
+        private ChannelDeletionCheckerInterface $channelDeletionChecker,
+    ) {
+    }
+
+    public function supports($data, array $context = []): bool
+    {
+        return $data instanceof ChannelInterface;
+    }
+
+    public function persist($data, array $context = [])
+    {
+        return $this->decoratedDataPersister->persist($data, $context);
+    }
+
+    public function remove($data, array $context = [])
+    {
+        if (!$this->channelDeletionChecker->isDeletable($data)) {
+            throw new ChannelCannotBeRemoved('The channel cannot be deleted. At least one enabled channel is required.');
+        }
+
+        return $this->decoratedDataPersister->remove($data, $context);
+    }
+}

src/Sylius/Bundle/ApiBundle/Resources/config/services.xml

@@ -177,11 +177,6 @@
             <tag name="kernel.event_listener" event="lexik_jwt_authentication.on_authentication_success" method="onAuthenticationSuccessResponse" />
         </service>
 
-        <service id="Sylius\Bundle\ApiBundle\EventListener\ChannelDeletionEventListener">
-            <argument type="service" id="sylius.repository.channel"/>
-            <tag name="kernel.event_listener" event="kernel.view" method="protectFromRemovalTheOnlyChannelInStore" priority="33"/>
-        </service>
-
         <service id="Sylius\Bundle\ApiBundle\Validator\ResourceInputDataPropertiesValidatorInterface" class="Sylius\Bundle\ApiBundle\Validator\ResourceApiInputDataPropertiesValidator">
             <argument type="service" id="validator" />
         </service>

src/Sylius/Bundle/ApiBundle/Resources/config/services/data_persisters.xml

@@ -31,6 +31,12 @@
             <tag name="api_platform.data_persister" />
         </service>
 
+        <service id="Sylius\Bundle\ApiBundle\DataPersister\ChannelDataPersister">
+            <argument type="service" id="api_platform.doctrine.orm.data_persister" />
+            <argument type="service" id="sylius.checker.channel_deletion" />
+            <tag name="api_platform.data_persister" />
+        </service>
+
         <service id="Sylius\Bundle\ApiBundle\DataPersister\MessengerDataPersister">
             <argument type="service" id="api_platform.messenger.data_persister" />
             <tag name="api_platform.data_persister" />

src/Sylius/Bundle/ApiBundle/spec/DataPersister/ChannelDataPersisterSpec.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace spec\Sylius\Bundle\ApiBundle\DataPersister;
+
+use ApiPlatform\Core\DataPersister\ContextAwareDataPersisterInterface;
+use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\ApiBundle\Exception\ChannelCannotBeRemoved;
+use Sylius\Component\Channel\Checker\ChannelDeletionCheckerInterface;
+use Sylius\Component\Core\Model\ChannelInterface;
+
+final class ChannelDataPersisterSpec extends ObjectBehavior
+{
+    function let(
+        ContextAwareDataPersisterInterface $decoratedDataPersister,
+        ChannelDeletionCheckerInterface $channelDeletionChecker,
+    ): void {
+        $this->beConstructedWith($decoratedDataPersister, $channelDeletionChecker);
+    }
+
+    function it_supports_only_channel_entity(ChannelInterface $channel, \stdClass $object): void
+    {
+        $this->supports($channel)->shouldReturn(true);
+        $this->supports($object)->shouldReturn(false);
+    }
+
+    function it_persists_channel(
+        ContextAwareDataPersisterInterface $decoratedDataPersister,
+        ChannelInterface $channel
+    ): void {
+        $decoratedDataPersister->persist($channel, [])->willReturn($channel);
+
+        $this->persist($channel, [])->shouldReturn($channel);
+    }
+
+    function it_throws_an_exception_if_channel_is_not_deletable(
+        ChannelDeletionCheckerInterface $channelDeletionChecker,
+        ChannelInterface $channel
+    ): void {
+        $channelDeletionChecker->isDeletable($channel)->willReturn(false);
+
+        $this
+            ->shouldThrow(ChannelCannotBeRemoved::class)
+            ->during('remove', [$channel])
+        ;
+    }
+
+    function it_removes_channel(
+        ContextAwareDataPersisterInterface $decoratedDataPersister,
+        ChannelDeletionCheckerInterface $channelDeletionChecker,
+        ChannelInterface $channel
+    ): void {
+        $channelDeletionChecker->isDeletable($channel)->willReturn(true);
+        $decoratedDataPersister->remove($channel, [])->willReturn(null);
+
+        $this->remove($channel, [])->shouldReturn(null);
+    }
+}

src/Sylius/Bundle/ChannelBundle/Doctrine/ORM/ChannelRepository.php

@@ -56,6 +56,11 @@ public function findAllWithBasicData(): iterable
         ;
     }
 
+    public function findEnabled(): iterable
+    {
+        return $this->findBy(['enabled' => true]);
+    }
+
     public function countAll(): int
     {
         return $this->count([]);

src/Sylius/Bundle/ChannelBundle/Resources/config/services.xml

@@ -69,5 +69,10 @@
             <argument>false</argument>
             <tag name="data_collector" template="@SyliusChannel/Collector/channel.html.twig" id="sylius.channel_collector" />
         </service>
+
+        <service id="sylius.checker.channel_deletion" class="Sylius\Component\Channel\Checker\ChannelDeletionChecker">
+            <argument type="service" id="sylius.repository.channel" />
+        </service>
+        <service id="Sylius\Component\Channel\Checker\ChannelDeletionCheckerInterface" alias="sylius.checker.channel_deletion" />
     </services>
 </container>

src/Sylius/Bundle/CoreBundle/EventListener/ChannelDeletionListener.php

@@ -14,13 +14,13 @@
 namespace Sylius\Bundle\CoreBundle\EventListener;
 
 use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
+use Sylius\Component\Channel\Checker\ChannelDeletionCheckerInterface;
 use Sylius\Component\Channel\Model\ChannelInterface;
-use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
 use Sylius\Component\Resource\Exception\UnexpectedTypeException;
 
 final class ChannelDeletionListener
 {
-    public function __construct(private ChannelRepositoryInterface $channelRepository)
+    public function __construct(private ChannelDeletionCheckerInterface $channelDeletionChecker)
     {
     }
 
@@ -38,9 +38,7 @@ public function onChannelPreDelete(ResourceControllerEvent $event): void
             );
         }
 
-        $results = $this->channelRepository->findBy(['enabled' => true]);
-
-        if (!$results || (count($results) === 1 && current($results) === $channel)) {
+        if (!$this->channelDeletionChecker->isDeletable($channel)) {
             $event->stop('sylius.channel.delete_error');
         }
     }

src/Sylius/Bundle/CoreBundle/Resources/config/services/listeners.xml

@@ -20,7 +20,7 @@
         <defaults public="true" />
 
         <service id="sylius.listener.channel" class="Sylius\Bundle\CoreBundle\EventListener\ChannelDeletionListener">
-            <argument type="service" id="sylius.repository.channel" />
+            <argument type="service" id="sylius.checker.channel_deletion" />
             <tag name="kernel.event_listener" event="sylius.channel.pre_delete" method="onChannelPreDelete" />
         </service>