add period id in tag-list, when normalizing a ScheduleEntry

Author: usu

api/src/HttpCache/TagCollector.php

@@ -8,6 +8,7 @@
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Serializer\TagCollectorInterface;
 use App\Entity\HasId;
+use App\Entity\ScheduleEntry;
 
 /**
  * Collects cache tags during normalization.
@@ -48,6 +49,12 @@ public function collect(array $context = []): void {
         }
 
         $this->addCacheTagForResource($iri);
+
+        // add resource specific tags
+        if ($object instanceof ScheduleEntry) {
+            // various content of ScheduleEntry such as Start, DayNumber, ScheduleNumber is calculated from period properties
+            $this->addCacheTagForResource($object->getPeriod()->getId());
+        }
     }
 
     private function addCacheTagForResource(string $iri): void {

api/src/State/PeriodPersistProcessor.php

@@ -8,15 +8,13 @@
 use App\Entity\Period;
 use App\State\Util\AbstractPersistProcessor;
 use App\Util\DateTimeUtil;
-use FOS\HttpCacheBundle\CacheManager;
 
 /**
  * @template-extends AbstractPersistProcessor<Period>
  */
 class PeriodPersistProcessor extends AbstractPersistProcessor {
     public function __construct(
-        ProcessorInterface $decorated,
-        private readonly CacheManager $cacheManager
+        ProcessorInterface $decorated
     ) {
         parent::__construct($decorated);
     }
@@ -25,32 +23,29 @@ public function __construct(
      * @param Period $data
      */
     public function onBefore($data, Operation $operation, array $uriVariables = [], array $context = []): Period {
-        $this->moveDaysAndScheduleEntries($data, $context['previous_data'] ?? null);
+        self::moveDaysAndScheduleEntries($data, $context['previous_data'] ?? null);
         self::removeExtraDays($data);
         self::addMissingDays($data);
 
         return $data;
     }
 
-    public function moveDaysAndScheduleEntries(Period $period, ?Period $originalPeriod = null) {
+    public static function moveDaysAndScheduleEntries(Period $period, ?Period $originalPeriod = null) {
         if (!$originalPeriod) {
             return;
         }
 
-        $deltaMinutes = DateTimeUtil::differenceInMinutes($originalPeriod->start, $period->start);
-        if (0 === $deltaMinutes) {
-            return;
-        }
-
-        // start date shifts --> purge schedule_entries subresource to reflect changes in dates + numbers
-        $this->cacheManager->invalidateTags(["/api/periods/{$period->getId()}/schedule_entries"]);
-
         // moveScheduleEntries === true: scheduleEntries move relative to the start date (no change of offset needed -> return)
         // moveScheduleEntries === false: scheduleEntries stay absolutely on the scheduled calendar date (change of offset needed)
         if ($period->moveScheduleEntries) {
             return;
         }
 
+        $deltaMinutes = DateTimeUtil::differenceInMinutes($originalPeriod->start, $period->start);
+        if (0 === $deltaMinutes) {
+            return;
+        }
+
         // Move ScheduleEntries
         // --> existing scheduleEntries outside the new period boundary are not possible (validation should have already failed)
         foreach ($period->scheduleEntries as $scheduleEntry) {

api/tests/State/PeriodPersistProcessorTest.php

@@ -10,7 +10,6 @@
 use App\Entity\Period;
 use App\Entity\ScheduleEntry;
 use App\State\PeriodPersistProcessor;
-use FOS\HttpCacheBundle\CacheManager;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -50,11 +49,9 @@ protected function setUp(): void {
         $day2->addDayResponsible($this->dayResponsible);
 
         $decoratedProcessor = $this->createMock(ProcessorInterface::class);
-        $cacheManager = $this->createMock(CacheManager::class);
 
         $this->processor = new PeriodPersistProcessor(
-            $decoratedProcessor,
-            $cacheManager
+            $decoratedProcessor
         );
     }
 

e2e/specs/httpCache/scheduleEntries.cy.js

@@ -14,7 +14,8 @@ const collectionXKeys =
   /* campCollaboration for bipiUser */
   '10d8f02ce5b4 ' +
   /* scheduleEntries + links */
-  'e68f4e47517a e68f4e47517a#period e68f4e47517a#activity e68f4e47517a#day ' +
+  /* the first scheduleEntry also includes the period id 7fa4564a5d5d */
+  'e68f4e47517a 7fa4564a5d5d e68f4e47517a#period e68f4e47517a#activity e68f4e47517a#day ' +
   'f0883e931649 f0883e931649#period f0883e931649#activity f0883e931649#day ' +
   '29c9e9a07d82 29c9e9a07d82#period 29c9e9a07d82#activity 29c9e9a07d82#day ' +
   'ee85308a97d1 ee85308a97d1#period ee85308a97d1#activity ee85308a97d1#day ' +