[FrameworkBundle] Deprecate doctrine/annotations integration #50888

derrabus · 2023-07-05T12:40:51Z

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	yes
Tickets	N/A
License	MIT
Doc PR	TODO

This PR deprecates the integration of the doctrine/annotations package in FrameworkBundle. Currently, the integration is enabled by default if doctrine/annotations is installed. This PR adds a runtime deprecation if the app does not explicitly disable it by setting:

framework:
    annotations: false

The plan is to make this the default and only valid option in Symfony 7 and remove that setting entirely in Symfony 8. This change unlocks #49358 and similar PRs that remove support for Doctrine Annotations from components.

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/default_config.php

UPGRADE-6.4.md

GromNaN · 2023-07-05T15:00:53Z

I don't have the whole thing in my head. Is it necessary to add the framework.annotations.enabled: false config when the doctrine/annotations package is not detected?

Self-reply: it's documented in FrameworkBundle's changelog.
Thanks.

derrabus · 2023-07-05T15:12:48Z

Is it necessary to add the framework.annotations.enabled: false config when the doctrine/annotations package is not detected?

No.

Long answer: Unfortunately, we currently enable the annotations integration by default if the doctrine/annotations package is installed. However if the package is not installed, FrameworkBundle's default behavior is fine, so you don't have to opt out of anything.

stof · 2023-07-05T16:44:54Z

@derrabus regarding the "unlocking" part, shouldn't we actually first deprecate annotations in components and then deprecate the FrameworkBundle integration configuring a reader only once we don't rely on it anymore ?

derrabus · 2023-07-05T16:51:47Z

shouldn't we actually first deprecate annotations in components and then deprecate the FrameworkBundle integration configuring a reader only once we don't rely on it anymore ?

That was my first approach, but I think it's easier this way. This PR is self-contained: If we merge it and remove the integration in 7.0, the components might still support Doctrine annotations, but FrameworkBundle won't have a way to enable them. Removing a feature that FrameworkBundle doesn't use should be easy. 🙂

stof · 2023-07-05T16:55:25Z

@derrabus but the DX would be worse as devs would not get deprecation warnings telling them where they still use annotations, which they should solve before disabling them.
To me, we should first have a component-level deprecation triggered when annotations are actually found (so in the case of the routing component, triggered when you actually have a route defined with annotations).

derrabus · 2023-07-14T09:39:35Z

@derrabus but the DX would be worse as devs would not get deprecation warnings telling them where they still use annotations, which they should solve before disabling them.

#49358, #50982 and #50983 trigger the deprecations you want.

To me, we should first have a component-level deprecation triggered when annotations are actually found (so in the case of the routing component, triggered when you actually have a route defined with annotations).

This is kinda a chicken-egg problem. I'm working on removing annotations everywhere and I believe we both agree on how the end result should look like. Unless we want to discuss a big all-or-nothing PR, I think we can live with this DX flaw, knowing we will resolve it before 6.4.

...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/serializer_mapping.php

...ameworkBundle/Tests/DependencyInjection/Fixtures/xml/workflow_with_no_events_to_dispatch.xml

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml

...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/serializer_mapping.yml

nicolas-grekas · 2023-07-20T10:12:14Z

Thank you @derrabus.

…ion (derrabus) This PR was merged into the 7.0 branch. Discussion ---------- [FrameworkBundle] Remove doctrine/annotations integration | Q | A | ------------- | --- | Branch? | 7.0 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Follows #50888 | License | MIT | Doc PR | TODO, see symfony/symfony-docs#18589 Commits ------- 713ff44 [FrameworkBundle] Remove doctrine/annotations integration

