Deprecate ClassCollectionLoader and Kernel::loadClassCache #20735

dbrumann · 2016-12-03T10:57:47Z

Q	A
Branch?	"master"
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#20668
License	MIT

As suggested by @nicolas-grekas in #20668 I added deprecation notices to ClassCollectionLoader and Kernel::loadClassCache.

fabpot · 2016-12-03T11:42:54Z

src/Symfony/Component/HttpKernel/Kernel.php

     */
    public function loadClassCache($name = 'classes', $extension = '.php')
    {
+        @trigger_error('loadClassCache() is deprecated  since 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


extra space before since

fabpot · 2016-12-03T11:48:05Z

That's a good first step, but there are other parts of the code to change, like any usages of ClassCollectionLoader like in ClassCacheCacheWarmer.

fabpot · 2016-12-03T11:55:42Z

The ClassCacheCacheWarmer should be deprecated as well, and the same goes for Kernel::setClassCache().

The Symfony\Component\HttpKernel\DependencyInjection\Extension::addClassesToCompile() method should also be deprecated.

dbrumann · 2016-12-03T14:32:27Z

I still have some issues in functional tests probably related to deprecating ClassCacheWarmer (see AppVeyor results). For instance I assume that I have to adjust FrameworkBundle's AddCacheWarmerPass to exclude kernel.class_cache.cache_warmer when PHP 7.x is being used?

Another question that remains for me is how we will address deprecation warnings in tests for php versions lower than PHP 7 as these should still use the depreacted class cache. I don't think it's practical to annotate these tests with @group legacy. @nicolas-grekas maybe you have an advice how to approach this?

fabpot · 2016-12-04T07:41:27Z

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

@@ -531,6 +542,10 @@ private function registerRouterConfiguration(array $config, ContainerBuilder $co
        $container->setParameter('request_listener.http_port', $config['http_port']);
        $container->setParameter('request_listener.https_port', $config['https_port']);

+        if (PHP_VERSION_ID >= 7000 || !method_exists($this, 'addClassesToCompile')) {
+            return;
+        }


I would wrap the next call instead of returning early here to make the intent clear.

nicolas-grekas · 2016-12-06T11:02:27Z

src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ClassCacheCacheWarmer.php

 use Symfony\Component\ClassLoader\ClassCollectionLoader;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;

 /**
 * Generates the Class Cache (classes.php) file.
 *
 * @author Tugdual Saunier <[email protected]>
+ *
+ * @deprecated Deprecated since version 3.3, to be removed in 4.0.


~~Deprecated~~

stof · 2016-12-06T11:05:33Z

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

@@ -71,6 +72,12 @@ public function load(array $configs, ContainerBuilder $container)

        $loader->load('web.xml');
        $loader->load('services.xml');
+
+        if (PHP_VERSION_ID < 70000) {


this will still trigger a deprecation warning for PHP 5.6 users. Do we want it ?

stof · 2016-12-06T11:05:52Z

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

-            // 'Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle',
-        ));
+        if (PHP_VERSION_ID < 70000) {
+            $this->addClassesToCompile(array(


same here about deprecation warnings

stof · 2016-12-06T11:07:01Z

Kernel::addAnnotatedClassesToCompile must also be deprecated

nicolas-grekas · 2016-12-06T11:07:38Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml

@@ -34,6 +33,7 @@
                <argument>Symfony\Component\ClassLoader\ClassCollectionLoader</argument>


you should remove this line

nicolas-grekas · 2016-12-06T11:08:47Z

src/Symfony/Component/ClassLoader/ClassCollectionLoader.php

 /**
 * ClassCollectionLoader.
 *
 * @author Fabien Potencier <[email protected]>
+ *
+ * @deprecated Deprecated since version 3.3, to be removed in 4.0.


@deprecated since version 3.3, to be removed in 4.0. (same below: no need to duplicate the "deprecated" word)

stof · 2016-12-06T11:09:19Z

@nicolas-grekas can you reproduce your benchmark on PHP 5.6 as well ? I would really prefer to stop using it for all PHP versions rather than keeping usage of deprecated APIs in the core on PHP 5.6 (which would mean that users cannot get rid of deprecation warnings)

nicolas-grekas · 2016-12-06T11:10:33Z

src/Symfony/Component/HttpKernel/Kernel.php

     */
    public function loadClassCache($name = 'classes', $extension = '.php')
    {
+        @trigger_error('loadClassCache() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


The Kernel::loadClassCache() method ... (same below and above)

xabbuh · 2016-12-06T11:11:47Z

We could think about triggering the deprecations on PHP < 7.0 (or maybe < 5.6) only. Besides that we have to realise that Symfony 4.0 will have to drop support for PHP versions < 7.0 (or < 5.6 if the benchmark turns out to be promising for it too). Otherwise the deprecations wouldn't make much sense.

nicolas-grekas · 2016-12-06T11:11:57Z

Kernel::addAnnotatedClassesToCompile must also be deprecated

I don't think so. Why?

stof · 2016-12-06T11:13:21Z

@nicolas-grekas isn't it part of the same feature set ?

nicolas-grekas · 2016-12-06T11:42:13Z

@xabbuh do you mean triggering them on PHP >= 7.0? That's a good idea! Moving to 4.0 is going to require moving to PHP 7 before so it really makes sense. @dbrumann can you take care of that also please?

@stof Kernel::addAnnotatedClassesToCompile is especially usefull on PHP 7, so we should keep it.

stof · 2016-12-06T11:47:04Z

@nicolas-grekas have you tried the same benchmark on PHP 5.6 to see whether we could deprecate the feature for all PHP versions instead, which would be much simpler ?

Regarding addAnnotatedClassesToCompile, I was confused about what it does due to its naming: it does not compile the classes at all. These classes are just classes for which the annotation cache is warmed up.

nicolas-grekas · 2016-12-06T11:53:57Z

@stof you mean PHP 5.5 (our lowest supported version?) I didn't check but the optims that allow PHP7 to be faster do not exists on 5.5 so I'm pretty sure inlining still wins on 5.5.

About addAnnotatedClassesToCompile, you're right.

stof · 2016-12-06T11:56:23Z

hmm yeah, I forgot the lowest bound in 5.5.9, not 5.6.
Would still be good to know what happens on 5.6 (which has the composer classmap optimization).
If we only need it for PHP 5.5, we might stop using the deprecated feature for it IMO, as PHP 5.5 is already EOLed (and people really caring about such autoloading performance improvement should update to 5.6+ to have the composer optims)

derrabus · 2016-12-06T21:09:05Z

@stof I would not want to give php 5.5 users a sudden performance penalty just because we don't like that feature anymore. People who are pinned to php 5.5 (for whatever reason) are thankful for optimizations like this one.

dbrumann · 2016-12-11T09:03:17Z

@xabbuh and @nicolas-grekas is there already a way to trigger deprecation warnings conditionally? If not, what would be the best way to go about it?

@stof we had the discussion about performance penalty on older php versions during the SymfonyCon hackday and consensus seemed to be that we should avoid it.

nicolas-grekas · 2016-12-11T09:58:56Z

This would be the first time, but it should be just a matter of wrapping the deprecation in a check against PHP_VERSION_ID as you already did in other places.
For php 5.5, I don't have recent numbers, but I saw several benchs that demonstrated the benefit of inlining, so we should keep it I agree.

nicolas-grekas · 2016-12-11T10:03:36Z

I don't have 5.6 anymore so if someone could give it a try, please do.

nicolas-grekas · 2016-12-11T10:07:55Z

src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php

     */
    public function addClassesToCompile(array $classes)
    {
+        @trigger_error('Extension::loadClassCache() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


Fqcn, + wrong method name, isn't it?

nicolas-grekas · 2016-12-11T10:08:35Z

src/Symfony/Component/HttpKernel/Kernel.php

 use Symfony\Component\HttpKernel\DependencyInjection\AddClassesToCachePass;
+use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;


No reorder, to save us some merge conflicts

nicolas-grekas · 2016-12-11T10:08:47Z

src/Symfony/Component/HttpKernel/Kernel.php

     */
    public function loadClassCache($name = 'classes', $extension = '.php')
    {
+        @trigger_error('Kernel::loadClassCache() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


nicolas-grekas · 2016-12-11T10:09:14Z

src/Symfony/Component/HttpKernel/Kernel.php

     */
    public function setClassCache(array $classes)
    {
+        @trigger_error('Kernel::setClassCache() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


nicolas-grekas · 2016-12-11T10:09:27Z

src/Symfony/Component/HttpKernel/Kernel.php

    protected function doLoadClassCache($name, $extension)
    {
+        @trigger_error('Kernel::doLoadClassCache() is deprecated since version 3.3, to be removed in 4.0.', E_USER_DEPRECATED);


…ann) This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #7243). Discussion ---------- Removes duplicated Deprecated and adds an example. Removes the duplicate "Deprecated" after `@deprecated` annotation as was asked in my PR symfony/symfony#20735. Also adds a randomly selected example that shows how the abstract `XXX` should look like and an edge case of `trigger_error()` when deprecating a whole class. Commits ------- a2c04e7 Deletes duplicate "Deprecated" and adds a more explicit example.

nicolas-grekas · 2017-01-06T13:46:01Z

👍

fabpot · 2017-01-06T15:22:14Z

Thank you @dbrumann.

@nicolas-grekas

…ache (dbrumann) This PR was merged into the 3.3-dev branch. Discussion ---------- Deprecate ClassCollectionLoader and Kernel::loadClassCache | Q | A | ------------- | --- | Branch? | "master" | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #20668 | License | MIT As suggested by @nicolas-grekas in #20668 I added deprecation notices to ClassCollectionLoader and Kernel::loadClassCache. Commits ------- 660d79a Deprecates ClassCache-cache warmer.

…oCompile() / AddClassesToCachePass (nicolas-grekas) This PR was merged into the 3.3-dev branch. Discussion ---------- [HttpKernel] Fix deprecation of Extension::addClassesToCompile() / AddClassesToCachePass | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - As done in #20735 Commits ------- f4b5784 [HttpKernel] Fix deprecation of Extension::addClassesToCompile() / AddClassesToCachePass

…oCompile() / AddClassesToCachePass (nicolas-grekas) This PR was merged into the 3.3-dev branch. Discussion ---------- [HttpKernel] Fix deprecation of Extension::addClassesToCompile() / AddClassesToCachePass | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - As done in symfony/symfony#20735 Commits ------- f4b5784 [HttpKernel] Fix deprecation of Extension::addClassesToCompile() / AddClassesToCachePass

… & Kernel::loadClassCache (ogizanagi, xabbuh) This PR was merged into the 4.0-dev branch. Discussion ---------- [ClassLoader][HttpKernel] Remove ClassLoader component & Kernel::loadClassCache | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? |no | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20735 | License | MIT | Doc PR | N/A As deprecated in #20735 Commits ------- 551aaef [ClassLoader] remove the component 4f8916c [ClassLoader][HttpKernel] Remove ClassCollectionLoader & Kernel::loadClassCache BC layer

carsonbot added Status: Needs Review Deprecation labels Dec 3, 2016

dbrumann changed the title ~~#20668 Deprecate ClassCollectionLoader and Kernel::loadC…~~ Deprecate ClassCollectionLoader and Kernel::loadClassCache Dec 3, 2016

fabpot reviewed Dec 3, 2016

View reviewed changes

fabpot reviewed Dec 4, 2016

View reviewed changes

nicolas-grekas reviewed Dec 6, 2016

View reviewed changes

stof reviewed Dec 6, 2016

View reviewed changes

nicolas-grekas reviewed Dec 6, 2016

View reviewed changes

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

dbrumann mentioned this pull request Dec 11, 2016

Removes duplicated Deprecated and adds an example. symfony/symfony-docs#7243

Closed

nicolas-grekas reviewed Dec 11, 2016

View reviewed changes

Deprecates ClassCache-cache warmer.

660d79a

nicolas-grekas modified the milestones: 3.3, 3.x Jan 6, 2017

fabpot merged commit 660d79a into symfony:master Jan 6, 2017

javiereguiluz mentioned this pull request Jan 8, 2017

ClassCollectionLoader and Kernel::loadClassCache are now deprecated symfony/symfony-docs#7337

Closed

core23 mentioned this pull request Jan 23, 2017

Road to Sonata 4 sonata-project/dev-kit#216

Closed

dbrumann mentioned this pull request Feb 4, 2017

How to improve performance of your Symfony application symfony-cat/cfp-2017#12

Closed

kbond mentioned this pull request Mar 23, 2017

Don't call Extension::addClassesToCompile() on php versions greater than 7 schmittjoh/JMSI18nRoutingBundle#202

Merged

nicolas-grekas mentioned this pull request Apr 17, 2017

[HttpKernel] Fix deprecation of Extension::addClassesToCompile() / AddClassesToCachePass #22459

Merged

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

ogizanagi mentioned this pull request May 19, 2017

[ClassLoader][HttpKernel] Remove ClassLoader component & Kernel::loadClassCache #22786

Merged

acrobat mentioned this pull request Sep 5, 2017

Don't call Extension::addClassesToCompile() on php versions greater than 7 sonata-project/SonataPageBundle#862

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate ClassCollectionLoader and Kernel::loadClassCache #20735

Deprecate ClassCollectionLoader and Kernel::loadClassCache #20735

dbrumann commented Dec 3, 2016

fabpot Dec 3, 2016

fabpot commented Dec 3, 2016

fabpot commented Dec 3, 2016

dbrumann commented Dec 3, 2016

fabpot Dec 4, 2016

nicolas-grekas Dec 6, 2016

stof Dec 6, 2016

stof Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas Dec 6, 2016

nicolas-grekas Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas Dec 6, 2016 •

edited

Loading

xabbuh commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

derrabus commented Dec 6, 2016 •

edited

Loading

dbrumann commented Dec 11, 2016

nicolas-grekas commented Dec 11, 2016

nicolas-grekas commented Dec 11, 2016

nicolas-grekas Dec 11, 2016

nicolas-grekas Dec 11, 2016

nicolas-grekas Dec 11, 2016

nicolas-grekas Dec 11, 2016

nicolas-grekas Dec 11, 2016

nicolas-grekas commented Jan 6, 2017

fabpot commented Jan 6, 2017

		@@ -34,6 +33,7 @@
		<argument>Symfony\Component\ClassLoader\ClassCollectionLoader</argument>

		use Symfony\Component\HttpKernel\DependencyInjection\AddClassesToCachePass;
		use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;

Deprecate ClassCollectionLoader and Kernel::loadClassCache #20735

Deprecate ClassCollectionLoader and Kernel::loadClassCache #20735

Conversation

dbrumann commented Dec 3, 2016

Choose a reason for hiding this comment

fabpot commented Dec 3, 2016

fabpot commented Dec 3, 2016

dbrumann commented Dec 3, 2016

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

stof commented Dec 6, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Dec 6, 2016

nicolas-grekas Dec 6, 2016 • edited Loading

Choose a reason for hiding this comment

xabbuh commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

nicolas-grekas commented Dec 6, 2016

stof commented Dec 6, 2016

derrabus commented Dec 6, 2016 • edited Loading

dbrumann commented Dec 11, 2016

nicolas-grekas commented Dec 11, 2016

nicolas-grekas commented Dec 11, 2016

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 commented Jan 6, 2017

fabpot commented Jan 6, 2017

nicolas-grekas Dec 6, 2016 •

edited

Loading

derrabus commented Dec 6, 2016 •

edited

Loading