[Debug] Trigger a deprecation for new parameters not defined in sub classes #28329

GuilhemN · 2018-08-31T14:51:48Z

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

I'm not sure the way #28316 is implemented is the best so here is an alternative.
Instead of counting on a call from the child method, it uses the DebugClassLoader and @param annotations. If a @param annotation is used on a parent but is then not actually implemented in the child class, a deprecation will be thrown.

Example:

class ClassWithAnnotatedParameters
{
    /**
     * @param string $foo This is a foo parameter.
     */
    public function fooMethod(string $foo)
    {
    }

    /**
     * @param string $bar parameter not implemented yet
     */
    public function barMethod(/** string $bar = null */)
    {
    }


    /**
     * @param Quz $quz parameter not implemented yet
     */
    public function quzMethod(/** Quz $quz = null */)
    {
    }
}

class SubClassWithAnnotatedParameters extends ClassWithAnnotatedParameters {
    public function fooMethod(string $foo) { }
    public function barMethod($bar = null) { }
    public function quzMethod() { }
}

A deprecation will be triggered because SubClassWithAnnotatedParameters::quzMethod() which doesn't definee $quz.

GuilhemN · 2018-08-31T14:55:54Z

src/Symfony/Component/Debug/DebugClassLoader.php

-                        if (\strncmp($ns, $declaringClass, $len)) {
-                            @trigger_error(sprintf('The "%s::%s()" method is considered internal%s. It may change without further notice. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);
-                        }
+                if (isset(self::$internalMethods[$name][$method->name])) {


Unrelated change but the foreach was useless since we merge parent + traits infos a few lines above.

nicolas-grekas · 2018-08-31T15:05:03Z

We should try to enable DebugClassLoader using the phpunit bridge and see how it goes!

GuilhemN · 2018-08-31T15:42:50Z

@nicolas-grekas imo we can enable it either by updating the bridge and adding an SYMFONY_CLASS_DEBUG_LOADER env checked in its bootstrap.php or by having an autoloader dedicated to tests at the root of the symfony repository.

In both cases, it will require a consequent work to fix all deprecations (using php 7.1, I already have 2x: The "Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6" class extends "PHPUnit\Framework\BaseTestListener" that is deprecated Use TestListenerDefaultImplementation trait instead., I'm not sure we can fix it without a new class). So 👍 for enabling it but I'd say in another PR 😄

nicolas-grekas · 2018-08-31T15:58:30Z

Ok works for me :)

nicolas-grekas · 2018-09-08T22:26:55Z

@GuilhemN FYI I push-forced on your fork after squashing the CS commit. See also the 2nd commit I added: it enables DebugClassLoader from the PhpUnitBridge and it fixes a few issues found while doing so.

nicolas-grekas · 2018-09-08T22:28:34Z

src/Symfony/Component/Debug/DebugClassLoader.php


 namespace Symfony\Component\Debug;

+use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;


related to sebastianbergmann/phpunit-mock-objects#427

nicolas-grekas · 2018-09-08T22:31:21Z

src/Symfony/Component/HttpFoundation/Response.php

     *
     * @see http://tools.ietf.org/html/rfc2616#section-10.3.5
-     *
-     * @final


Required because StreamedResponse overrides this method. Otherwise, we'll see The "Symfony\Component\HttpFoundation\Response::setNotModified()" method is considered final. It may change without further notice as of its next major version. You should not extend it from "Symfony\Component\HttpFoundation\StreamedResponse". as e.g. in https://travis-ci.org/symfony/symfony/jobs/426209061

(to be discussed; there might be other solutions than this one, wdyt?)

We could ignore @final annotations from the same namespace like we do for @deprecated but imo this is not worth it and maybe we even don't want this behavior

GuilhemN · 2018-09-08T23:37:12Z

👍 thanks for doing these changes, I hope your second commit will help symfony keep a clean codebase :)

nicolas-grekas

With this PR, DebugClassLoader will trigger a deprecation whenever a child method doesn't declare an argument while its parent does so via an @param annotation. This provides a forward path to adding new arguments to methods of base classes/interfaces in next major versions.

nicolas-grekas · 2018-09-09T09:47:52Z

phpunit-bridge part split in #28412

GuilhemN · 2018-09-09T12:25:56Z

src/Symfony/Component/Debug/DebugClassLoader.php

            self::$finalMethods[$name] = array();
            self::$internalMethods[$name] = array();
+            self::$annotatedParameters[$name] = array();
            foreach ($parentAndTraits as $use) {


Do we want to support @param in interfaces (imo yes)? If so we should add a separate foreach to inherit annotatedParameters.

yep we want to report @param added to interfaces for sure

GuilhemN · 2018-09-09T12:28:35Z

src/Symfony/Component/Debug/DebugClassLoader.php

                }

-                // Method from a trait
-                if ($method->getFilename() !== $refl->getFileName()) {


This should be kept imo, I think we also don't want methods from traits being checked against their own @param annotations.

worth a new test case :)
we also want to report implementations provided by traits that don't provide the argument declared by parents
and also to report missing arguments declared by @param on traits

we also want to report implementations provided by traits that don't provide the argument declared by parents

👍, you were right about this change.

and also to report missing arguments declared by @param on traits

Thinking of it again, I prefer not parsing @param in traits directly since PHP allows a full overwriting of their methods, instead their methods are checked as if they belong to the sub classes using them.

…colas-grekas) This PR was merged into the 4.2-dev branch. Discussion ---------- [PhpUnitBridge] enable DebugClassLoader by default | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#10360 With this PR, the phpunit-bridge will enable `DebugClassLoader` by default, making it do its job: throw deprecation notices at autoloading time. On top of #28329, this made me spot some glitches in the code base, fixed here also. This can be disabled by configuring the listener in `phpunit.xml.dist` files, adding `<element key="debug-class-loader"><integer>0</integer></element>` next to `<element key="time-sensitive">...`. Commits ------- 2fb11fc [PhpUnitBridge] enable DebugClassLoader by default

nicolas-grekas · 2018-09-19T17:37:04Z

src/Symfony/Component/Debug/DebugClassLoader.php

            self::$annotatedParameters[$name] = array();
-            foreach ($parentAndTraits as $use) {
-                foreach (array('finalMethods', 'internalMethods', 'annotatedParameters') as $property) {
+            foreach (array(


the CS is a bit weird here, better move the array in some local var

nicolas-grekas · 2018-09-19T17:39:02Z

Could you please rebase (+squash) while fixing the small comment above to trigger tests?
There are some failures we need to take care of.

…lasses

nicolas-grekas · 2018-09-21T16:04:45Z

Thank you @GuilhemN.

@param

…efined in sub classes (GuilhemN) This PR was merged into the 4.2-dev branch. Discussion ---------- [Debug] Trigger a deprecation for new parameters not defined in sub classes | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #28316 | License | MIT | Doc PR | - I'm not sure the way #28316 is implemented is the best so here is an alternative. Instead of counting on a call from the child method, it uses the `DebugClassLoader` and `@param` annotations. If a `@param` annotation is used on a parent but is then not actually implemented in the child class, a deprecation will be thrown. Example: ```php class ClassWithAnnotatedParameters { /** * @param string $foo This is a foo parameter. */ public function fooMethod(string $foo) { } /** * @param string $bar parameter not implemented yet */ public function barMethod(/** string $bar = null */) { } /** * @param Quz $quz parameter not implemented yet */ public function quzMethod(/** Quz $quz = null */) { } } ``` ```php class SubClassWithAnnotatedParameters extends ClassWithAnnotatedParameters { public function fooMethod(string $foo) { } public function barMethod($bar = null) { } public function quzMethod() { } } ``` A deprecation will be triggered because ``SubClassWithAnnotatedParameters::quzMethod()`` which doesn't definee `$quz`. Commits ------- 1f5d8b6 [Debug] Trigger a deprecation for new parameters not defined in sub classes

GuilhemN · 2018-09-21T19:44:28Z

Thank you, you've made a significant part (most? 😅) of this PR :)

GuilhemN mentioned this pull request Aug 31, 2018

Trigger deprecation notices when inherited class calls parent method but misses adding new arguments #28316

Merged

GuilhemN commented Aug 31, 2018

View reviewed changes

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

GuilhemN force-pushed the newparams branch from 3a63ad2 to fdc2197 Compare August 31, 2018 14:57

GuilhemN force-pushed the newparams branch 2 times, most recently from 7fd5331 to 57d935a Compare August 31, 2018 15:46

nicolas-grekas changed the title ~~Trigger a deprecation for new parameters not defined in sub classes~~ [Debug] Trigger a deprecation for new parameters not defined in sub classes Sep 2, 2018

nicolas-grekas added Feature Debug labels Sep 2, 2018

nicolas-grekas force-pushed the newparams branch 2 times, most recently from 623ebe7 to f69ec6f Compare September 8, 2018 22:24

nicolas-grekas reviewed Sep 8, 2018

View reviewed changes

nicolas-grekas force-pushed the newparams branch from f69ec6f to 7ef91b9 Compare September 8, 2018 22:29

nicolas-grekas reviewed Sep 8, 2018

View reviewed changes

nicolas-grekas force-pushed the newparams branch from 7ef91b9 to c8fdf03 Compare September 9, 2018 09:31

nicolas-grekas approved these changes Sep 9, 2018

View reviewed changes

carsonbot added the Status: Reviewed label Sep 9, 2018

nicolas-grekas mentioned this pull request Sep 9, 2018

[PhpUnitBridge] enable DebugClassLoader by default #28412

Merged

GuilhemN commented Sep 9, 2018

View reviewed changes

nicolas-grekas reviewed Sep 19, 2018

View reviewed changes

nicolas-grekas force-pushed the newparams branch 2 times, most recently from 7cef7f2 to c03d5a1 Compare September 21, 2018 15:50

[Debug] Trigger a deprecation for new parameters not defined in sub c…

1f5d8b6

…lasses

nicolas-grekas force-pushed the newparams branch from c03d5a1 to 1f5d8b6 Compare September 21, 2018 15:50

nicolas-grekas approved these changes Sep 21, 2018

View reviewed changes

nicolas-grekas merged commit 1f5d8b6 into symfony:master Sep 21, 2018

GuilhemN deleted the newparams branch September 21, 2018 19:40

nicolas-grekas mentioned this pull request Sep 21, 2018

[symfony/debug] ...MicroKernelTrait::loadRoutes()" method is considered internal... #28549

Closed

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


		namespace Symfony\Component\Debug;

		use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;

Uh oh!

[Debug] Trigger a deprecation for new parameters not defined in sub classes #28329

[Debug] Trigger a deprecation for new parameters not defined in sub classes #28329

Uh oh!

Conversation

GuilhemN commented Aug 31, 2018 • edited by nicolas-grekas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Aug 31, 2018

Uh oh!

GuilhemN commented Aug 31, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Aug 31, 2018

Uh oh!

nicolas-grekas commented Sep 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuilhemN commented Sep 8, 2018

Uh oh!

nicolas-grekas left a comment

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Sep 9, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Sep 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuilhemN Sep 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Sep 19, 2018

Uh oh!

nicolas-grekas commented Sep 21, 2018

Uh oh!

GuilhemN commented Sep 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GuilhemN commented Aug 31, 2018 •

edited by nicolas-grekas

Loading

GuilhemN commented Aug 31, 2018 •

edited

Loading

nicolas-grekas commented Sep 8, 2018 •

edited

Loading

nicolas-grekas Sep 9, 2018 •

edited

Loading

GuilhemN Sep 12, 2018 •

edited

Loading

GuilhemN commented Sep 21, 2018 •

edited

Loading