[DI] Implement PSR-11 #21265

greg0ire · 2017-01-12T22:31:02Z

TODO:

wait for a stable version of the psr/container package;
~~deprecate instanciating ServiceNotFoundException directly, or using any of its methods directly;~~ not relevant anymore
act on the outcome of Interface suffix? php-fig/container#8 (solved in Suffix interfaces with "Interface" php-fig/container#9) ;
solve the mandatory NotFoundExceptionInterface on non-existing service
problem (with a flag ?); non-issue, see comments below
provide meta-package psr/container-implementation if all problems can
be solved.

Q	A
Branch?	master
New feature?	yes
BC breaks?	not at the moment
Tests pass?	didn't pass before pushing, or even starting to code, will see Travis
License	MIT
Doc PR	TODO

This PR is a first attempt at implementing PSR-11, or at least trying to get closer to it.
Delegate lookup is optional, and thus not implemented for now.

greg0ire · 2017-01-12T22:33:42Z

src/Symfony/Component/DependencyInjection/ContainerInterface.php

@@ -21,7 +22,7 @@
 * @author Fabien Potencier <[email protected]>
 * @author Johannes M. Schmitt <[email protected]>
 */
-interface ContainerInterface
+interface ContainerInterface extends PsrContainerInterface


I chose to have ContainerInterface extend PsrContainerInterface, so that any interface is marked as psr-compliant. Not sure it is the right thing to do though, because php cannot enforce all the contracts defined in the interface docs (like what exception to throw when). Tell me if you feel I should remove this and add implements ContainerInterface in the main implementation.

If it works for PHP, fine.

that basically means in whole framework you will not use Psr version, but Symfony version.
Then, one will be able to use concrete class that implements Symfony version as parameter for method expecting Psr version, but not the other way around. So, if I will have some package that follows Psr, I won't be able to use it directly in Symfony project, because everywhere the framework will require Symfony version instead

everywhere the framework will require Symfony

Not sure I get what you mean, but IMO once this is merged, we should hunt for the Symfony version everywhere, see what calls are made there, and if we can replace use Psr version as type hinting there.

@greg0ire without breaking BC, with the benefit of reducing the feature-set for the shake of PSR11 compliance? I doubt this is ever going to happen...

@jvasseur yes it does
the issue is that $foo instanceof A implies that calling $foo->test($anotherInstanceOfA) is allowed.
Since $anInstanceofB instanceof A, calling $anInstanceofB->test($anotherInstanceOfAButNotB) must thus be allowed.

So… I found a bug in php?

It's a know limitation of the PHP engine : https://bugs.php.net/bug.php?id=69612#1431343525

But your example is wrong anyway, functions parameters could be contravariant (they are invariant in PHP) meaning they can accept a wider type. In your example they are covariant instead.

Oh you're right, my logic was wrong indeed! Which means this would indeed be a BC-break, sorry I got confused.

greg0ire · 2017-01-12T22:35:43Z

src/Symfony/Component/DependencyInjection/Exception/InvalidArgumentException.php

 /**
 * Base InvalidArgumentException for Dependency Injection component.
 *
 * @author Bulat Shakirzyanov <[email protected]>
 */
-class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
+class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface, ContainerException


EnvNotFound extends this exception, so no need to add implementation declaration in it.

greg0ire · 2017-01-12T22:42:22Z

About "the mandatory NotFoundExceptionInterface on non-existing service problem", throwing an exception on missing service id is optional in the current implementation while mandatory in the PSR. How should we solve this problem? I was thinking we could deprecate the second argument of get, but can we pretend this is a valid implementation if using get with a special argument makes it no longer compliant?

Koc · 2017-01-12T22:49:42Z

src/Symfony/Component/DependencyInjection/composer.json

@@ -16,7 +16,8 @@
        }
    ],
    "require": {
-        "php": ">=5.5.9"
+        "php": ">=5.5.9",
+        "psr/container": "^1.0@dev"


add also provide section https://getcomposer.org/doc/04-schema.md#provide , like in https://github.com/Seldaek/monolog/blob/master/composer.json#L52-L54

See TODO list ;) , I'm not sure to be able to implement it perfectly, so first, let's get as close as we can without a BC-break.

Still please add it.

Looks like it should also be added to the root composer.json.

Uuuuh… it's already there, isn't it?

Indeed... I missed it 😳

Thanks for reviewing anyway :)

nicolas-grekas

There is no issue with throwing : the PSR standardize only one argument, and says to throw. Fortunately that's the default behavior so anyone using the container in the PSR11 way will have it work as expected.
When the 2nd argument is used, we're not in PSR11 anymore, thus we can behave as we want.

