chore(print): improve performance for data loading

api/src/Doctrine/Filter/ContentNodePeriodFilter.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace App\Doctrine\Filter;
+
+use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractContextAwareFilter;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use App\Entity\Activity;
+use App\Entity\ContentNode;
+use Doctrine\ORM\Query\Expr\Join;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\Persistence\ManagerRegistry;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+final class ContentNodePeriodFilter extends AbstractContextAwareFilter {
+    public const PERIOD_QUERY_NAME = 'period';
+
+    public function __construct(
+        private IriConverterInterface $iriConverter,
+        ManagerRegistry $managerRegistry,
+        ?RequestStack $requestStack = null,
+        LoggerInterface $logger = null,
+        array $properties = null,
+        NameConverterInterface $nameConverter = null
+    ) {
+        parent::__construct($managerRegistry, $requestStack, $logger, $properties, $nameConverter);
+    }
+
+    // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
+    public function getDescription(string $resourceClass): array {
+        $description = [];
+        $description['period'] = [
+            'property' => self::PERIOD_QUERY_NAME,
+            'type' => Type::BUILTIN_TYPE_STRING,
+            'required' => false,
+        ];
+
+        return $description;
+    }
+
+    protected function filterProperty(
+        string $property,
+        $value,
+        QueryBuilder $queryBuilder,
+        QueryNameGeneratorInterface $queryNameGenerator,
+        string $resourceClass,
+        string $operationName = null
+    ) {
+        if (ContentNode::class !== $resourceClass) {
+            throw new \Exception("ContentNodePeriodFilter can only be applied to entities of type ContentNode (received: {$resourceClass}).");
+        }
+
+        if (self::PERIOD_QUERY_NAME !== $property) {
+            return;
+        }
+
+        // load period from query parameter value
+        $period = $this->iriConverter->getItemfromIri($value);
+
+        // generate alias to avoid interference with other filters
+        $periodParameterName = $queryNameGenerator->generateParameterName($property);
+        $rootJoinAlias = $queryNameGenerator->generateJoinAlias('root');
+        $ownerJoinAlias = $queryNameGenerator->generateJoinAlias('owner');
+        $activityJoinAlias = $queryNameGenerator->generateJoinAlias('activity');
+        $scheduleEntryJoinAlias = $queryNameGenerator->generateJoinAlias('scheduleEntry');
+
+        $rootAlias = $queryBuilder->getRootAliases()[0];
+
+        $queryBuilder
+            ->join("{$rootAlias}.root", $rootJoinAlias)
+            ->join("{$rootJoinAlias}.owner", $ownerJoinAlias)
+            ->join(Activity::class, $activityJoinAlias, Join::WITH, "{$activityJoinAlias}.id = {$ownerJoinAlias}.id")
+            ->join("{$activityJoinAlias}.scheduleEntries", $scheduleEntryJoinAlias)
+            ->andWhere($queryBuilder->expr()->eq("{$scheduleEntryJoinAlias}.period", ":{$periodParameterName}"))
+        ;
+
+        $queryBuilder->setParameter($periodParameterName, $period);
+    }
+}

api/src/Entity/Activity.php

@@ -24,7 +24,7 @@
 #[ApiResource(
     collectionOperations: [
         'get' => [
-            'normalization_context' => ['groups' => ['read', 'Activity:ActivityResponsibles', 'Activity:ContentNodes']],
+            'normalization_context' => ['groups' => ['read', 'Activity:ActivityResponsibles']],
             'security' => 'is_authenticated()',
         ],
         'post' => [

api/src/Entity/ContentNode.php

@@ -6,6 +6,7 @@
 use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
+use App\Doctrine\Filter\ContentNodePeriodFilter;
 use App\Repository\ContentNodeRepository;
 use App\Util\EntityMap;
 use App\Validator\AssertEitherIsNull;
@@ -41,7 +42,8 @@
     denormalizationContext: ['groups' => ['write']],
     normalizationContext: ['groups' => ['read']],
 )]
