Lazy services #4146

Ocramius · 2013-03-29T18:21:26Z

This PR is based on #4145

It introduces two factories that define delegates capable of generating lazy services. For this, an optional dependency to ProxyManager was introduced.

If this one is ok, I'll start writing docs for it.

Current usage is via config - in an MVC application, define following:

return array(
    'lazy_services' => array(
        // needed, defines a map of service name to class name
        'map'                   => array('foo' => 'stdClass'),
        // namespace of the proxies to be generated
        'proxies_namespace'     => 'MyAppProxy',
        // whether to generate or not the proxies at runtime
        // if false, an autoloader will be registered
        'auto_generate_proxies' => true,
        // where should the proxies be saved?
        'proxies_target_dir'    => 'foo/bar',
        // should the generated proxies be written to disk?
        'write_proxy_files' => false,
    ),
    'service_manager' => array(
        'invokables' => array(
            'foo' => 'stdClass',
        ),
        'factories' => array(
            'foo-delegate' => 'Zend\ServiceManager\Proxy\LazyServiceFactoryFactory',
        ),
        'delegates' => array(
            'foo' => 'foo-delegate',
        ),
    ),
);

Documentation PR at zendframework/zf2-documentation#832

Implemented also for symfony at symfony/symfony#7527

Ocramius · 2013-03-29T18:22:11Z

composer.json

@@ -11,16 +11,19 @@
    "require": {
        "php": ">=5.3.3"
    },
+    "minimum-stability": "dev",


This is because of a (current) dependency to a dev-version of jms/cg. I'll ping the author to get it stable asap

Actually, it's up to individual users who want to install proxy-manager to add the stability flag. For those of us doing development, we'll get that stability; it's only the end-user consumers that need to be aware of that. That said, a stable tag and/or docs indicating this would be good.

@weierophinney yes, this is here only to make travis happy. I'll revert it as soon as I got feedback

Odd -- I'd expect travis would be using the --dev flag when installing composer deps...

FYI, --dev is not related to stability, it's related to require-dev only. Confusing, I know, but two separate concepts with similar terminology.

Ocramius · 2013-03-30T04:26:47Z

@weierophinney @ralphschindler there is a problem with the license of CG-library which makes this PR impossible until either:

I convert ProxyManager to use Zend\Code
CG-lib changes license