nicolas-grekas · 2017-01-12T23:02:02Z

src/Symfony/Component/DependencyInjection/ContainerInterface.php

@@ -21,7 +22,7 @@
 * @author Fabien Potencier <[email protected]>
 * @author Johannes M. Schmitt <[email protected]>
 */
-interface ContainerInterface
+interface ContainerInterface extends PsrContainerInterface


If it works for PHP, fine.

nicolas-grekas · 2017-01-12T23:02:28Z

src/Symfony/Component/DependencyInjection/composer.json

@@ -16,7 +16,8 @@
        }
    ],
    "require": {
-        "php": ">=5.5.9"
+        "php": ">=5.5.9",
+        "psr/container": "^1.0@dev"


Still please add it.

greg0ire · 2017-01-12T23:16:16Z

When the 2nd argument is used, we're not in PSR11 anymore

Makes sense. We can't hurt people that don't know which implementation they are using, because if they don't they will probably not risk calling get with two arguments. So it's indeed a non-issue.

soullivaneuh · 2017-01-12T23:35:59Z

composer.json

@@ -20,6 +20,7 @@
        "doctrine/common": "~2.4",
        "twig/twig": "~1.28|~2.0",
        "psr/cache": "~1.0",
+        "psr/container": "^1.0@dev",


Just reminder comment: Remove @dev annotation when the package will be stable.

Can we remove it now so that this PR is ready to be merged?

mnapoli · 2017-01-13T07:41:46Z

@greg0ire

Makes sense. We can't hurt people that don't know which implementation they are using, because if they don't they will probably not risk calling get with two arguments. So it's indeed a non-issue.

👍 the interface was designed to be compatible with Symfony's default behavior when called with the PSR signature.

greg0ire · 2017-01-13T08:12:58Z

👍 the interface was designed to be compatible with Symfony's default behavior when called with the PSR signature.

I did not read the underlying discussions for this spec but there definitely was a "well this is convenient" feeling when implementing it in Symfony 😄

dunglas · 2017-01-13T08:26:12Z

It looks only small changes are required, nice!

greg0ire · 2017-01-13T09:31:46Z

@dunglas yup, that was a breeze :)

nicolas-grekas · 2017-01-13T12:28:29Z

RuntimeException also isn't it?

nicolas-grekas · 2017-01-13T12:31:40Z

Why not make ExceptionInterface extend Psr\Container\ContainerExceptionInterface?

greg0ire · 2017-01-13T13:20:06Z

Why not make ExceptionInterface extend Psr\Container\ContainerExceptionInterface?

Only exceptions thrown directly by the container are supposed to implement this, so I only applied it to exceptions listed here

This means this is an issue doesn't it ? Should I change this line so that the exception thrown here is wrapped into another?

greg0ire · 2017-01-13T13:22:30Z

RuntimeException also isn't it?

Can't find it in Container.php, so no.

nicolas-grekas · 2017-01-13T13:28:07Z

In fact, it can, see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php#L601

nicolas-grekas · 2017-01-13T13:29:56Z

And https://github.com/symfony/symfony/blob/master/src/Symfony/Component/DependencyInjection/ContainerBuilder.php#L858

nicolas-grekas · 2017-01-13T13:30:33Z

And https://github.com/symfony/symfony/blob/master/src/Symfony/Component/DependencyInjection/ContainerBuilder.php#L374

nicolas-grekas · 2017-01-13T13:31:12Z

I suggest to play simpe here. We don't care to add the interface on all exceptions. This wouldn't hurt.

greg0ire · 2017-01-13T13:47:32Z

In fact, it can, see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php#L601

Yeah but :

Exceptions directly thrown by the container

What does "directly" mean here?

nicolas-grekas · 2017-01-13T13:50:10Z

I don't know in fact, and that's a good question!
But throwing this exception in other cases is not going to make things not-PSR11 compliant. It just wouldn't be a normalized use case. Fine, nothing broken.
I showed you that in fact, via ContainerBuilder, there is a much greater variety of exceptions that can be thrown out there.

greg0ire · 2017-01-13T13:51:21Z

Very true, plus, less code, so… I'll change that. @mnapoli , can you advise about the meaning of "directly" here though? You know, for science?

greg0ire · 2017-01-13T14:02:44Z

There. The diff is tiny now :)

greg0ire · 2017-01-13T14:03:50Z

This means this is an issue doesn't it ? Should I change this line so that the exception thrown here is wrapped into another?

@nicolas-grekas what about this? Any thoughts?

dunglas · 2017-02-08T11:56:04Z

👍

javiereguiluz

👍

