Enable `use_savepoints` by default for Doctrine DBAL

[fabpot]

Q	A
License	MIT
Doc issue/PR	symfony/symfony-docs#...

[github-actions[bot]]

Thanks for the PR 😍

How to test these changes in your application

1. Define the SYMFONY_ENDPOINT environment variable:

   # On Unix-like (BSD, Linux and macOS)
   export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1290/index.json
   # On Windows
   SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1290/index.json

2. Install the package(s) related to this recipe:

   composer req 'symfony/flex:^1.16'
   composer req 'doctrine/doctrine-bundle:^2.10'

3. Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

   # On Unix-like (BSD, Linux and macOS)
   unset SYMFONY_ENDPOINT
   # On Windows
   SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes. I'm going keep this comment up to date with any updates of the attached patch.

doctrine/doctrine-bundle

1.6 vs 1.12

```diff diff --git a/doctrine/doctrine-bundle/1.6/config/packages/doctrine.yaml b/doctrine/doctrine-bundle/1.12/config/packages/doctrine.yaml index 2f611de..30d710d 100644 --- a/doctrine/doctrine-bundle/1.6/config/packages/doctrine.yaml +++ b/doctrine/doctrine-bundle/1.12/config/packages/doctrine.yaml @@ -10,9 +10,12 @@ doctrine: charset: utf8mb4 default_table_options: collate: utf8mb4_unicode_ci + + # backtrace queries in profiler (increases memory usage per request) + #profiling_collect_backtrace: '%kernel.debug%' orm: auto_generate_proxy_classes: true - naming_strategy: doctrine.orm.naming_strategy.underscore + naming_strategy: doctrine.orm.naming_strategy.underscore_number_aware auto_mapping: true mappings: App: diff --git a/doctrine/doctrine-bundle/1.6/config/packages/prod/doctrine.yaml b/doctrine/doctrine-bundle/1.12/config/packages/prod/doctrine.yaml index 0a7c53b..084f59a 100644 --- a/doctrine/doctrine-bundle/1.6/config/packages/prod/doctrine.yaml +++ b/doctrine/doctrine-bundle/1.12/config/packages/prod/doctrine.yaml @@ -2,26 +2,14 @@ doctrine: orm: auto_generate_proxy_classes: false metadata_cache_driver: - type: service - id: doctrine.system_cache_provider + type: pool + pool: doctrine.system_cache_pool query_cache_driver: - type: service - id: doctrine.system_cache_provider + type: pool + pool: doctrine.system_cache_pool result_cache_driver: - type: service - id: doctrine.result_cache_provider - -services: - doctrine.result_cache_provider: - class: Symfony\Component\Cache\DoctrineProvider - public: false - arguments: - - '@doctrine.result_cache_pool' - doctrine.system_cache_provider: - class: Symfony\Component\Cache\DoctrineProvider - public: false - arguments: - - '@doctrine.system_cache_pool' + type: pool + pool: doctrine.result_cache_pool framework: cache: diff --git a/doctrine/doctrine-bundle/1.6/manifest.json b/doctrine/doctrine-bundle/1.12/manifest.json index 04da3d1..2d3a40a 100644 --- a/doctrine/doctrine-bundle/1.6/manifest.json +++ b/doctrine/doctrine-bundle/1.12/manifest.json @@ -11,8 +11,8 @@ "#2": "IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml", "#3": "", "#4": "DATABASE_URL=\"sqlite:///%kernel.project_dir%/var/data.db\"", - "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8\"", - "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8" + "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/db_name?serverVersion=8\"", + "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/db_name?serverVersion=16&charset=utf8" }, "dockerfile": [ "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev && \\", ```

1.12 vs 2.0

```diff diff --git a/doctrine/doctrine-bundle/1.12/config/packages/doctrine.yaml b/doctrine/doctrine-bundle/2.0/config/packages/doctrine.yaml index 30d710d..365fef1 100644 --- a/doctrine/doctrine-bundle/1.12/config/packages/doctrine.yaml +++ b/doctrine/doctrine-bundle/2.0/config/packages/doctrine.yaml @@ -5,14 +5,7 @@ doctrine: # IMPORTANT: You MUST configure your server version, # either here or in the DATABASE_URL env var (see .env file) #server_version: '16' - - # only needed for MySQL - charset: utf8mb4 - default_table_options: - collate: utf8mb4_unicode_ci - - # backtrace queries in profiler (increases memory usage per request) - #profiling_collect_backtrace: '%kernel.debug%' + use_savepoints: true orm: auto_generate_proxy_classes: true naming_strategy: doctrine.orm.naming_strategy.underscore_number_aware diff --git a/doctrine/doctrine-bundle/1.12/manifest.json b/doctrine/doctrine-bundle/2.0/manifest.json index 2d3a40a..04da3d1 100644 --- a/doctrine/doctrine-bundle/1.12/manifest.json +++ b/doctrine/doctrine-bundle/2.0/manifest.json @@ -11,8 +11,8 @@ "#2": "IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml", "#3": "", "#4": "DATABASE_URL=\"sqlite:///%kernel.project_dir%/var/data.db\"", - "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/db_name?serverVersion=8\"", - "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/db_name?serverVersion=16&charset=utf8" + "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8\"", + "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8" }, "dockerfile": [ "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev && \\", ```

