[FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` #28243

sroze · 2018-08-22T17:07:07Z

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#28215
License	MIT
Doc PR	ø

Time to deprecate Controller, youpi !! 🎉

nicolas-grekas · 2018-08-23T09:14:12Z

src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php

@@ -19,6 +19,8 @@
 *
 * It provides methods to common features needed in controllers.
 *
+ * @deprecated since Symfony 4.2. Use {@see AbstractController} instead.


shouldn't we add a runtime deprecation notice also?

DebugClassLoader will warn when you extend the class already (and this class is abstract, so it can only be used by extending it)

yes, but still: when we can, we should add the notice

but wouldn't this report duplicate notice all the time then ?

The issue with not sending the notice is that we cannot spot in our own code when we extend Controller. Do we? Only the runtime notice would tell, at least with the current strategy in place.
The maybe double notice is not an issue IMHO. Better one more than a missed notice leading to a fatal error when moving to next major.

nicolas-grekas

missing runtime notice (which will allow spotting that ControllerTest misses an @group legacy annotation, and maybe other glitches.)

stof · 2018-08-23T10:12:27Z

aren't we running our testsuite with the DebugClassLoader enabled ? If no, it means that any deprecation coming from DebugClassLoader would be missed (and DebugClassLoader is the best place to report some of them, which is why we have this logic in it).

nicolas-grekas · 2018-08-23T10:37:00Z

Nope, we're not, and there is a good reason to it: we always add runtime deprecation notices. And then, IF there is some Symfony\* class that must implement/extend some interface/class for BC, then we remove the runtime notice so that our own code is deprecation free in the phpunit report. As you can see, making DebugClassLoader report these would defeat the whole process.

chalasr · 2018-08-24T04:58:06Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -8,6 +8,7 @@ CHANGELOG
 * Allowed configuring PDO-based cache pools via a new `cache.adapter.pdo` abstract service
 * Deprecated auto-injection of the container in AbstractController instances, register them as service subscribers instead
 * Deprecated processing of services tagged `security.expression_language_provider` in favor of a new `AddExpressionLanguageProvidersPass` in SecurityBundle.
+ * Deprecated the `Symfony\Bundle\FrameworkBundle\Controller\Controller` class in favour of `Symfony\Bundle\FrameworkBundle\Controller\AbstractController`.


should be favor

nicolas-grekas · 2018-08-24T10:13:06Z

See tests :)

sroze · 2018-08-26T12:11:58Z

Updated; needed some tweaks since we trigger the depreciation when the file is loaded.

chalasr · 2018-08-26T17:06:10Z

UPGRADE-4.2 needs to be updated

fabpot

with some minor comments

fabpot · 2018-08-27T16:06:37Z

src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php

@@ -14,11 +14,15 @@
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareTrait;

+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2. Use %s instead.', Controller::class, AbstractController::class), E_USER_DEPRECATED);


... Symfony 4.2, use ...

fabpot · 2018-08-27T16:06:48Z

src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php

 /**
 * Controller is a simple implementation of a Controller.
 *
 * It provides methods to common features needed in controllers.
 *
+ * @deprecated since Symfony 4.2. Use {@see AbstractController} instead.


... Symfony 4.2, use ...

sroze · 2018-08-27T18:13:30Z

@fabpot wording updated 👍

fabpot · 2018-08-28T06:35:30Z

Thank you @sroze.

…undle\Controller\Controller` (sroze) This PR was merged into the 4.2-dev branch. Discussion ---------- [FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #28215 | License | MIT | Doc PR | ø Time to deprecate `Controller`, youpi !! 🎉 Commits ------- a7e319d Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller`

TomasVotruba · 2018-09-02T21:26:11Z

@sroze Very nice, thanks 👍

javiereguiluz · 2018-09-07T14:31:35Z

I've created symfony/symfony-docs#10282 to document this new feature. Please, don't forget to create a doc issue for every new feature, specially for critical changes like this one (we use the deprecated class hundreds of times in the docs ... it should be a top-priority doc change). Thanks!

… (chalasr) This PR was merged into the 4.2-dev branch. Discussion ---------- Add missing UPGRADE-4.2 entry for Controller deprecation | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Forgot in #28243, removal documented in UPGRADE-5.0 Commits ------- cc23f5d Add missing UPGRADE-4.2 entry for Controller deprecation

carsonbot added Status: Needs Review FrameworkBundle Deprecation labels Aug 22, 2018

nicolas-grekas added this to the next milestone Aug 23, 2018

nicolas-grekas reviewed Aug 23, 2018

View reviewed changes

nicolas-grekas requested changes Aug 23, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Aug 23, 2018

chalasr reviewed Aug 24, 2018

View reviewed changes

sroze force-pushed the deprecate-controller branch from 38dd419 to f74d509 Compare August 24, 2018 09:42

sroze force-pushed the deprecate-controller branch from f74d509 to bd57d7d Compare August 26, 2018 12:10

nicolas-grekas approved these changes Aug 26, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Aug 26, 2018

nicolas-grekas mentioned this pull request Aug 27, 2018

Difference between Controller and AbstractController symfony/symfony-docs#9926

Closed

fabpot approved these changes Aug 27, 2018

View reviewed changes

Deprecate Symfony\Bundle\FrameworkBundle\Controller\Controller

a7e319d

sroze force-pushed the deprecate-controller branch from bd57d7d to a7e319d Compare August 27, 2018 18:13

fabpot merged commit a7e319d into symfony:master Aug 28, 2018

javiereguiluz mentioned this pull request Sep 7, 2018

[FrameworkBundle] Deprecate Controller in favor of AbstractController symfony/symfony-docs#10282

Closed

chalasr mentioned this pull request Sep 8, 2018

Add missing UPGRADE-4.2 entry for Controller deprecation #28407

Merged

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

Addvilz mentioned this pull request Feb 13, 2019

[Symfony] Replace deprecated Controller with new one OpenAPITools/openapi-generator#2146

Merged

4 tasks

yaffol mentioned this pull request Mar 25, 2019

Custom methods, Orphan path and Symfony controller extention 1up-lab/OneupUploaderBundle#351

Closed

mantis mentioned this pull request Dec 23, 2019

Symfony integration - documentation ankitpokhrel/tus-php#226

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` #28243

[FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` #28243

sroze commented Aug 22, 2018 •

edited

Loading

nicolas-grekas Aug 23, 2018

stof Aug 23, 2018

nicolas-grekas Aug 23, 2018

stof Aug 23, 2018

nicolas-grekas Aug 23, 2018

nicolas-grekas left a comment •

edited

Loading

stof commented Aug 23, 2018

nicolas-grekas commented Aug 23, 2018 •

edited

Loading

chalasr Aug 24, 2018

nicolas-grekas commented Aug 24, 2018

sroze commented Aug 26, 2018

chalasr commented Aug 26, 2018

fabpot left a comment

fabpot Aug 27, 2018

fabpot Aug 27, 2018

sroze commented Aug 27, 2018

fabpot commented Aug 28, 2018

TomasVotruba commented Sep 2, 2018

javiereguiluz commented Sep 7, 2018

[FrameworkBundle] Deprecate Symfony\Bundle\FrameworkBundle\Controller\Controller #28243

[FrameworkBundle] Deprecate Symfony\Bundle\FrameworkBundle\Controller\Controller #28243

Conversation

sroze commented Aug 22, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment • edited Loading

Choose a reason for hiding this comment

stof commented Aug 23, 2018

nicolas-grekas commented Aug 23, 2018 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas commented Aug 24, 2018

sroze commented Aug 26, 2018

chalasr commented Aug 26, 2018

fabpot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze commented Aug 27, 2018

fabpot commented Aug 28, 2018

TomasVotruba commented Sep 2, 2018

javiereguiluz commented Sep 7, 2018

[FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` #28243

[FrameworkBundle] Deprecate `Symfony\Bundle\FrameworkBundle\Controller\Controller` #28243

sroze commented Aug 22, 2018 •

edited

Loading

nicolas-grekas left a comment •

edited

Loading

nicolas-grekas commented Aug 23, 2018 •

edited

Loading