[All] Add doctrine persistence 4 (#174)

This pull request updates the codebase to support PHP 8.4 and modernizes
dependencies and configuration files for improved compatibility and
maintainability. The most significant changes include updating CI
workflows and test matrices for PHP 8.4, raising minimum versions for
key dependencies (including PHPUnit, PHPStan, Rector, and Psalm), and
refactoring PHPUnit configuration files to align with PHPUnit 10
standards. Additionally, the Symfony Stimulus bundle is now included,
and several code annotations and overrides have been added for better
clarity and static analysis support.

**Platform and Dependency Upgrades**

* CI workflows (`.github/workflows/ci.yaml`, `monorepo.yaml`, `qa.yaml`,
`split_ci.yaml`) now test against PHP 8.4, updating all relevant
matrices and job definitions.
[[1]](diffhunk://#diff-944291df2c9c06359d37cc8833d182d705c9e8c3108e7cfe132d61a06e9133ddL14-R32)
[[2]](diffhunk://#diff-c807f1f07915bfe6b561350c38134836c4aae8288a6ee205aec569d75e7e085cL15-R15)
[[3]](diffhunk://#diff-6cda67a2225baf6fd03fab6c06f989f6ed05461024b036dbf7eea8e11fc95da3L14-R14)
[[4]](diffhunk://#diff-c255c954d67add37f0fe00bf40275e61b446cf28527c99016229c31537aed7a0L17-R17)
[[5]](diffhunk://#diff-c255c954d67add37f0fe00bf40275e61b446cf28527c99016229c31537aed7a0L36-R36)
* Composer dependencies in `composer.json`,
`packages/basic-page-bundle/composer.json`, and
`packages/ckeditor-sonata-media-bundle/composer.json` are updated to
require newer versions, including PHPUnit 10, PHPStan 2.x, Rector 2.x,
Psalm 6.x, and Symfony Stimulus Bundle.
[[1]](diffhunk://#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34L17-R19)
[[2]](diffhunk://#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34L59-R80)
[[3]](diffhunk://#diff-3241b904b4180f03c366cfa9ea34506d1d809e675c15465c86323cfa708de4d8L25-R25)
[[4]](diffhunk://#diff-3241b904b4180f03c366cfa9ea34506d1d809e675c15465c86323cfa708de4d8L47-R57)
[[5]](diffhunk://#diff-bddaf4a4056c2af8c1430016f875c17ab339991fef9985cda597f9fd88034839L36-R46)

**Testing and Static Analysis Improvements**

* PHPUnit configuration files (`phpunit.xml.dist` in both bundles) are
refactored for PHPUnit 10, including schema updates, cache directory
settings, removal of deprecated listeners, and migration from
`<coverage>` to `<source>`.
[[1]](diffhunk://#diff-d6a8c5108cf1c3f3e2fccbe9a7d2f9985d8f0cd3c4afb1e69b68adc8fe24397fL6-L39)
[[2]](diffhunk://#diff-0477cb7bafd9b0e20e3f472dbd3d278cedf555c866379a9d5225636893d7f802L6-L39)
* Development dependencies in `monorepo-builder.php` are updated to
match the new minimum versions for static analysis and testing tools.

**Symfony and Bundle Enhancements**

* The Symfony Stimulus bundle is now included in both production and
test environments (`composer.json`, `Kernel.php`), supporting modern
frontend integration.
[[1]](diffhunk://#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34L59-R80)
[[2]](diffhunk://#diff-3241b904b4180f03c366cfa9ea34506d1d809e675c15465c86323cfa708de4d8L47-R57)
[[3]](diffhunk://#diff-e1942184052ea6a037d0862107c9183b48b78da5743df5cd0b8691a7ce4d3f0aR36)
[[4]](diffhunk://#diff-e1942184052ea6a037d0862107c9183b48b78da5743df5cd0b8691a7ce4d3f0aR58-R78)

**Code Quality and Annotation Updates**

* Added `@api` annotations to key entity classes and `#[\Override]`
attributes to overridden methods for improved static analysis and
documentation.
[[1]](diffhunk://#diff-2aa398dd56e69e0a5d49490b8d9c218ef769c3020dc4d2091b510d047b009bbdR24-R26)
[[2]](diffhunk://#diff-67a04b170ba555970cc7e28952c8f496aa92025aac59e941e65761b2a4de053eR23-R25)
[[3]](diffhunk://#diff-b2d670f86e93dbbc4bd8c0a4794a0e4d81bb3e5b9d0f2b520b9f10172890a159R21)
[[4]](diffhunk://#diff-49277f5d5184d863f419106dd66f845ae60bce9d2a60e5e2e253aa0ccdb99209R34-R50)
[[5]](diffhunk://#diff-d695325593b9abf5de4edf68cfbc86a60f00f93f3f9ad814365e8188f385356dR29)
[[6]](diffhunk://#diff-df733786eb79b5b7b27301cdc1cffc9883880e9c991c9a0ff69ff20eb964be24R37)
* Minor code quality improvements, such as suppressing Psalm warnings
and updating entity methods for better testability.
[[1]](diffhunk://#diff-debc95e230ea9fbca72a94b8363cf0c7e72aa2fecbc9f2209222df894c32c88bR20-R22)
[[2]](diffhunk://#diff-debc95e230ea9fbca72a94b8363cf0c7e72aa2fecbc9f2209222df894c32c88bR31-R37)
[[3]](diffhunk://#diff-bd41bcbda81bc0d4b77992c220c0efe08e0ee30ab44ac37c5c35aa482278ff1eR27)

**Coding Standards**

* Updated `.php-cs-fixer.dist.php` to refine ignored PHPDoc tags and
remove obsolete rules for better code style enforcement.

## Checklist
Ensure your pull request meets the following requirements:

- [x] Tests have been added or updated.
- [x] Documentation has been updated (if applicable).
- [x] I have applied neccessary labels to this PR.
- [x] I have tested this change locally and on staging.
- [x] At a functional level, it has been validated with the team/PO.

Author: jordisala1991

.github/workflows/ci.yaml

@@ -11,19 +11,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.1', '8.2', '8.3']
+        php: ['8.1', '8.2', '8.3', '8.4']
         dependencies: [highest]
         symfony-require: [highest]
         include:
           - php: '8.1'
             dependencies: lowest
             symfony-require: highest
-          - php: '8.3'
+          - php: '8.4'
             dependencies: highest
             symfony-require: 6.4.*
-          - php: '8.3'
+          - php: '8.4'
             dependencies: highest
             symfony-require: 7.1.*
+          - php: '8.4'
+            dependencies: highest
+            symfony-require: 7.2.*
+          - php: '8.4'
+            dependencies: highest
+            symfony-require: 7.3.*
     env:
       SYMFONY_REQUIRE: ${{ matrix.symfony-require }}
     steps:

.github/workflows/monorepo.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.3']
+        php: ['8.4']
         package:
           - { folder: basic-page-bundle, repository: RunroomBasicPageBundle }
           - { folder: ckeditor-sonata-media-bundle, repository: RunroomCkeditorSonataMediaBundle }

.github/workflows/qa.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.3']
+        php: ['8.4']
     steps:
       - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2

.github/workflows/split_ci.yaml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.3']
+        php: ['8.4']
     steps:
       - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
@@ -33,7 +33,7 @@ jobs:
     needs: provide_packages_json
     strategy:
       matrix:
-        php: ['8.3']
+        php: ['8.4']
         packages: ${{ fromJson(needs.provide_packages_json.outputs.matrix ) }}
         dependencies: [lowest, highest]
     steps:

.gitignore

@@ -5,6 +5,7 @@ phpunit.xml
 .php-cs-fixer.php
 .php-cs-fixer.cache
 .phpunit.result.cache
+.phpunit.cache
 /node_modules
 yarn.lock
 coverage

.php-cs-fixer.dist.php

@@ -47,8 +47,7 @@
         ['ORM\\*'],
     ]],
     'php_unit_strict' => true,
-    'php_unit_test_case_static_method_calls' => true,
-    'phpdoc_to_comment' => ['ignored_tags' => ['psalm-suppress', 'phpstan-var', 'phpstan-ignore-next-line', 'todo', 'return']],
+    'phpdoc_to_comment' => ['ignored_tags' => ['var', 'psalm-suppress', 'phpstan-var', 'phpstan-ignore-next-line', 'todo', 'return']],
     'single_line_empty_body' => true,
     'single_line_throw' => false,
     'static_lambda' => true,

composer.json

@@ -14,9 +14,9 @@
         "doctrine/dbal": "^3.6 || ^4.0",
         "doctrine/doctrine-bundle": "^2.10",
         "doctrine/orm": "^2.19 || ^3.2",
-        "doctrine/persistence": "^3.1",
+        "doctrine/persistence": "^3.1 || ^4.0",
         "gedmo/doctrine-extensions": "^3.11",
-        "phpunit/phpunit": "^9.6",
+        "phpunit/phpunit": "^10.5",
         "psr/container": "^1.1 || ^2.0",
         "sonata-project/admin-bundle": "^4.25",
         "sonata-project/doctrine-extensions": "^2.0",
@@ -56,28 +56,28 @@
         "friendsofsymfony/ckeditor-bundle": "^2.3",
         "imagine/imagine": "^1.3",
         "knplabs/knp-menu-bundle": "^3.1",
-        "matthiasnoback/symfony-config-test": "^5.1",
-        "matthiasnoback/symfony-dependency-injection-test": "^5.1",
-        "phpstan/phpstan": "^1.10",
-        "phpstan/phpstan-doctrine": "^1.0",
-        "phpstan/phpstan-phpunit": "^1.0",
-        "phpstan/phpstan-strict-rules": "^1.0",
-        "phpstan/phpstan-symfony": "^1.0",
+        "matthiasnoback/symfony-config-test": "^6.1",
+        "matthiasnoback/symfony-dependency-injection-test": "^6.1",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-doctrine": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-strict-rules": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "psalm/plugin-phpunit": "^0.19",
         "psalm/plugin-symfony": "^5.0",
         "psr/event-dispatcher": "^1.0",
-        "rector/rector": "^1.0",
+        "rector/rector": "^2.1",
         "sonata-project/block-bundle": "^5.0",
         "sonata-project/doctrine-orm-admin-bundle": "^4.13",
         "sonata-project/form-extensions": "^2.0",
         "sonata-project/twig-extensions": "^2.0",
         "symfony/browser-kit": "^6.4 || ^7.1",
         "symfony/mailer": "^6.4 || ^7.1",
         "symfony/mime": "^6.4 || ^7.1",
-        "symfony/phpunit-bridge": "^7.1",
+        "symfony/stimulus-bundle": "^2.30",
         "symfonycasts/reset-password-bundle": "^1.10",
         "symplify/monorepo-builder": "^11.0 <11.1",
-        "vimeo/psalm": "^5.14",
+        "vimeo/psalm": "^6.13",
         "weirdan/doctrine-psalm-plugin": "^2.6",
         "zenstruck/foundry": "^2.0"
     },

monorepo-builder.php

@@ -32,16 +32,16 @@
         ComposerJsonSection::REQUIRE_DEV => [
             'ergebnis/composer-normalize' => '^2.6',
             'friendsofphp/php-cs-fixer' => '^3.14',
-            'phpstan/phpstan' => '^1.10',
-            'phpstan/phpstan-doctrine' => '^1.0',
-            'phpstan/phpstan-phpunit' => '^1.0',
-            'phpstan/phpstan-symfony' => '^1.0',
-            'phpstan/phpstan-strict-rules' => '^1.0',
+            'phpstan/phpstan' => '^2.1',
+            'phpstan/phpstan-doctrine' => '^2.0',
+            'phpstan/phpstan-phpunit' => '^2.0',
+            'phpstan/phpstan-symfony' => '^2.0',
+            'phpstan/phpstan-strict-rules' => '^2.0',
             'psalm/plugin-phpunit' => '^0.19',
             'psalm/plugin-symfony' => '^5.0',
-            'rector/rector' => '^1.0',
+            'rector/rector' => '^2.1',
             'symplify/monorepo-builder' => '^11.0 <11.1',
-            'vimeo/psalm' => '^5.14',
+            'vimeo/psalm' => '^6.13',
             'weirdan/doctrine-psalm-plugin' => '^2.6',
         ],
     ]);

packages/basic-page-bundle/composer.json

@@ -22,7 +22,7 @@
         "doctrine/dbal": "^3.6 || ^4.0",
         "doctrine/doctrine-bundle": "^2.10",
         "doctrine/orm": "^2.19 || ^3.2",
-        "doctrine/persistence": "^3.1",
+        "doctrine/persistence": "^3.1 || ^4.0",
         "gedmo/doctrine-extensions": "^3.11",
         "psr/container": "^1.1 || ^2.0",
         "runroom-packages/doctrine-translatable-bundle": "^0.21",
@@ -44,17 +44,17 @@
         "dama/doctrine-test-bundle": "^8.0",
         "friendsofsymfony/ckeditor-bundle": "^2.3",
         "knplabs/knp-menu-bundle": "^3.1",
-        "matthiasnoback/symfony-config-test": "^5.1",
-        "matthiasnoback/symfony-dependency-injection-test": "^5.1",
-        "phpunit/phpunit": "^9.6",
+        "matthiasnoback/symfony-config-test": "^6.1",
+        "matthiasnoback/symfony-dependency-injection-test": "^6.1",
+        "phpunit/phpunit": "^10.5",
         "runroom-packages/testing": "^0.21",
         "sonata-project/admin-bundle": "^4.25",
         "sonata-project/doctrine-orm-admin-bundle": "^4.13",
         "sonata-project/media-bundle": "^4.9",
         "symfony/browser-kit": "^6.4 || ^7.1",
-        "symfony/phpunit-bridge": "^7.1",
         "symfony/routing": "^6.4 || ^7.1",
         "symfony/security-bundle": "^6.4 || ^7.1",
+        "symfony/stimulus-bundle": "^2.30",
         "symfony/twig-bundle": "^6.4 || ^7.1",
         "zenstruck/foundry": "^2.0"
     },

packages/basic-page-bundle/phpunit.xml.dist

@@ -3,40 +3,33 @@
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     backupGlobals="false"
-    backupStaticAttributes="false"
     colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
     bootstrap="tests/bootstrap.php"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
 >
     <testsuite name="RunroomBasicPageBundle">
         <directory>tests</directory>
     </testsuite>
 
-    <listeners>
-        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener"/>
-    </listeners>
-
     <extensions>
-        <extension class="DAMA\DoctrineTestBundle\PHPUnit\PHPUnitExtension" />
+        <bootstrap class="DAMA\DoctrineTestBundle\PHPUnit\PHPUnitExtension" />
     </extensions>
 
-    <coverage>
+    <source>
         <include>
             <directory suffix=".php">src</directory>
         </include>
-    </coverage>
+    </source>
 
     <php>
         <ini name="precision" value="8"/>
         <server name="APP_ENV" value="test" force="true" />
         <server name="APP_DEBUG" value="false" />
         <server name="SHELL_VERBOSITY" value="-1"/>
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[self]=0"/>
         <env name="KERNEL_CLASS" value="Runroom\BasicPageBundle\Tests\App\Kernel"/>
     </php>
 </phpunit>