[framework] feed modules are now removed if appropriate feed no longer exists (#3024)

Author: TomasLudvik

src/Model/Feed/FeedCronModule.php

@@ -6,6 +6,7 @@
 
 use Shopsys\FrameworkBundle\Component\Domain\Domain;
 use Shopsys\FrameworkBundle\Component\Setting\Setting;
+use Shopsys\FrameworkBundle\Model\Feed\Exception\FeedNotFoundException;
 use Shopsys\Plugin\Cron\IteratedCronModuleInterface;
 use Symfony\Bridge\Monolog\Logger;
 
@@ -24,12 +25,14 @@ class FeedCronModule implements IteratedCronModuleInterface
      * @param \Shopsys\FrameworkBundle\Component\Domain\Domain $domain
      * @param \Shopsys\FrameworkBundle\Component\Setting\Setting $setting
      * @param \Shopsys\FrameworkBundle\Model\Feed\FeedModuleRepository $feedModuleRepository
+     * @param \Shopsys\FrameworkBundle\Model\Feed\FeedModuleFacade $feedModuleFacade
      */
     public function __construct(
         protected readonly FeedFacade $feedFacade,
         protected readonly Domain $domain,
         protected readonly Setting $setting,
         protected readonly FeedModuleRepository $feedModuleRepository,
+        protected readonly FeedModuleFacade $feedModuleFacade,
     ) {
     }
 
@@ -60,6 +63,10 @@ public function iterate(): bool
         if ($this->currentFeedExport === null) {
             $this->currentFeedExport = $this->createCurrentFeedExport();
 
+            if ($this->currentFeedExport === null) {
+                return false;
+            }
+
             $this->logger->info(sprintf(
                 'Started generation of feed "%s" generated on domain "%s" into "%s".',
                 $this->currentFeedExport->getFeedInfo()->getName(),
@@ -94,6 +101,10 @@ public function iterate(): bool
             if ($existsNext === true) {
                 $this->currentFeedExport = $this->createCurrentFeedExport();
 
+                if ($this->currentFeedExport === null) {
+                    return false;
+                }
+
                 $this->logger->info(sprintf(
                     'Started generation of feed "%s" generated on domain "%s" into "%s".',
                     $this->currentFeedExport->getFeedInfo()->getName(),
@@ -166,6 +177,11 @@ public function wakeUp(): void
 
         $lastSeekId = $this->setting->get(Setting::FEED_ITEM_ID_TO_CONTINUE);
         $this->currentFeedExport = $this->createCurrentFeedExport($lastSeekId);
+
+        if ($this->currentFeedExport === null) {
+            return;
+        }
+
         $this->currentFeedExport->wakeUp();
 
         $this->logger->info(sprintf(
@@ -178,15 +194,31 @@ public function wakeUp(): void
 
     /**
      * @param int|null $lastSeekId
-     * @return \Shopsys\FrameworkBundle\Model\Feed\FeedExport
+     * @return \Shopsys\FrameworkBundle\Model\Feed\FeedExport|null
      */
-    protected function createCurrentFeedExport(?int $lastSeekId = null): FeedExport
+    protected function createCurrentFeedExport(?int $lastSeekId = null): ?FeedExport
     {
-        return $this->feedFacade->createFeedExport(
-            $this->getFeedExportCreationDataQueue()->getCurrentFeedName(),
-            $this->getFeedExportCreationDataQueue()->getCurrentDomain(),
-            $lastSeekId,
-        );
+        try {
+            $feedExport = $this->feedFacade->createFeedExport(
+                $this->getFeedExportCreationDataQueue()->getCurrentFeedName(),
+                $this->getFeedExportCreationDataQueue()->getCurrentDomain(),
+                $lastSeekId,
+            );
+        } catch (FeedNotFoundException $e) {
+            $this->logger->error($e->getMessage());
+
+            $this->feedModuleFacade->deleteFeedCronModulesByName($this->getFeedExportCreationDataQueue()->getCurrentFeedName());
+
+            $isNextFeedInQueue = $this->getFeedExportCreationDataQueue()->next();
+
+            if ($isNextFeedInQueue === false) {
+                return null;
+            }
+
+            return $this->createCurrentFeedExport();
+        }
+
+        return $feedExport;
     }
 
     /**

src/Model/Feed/FeedModuleFacade.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Model\Feed;
+
+use Doctrine\ORM\EntityManagerInterface;
+
+class FeedModuleFacade
+{
+    /**
+     * @param \Doctrine\ORM\EntityManagerInterface $em
+     * @param \Shopsys\FrameworkBundle\Model\Feed\FeedModuleRepository $feedModuleRepository
+     */
+    public function __construct(
+        protected readonly EntityManagerInterface $em,
+        protected readonly FeedModuleRepository $feedModuleRepository,
+    ) {
+    }
+
+    /**
+     * @param string $feedName
+     */
+    public function deleteFeedCronModulesByName(string $feedName): void
+    {
+        $feedModules = $this->feedModuleRepository->findFeedModulesByName($feedName);
+
+        foreach ($feedModules as $feedModule) {
+            $this->em->remove($feedModule);
+        }
+
+        $this->em->flush();
+    }
+}

src/Model/Feed/FeedModuleRepository.php

@@ -86,4 +86,15 @@ public function getAllScheduledFeedModules(): array
     {
         return $this->getFeedModuleRepository()->findBy(['scheduled' => true]);
     }
+
+    /**
+     * @param string $feedName
+     * @return \Shopsys\FrameworkBundle\Model\Feed\FeedModule[]
+     */
+    public function findFeedModulesByName(string $feedName): array
+    {
+        return $this->getFeedModuleRepository()->findBy([
+            'name' => $feedName,
+        ]);
+    }
 }

tests/Unit/Model/Feed/FeedCronModuleTest.php

@@ -14,6 +14,7 @@
 use Shopsys\FrameworkBundle\Model\Feed\FeedFacade;
 use Shopsys\FrameworkBundle\Model\Feed\FeedInfoInterface;
 use Shopsys\FrameworkBundle\Model\Feed\FeedModule;
+use Shopsys\FrameworkBundle\Model\Feed\FeedModuleFacade;
 use Shopsys\FrameworkBundle\Model\Feed\FeedModuleRepository;
 use Symfony\Bridge\Monolog\Logger;
 use Tests\FrameworkBundle\Unit\TestCase;
@@ -67,7 +68,12 @@ public function testSleepExactBetweenFeeds(): void
         $feedFacadeMock->expects($this->any())->method('scheduleFeedsForCurrentTime');
         $feedFacadeMock->expects($this->any())->method('markFeedModuleAsUnscheduled');
 
-        $feedCronModule = new FeedCronModule($feedFacadeMock, $domain, $settingMock, $feedModuleRepositoryMock);
+        $feedModuleFacadeMock = $this->getMockBuilder(FeedModuleFacade::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['deleteFeedCronModulesByName'])
+            ->getMock();
+
+        $feedCronModule = new FeedCronModule($feedFacadeMock, $domain, $settingMock, $feedModuleRepositoryMock, $feedModuleFacadeMock);
         $feedCronModule->setLogger($logger);
 
         $feedCronModule->iterate();