So please stand by :(

Ocramius · 2013-03-30T11:35:06Z

Ok, I fixed the issue by making ProxyManager depend on Zend\Code in Ocramius/ProxyManager#18, but now composer would refuse to resolve dependencies because ocramius/proxy-manager requires "zendframework/zend-code": "2.*", while the current version I am on is "dev-feature/proxy-delegate-services"

EDIT: spawned composer/composer#1748

Ocramius · 2013-04-12T21:40:08Z

@weierophinney travis really doesn't like me :) The failure is on cache stuff (unrelated, probably timing issue).

For the rest, this and #4145 are good to go - this one is based on the branch of #4145.

Lazy services

Close #4146

richardjennings · 2013-04-16T13:16:37Z

Very nice !

@beberlei

This PR was squashed before being merged into the master branch (closes #7890). Discussion ---------- ProxyManager Bridge As of @beberlei's suggestion, I re-implemented #7527 as a new bridge to avoid possible hidden dependencies. Everything is like #7527 except that the new namespace (and possibly package/subtree split) `Symfony\Bridge\ProxyManager` is introduced | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #6140 (supersedes) #5012 #6102 (maybe) #7527 (supersedes) | License | MIT (attached code) - BSD-3-Clause (transitive dependency) | Doc PR | Please pester me to death so I do it This PR introduces lazy services along the lines of zendframework/zendframework#4146 It introduces an **OPTIONAL** dependency to [ProxyManager](https://github.com/Ocramius/ProxyManager) and transitively to [`"zendframework/zend-code": "2.*"`](https://github.com/zendframework/zf2/tree/master/library/Zend/Code). ## Lazy services: why? A comprehensive example For those who don't know what this is about, here's an example. Assuming you have a service class like following: ```php class MySuperSlowClass { public function __construct() { // inject large object graph or do heavy computation sleep(10); } public function doFoo() { echo 'Foo!'; } } ``` The DIC will hang for 10 seconds when calling: ```php $container->get('my_super_slow_class'); ``` With this PR, this can be avoided, and the following call will return a proxy immediately. ```php $container->getDefinitions('my_super_slow_class')->setLazy(true); $service = $container->get('my_super_slow_class'); ``` The 10 seconds wait time will be delayed until the object is actually used: ```php $service->doFoo(); // wait 10 seconds, then 'Foo!' ``` A more extensive description of the functionality can be found [here](https://github.com/Ocramius/ProxyManager/blob/master/docs/lazy-loading-value-holder.md). ## When do we need it? Lazy services can be used to optimize the dependency graph in cases like: * Webservice endpoints * Db connections * Objects that cause I/O in general * Large dependency graphs that are not always used This could also help in reducing excessive service location usage as I've explained [here](http://ocramius.github.com/blog/zf2-and-symfony-service-proxies-with-doctrine-proxies/). ## Implementation quirks of this PR There's a couple of quirks in the implementation: * `Symfony\Component\DependencyInjection\CompilerBuilder#createService` is now public because of the limitations of PHP 5.3 * `Symfony\Component\DependencyInjection\Dumper\PhpDumper` now with extra mess! * The proxies are dumped at the end of compiled containers, therefore the container class is not PSR compliant anymore Commits ------- 78e3710 ProxyManager Bridge

@beberlei

This PR was squashed before being merged into the master branch (closes #7890). Discussion ---------- ProxyManager Bridge As of @beberlei's suggestion, I re-implemented #7527 as a new bridge to avoid possible hidden dependencies. Everything is like #7527 except that the new namespace (and possibly package/subtree split) `Symfony\Bridge\ProxyManager` is introduced | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #6140 (supersedes) #5012 #6102 (maybe) #7527 (supersedes) | License | MIT (attached code) - BSD-3-Clause (transitive dependency) | Doc PR | Please pester me to death so I do it This PR introduces lazy services along the lines of zendframework/zendframework#4146 It introduces an **OPTIONAL** dependency to [ProxyManager](https://github.com/Ocramius/ProxyManager) and transitively to [`"zendframework/zend-code": "2.*"`](https://github.com/zendframework/zf2/tree/master/library/Zend/Code). ## Lazy services: why? A comprehensive example For those who don't know what this is about, here's an example. Assuming you have a service class like following: ```php class MySuperSlowClass { public function __construct() { // inject large object graph or do heavy computation sleep(10); } public function doFoo() { echo 'Foo!'; } } ``` The DIC will hang for 10 seconds when calling: ```php $container->get('my_super_slow_class'); ``` With this PR, this can be avoided, and the following call will return a proxy immediately. ```php $container->getDefinitions('my_super_slow_class')->setLazy(true); $service = $container->get('my_super_slow_class'); ``` The 10 seconds wait time will be delayed until the object is actually used: ```php $service->doFoo(); // wait 10 seconds, then 'Foo!' ``` A more extensive description of the functionality can be found [here](https://github.com/Ocramius/ProxyManager/blob/master/docs/lazy-loading-value-holder.md). ## When do we need it? Lazy services can be used to optimize the dependency graph in cases like: * Webservice endpoints * Db connections * Objects that cause I/O in general * Large dependency graphs that are not always used This could also help in reducing excessive service location usage as I've explained [here](http://ocramius.github.com/blog/zf2-and-symfony-service-proxies-with-doctrine-proxies/). ## Implementation quirks of this PR There's a couple of quirks in the implementation: * `Symfony\Component\DependencyInjection\CompilerBuilder#createService` is now public because of the limitations of PHP 5.3 * `Symfony\Component\DependencyInjection\Dumper\PhpDumper` now with extra mess! * The proxies are dumped at the end of compiled containers, therefore the container class is not PSR compliant anymore Commits ------- 78e3710 ProxyManager Bridge

@beberlei

This PR was squashed before being merged into the master branch (closes #7890). Discussion ---------- ProxyManager Bridge As of @beberlei's suggestion, I re-implemented #7527 as a new bridge to avoid possible hidden dependencies. Everything is like #7527 except that the new namespace (and possibly package/subtree split) `Symfony\Bridge\ProxyManager` is introduced | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #6140 (supersedes) #5012 #6102 (maybe) #7527 (supersedes) | License | MIT (attached code) - BSD-3-Clause (transitive dependency) | Doc PR | Please pester me to death so I do it This PR introduces lazy services along the lines of zendframework/zendframework#4146 It introduces an **OPTIONAL** dependency to [ProxyManager](https://github.com/Ocramius/ProxyManager) and transitively to [`"zendframework/zend-code": "2.*"`](https://github.com/zendframework/zf2/tree/master/library/Zend/Code). ## Lazy services: why? A comprehensive example For those who don't know what this is about, here's an example. Assuming you have a service class like following: ```php class MySuperSlowClass { public function __construct() { // inject large object graph or do heavy computation sleep(10); } public function doFoo() { echo 'Foo!'; } } ``` The DIC will hang for 10 seconds when calling: ```php $container->get('my_super_slow_class'); ``` With this PR, this can be avoided, and the following call will return a proxy immediately. ```php $container->getDefinitions('my_super_slow_class')->setLazy(true); $service = $container->get('my_super_slow_class'); ``` The 10 seconds wait time will be delayed until the object is actually used: ```php $service->doFoo(); // wait 10 seconds, then 'Foo!' ``` A more extensive description of the functionality can be found [here](https://github.com/Ocramius/ProxyManager/blob/master/docs/lazy-loading-value-holder.md). ## When do we need it? Lazy services can be used to optimize the dependency graph in cases like: * Webservice endpoints * Db connections * Objects that cause I/O in general * Large dependency graphs that are not always used This could also help in reducing excessive service location usage as I've explained [here](http://ocramius.github.com/blog/zf2-and-symfony-service-proxies-with-doctrine-proxies/). ## Implementation quirks of this PR There's a couple of quirks in the implementation: * `Symfony\Component\DependencyInjection\CompilerBuilder#createService` is now public because of the limitations of PHP 5.3 * `Symfony\Component\DependencyInjection\Dumper\PhpDumper` now with extra mess! * The proxies are dumped at the end of compiled containers, therefore the container class is not PSR compliant anymore Commits ------- 78e3710 ProxyManager Bridge

localheinz · 2013-05-30T13:02:31Z

Would it make sense to add and implement a LazyServiceProviderInterface in modules, then?

Just trying to wrap my head around this.

Ocramius · 2013-05-30T14:29:45Z

@localheinz this logic applies to ANY service manager and abstract plugin manager ;)

…ture/proxy-delegate-services Lazy services

Close zendframework/zendframework#4146

Ocramius reviewed Mar 29, 2013
View reviewed changes

Ocramius mentioned this pull request Mar 30, 2013

Lazy services - service proxies symfony/symfony#7527

Closed

8 tasks

This was referenced Apr 7, 2013

[WIP] Feature/lazy services zendframework/zf2-documentation#832

Closed

Proxy can not be created for services with circular dependencies Ocramius/OcraServiceManager#11

Closed

Ocramius added 14 commits April 12, 2013 21:43

Implementing first version of delegate factories for services

93b585d

Allowing multiple wrapped delegates

59fd2ae

Minor CS fixes

b0f3c4d

Fixing problem with 5.3 compatibility (wrong context for $this)

020b28a

Renaming 'delegates' => 'delegators'

32bd19d

Renaming 'delegates' => 'delegators'

b531502

Implementing first version of delegate factories for services

4efc0c3

Renaming 'delegates' => 'delegators'

755c33d

Adding support for lazy services

6594369

Verifying proxy initialization

df4ccd8

Rebasing, bumping proxy manager version

21285ff

Rebase adjustments

99ed3a5

Defaulting the proxy generator so that no proxies are written

64a8357

Removing minimum stability flag

3299c82

ghost assigned weierophinney Apr 15, 2013

weierophinney added a commit that referenced this pull request Apr 15, 2013

Merge pull request #4146 from Ocramius/feature/proxy-delegate-services

b22828d

Lazy services

weierophinney added a commit that referenced this pull request Apr 15, 2013

Merge branch 'feature/4146' into develop

73bb550

Close #4146

weierophinney merged commit 3299c82 into zendframework:develop Apr 15, 2013

Ocramius mentioned this pull request Apr 15, 2013

Feature/lazy services zendframework/zf2-documentation#839

Merged

This was referenced Apr 19, 2013

Alternative approach - feedback? Ocramius/ProxyManager#32

Closed

Create callback metadata driver doctrine/DoctrineModule#138

Closed

Ocramius mentioned this pull request May 1, 2013

ProxyManager Bridge symfony/symfony#7890

Closed

Ocramius deleted the feature/proxy-delegate-services branch May 1, 2013 18:15

localheinz mentioned this pull request May 30, 2013

Translate in the controller #4551

Closed

weierophinney added a commit to zendframework/zend-servicemanager that referenced this pull request May 15, 2015

Merge pull request zendframework/zendframework#4146 from Ocramius/fea…

06b0f8c

…ture/proxy-delegate-services Lazy services

weierophinney added a commit to zendframework/zend-servicemanager that referenced this pull request May 15, 2015

Merge branch 'feature/4146' into develop

44807bd

Close zendframework/zendframework#4146

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lazy services #4146

Lazy services #4146

Ocramius commented Mar 29, 2013

Ocramius Mar 29, 2013

weierophinney Mar 29, 2013

Ocramius Mar 29, 2013

weierophinney Mar 29, 2013

igorw Mar 30, 2013

Ocramius commented Mar 30, 2013

Ocramius commented Mar 30, 2013

Ocramius commented Apr 12, 2013

richardjennings commented Apr 16, 2013

localheinz commented May 30, 2013

Ocramius commented May 30, 2013

Lazy services #4146

Lazy services #4146

Conversation

Ocramius commented Mar 29, 2013

Ocramius Mar 29, 2013

Choose a reason for hiding this comment

weierophinney Mar 29, 2013

Choose a reason for hiding this comment

Ocramius Mar 29, 2013

Choose a reason for hiding this comment

weierophinney Mar 29, 2013

Choose a reason for hiding this comment

igorw Mar 30, 2013

Choose a reason for hiding this comment

Ocramius commented Mar 30, 2013

Ocramius commented Mar 30, 2013

Ocramius commented Apr 12, 2013

richardjennings commented Apr 16, 2013

localheinz commented May 30, 2013

Ocramius commented May 30, 2013