fabpot · 2017-02-08T15:52:40Z

Thank you @greg0ire.

This PR was merged into the 3.3-dev branch. Discussion ---------- [DI] Implement PSR-11 TODO: - [x] wait for a stable version of the psr/container package; - [x] ~~deprecate instanciating ServiceNotFoundException directly, or using any of its methods directly;~~ not relevant anymore - [x] act on the outcome of php-fig/container#8 (solved in php-fig/container#9) ; - [x] ~~solve the mandatory NotFoundExceptionInterface on non-existing service problem (with a flag ?);~~ non-issue, see comments below - [x] provide meta-package psr/container-implementation if all problems can be solved. | Q | A | ------------- | --- | Branch? | master | New feature? | yes | BC breaks? | not at the moment | Tests pass? | didn't pass before pushing, or even starting to code, will see Travis | License | MIT | Doc PR | TODO This PR is a first attempt at implementing PSR-11, or at least trying to get closer to it. Delegate lookup is optional, and thus not implemented for now. Commits ------- bde0efd Implement PSR-11

greg0ire · 2017-02-08T15:59:25Z

Thanks for merging!

allflame · 2017-06-07T10:01:16Z

Can you please consider BC breaks not only with respect to "implementation" but also to "declaration"?
This is how it was before:

interface I1 {} 
interface I2 {}
class C1 implements I1, I2 {}

And that's what happened:

interface I1 extends I2 {};
Class C1 implements I1, I2 -> Fatal Error

Your interfaces are your burden as much as your implementation.

greg0ire · 2017-06-07T10:24:32Z

@allflame can't reproduce : https://3v4l.org/gNuOY

jvasseur · 2017-06-07T10:28:52Z

@greg0ire you have to change the order of the implemented interfaces : https://3v4l.org/032Sk

It's a know PHP bug.

EDIT: here is the bugs.php.net reference : https://bugs.php.net/bug.php?id=63816

greg0ire · 2017-06-07T10:30:57Z

Oh ok... well sorry, but I didn't know that bug.

xabbuh · 2017-06-08T06:28:22Z

Which class should be affected by that? This PR did not change any class to implement two interfaces, did it?

greg0ire · 2017-06-08T07:15:29Z

@xabbuh classes outside Symfony that happen to implement ContainerInterfaceand PsrContainerInterface (not sure what order is buggy but one of them is)

xabbuh · 2017-06-08T07:56:40Z

Hm yeah, nothing we can account for here. This needs to be changed in those projects or fixed in PHP.

allflame · 2017-06-08T08:26:30Z

@xabbuh this "bug" is like 5 years old and since it just a consequence of OOP implementation in PHP it won't likely be "fixed" for another 5 years. My message here is the following: changes in "contracts/definitions" (that is interfaces, inheritance, function declaration etc) have way more potential to break things than changes in the "implementation" (e.g. actual code)
And one thing that you didn't know about PHP behavior and made that change - that's fine, but if you are aiming for BC in minor release - you cannot make statements like that, knowing this will break things (for whatever reasons)

stof · 2017-06-08T09:42:43Z

Well, this means that we would have to avoid providing a PSR-11 compliant container because someone might have already built an external project implementing both PSR-11 and our interface ? This means we would never be able to implement PSR on existing code outside major versions.

Btw, our BC promise explicitly mentions that we don't ensure BC if you add new methods in a child class (as this would then forbid us to add any method in our existing classes due to potential signature mismatches for the child class using the name already). Adding extra interfaces on the class generally involve adding such method (PSR-11 actually may not need it though)

allflame · 2017-06-08T10:51:28Z

@stof Yes, this is what software versioning, BC and PHP imply.
The code snippet I've provided has no child classes and I don't understand why you mentioned it here. The real cause was adding extra interfaces to interface which introduced incompatibility. I'll let you figure out why this differs so much with your classes example.

stof · 2017-06-08T12:24:16Z

Well, are you actually implementing the Symfony ContainerInterface from scratch without using our base classes ?

allflame · 2017-06-08T12:44:03Z

No, of course not.
My personal belief is that most Symfony code is very good to use as is, that's why I'm using it in other frameworks trying to substitute their classes.
Original piece of code was like this:
https://github.com/allflame/vain-phalcon/blob/v0.4.104/src/Di/Symfony/SymfonyContainerAdapter.php#L26
This has to be done, because part of the framework depends on PhalconInterface, Symfony on its own depends on SymfonyInterface and the whole application is container-agnostic (well, up to PSR-11), hence PsrInterface.
And that's when this commit backfired.

greg0ire commented Jan 12, 2017

View reviewed changes

