http://www.doctrine-project.org/jira This file is an XML representation of an issue en-us 5.2.7 850 21-02-2013 http://www.doctrine-project.org/jira/browse/DDC-717 Doctrine 2 - ORM <p>Proxy classes are generated in less than 1ms for me. I prefer to not have a "build" step to reducing loading time by a milisecond, so I use autogenerate.</p> <p>For users like me, wouldn't it be nicer if we wouldn't even have to configure a proxy dir and those files were never written (since they're not read more than once anyway)?</p> DDC-717

Do not use files when using proxy autogeneration

Improvement Major Open Unresolved All Benjamin Eberlei Jaka Jancar Thu, 22 Jul 2010 17:52:55 +0000 Mon, 4 Jul 2011 21:47:47 +0000 2.x ORM 2 2 <p>This very minimal patch removes the use of these temporary files:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">--- library/Doctrine/ORM/Proxy/ProxyFactory.php (revision 2) +++ library/Doctrine/ORM/Proxy/ProxyFactory.php (working copy) @@ -78,9 +78,8 @@ $fqn = $<span class="code-keyword">this</span>-&gt;_proxyNamespace . '\\' . $proxyClassName; <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;_autoGenerate &amp;&amp; ! class_exists($fqn, <span class="code-keyword">false</span>)) { - $fileName = $<span class="code-keyword">this</span>-&gt;_proxyDir . DIRECTORY_SEPARATOR . $proxyClassName . '.php'; - $<span class="code-keyword">this</span>-&gt;_generateProxyClass($<span class="code-keyword">this</span>-&gt;_em-&gt;getClassMetadata($className), $proxyClassName, $fileName, self::$_proxyClassTemplate); - require $fileName; + $file = $<span class="code-keyword">this</span>-&gt;_generateProxyClass($<span class="code-keyword">this</span>-&gt;_em-&gt;getClassMetadata($className), $proxyClassName, <span class="code-keyword">null</span>, self::$_proxyClassTemplate); + eval('?&gt;'.$file); } <span class="code-keyword">if</span> ( ! $<span class="code-keyword">this</span>-&gt;_em-&gt;getMetadataFactory()-&gt;hasMetadataFor($fqn)) { @@ -144,6 +143,9 @@ $file = str_replace($placeholders, $replacements, $file); + <span class="code-keyword">if</span> ($fileName === <span class="code-keyword">null</span>) + <span class="code-keyword">return</span> $file; + file_put_contents($fileName, $file); } </pre> </div></div> <p>The proxy dir is used for the "doctrine orm:generate-proxies" command in the case of "autogenerate= false", so you need to define it anyways.</p> <p>You have to use proxies, the option is not for Proxy yes/no. If you have autogenerate=false and doctrine requires a proxy for a use case but can't find it you will get a fatal error.</p> <p>I just saw the eval() keyword, ieeks <img class="emoticon" src="http://www.doctrine-project.org/jira/images/icons/emoticons/wink.gif" height="20" width="20" align="absmiddle" alt="" border="0"/> It could maybe be a convenience option for those that don't want to use proxy direcotiries, however i am not sure.</p> <p>eval() is no different than writing code to a file and using require().</p> <p>When using runtime-generated proxies, there are no benefits (that I know of) from writing them to a file. The disadvantages are:</p> <ul class="alternate" type="square"> <li>slower because of write disk access</li> <li>has problems with high concurrency, unless special care is taken (<a href="http://www.doctrine-project.org/jira/browse/DDC-716" title="Proxy autogeneration fails with concurrent requests"><del>DDC-716</del></a>)</li> <li>potentially has permission problems if code is executed by different users (e.g. nobody for a daemon and www-data for http)</li> <li>requires setup of a writable directory</li> </ul> <p>This is a nicer patch, which makes _generateProxyClass() return a string, just like other _generate* methods:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">--- library/Doctrine/ORM/Proxy/ProxyFactory.php (revision 2) +++ library/Doctrine/ORM/Proxy/ProxyFactory.php (working copy) @@ -78,9 +78,8 @@ $fqn = $<span class="code-keyword">this</span>-&gt;_proxyNamespace . '\\' . $proxyClassName; <span class="code-keyword">if</span> ($<span class="code-keyword">this</span>-&gt;_autoGenerate &amp;&amp; ! class_exists($fqn, <span class="code-keyword">false</span>)) { - $fileName = $<span class="code-keyword">this</span>-&gt;_proxyDir . DIRECTORY_SEPARATOR . $proxyClassName . '.php'; - $<span class="code-keyword">this</span>-&gt;_generateProxyClass($<span class="code-keyword">this</span>-&gt;_em-&gt;getClassMetadata($className), $proxyClassName, $fileName, self::$_proxyClassTemplate); - require $fileName; + $code = $<span class="code-keyword">this</span>-&gt;_generateProxyClass($<span class="code-keyword">this</span>-&gt;_em-&gt;getClassMetadata($className), $proxyClassName); + eval($code); } <span class="code-keyword">if</span> ( ! $<span class="code-keyword">this</span>-&gt;_em-&gt;getMetadataFactory()-&gt;hasMetadataFor($fqn)) { @@ -107,19 +106,19 @@ foreach ($classes as $class) { $proxyClassName = str_replace('\\', '', $class-&gt;name) . 'Proxy'; $proxyFileName = $proxyDir . $proxyClassName . '.php'; - $<span class="code-keyword">this</span>-&gt;_generateProxyClass($class, $proxyClassName, $proxyFileName, self::$_proxyClassTemplate); + $code = $<span class="code-keyword">this</span>-&gt;_generateProxyClass($class, $proxyClassName); + file_put_contents($proxyFileName, <span class="code-quote">"&lt;?php\n"</span> . $code); } } /** * Generates a proxy class file. * - * @param $class - * @param $originalClassName + * @param ClassMetadata $class * @param $proxyClassName - * @param $file The path of the file to write to. + * @<span class="code-keyword">return</span> string The code of the generated methods. */ - <span class="code-keyword">private</span> function _generateProxyClass($class, $proxyClassName, $fileName, $file) + <span class="code-keyword">private</span> function _generateProxyClass(ClassMetadata $class, $proxyClassName) { $methods = $<span class="code-keyword">this</span>-&gt;_generateMethods($class); $sleepImpl = $<span class="code-keyword">this</span>-&gt;_generateSleep($class); @@ -142,9 +141,9 @@ $methods, $sleepImpl ); - $file = str_replace($placeholders, $replacements, $file); + $file = str_replace($placeholders, $replacements, self::$_proxyClassTemplate); - file_put_contents($fileName, $file); + <span class="code-keyword">return</span> $file; } /** @@ -244,8 +243,7 @@ /** Proxy class code template */ <span class="code-keyword">private</span> <span class="code-keyword">static</span> $_proxyClassTemplate = -'&lt;?php - +' namespace &lt;namespace&gt;; /** </pre> </div></div> <p>Scheduled usage of eval() for 2.1, if the following conditions exist:</p> <p>1. Autogenerate is set to TRUE<br/> 2. No Proxy Directory is configured.</p> <p>Great, this is even better. This way you can have 1) autogenerated in ram-only, 2) autogenerated in files and 3) pregenerated.</p> <p>And the minimal amount of config needed to get up and running is reduced, which is always nice.</p> <p>you should know though, eval is dead slow. It generates the necessary proxies on EACH request and that cannot be cached in APC.</p> <p>It's no slower than current autogeneration (file_put_contents+require). TBH, I don't know why anyone would want to use that over eval(), but I don't mind it being there.</p> <p>Pre-generation is, of course, a different thing. Seems like a valid tradeoff to offer: build/a bit of config/better perfomance vs. no build/no config/potentially slower.</p> <p>Yes, that is because file_put_contents + require is a development only strategy. The manual clearly states that autogenerate has to be false in production.</p> <p>Using eval() instead of producing and requiring the file in the case of enabled auto-generation of proxy classes sounds like a good improvement for 2.1 to make proxies more transparent during deveopment and for anyone for whom performance is no issue.</p> <p>I'm increasing the priority as I think it is easy to implement for 2.1 and a good enhancement.</p> <p>A note on why having the proxies written to a file can be useful even with autogenerate being on: it makes it really easy to check the proxy code being generated. I use that a lot currently.</p> <p>The solution suggested, giving three possibilities is cool, though.</p>