…tes (derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [Serializer] Deprecate annotations in favor of attributes | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Follows #50888 | License | MIT | Doc PR | TODO, see symfony/symfony-docs#18589 This PR deprecates using Doctrine annotations to configure serialization. Attributes shall be used instead. Existing applications can be migrated easily using [Rector](https://getrector.com/blog/how-to-upgrade-annotations-to-attributes). Deprecation errors triggered by the bundles' functional tests will be resolved once #50888 is merged. Commits ------- 9b7b397 [Serializer] Deprecate annotations in favor of attributes

…tes (derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [Serializer] Deprecate annotations in favor of attributes | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Follows #50888 | License | MIT | Doc PR | TODO, see symfony/symfony-docs#18589 This PR deprecates using Doctrine annotations to configure serialization. Attributes shall be used instead. Existing applications can be migrated easily using [Rector](https://getrector.com/blog/how-to-upgrade-annotations-to-attributes). Deprecation errors triggered by the bundles' functional tests will be resolved once symfony/symfony#50888 is merged. Commits ------- 9b7b397ec4 [Serializer] Deprecate annotations in favor of attributes

…es (derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [Validator] Deprecate annotations in favor of attributes | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Follows #50888 | License | MIT | Doc PR | TODO, see symfony/symfony-docs#18589 This PR deprecates using Doctrine annotations to configure validation constraints. Attributes shall be used instead. Existing applications can be migrated easily using [Rector](https://getrector.com/blog/how-to-upgrade-annotations-to-attributes). Deprecation errors triggered by the bundles' functional tests will be resolved once #50888 is merged. Commits ------- 6b6dc62 [Validator] Deprecate annotations in favor of attributes

… (derrabus) This PR was merged into the 6.4 branch. Discussion ---------- [Routing] Deprecate annotations in favor of attributes | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Follows #50888 | License | MIT | Doc PR | TODO, see symfony/symfony-docs#18589 This PR deprecates the integration of Doctrine Annotations for the Routing component. Attributes are the way to go now if we want to annotate controllers with routing information. Existing applications can be migrated easily using [Rector](https://getrector.com/blog/how-to-upgrade-annotations-to-attributes). Thus I believe that keeping support for oldschool Doctrine Annotations is not necessary anymore. If this PR is accepted, I would work on a follow-up that renames all `Annotation*Loader` classes because the names of those classes are probably misleading as soon as they support attributes only. Commits ------- 6ce15f2 [Routing] Deprecate annotations in favor of attributes

derrabus requested review from yceruto, wouterj and chalasr as code owners July 5, 2023 12:40

carsonbot added Status: Needs Review Deprecation Feature FrameworkBundle labels Jul 5, 2023

carsonbot added this to the 6.4 milestone Jul 5, 2023

OskarStark reviewed Jul 5, 2023

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php Outdated Show resolved Hide resolved

OskarStark reviewed Jul 5, 2023

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/default_config.php Outdated Show resolved Hide resolved

derrabus force-pushed the deprecate/annotations branch 4 times, most recently from 7741661 to 336d0a1 Compare July 5, 2023 13:10

94noni reviewed Jul 5, 2023

View reviewed changes

UPGRADE-6.4.md Show resolved Hide resolved

derrabus force-pushed the deprecate/annotations branch 2 times, most recently from 45a4183 to 3387235 Compare July 5, 2023 14:39

derrabus force-pushed the deprecate/annotations branch from 3387235 to e0b4c95 Compare July 5, 2023 15:04

derrabus force-pushed the deprecate/annotations branch from e0b4c95 to bbb95eb Compare July 14, 2023 09:17

This was referenced Jul 14, 2023

[Validator] Deprecate annotations in favor of attributes #50982

Merged

[Serializer] Deprecate annotations in favor of attributes #50983

Merged

derrabus force-pushed the deprecate/annotations branch from bbb95eb to 30bd8d8 Compare July 14, 2023 19:53

derrabus mentioned this pull request Jul 14, 2023

[FrameworkBundle][Routing][Serializer][Validator] Deprecate Doctrine annotations #50986

Closed

derrabus force-pushed the deprecate/annotations branch from 30bd8d8 to 7cae682 Compare July 14, 2023 22:59

derrabus force-pushed the deprecate/annotations branch 3 times, most recently from ea0b7a2 to 6ef6b5b Compare July 15, 2023 22:07

nicolas-grekas reviewed Jul 16, 2023

View reviewed changes

...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/serializer_mapping.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jul 16, 2023

View reviewed changes

...ameworkBundle/Tests/DependencyInjection/Fixtures/xml/workflow_with_no_events_to_dispatch.xml Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jul 16, 2023

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml Outdated Show resolved Hide resolved

nicolas-grekas reviewed Jul 16, 2023

View reviewed changes

...Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/serializer_mapping.yml Outdated Show resolved Hide resolved

derrabus force-pushed the deprecate/annotations branch from 6ef6b5b to 1d3e0c6 Compare July 16, 2023 17:45

nicolas-grekas approved these changes Jul 16, 2023

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jul 16, 2023

[FrameworkBundle] Deprecate doctrine/annotations integration

2b3c954

nicolas-grekas force-pushed the deprecate/annotations branch from 1d3e0c6 to 2b3c954 Compare July 20, 2023 10:11

nicolas-grekas merged commit 02147d3 into symfony:6.4 Jul 20, 2023

nicolas-grekas mentioned this pull request Jul 20, 2023

[FrameworkBundle] Deprecate doctrine/annotations integration symfony/symfony-docs#18589

Closed

derrabus deleted the deprecate/annotations branch July 20, 2023 13:43

This was referenced Jul 20, 2023

[FrameworkBundle] Remove doctrine/annotations integration #51050

Merged

[Routing] Deprecate annotations in favor of attributes #49358

Merged

This was referenced Jul 25, 2023

Disable doctrine/annotations integration symfony/recipes#1224

Merged

[RFC] Deprecate most of or all annotations? #49369

Closed

This was referenced Oct 21, 2023

Release v6.4.0-BETA1 #52220

Merged

Release v7.0.0-BETA1 #52224

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[FrameworkBundle] Deprecate doctrine/annotations integration #50888

[FrameworkBundle] Deprecate doctrine/annotations integration #50888

Uh oh!

derrabus commented Jul 5, 2023 •

edited by nicolas-grekas

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN commented Jul 5, 2023 •

edited

Loading

Uh oh!

derrabus commented Jul 5, 2023

Uh oh!

stof commented Jul 5, 2023

Uh oh!

derrabus commented Jul 5, 2023

Uh oh!

stof commented Jul 5, 2023

Uh oh!

derrabus commented Jul 14, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Jul 20, 2023

Uh oh!

Uh oh!

Uh oh!

[FrameworkBundle] Deprecate doctrine/annotations integration #50888

[FrameworkBundle] Deprecate doctrine/annotations integration #50888

Uh oh!

Conversation

derrabus commented Jul 5, 2023 • edited by nicolas-grekas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GromNaN commented Jul 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

derrabus commented Jul 5, 2023

Uh oh!

stof commented Jul 5, 2023

Uh oh!

derrabus commented Jul 5, 2023

Uh oh!

stof commented Jul 5, 2023

Uh oh!

derrabus commented Jul 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Jul 20, 2023

Uh oh!

Uh oh!

derrabus commented Jul 5, 2023 •

edited by nicolas-grekas

Loading

GromNaN commented Jul 5, 2023 •

edited

Loading

derrabus commented Jul 14, 2023 •

edited

Loading