feat: Added new NodeTypeField.php normalizationContext to alter nor…

…malization groups per field basis (#29) We can optimize API responses by configuring serialization context per NodeType field. This will avoid heavy WebResponse resources.
roadiz · Dec 19, 2024 · 39448bd · 39448bd
1 parent 458cd19
commit 39448bd
Show file tree

Hide file tree

Showing 36 changed files with 270 additions and 46 deletions.
diff --git a/... path wrapped in a WebResponse object.bru → ...ent app/WebResponse/Get a WebResponse.bru b/... path wrapped in a WebResponse object.bru → ...ent app/WebResponse/Get a WebResponse.bru
@@ -1,5 +1,5 @@
 meta {
-  name: Get a Page by its path wrapped in a WebResponse object
+  name: Get a WebResponse
   type: http
   seq: 1
 }
@@ -12,19 +12,18 @@ get {
 
 params:query {
   path: /
-  ~path: /articles/article-with-attributes
+  ~properties[item][]: nodeReferences
+  ~properties[item][]: title
   ~properties[]: item
-  ~properties[item]: title
+  ~path: /articles/article-with-attributes
   ~properties[]: blocks
-  ~properties[item]: url
+  ~properties[item][]: url
   ~path: /contact
   ~_preview: 1
   ~path: /fr/articles/article-with-attributes
-  ~testsd: sd
   ~path: /fr/articles
   ~properties[item][]: nodeReferences
   ~path: /data:image/svg-xml
-  ~_locale: zh
 }
 
 auth:bearer {

diff --git a/composer.json b/composer.json
@@ -143,6 +143,7 @@
         "league/flysystem-aws-s3-v3": "^3.10",
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpstan/phpstan-symfony": "^1.1.8",
         "phpunit/phpunit": "^9.5",

diff --git a/config/api_resources/web_response.yml b/config/api_resources/web_response.yml
@@ -1,5 +1,7 @@
 resources:
     RZ\Roadiz\CoreBundle\Api\Model\WebResponse:
+        filters:
+            - app.property_filter
         graphQlOperations: {  }
         operations:
             article_get_by_path:

diff --git a/config/services.yaml b/config/services.yaml
@@ -32,3 +32,10 @@ services:
     app.serializer.normalizer.menu_link_path.json:
         class: 'App\Serializer\Normalizer\MenuLinkPathNormalizer'
         decorates: 'api_platform.serializer.normalizer.item'
+
+    app.property_filter:
+        parent: 'api_platform.serializer.property_filter'
+        tags: [ 'api_platform.filter' ]
+        autowire: false
+        autoconfigure: false
+        public: false
diff --git a/lib/DocGenerator/composer.json b/lib/DocGenerator/composer.json
@@ -23,7 +23,8 @@
         }
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "extra": {
         "branch-alias": {

diff --git a/lib/Documents/composer.json b/lib/Documents/composer.json
@@ -46,6 +46,7 @@
         "doctrine/doctrine-bundle": "^2.8.1",
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpunit/phpunit": "^9.5"
     },

diff --git a/lib/DtsGenerator/composer.json b/lib/DtsGenerator/composer.json
@@ -7,7 +7,8 @@
         "symfony/http-foundation": "6.4.*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "license": "MIT",
     "authors": [

diff --git a/lib/EntityGenerator/composer.json b/lib/EntityGenerator/composer.json
@@ -36,6 +36,7 @@
     },
     "require-dev": {
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpunit/phpunit": "^9.5",
         "api-platform/core": "~3.3.11"
     },

diff --git a/lib/EntityGenerator/src/Field/AbstractFieldGenerator.php b/lib/EntityGenerator/src/Field/AbstractFieldGenerator.php
@@ -93,6 +93,21 @@ protected function getFieldDefaultValueDeclaration(): Literal|string|null
         return null;
     }
 
+    /**
+     * @return array<string, mixed>|null
+     */
+    protected function getNormalizationContext(): ?array
+    {
+        if (\method_exists($this->field, 'getNormalizationContext')) {
+            $normalizationContext = $this->field->getNormalizationContext();
+            if (\is_array($normalizationContext) && !empty($normalizationContext['groups'])) {
+                return $normalizationContext;
+            }
+        }
+
+        return null;
+    }
+
     protected function addFieldAttributes(Property $property, PhpNamespace $namespace, bool $exclude = false): self
     {
         if ($exclude) {
@@ -134,6 +149,16 @@ protected function addFieldAttributes(Property $property, PhpNamespace $namespac
                     $this->getSerializationMaxDepth(),
                 ]);
             }
+
+            /*
+             * Enable different serialization context for this field.
+             */
+            if (null !== $this->getNormalizationContext()) {
+                $property->addAttribute('Symfony\Component\Serializer\Attribute\Context', [
+                    'normalizationContext' => $this->getNormalizationContext(),
+                    'groups' => $this->getSerializationGroups(),
+                ]);
+            }
         }
 
         if (

diff --git a/lib/EntityGenerator/src/Field/CustomFormsFieldGenerator.php b/lib/EntityGenerator/src/Field/CustomFormsFieldGenerator.php
@@ -23,6 +23,24 @@ protected function addSerializationAttributes(Property|Method $property): self
         return $this;
     }
 
+    protected function addFieldAnnotation(Property $property): AbstractFieldGenerator
+    {
+        parent::addFieldAnnotation($property);
+
+        $property->addComment('');
+        $property->addComment('@var '.$this->options['custom_form_class'].'[]|null');
+
+        return $this;
+    }
+
+    protected function getNormalizationContext(): array
+    {
+        return [
+            'groups' => ['nodes_sources', 'urls'],
+            ...(parent::getNormalizationContext() ?? []),
+        ];
+    }
+
     protected function getDefaultSerializationGroups(): array
     {
         $groups = parent::getDefaultSerializationGroups();

diff --git a/lib/EntityGenerator/tests/Mocks/GeneratedNodesSources/NSMock.php b/lib/EntityGenerator/tests/Mocks/GeneratedNodesSources/NSMock.php
@@ -309,12 +309,18 @@ class NSMock extends NodesSources
     /**
      * Custom forms field.
      * (Virtual field, this var is a buffer)
+     *
+     * @var \mock\Entity\CustomForm[]|null
      */
     #[JMS\Exclude]
     #[Serializer\SerializedName(serializedName: 'theForms')]
     #[Serializer\Groups(['nodes_sources', 'nodes_sources_default', 'nodes_sources_custom_forms'])]
     #[ApiProperty(description: 'Custom forms field')]
     #[Serializer\MaxDepth(2)]
+    #[Serializer\Context(
+        normalizationContext: ['groups' => ['nodes_sources', 'urls']],
+        groups: ['nodes_sources', 'nodes_sources_default', 'nodes_sources_custom_forms'],
+    )]
     private ?array $theForms = null;
 
     /**

diff --git a/lib/EntityGenerator/tests/Mocks/GeneratedNodesSourcesWithRepository/NSMock.php b/lib/EntityGenerator/tests/Mocks/GeneratedNodesSourcesWithRepository/NSMock.php
@@ -309,12 +309,18 @@ class NSMock extends NodesSources
     /**
      * Custom forms field.
      * (Virtual field, this var is a buffer)
+     *
+     * @var \mock\Entity\CustomForm[]|null
      */
     #[JMS\Exclude]
     #[Serializer\SerializedName(serializedName: 'theForms')]
     #[Serializer\Groups(['nodes_sources', 'nodes_sources_default', 'nodes_sources_custom_forms'])]
     #[ApiProperty(description: 'Custom forms field')]
     #[Serializer\MaxDepth(2)]