2.0 vs 2.3

```diff diff --git a/doctrine/doctrine-bundle/2.0/config/packages/prod/doctrine.yaml b/doctrine/doctrine-bundle/2.3/config/packages/prod/doctrine.yaml index 084f59a..17299e2 100644 --- a/doctrine/doctrine-bundle/2.0/config/packages/prod/doctrine.yaml +++ b/doctrine/doctrine-bundle/2.3/config/packages/prod/doctrine.yaml @@ -1,9 +1,6 @@ doctrine: orm: auto_generate_proxy_classes: false - metadata_cache_driver: - type: pool - pool: doctrine.system_cache_pool query_cache_driver: type: pool pool: doctrine.system_cache_pool diff --git a/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml b/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml new file mode 100644 index 0000000..2ace640 --- /dev/null +++ b/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml @@ -0,0 +1,4 @@ +doctrine: + dbal: + # "TEST_TOKEN" is typically set by ParaTest + dbname: 'main_test%env(default::TEST_TOKEN)%' diff --git a/doctrine/doctrine-bundle/2.0/manifest.json b/doctrine/doctrine-bundle/2.3/manifest.json index 04da3d1..26e52b9 100644 --- a/doctrine/doctrine-bundle/2.0/manifest.json +++ b/doctrine/doctrine-bundle/2.3/manifest.json @@ -11,13 +11,13 @@ "#2": "IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml", "#3": "", "#4": "DATABASE_URL=\"sqlite:///%kernel.project_dir%/var/data.db\"", - "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8\"", + "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8&charset=utf8mb4\"", "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8" }, "dockerfile": [ - "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev && \\", - "\tdocker-php-ext-install -j$(nproc) pdo_pgsql && \\", - "\tapk add --no-cache --virtual .pgsql-rundeps so:libpq.so.5 && \\", + "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev; \\", + "\tdocker-php-ext-install -j$(nproc) pdo_pgsql; \\", + "\tapk add --no-cache --virtual .pgsql-rundeps so:libpq.so.5; \\", "\tapk del .pgsql-deps" ], "docker-compose": { ```

2.3 vs 2.4

```diff diff --git a/doctrine/doctrine-bundle/2.3/config/packages/doctrine.yaml b/doctrine/doctrine-bundle/2.4/config/packages/doctrine.yaml index 365fef1..e517e07 100644 --- a/doctrine/doctrine-bundle/2.3/config/packages/doctrine.yaml +++ b/doctrine/doctrine-bundle/2.4/config/packages/doctrine.yaml @@ -13,7 +13,32 @@ doctrine: mappings: App: is_bundle: false - type: annotation dir: '%kernel.project_dir%/src/Entity' prefix: 'App\Entity' alias: App + +when@test: + doctrine: + dbal: + # "TEST_TOKEN" is typically set by ParaTest + dbname_suffix: '_test%env(default::TEST_TOKEN)%' + +when@prod: + doctrine: + orm: + auto_generate_proxy_classes: false + proxy_dir: '%kernel.build_dir%/doctrine/orm/Proxies' + query_cache_driver: + type: pool + pool: doctrine.system_cache_pool + result_cache_driver: + type: pool + pool: doctrine.result_cache_pool + + framework: + cache: + pools: + doctrine.result_cache_pool: + adapter: cache.app + doctrine.system_cache_pool: + adapter: cache.system diff --git a/doctrine/doctrine-bundle/2.3/config/packages/prod/doctrine.yaml b/doctrine/doctrine-bundle/2.3/config/packages/prod/doctrine.yaml deleted file mode 100644 index 17299e2..0000000 --- a/doctrine/doctrine-bundle/2.3/config/packages/prod/doctrine.yaml +++ /dev/null @@ -1,17 +0,0 @@ -doctrine: - orm: - auto_generate_proxy_classes: false - query_cache_driver: - type: pool - pool: doctrine.system_cache_pool - result_cache_driver: - type: pool - pool: doctrine.result_cache_pool - -framework: - cache: - pools: - doctrine.result_cache_pool: - adapter: cache.app - doctrine.system_cache_pool: - adapter: cache.system diff --git a/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml b/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml deleted file mode 100644 index 2ace640..0000000 --- a/doctrine/doctrine-bundle/2.3/config/packages/test/doctrine.yaml +++ /dev/null @@ -1,4 +0,0 @@ -doctrine: - dbal: - # "TEST_TOKEN" is typically set by ParaTest - dbname: 'main_test%env(default::TEST_TOKEN)%' diff --git a/doctrine/doctrine-bundle/2.3/manifest.json b/doctrine/doctrine-bundle/2.4/manifest.json index 26e52b9..88bac7a 100644 --- a/doctrine/doctrine-bundle/2.3/manifest.json +++ b/doctrine/doctrine-bundle/2.4/manifest.json @@ -44,5 +44,8 @@ " - \"5432\"" ] } + }, + "conflict": { + "symfony/framework-bundle": "<5.3" } } ```

