Compile factories, including closures #507

mnapoli · 2017-06-11T19:30:06Z

Factory definitions are now dumped into the compiled container!

This follows #494 where all definitions but factories, decorators and wildcards were compiled. Decorators and wildcards are still not compiled.

Compiling factories means also compiling closures. That was actually much more doable than I thought, I've used Roave/BetterReflection (thanks @asgrim and @Ocramius!)

The main downside of the whole pull request is the number of dependencies that BetterReflection brings:

Installing symfony/polyfill-util (v1.4.0) Loading from cache
Installing symfony/polyfill-php56 (v1.4.0) Loading from cache
Installing nikic/php-parser (v2.1.1) Loading from cache
Installing jeremeamia/superclosure (2.3.0) Loading from cache
Installing zendframework/zend-eventmanager (3.1.0) Loading from cache
Installing zendframework/zend-code (3.1.0) Loading from cache
Installing phpdocumentor/reflection-common (1.0) Loading from cache
Installing phpdocumentor/type-resolver (0.2.1) Loading from cache
Installing phpdocumentor/reflection-docblock (2.0.5) Loading from cache
Installing roave/better-reflection (1.2.0) Loading from cache

Maybe we could get on with superclosure only. Or else make compiling closures optional (only compile them if BetterReflection is installed…). Also I've seen that there is a v2.0 of BetterReflection in development but it requires 7.1, I have no idea for how long the v1 will be supported (e.g. will it support PHP 7.2). PHP-DI could upgrade to 7.1 at the end of this year but that's not for sure yet.

Performance improvements: -20% on the factory.php benchmark, profile, which is very good for a micro-benchmark IMO. I'll test all that in larger scenarios for the complete 6.0 release but it's safe to say this PR is an improvement.

There are also a lot of micro/not-so-micro optimisations possible here in the future, especially because there are a lot of parameter-guessing done at runtime (you can inject dependencies into the factories and PHP-DI figures it out with type-hints). https://github.com/PHP-DI/Invoker could be compiled in the future (optionally), and simpler scenarios (classic closures) could be much more optimized than that. Work for later! :)

Because of closures, some scenarios are explicitly not supported:

