Fix metadata loading of form_details (#418)

* Fix metadata loading ofform_details

* Update issues

* Update compsoer.json

* Fix lint

* Apply suggestions from code review

* Apply suggestions from code review

Author: alexander-schranz

.github/workflows/test-application.yaml

@@ -50,13 +50,22 @@ jobs:
                       database: mysql
                       dependency-versions: 'highest'
                       tools: 'composer:v2'
-                      composer-stability: 'dev'
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: weak
                           DATABASE_URL: mysql://root:root@127.0.0.1/sulu_form_test?serverVersion=8.0
                           DATABASE_CHARSET: utf8mb4
                           DATABASE_COLLATE: utf8mb4_unicode_ci
 
+                    - php-version: '8.4'
+                      database: postgres
+                      dependency-versions: 'highest'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+                          DATABASE_URL: postgres://postgres:postgres@127.0.0.1/sulu_form_test?serverVersion=14
+                          DATABASE_CHARSET: UTF8
+                          DATABASE_COLLATE:
+
                     - php-version: '8.5'
                       database: mysql
                       dependency-versions: 'highest'
@@ -118,7 +127,7 @@ jobs:
               env: ${{ matrix.env }}
 
             - name: Execute test cases
-              run: time composer test -- --config phpunit.xml.dist
+              run: time composer test
               env: ${{ matrix.env }}
 
     lint:

.php-cs-fixer.dist.php

@@ -32,6 +32,9 @@
         'single_line_throw' => false,
         'single_line_comment_spacing' => false,
         'trailing_comma_in_multiline' => false,
+        'phpdoc_to_comment' => [
+            'ignored_tags' => ['todo', 'var', 'see'],
+        ],
     ])
     ->setFinder($finder);
 

Command/FormGeneratorCommand.php

@@ -259,7 +259,7 @@ private function loadTestForm(): ?Form
                 ->where($queryBuilder->expr()->eq('translation.title', ':title'))
                 ->setParameter('title', 'Test Form');
 
-            /* @var Form */
+            /** @var Form */
             return $queryBuilder->getQuery()->getSingleResult();
         } catch (NoResultException $e) {
             return null;

Event/CacheInvalidationListener.php

@@ -11,15 +11,14 @@
 
 namespace Sulu\Bundle\FormBundle\Event;
 
-use Doctrine\ORM\Event\LifecycleEventArgs;
 use Doctrine\ORM\Event\PostUpdateEventArgs;
 use Doctrine\ORM\Event\PreRemoveEventArgs;
 use Sulu\Bundle\FormBundle\Entity\Form;
 use Sulu\Bundle\FormBundle\Entity\FormTranslation;
 use Sulu\Bundle\HttpCacheBundle\Cache\CacheManagerInterface;
 
 /**
- * Invalidate references when form is persisted.
+ * @internal no backwards compatibility promise is given for this class it can be removed at any time
  */
 class CacheInvalidationListener
 {
@@ -33,12 +32,12 @@ public function __construct(?CacheManagerInterface $cacheManager)
         $this->cacheManager = $cacheManager;
     }
 
-    public function postUpdate(PostUpdateEventArgs|LifecycleEventArgs $eventArgs): void
+    public function postUpdate(PostUpdateEventArgs $eventArgs): void
     {
         $this->invalidateEntity($eventArgs->getObject());
     }
 
-    public function preRemove(PreRemoveEventArgs|LifecycleEventArgs $eventArgs): void
+    public function preRemove(PreRemoveEventArgs $eventArgs): void
     {
         $this->invalidateEntity($eventArgs->getObject());
     }

Metadata/DynamicFormMetadataLoader.php

@@ -26,6 +26,9 @@
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Webmozart\Assert\Assert;
 
+/**
+ * @internal no backwards compatibility promise is given for this class it can be removed at any time
+ */
 class DynamicFormMetadataLoader implements FormMetadataLoaderInterface, CacheWarmerInterface
 {
     /**
@@ -90,6 +93,10 @@ public function warmUp($cacheDir, ?string $buildDir = null): array
 
     public function getMetadata(string $key, string $locale, array $metadataOptions = []): ?MetadataInterface
     {
+        if ('form_details' !== $key) {
+            return null;
+        }
+
         $configCache = $this->getConfigCache($key);
 
         if (!\file_exists($configCache->getPath()) || !$configCache->isFresh()) {

Repository/FormRepository.php

@@ -34,7 +34,7 @@ public function loadById(int $id, ?string $locale = null): ?Form
         $query = $queryBuilder->getQuery();
 
         try {
-            /* @var Form */
+            /** @var Form */
             return $query->getSingleResult();
         } catch (NoResultException $e) {
             return null;

Resources/config/services.xml

@@ -185,7 +185,7 @@
             <argument>%kernel.debug%</argument>
             <tag name="sulu.context" context="admin"/>
             <tag name="kernel.cache_warmer" />
-            <tag name="sulu_admin.form_metadata_loader"/>
+            <tag name="sulu_admin.form_metadata_loader" priority="256"/>
         </service>
 
         <!-- Dynamic Controller -->

composer.json

@@ -18,10 +18,10 @@
     ],
     "require": {
         "php": "^8.2",
-        "doctrine/collections": "^2.0",
+        "doctrine/collections": "^1.6 || ^2.0",
         "doctrine/orm": "^2.17.3 || ^3.3",
-        "doctrine/persistence": "^3.0",
-        "sulu/sulu": "^3.0",
+        "doctrine/persistence": "^3.1 || ^4.0",
+        "sulu/sulu": "^3.0.4 || 3.0.x-dev",
         "symfony/config": "^6.4 || ^7.1",
         "symfony/console": "^6.4 || ^7.1",
         "symfony/dependency-injection": "^6.4 || ^7.1",
@@ -121,8 +121,7 @@
             "Tests/Application/bin/websiteconsole lint:container --env prod"
         ],
         "lint-doctrine": [
-            "Tests/Application/bin/adminconsole doctrine:schema:validate --skip-sync",
-            "Tests/Application/bin/adminconsole doctrine:ensure-production-settings --env prod"
+            "Tests/Application/bin/adminconsole doctrine:schema:validate --skip-sync"
         ]
     },
     "config": {

phpstan-baseline.neon

@@ -315,11 +315,6 @@ parameters:
 			count: 1
 			path: Dynamic/Types/AttachmentType.php
 
-		-
-			message: "#^Parameter \\#1 \\$constraints of class Symfony\\\\Component\\\\Validator\\\\Constraints\\\\All constructor expects array\\<Symfony\\\\Component\\\\Validator\\\\Constraint\\>\\|Symfony\\\\Component\\\\Validator\\\\Constraint\\|null, array\\<string, array\\<Symfony\\\\Component\\\\Validator\\\\Constraint\\>\\> given\\.$#"
-			count: 1
-			path: Dynamic/Types/AttachmentType.php
-
 		-
 			message: "#^Cannot call method getDefaultValue\\(\\) on Sulu\\\\Bundle\\\\FormBundle\\\\Entity\\\\FormFieldTranslation\\|null\\.$#"
 			count: 1