2.4 vs 2.8

```diff diff --git a/doctrine/doctrine-bundle/2.4/config/packages/doctrine.yaml b/doctrine/doctrine-bundle/2.8/config/packages/doctrine.yaml index e517e07..c00894c 100644 --- a/doctrine/doctrine-bundle/2.4/config/packages/doctrine.yaml +++ b/doctrine/doctrine-bundle/2.8/config/packages/doctrine.yaml @@ -8,6 +8,7 @@ doctrine: use_savepoints: true orm: auto_generate_proxy_classes: true + enable_lazy_ghost_objects: true naming_strategy: doctrine.orm.naming_strategy.underscore_number_aware auto_mapping: true mappings: diff --git a/doctrine/doctrine-bundle/2.4/manifest.json b/doctrine/doctrine-bundle/2.8/manifest.json index 88bac7a..addfd20 100644 --- a/doctrine/doctrine-bundle/2.4/manifest.json +++ b/doctrine/doctrine-bundle/2.8/manifest.json @@ -11,12 +11,13 @@ "#2": "IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml", "#3": "", "#4": "DATABASE_URL=\"sqlite:///%kernel.project_dir%/var/data.db\"", - "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8&charset=utf8mb4\"", + "#5": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8.0.32&charset=utf8mb4\"", + "#6": "DATABASE_URL=\"mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=10.11.2-MariaDB&charset=utf8mb4\"", "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8" }, "dockerfile": [ "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev; \\", - "\tdocker-php-ext-install -j$(nproc) pdo_pgsql; \\", + "\tdocker-php-ext-install -j\"$(nproc)\" pdo_pgsql; \\", "\tapk add --no-cache --virtual .pgsql-rundeps so:libpq.so.5; \\", "\tapk del .pgsql-deps" ], @@ -46,6 +47,8 @@ } }, "conflict": { + "doctrine/orm": "<2.14", + "symfony/dependency-injection": "<6.2", "symfony/framework-bundle": "<5.3" } } ```

2.8 vs 2.9

```diff diff --git a/doctrine/doctrine-bundle/2.8/manifest.json b/doctrine/doctrine-bundle/2.9/manifest.json index addfd20..1d8996a 100644 --- a/doctrine/doctrine-bundle/2.8/manifest.json +++ b/doctrine/doctrine-bundle/2.9/manifest.json @@ -16,10 +16,7 @@ "DATABASE_URL": "postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8" }, "dockerfile": [ - "RUN apk add --no-cache --virtual .pgsql-deps postgresql-dev; \\", - "\tdocker-php-ext-install -j\"$(nproc)\" pdo_pgsql; \\", - "\tapk add --no-cache --virtual .pgsql-rundeps so:libpq.so.5; \\", - "\tapk del .pgsql-deps" + "RUN install-php-extensions pdo_pgsql" ], "docker-compose": { "docker-compose.yml": { ```

2.9 vs 2.10

```diff diff --git a/doctrine/doctrine-bundle/2.9/config/packages/doctrine.yaml b/doctrine/doctrine-bundle/2.10/config/packages/doctrine.yaml index c00894c..d42c52d 100644 --- a/doctrine/doctrine-bundle/2.9/config/packages/doctrine.yaml +++ b/doctrine/doctrine-bundle/2.10/config/packages/doctrine.yaml @@ -5,14 +5,19 @@ doctrine: # IMPORTANT: You MUST configure your server version, # either here or in the DATABASE_URL env var (see .env file) #server_version: '16' + + profiling_collect_backtrace: '%kernel.debug%' use_savepoints: true orm: auto_generate_proxy_classes: true enable_lazy_ghost_objects: true + report_fields_where_declared: true + validate_xml_mapping: true naming_strategy: doctrine.orm.naming_strategy.underscore_number_aware auto_mapping: true mappings: App: + type: attribute is_bundle: false dir: '%kernel.project_dir%/src/Entity' prefix: 'App\Entity' ```

[dmaicher]

@derrabus @fabpot this will however lead to deprecations on DBAL 4. See https://github.com/symfony/demo/pull/1494#issuecomment-1945549526

:confused:

[derrabus]

Can you open an issue for that in the DoctrineBundle repository? We should fix it there.

[dmaicher]

Can you open an issue for that in the DoctrineBundle repository? We should fix it there.

Hm but how would you fix it on DoctrineBundle? I mean on DBAL 4 not setting use_savepoints at all seems the way to go, or? This does not cause any deprecation. Eventually we should deprecate and remove the use_savepoints option from the Bundle I guess.

[dmaicher]

Let's discuss it here

[derrabus]

Hm but how would you fix it on DoctrineBundle?

use_savepoints: true should be a no-op on DBAL 4 while use_savepoints: false should error.

I mean on DBAL 4 not setting use_savepoints at all seems the way to go, or?

Yes. But projects should be able to gradually upgrade which is why it should be fine to still define this option on DBAL 4, even if there's only one valid setting.