-#[ApiFilter(SearchFilter::class, properties: ['parent', 'contentType', 'root'])]
+#[ApiFilter(SearchFilter::class, properties: ['contentType', 'root'])]
+#[ApiFilter(ContentNodePeriodFilter::class)]
 abstract class ContentNode extends BaseEntity implements BelongsToCampInterface, CopyFromPrototypeInterface {
     /**
      * @ORM\OneToOne(targetEntity="AbstractContentNodeOwner", mappedBy="rootContentNode", cascade={"persist"})

api/tests/Api/ContentNodes/ColumnLayout/ListColumnLayoutTest.php

@@ -34,10 +34,4 @@ public function setUp(): void {
             $this->getIriFor('columnLayout2campPrototype'),
         ];
     }
-
-    public function testListColumnLayoutsFilteredByParent() {
-        $response = static::createClientWithCredentials()->request('GET', '/content_node/column_layouts?parent='.$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-        $this->assertJsonContainsItems($response, [$this->getIriFor('columnLayoutChild1')]);
-    }
 }

api/tests/Api/ContentNodes/ColumnLayout/ReadColumnLayoutTest.php

@@ -29,7 +29,7 @@ public function testGetColumnLayout() {
         $this->assertJsonContains([
             'columns' => $contentNode->columns,
             '_links' => [
-                'children' => ['href' => '/content_nodes?parent='.$this->getIriFor('columnLayoutChild1')],
+                'children' => [],
             ],
         ]);
     }

api/tests/Api/ContentNodes/ContentNode/ListContentNodesTest.php

@@ -44,27 +44,4 @@ public function testListContentNodesIsAllowedForCollaborator() {
             ['href' => $this->getIriFor('multiSelect2')],
         ], $response->toArray()['_links']['items']);
     }
-
-    public function testListContentNodesFilteredByParentIsAllowedForCollaborator() {
-        $parent = static::$fixtures['columnLayout1'];
-        $response = static::createClientWithCredentials()->request('GET', '/content_nodes?parent='.$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-        $this->assertJsonContains([
-            'totalItems' => 6,
-            '_links' => [
-                'items' => [],
-            ],
-            '_embedded' => [
-                'items' => [],
-            ],
-        ]);
-        $this->assertEqualsCanonicalizing([
-            ['href' => $this->getIriFor('columnLayoutChild1')],
-            ['href' => $this->getIriFor('singleText1')],
-            ['href' => $this->getIriFor('safetyConcept1')],
-            ['href' => $this->getIriFor('materialNode1')],
-            ['href' => $this->getIriFor('storyboard1')],
-            ['href' => $this->getIriFor('multiSelect1')],
-        ], $response->toArray()['_links']['items']);
-    }
 }

api/tests/Api/ContentNodes/ContentNode/ReadContentNodeTest.php

@@ -26,7 +26,7 @@ public function testGetSingleContentNodeIsAllowedForCollaborator() {
                 'parent' => ['href' => $this->getIriFor($contentNode->parent)],
                 'owner' => ['href' => $this->getIriFor('activity1')],
                 'ownerCategory' => ['href' => $this->getIriFor('category1')],
-                'children' => ['href' => '/content_nodes?parent='.$this->getIriFor('columnLayoutChild1')],
+                'children' => [],
                 'self' => ['href' => $this->getIriFor('columnLayoutChild1')],
             ],
         ]);

api/tests/Api/ContentNodes/CreateContentNodeTestCase.php

@@ -137,9 +137,7 @@ protected function getExampleReadPayload(ContentNode $self, $attributes = [], $e
                 'parent' => [
                     'href' => $this->getIriFor($parent),
                 ],
-                'children' => [
-                    'href' => '/content_nodes?parent='.$this->getIriFor($self),
-                ],
+                'children' => [],
                 'contentType' => [
                     'href' => $this->getIriFor($contentType),
                 ],

api/tests/Api/ContentNodes/MaterialNode/ListMaterialNodeTest.php

@@ -22,11 +22,4 @@ public function setUp(): void {
             $this->getIriFor('materialNodeCampUnrelated'),
         ];
     }
-
-    public function testListMaterialNodesFilteredByParent() {
-        $response = static::createClientWithCredentials()->request('GET', "{$this->endpoint}?parent=".$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-
-        $this->assertJsonContainsItems($response, [$this->getIriFor('materialNode1')]);
-    }
 }

api/tests/Api/ContentNodes/MultiSelect/ListMultiSelectTest.php

@@ -22,11 +22,4 @@ public function setUp(): void {
             $this->getIriFor('multiSelectCampUnrelated'),
         ];
     }
-
-    public function testListMultiSelectsFilteredByParent() {
-        $response = static::createClientWithCredentials()->request('GET', "{$this->endpoint}?parent=".$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-
-        $this->assertJsonContainsItems($response, [$this->getIriFor('multiSelect1')]);
-    }
 }

api/tests/Api/ContentNodes/SingleText/ListSingleTextTest.php

@@ -23,9 +23,4 @@ public function setUp(): void {
             $this->getIriFor('singleTextCampUnrelated'),
         ];
     }
-
-    public function testListSingleTextsFilteredByParent() {
-        $response = static::createClientWithCredentials()->request('GET', "{$this->endpoint}?parent=".$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-    }
 }

api/tests/Api/ContentNodes/Storyboard/ListStoryboardTest.php

@@ -22,11 +22,4 @@ public function setUp(): void {
             $this->getIriFor('storyboardCampUnrelated'),
         ];
     }
-
-    public function testListStoryboardsFilteredByParent() {
-        $response = static::createClientWithCredentials()->request('GET', "{$this->endpoint}?parent=".$this->getIriFor('columnLayout1'));
-        $this->assertResponseStatusCodeSame(200);
-
-        $this->assertJsonContainsItems($response, [$this->getIriFor('storyboard1')]);
-    }
 }

api/tests/Doctrine/Filter/ContentNodePeriodFilterTest.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace App\Tests\Doctrine\Filter;
+
+use ApiPlatform\Core\Api\IriConverterInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use App\Doctrine\Filter\ContentNodePeriodFilter;
+use App\Entity\ContentNode;
+use App\Entity\Period;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\Persistence\ManagerRegistry;
+use Exception;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ */
+class ContentNodePeriodFilterTest extends TestCase {
+    private MockObject|ManagerRegistry $managerRegistryMock;
+    private MockObject|QueryBuilder $queryBuilderMock;
+    private MockObject|QueryNameGeneratorInterface $queryNameGeneratorInterfaceMock;
+    private MockObject|IriConverterInterface $iriConverterMock;
+
+    public function setUp(): void {
+        parent::setUp();
+        $this->managerRegistryMock = $this->createMock(ManagerRegistry::class);
+        $this->queryBuilderMock = $this->createMock(QueryBuilder::class);
+        $this->queryNameGeneratorInterfaceMock = $this->createMock(QueryNameGeneratorInterface::class);
+        $this->iriConverterMock = $this->createMock(IriConverterInterface::class);
+
+        $this->queryBuilderMock
+            ->method('join')
+            ->will($this->returnSelf())
+        ;
+
+        $this->queryBuilderMock
+            ->method('andWhere')
+            ->will($this->returnSelf())
+        ;
+
+        $this->queryBuilderMock
+            ->method('getRootAliases')
+            ->willReturn(['o'])
+        ;
+
+        $expr = new Expr();
+        $this->queryBuilderMock
+            ->method('expr')
+            ->will($this->returnValue($expr))
+        ;
+
+        $this->queryNameGeneratorInterfaceMock
+            ->method('generateParameterName')
+            ->willReturnCallback(fn ($field) => $field.'_a1')
+        ;
+        $this->queryNameGeneratorInterfaceMock
+            ->method('generateJoinAlias')
+            ->willReturnCallback(fn ($field) => $field.'_j1')
+        ;
+    }
+
+    public function testGetDescription() {
+        // given
+        $filter = new ContentNodePeriodFilter($this->iriConverterMock, $this->managerRegistryMock);
+
+        // when
+        $description = $filter->getDescription('Dummy');
+
+        // then
+        $this->assertEquals([
+            'period' => [
+                'property' => 'period',
+                'type' => 'string',
+                'required' => false,
+            ],
+        ], $description);
+    }
+
+    public function testFailsForResouceClassOtherThanContentNode() {
+        // given
+        $filter = new ContentNodePeriodFilter($this->iriConverterMock, $this->managerRegistryMock);
+
+        // then
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessage('ContentNodePeriodFilter can only be applied to entities of type ContentNode (received: DummyClass).');
+
+        // when
+        $filter->apply($this->queryBuilderMock, $this->queryNameGeneratorInterfaceMock, 'DummyClass', null, ['filters' => [
+            'period' => '/period/123',
+        ]]);
+    }
+
+    public function testDoesNothingForPropertiesOtherThanPeriod() {
+        // given
+        $filter = new ContentNodePeriodFilter($this->iriConverterMock, $this->managerRegistryMock);
+
+        // then
+        $this->queryBuilderMock
+            ->expects($this->never())
+            ->method('getRootAliases')
+        ;
+
+        $this->queryBuilderMock
+            ->expects($this->never())
+            ->method('join')
+        ;
+
+        $this->queryBuilderMock
+            ->expects($this->never())
+            ->method('andWhere')
+        ;
+
+        // when
+        $filter->apply($this->queryBuilderMock, $this->queryNameGeneratorInterfaceMock, ContentNode::class, null, ['filters' => [
+            'dummyProperty' => 'abc',
+        ]]);
+    }
+
+    public function testAddsFilterForPeriodProperty() {
+        // given
+        $filter = new ContentNodePeriodFilter($this->iriConverterMock, $this->managerRegistryMock);
+        $period = new Period();
+
+        // then
+        $this->iriConverterMock
+            ->expects($this->once())
+            ->method('getItemfromIri')
+            ->with('/period/123')
+            ->will($this->returnValue($period))
+        ;
+
+        $this->queryBuilderMock
+            ->expects($this->once())
+            ->method('andWhere')
+        ;
+
+        $this->queryBuilderMock
+            ->expects($this->once())
+            ->method('setParameter')
+            ->with('period_a1', $period)
+        ;
+
+        $this->queryBuilderMock
+            ->expects($this->exactly(4))
+            ->method('join')
+        ;
+
+        // when
+        $filter->apply($this->queryBuilderMock, $this->queryNameGeneratorInterfaceMock, ContentNode::class, null, ['filters' => [
+            'period' => '/period/123',
+        ]]);
+    }
+}