+    #[Serializer\Context(
+        normalizationContext: ['groups' => ['nodes_sources', 'urls']],
+        groups: ['nodes_sources', 'nodes_sources_default', 'nodes_sources_custom_forms'],
+    )]
     private ?array $theForms = null;
 
     /**

diff --git a/lib/Jwt/composer.json b/lib/Jwt/composer.json
@@ -17,7 +17,8 @@
         "symfony/http-client": "6.4.*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "autoload": {
         "psr-4": {

diff --git a/lib/Markdown/composer.json b/lib/Markdown/composer.json
@@ -10,7 +10,8 @@
         "twig/twig": "^3.16"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "license": "MIT",
     "authors": [

diff --git a/lib/Models/composer.json b/lib/Models/composer.json
@@ -32,6 +32,7 @@
         "doctrine/doctrine-bundle": "^2.8.1",
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpunit/phpunit": "^9.5"
     },
     "autoload": {

diff --git a/lib/OpenId/composer.json b/lib/OpenId/composer.json
@@ -30,7 +30,8 @@
         "symfony/security-http": "6.4.*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "autoload": {
         "psr-4": {

diff --git a/lib/Random/composer.json b/lib/Random/composer.json
@@ -17,7 +17,8 @@
         "ext-openssl": "*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3"
+        "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2"
     },
     "autoload": {
         "psr-4": {

diff --git a/lib/RoadizCompatBundle/composer.json b/lib/RoadizCompatBundle/composer.json
@@ -26,6 +26,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpstan/phpstan-symfony": "^1.1.8",
         "roadiz/doc-generator": "2.4.*",

diff --git a/lib/RoadizCoreBundle/composer.json b/lib/RoadizCoreBundle/composer.json
@@ -100,6 +100,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpunit/phpunit": "^9.5",
         "symfony/browser-kit": "6.4.*",

diff --git a/lib/RoadizCoreBundle/migrations/Version20241218095458.php b/lib/RoadizCoreBundle/migrations/Version20241218095458.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241218095458 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Added normalization_context to NodeTypeField';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE node_type_fields ADD normalization_context JSON DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE node_type_fields DROP normalization_context');
+    }
+}
diff --git a/lib/RoadizCoreBundle/src/Entity/NodeTypeField.php b/lib/RoadizCoreBundle/src/Entity/NodeTypeField.php
@@ -98,6 +98,14 @@ class NodeTypeField extends AbstractField implements NodeTypeFieldInterface, Ser
     ]
     private ?array $serializationGroups = null;
 
+    #[
+        Serializer\Groups(['node_type']),
+        SymfonySerializer\Groups(['node_type']),
+        Serializer\Type('array<string, array>'),
+        ORM\Column(name: 'normalization_context', type: 'json', nullable: true)
+    ]
+    private ?array $normalizationContext = null;
+
     #[
         Serializer\Groups(['node_type']),
         SymfonySerializer\Groups(['node_type']),
@@ -330,4 +338,33 @@ public function setExcludedFromSerialization(bool $excludedFromSerialization): N
 
         return $this;
     }
+
+    public function getNormalizationContext(): ?array
+    {
+        return $this->normalizationContext;
+    }
+
+    public function setNormalizationContext(?array $normalizationContext): NodeTypeField
+    {
+        $this->normalizationContext = $normalizationContext;
+
+        return $this;
+    }
+
+    #[SymfonySerializer\Ignore]
+    public function getNormalizationContextGroups(): ?array
+    {
+        return $this->normalizationContext['groups'] ?? [];
+    }
+
+    #[SymfonySerializer\Ignore]
+    public function setNormalizationContextGroups(?array $normalizationContextGroups): NodeTypeField
+    {
+        if (null === $normalizationContextGroups) {
+            $this->normalizationContext = null;
+        }
+        $this->normalizationContext['groups'] = $normalizationContextGroups;
+
+        return $this;
+    }
 }
diff --git a/lib/RoadizFontBundle/composer.json b/lib/RoadizFontBundle/composer.json
@@ -51,6 +51,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpunit/phpunit": "^9.5",
         "roadiz/compat-bundle": "2.4.*",

diff --git a/lib/RoadizRozierBundle/composer.json b/lib/RoadizRozierBundle/composer.json
@@ -29,6 +29,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpstan/phpstan-symfony": "^1.1.8"
     },

diff --git a/lib/RoadizTwoFactorBundle/composer.json b/lib/RoadizTwoFactorBundle/composer.json
@@ -36,6 +36,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpunit/phpunit": "^9.5",
         "roadiz/doc-generator": "2.4.*",

diff --git a/lib/RoadizUserBundle/composer.json b/lib/RoadizUserBundle/composer.json
@@ -31,6 +31,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "roadiz/doc-generator": "2.4.*",
         "roadiz/entity-generator": "2.4.*",

diff --git a/lib/Rozier/composer.json b/lib/Rozier/composer.json
@@ -66,6 +66,7 @@
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
         "phpstan/phpstan": "^1.5.3",
+        "phpstan/phpdoc-parser": "<2",
         "phpstan/phpstan-doctrine": "^1.3",
         "roadiz/entity-generator": "2.4.*",
         "roadiz/jwt": "2.4.*",

diff --git a/lib/Rozier/src/AjaxControllers/AjaxSearchController.php b/lib/Rozier/src/AjaxControllers/AjaxSearchController.php
@@ -65,12 +65,12 @@ public function searchAction(Request $request): Response
         foreach ($nodesSources as $source) {
             $uniqueKey = null;
             if ($source instanceof NodesSources) {
-                $uniqueKey = 'n_' . $source->getNode()->getId();
+                $uniqueKey = 'n_'.$source->getNode()->getId();
                 if (!$this->security->isGranted(NodeVoter::READ, $source)) {
                     continue;
                 }
             } elseif ($source instanceof PersistableInterface) {
-                $uniqueKey = 'p_' . $source->getId();
+                $uniqueKey = 'p_'.$source->getId();
             }
             if (key_exists($uniqueKey, $data)) {
                 continue;