greg0ire force-pushed the implement_psr_11 branch from 9adc7ca to 0d62fdc Compare January 12, 2017 22:45

Koc reviewed Jan 12, 2017

View reviewed changes

nicolas-grekas reviewed Jan 12, 2017

View reviewed changes

greg0ire force-pushed the implement_psr_11 branch from 0d62fdc to f8bf6ea Compare January 12, 2017 23:10

greg0ire force-pushed the implement_psr_11 branch from f8bf6ea to 00a8126 Compare January 12, 2017 23:17

soullivaneuh suggested changes Jan 12, 2017

View reviewed changes

greg0ire force-pushed the implement_psr_11 branch from 00a8126 to 62c61ef Compare January 13, 2017 09:30

greg0ire changed the title ~~Implement PSR-11~~ [DI] Implement PSR-11 Jan 13, 2017

greg0ire force-pushed the implement_psr_11 branch from 62c61ef to ff1b247 Compare January 13, 2017 14:00

dunglas approved these changes Feb 8, 2017

View reviewed changes

javiereguiluz approved these changes Feb 8, 2017

View reviewed changes

fabpot merged commit bde0efd into symfony:master Feb 8, 2017

greg0ire deleted the implement_psr_11 branch February 8, 2017 15:57

Haehnchen mentioned this pull request Feb 8, 2017

[DIC] Implement support for PSR-11 containers Haehnchen/idea-php-symfony2-plugin#867

Closed

Jean85 mentioned this pull request Feb 9, 2017

[PSR-11] simplify implementors and consumers list php-fig/fig-standards#883

Merged

javiereguiluz mentioned this pull request Feb 12, 2017

Symfony containers are now PSR-11 compatible symfony/symfony-docs#7467

Closed

hannesvdvreken mentioned this pull request Feb 16, 2017

PSR-11 (ContainerInterface) thephpleague/container#122

Closed

chalasr mentioned this pull request Mar 7, 2017

[PSR-11] Add Symfony & Twig to implementers/consumers php-fig/fig-standards#898

Closed

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

[DI] Implement PSR-11 #21265

[DI] Implement PSR-11 #21265

Conversation

greg0ire commented Jan 12, 2017 • 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

nicolas-grekas Jan 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvasseur Jan 13, 2017 • 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

greg0ire commented Jan 12, 2017 • edited Loading

Choose a reason for hiding this comment

greg0ire Jan 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuilhemN Jan 14, 2017 • 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

nicolas-grekas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg0ire commented Jan 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mnapoli commented Jan 13, 2017

greg0ire commented Jan 13, 2017

dunglas commented Jan 13, 2017

greg0ire commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

greg0ire commented Jan 13, 2017 • edited Loading

greg0ire commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017

greg0ire commented Jan 13, 2017

nicolas-grekas commented Jan 13, 2017 • edited Loading

greg0ire commented Jan 13, 2017 • edited Loading

greg0ire commented Jan 13, 2017

greg0ire commented Jan 13, 2017

dunglas commented Feb 8, 2017

javiereguiluz left a comment

Choose a reason for hiding this comment

fabpot commented Feb 8, 2017

greg0ire commented Feb 8, 2017

allflame commented Jun 7, 2017 • edited Loading

greg0ire commented Jun 7, 2017 • edited Loading

jvasseur commented Jun 7, 2017 • edited Loading

greg0ire commented Jun 7, 2017

xabbuh commented Jun 8, 2017

greg0ire commented Jun 8, 2017

xabbuh commented Jun 8, 2017

allflame commented Jun 8, 2017

stof commented Jun 8, 2017

allflame commented Jun 8, 2017

stof commented Jun 8, 2017

allflame commented Jun 8, 2017 • edited Loading

greg0ire commented Jan 12, 2017 •

edited

Loading

nicolas-grekas Jan 13, 2017 •

edited

Loading

jvasseur Jan 13, 2017 •

edited

Loading

greg0ire commented Jan 12, 2017 •

edited

Loading

greg0ire Jan 12, 2017 •

edited

Loading

GuilhemN Jan 14, 2017 •

edited

Loading

nicolas-grekas left a comment •

edited

Loading

greg0ire commented Jan 12, 2017 •

edited

Loading

greg0ire commented Jan 13, 2017 •

edited

Loading

nicolas-grekas commented Jan 13, 2017 •

edited

Loading

greg0ire commented Jan 13, 2017 •

edited

Loading

allflame commented Jun 7, 2017 •

edited

Loading

greg0ire commented Jun 7, 2017 •

edited

Loading

jvasseur commented Jun 7, 2017 •

edited

Loading

allflame commented Jun 8, 2017 •

edited

Loading