you should not use $this inside closures
you should not import variables inside the closure using the use keyword, like in function () use ($foo) { ...
you should not define multiple closures on the same line

But those scenarios don't make sense in container factories written in array config so that's good!

Factory definitions are now dumped into the compiled container! This follows #494 where all definitions but factories, decorators and wildcards were compiled. Decorators and wildcards are still not compiled. Compiling factories means also compiling closures. That was actually much more doable than I thought, I've used [Roave/BetterReflection](https://github.com/Roave/BetterReflection) (thanks asgrim and ocramius!) The main downside of the whole pull request is the number of dependencies that BetterReflection brings: - Installing symfony/polyfill-util (v1.4.0) Loading from cache - Installing symfony/polyfill-php56 (v1.4.0) Loading from cache - Installing nikic/php-parser (v2.1.1) Loading from cache - Installing jeremeamia/superclosure (2.3.0) Loading from cache - Installing zendframework/zend-eventmanager (3.1.0) Loading from cache - Installing zendframework/zend-code (3.1.0) Loading from cache - Installing phpdocumentor/reflection-common (1.0) Loading from cache - Installing phpdocumentor/type-resolver (0.2.1) Loading from cache - Installing phpdocumentor/reflection-docblock (2.0.5) Loading from cache - Installing roave/better-reflection (1.2.0) Loading from cache Maybe we could get on with superclosure only. Or else make compiling closures optional (only compile them if BetterReflection is installed…). Also I've seen that there is a v2.0 of BetterReflection in development [but it requires 7.1](https://github.com/Roave/BetterReflection#changes-in-br-20), I have no idea for how long the v1 will be supported (e.g. will it support PHP 7.2). PHP-DI could upgrade to 7.1 at the end of this year but that's not for sure yet. Performance improvements: -20% on the factory.php benchmark, [profile](https://blackfire.io/profiles/compare/6692ca3e-521a-49df-96c6-1bf9833c8209/graph), which is very good for a micro-benchmark IMO. I'll test all that in larger scenarios for the complete 6.0 release but it's safe to say this PR is an improvement. There are also a lot of micro/not-so-micro optimisations possible here in the future, especially because there are a lot of parameter-guessing done at runtime (you can inject dependencies into the factories and PHP-DI figures it out with type-hints). https://github.com/PHP-DI/Invoker could be compiled in the future (optionally), and simpler scenarios (classic closures) could be much more optimized than that. Work for later! :) Because of closures, some scenarios are explicitly not supported: - you should not use `$this` inside closures - you should not import variables inside the closure using the `use` keyword, like in `function () use ($foo) { ...` - you should not define multiple closures on the same line But those scenarios don't make sense in container factories written in array config so that's good!

Ocramius

Good work! Unsure about the dependencies - it is indeed a large dependency graph, but I also don't have a good solution to fix that, sorry :-\

Ocramius · 2017-06-11T23:11:09Z

composer.json

+    },
+    "config": {
+        "platform": {
+            "php": "7.0"


What was I trying to do 🤔

Ocramius · 2017-06-11T23:11:43Z

src/CompiledContainer.php

+    protected function resolveFactory($callable, $entryName, array $extraParameters = [])
+    {
+        // Initialize the factory resolver
+        if (! $this->factoryInvoker) {


Make this a private getter

I wanted to avoid an unnecessary method call here, see the profile of the difference: https://blackfire.io/profiles/compare/5a49dac2-a8f2-454d-9074-598540040477/graph?settings%5Bdimension%5D=wt&settings%5Bdisplay%5D=focused&settings%5BtabPane%5D=nodes&selected=&callname=DI%5CCompiledContainer%3A%3AgetFactoryInvoker

Not much but if that can be avoided.

Ocramius · 2017-06-11T23:14:44Z

src/Compiler.php

+                break;
+            case $definition instanceof FactoryDefinition:
+                $value = $definition->getCallable();
+


Method should not be static

Variable name does not reflect its meaning: this is not a name, it's a bool

I'm not sure I should check for the staticness, PHP already throws a warning at compile time and it still works so I don't think PHP-DI should choose to make this stricter.

Ocramius · 2017-06-11T23:15:23Z

src/Compiler.php

+                $value = $definition->getCallable();
+
+                // Custom error message to help debugging
+                $isInvokableClassName = is_string($value) && class_exists($value) && method_exists($value, '__invoke');


You should really start using named constructors for exceptions :-P

I do for common ones but this error message is very specific to that line so moving it elsewhere would just spread logic around (cohesion ftw)

Ocramius · 2017-06-11T23:16:41Z

src/Compiler.php

+        if ($value instanceof \Closure) {
+            try {
+                $reflection = ReflectionFunction::createFromClosure($value);
+            } catch (TwoClosuresOneLine $e) {


Do you really want to catch this? Also, make sure to re-throw the previous exception if you do.

I want to hide the implementation details of the closure compiler, but good catch on forwarding the previous exception.

Ocramius · 2017-06-11T23:17:26Z

src/Compiler.php


            return "[\n$value        ]";
        }



Move to private method

Ocramius · 2017-06-11T23:18:06Z

src/Compiler.php

+            $ast = $reflection->getAst();
+
+            // Force all closures to be static (add the `static` keyword), i.e. they can't use
+            // $this, which makes sense since their code is copied into another class.


You are using the API from PHP-Parser here, so you should add that to your composer.json too

Ocramius · 2017-06-11T23:19:41Z

src/ContainerBuilder.php


        if ($this->compileToFile) {
-            $containerClass = (new Compiler)->compile($source, $this->compileToFile);
+            $autowiringEnabled = $this->useAutowiring || $this->useAnnotations;


Variable is redundant

Ocramius · 2017-06-11T23:21:12Z

I have no idea for how long the v1 will be supported (e.g. will it support PHP 7.2). PHP-DI could upgrade to 7.1 at the end of this year but that's not for sure yet.

You'll get security support, no worries :-)

mnapoli

You'll get security support, no worries :-)

Nice to know!

Thanks for the review!

mnapoli · 2017-06-12T20:24:50Z

composer.json

+    },
+    "config": {
+        "platform": {
+            "php": "7.0"


What was I trying to do 🤔

mnapoli · 2017-06-12T20:28:41Z

src/CompiledContainer.php

+    protected function resolveFactory($callable, $entryName, array $extraParameters = [])
+    {
+        // Initialize the factory resolver
+        if (! $this->factoryInvoker) {


I wanted to avoid an unnecessary method call here, see the profile of the difference: https://blackfire.io/profiles/compare/5a49dac2-a8f2-454d-9074-598540040477/graph?settings%5Bdimension%5D=wt&settings%5Bdisplay%5D=focused&settings%5BtabPane%5D=nodes&selected=&callname=DI%5CCompiledContainer%3A%3AgetFactoryInvoker

Not much but if that can be avoided.

mnapoli · 2017-06-12T20:39:48Z

src/Compiler.php

+        if ($value instanceof \Closure) {
+            try {
+                $reflection = ReflectionFunction::createFromClosure($value);
+            } catch (TwoClosuresOneLine $e) {


I want to hide the implementation details of the closure compiler, but good catch on forwarding the previous exception.

mnapoli · 2017-06-12T20:45:22Z

src/Compiler.php

+                break;
+            case $definition instanceof FactoryDefinition:
+                $value = $definition->getCallable();
+


I'm not sure I should check for the staticness, PHP already throws a warning at compile time and it still works so I don't think PHP-DI should choose to make this stricter.

mnapoli · 2017-06-12T20:46:20Z

src/Compiler.php

+                $value = $definition->getCallable();
+
+                // Custom error message to help debugging
+                $isInvokableClassName = is_string($value) && class_exists($value) && method_exists($value, '__invoke');


I do for common ones but this error message is very specific to that line so moving it elsewhere would just spread logic around (cohesion ftw)

# Conflicts: # src/Compiler.php # src/ContainerBuilder.php # tests/IntegrationTest/CompiledContainerTest.php

mnapoli · 2017-06-30T21:30:59Z

Less Composer dependencies are now installed:

Installing symfony/polyfill-util (v1.4.0): Loading from cache

Installing symfony/polyfill-php56 (v1.4.0): Loading from cache

Installing nikic/php-parser (v3.0.6): Loading from cache

Installing jeremeamia/superclosure (2.3.0): Loading from cache

Ocramius · 2017-07-02T12:19:07Z

@mnapoli would it be a good idea to have the factory compiling split out and handled as a dev dependency by consumer projects? Just wondering/rambling, not necessarily feasible or relevant.

mnapoli · 2017-07-02T12:22:46Z

That could be a good idea indeed (considering the whole compilation step to make sense only in dev env, not prod) but I'd like to keep the whole thing simple (simply calling a method on the ContainerBuilder to compile the container is nice). The 4 extra dependencies are OK I think.

mnapoli added the enhancement label Jun 11, 2017

mnapoli added this to the 6.0 milestone Jun 11, 2017

mnapoli force-pushed the compile-factories branch 2 times, most recently from d8c56b0 to 6ec16df Compare June 11, 2017 19:34

Ocramius suggested changes Jun 11, 2017

View reviewed changes

mnapoli added 5 commits June 12, 2017 22:31

Remove unnecessary platform config in composer.json

c4f260e

Require nikic/php-parser because we use it directly

1d47321

Move the compilation of closures to a private method

1effa92

Rename variable for better readability

880994c

Remove useless variable

a0b90a3

mnapoli commented Jun 12, 2017

View reviewed changes

mnapoli added 2 commits June 30, 2017 23:07

Merge branch 'master' into compile-factories

5c797a0

# Conflicts: # src/Compiler.php # src/ContainerBuilder.php # tests/IntegrationTest/CompiledContainerTest.php

Refactor closure compilation to require less Composer dependencies

22d232f

mnapoli merged commit 5540f71 into master Jul 16, 2017

mnapoli deleted the compile-factories branch July 16, 2017 11:36

mnapoli mentioned this pull request Aug 10, 2017

[DI] Add "PHP fluent format" for configuring the container symfony/symfony#23834

Merged

Uh oh!

Compile factories, including closures #507

Compile factories, including closures #507

Uh oh!

Conversation

mnapoli commented Jun 11, 2017

Uh oh!

Ocramius left a comment

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!

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!

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!

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!

Ocramius commented Jun 11, 2017

Uh oh!

mnapoli left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mnapoli commented Jun 30, 2017

Uh oh!

Ocramius commented Jul 2, 2017

Uh oh!

mnapoli commented Jul 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants