added scope as constructor parameter and properties for plugins cache

Author: Franciszek Wawrzak

lib/internal/Magento/Framework/CompiledInterception/Generator/CompiledInterceptor.php

@@ -8,6 +8,7 @@
 
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Code\Generator\EntityAbstract;
+use Magento\Framework\Config\Scope;
 use Magento\Framework\Interception\Code\Generator\Interceptor;
 use Magento\Framework\Interception\DefinitionInterface;
 
@@ -16,6 +17,9 @@ class CompiledInterceptor extends Interceptor
 
     protected $plugins;
 
+    protected $classMethods = [];
+    protected $classProperties = [];
+
     public function __construct(
         $sourceClassName = null,
         $resultClassName = null,
@@ -41,14 +45,12 @@ public function __construct(
         }
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
     public function setInterceptedMethods($interceptedMethods)
     {
-        //DUMMY
-    }
-
-    protected function _getClassProperties()
-    {
-        return [];
+        //NOOP
     }
 
     protected function _generateCode()
@@ -57,41 +59,98 @@ protected function _generateCode()
         $reflection = new \ReflectionClass($typeName);
 
         if ($reflection->isInterface()) {
-            $this->_classGenerator->setImplementedInterfaces([$typeName]);
+            return false;
         } else {
             $this->_classGenerator->setExtendedClass($typeName);
         }
 
         $this->_classGenerator->addUse(ObjectManager::class);
-        $this->_classGenerator->addUse(\Magento\Framework\Config\Scope::class);
+        $this->_classGenerator->addUse(Scope::class);
+
+        $this->classMethods = [];
+        $this->classProperties = [];
+        $this->overrideMethodsAndGeneratePluginGetters($reflection);
+
+        array_unshift($this->classMethods, $this->_getConstructorInfo($reflection->getConstructor()));
+        array_unshift($this->classProperties, [
+            'name' => '____scope',
+            'visibility' => 'private',
+            'docblock' => [
+                'tags' => [['name' => 'var', 'description' => 'Scope']],
+            ]
+        ]);
         //return parent::_generateCode();
         return EntityAbstract::_generateCode();
     }
 
-    protected function _getClassMethods()
+    protected function overrideMethodsAndGeneratePluginGetters(\ReflectionClass $reflection)
     {
-        $reflectionClass = new \ReflectionClass($this->getSourceClassName());
-        $publicMethods = $reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC);
+        $publicMethods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
 
-        $methods = [];
         $allPlugins = [];
         foreach ($publicMethods as $method) {
             if ($this->isInterceptedMethod($method)) {
                 $config = $this->_getPluginsConfig($method, $allPlugins);
                 if (!empty($config)) {
-                    $methods[] = $this->_getCompiledMethodInfo($method, $config);
+                    $this->classMethods[] = $this->_getCompiledMethodInfo($method, $config);
                 }
             }
         }
-        if (!empty($methods) && !empty($allPlugins)) {
-            foreach ($allPlugins as $key => $plugins) {
-                foreach ($plugins as $plugin) {
-                    $methods[] = $this->_getPluginGetterInfo($plugin);
+        foreach ($allPlugins as $plugins) {
+            foreach ($plugins as $plugin) {
+                $this->classMethods[] = $this->_getPluginGetterInfo($plugin);
+                $this->classProperties[] = $this->_getPluginPropertyInfo($plugin);
+            }
+        }
+    }
+
+    protected function _getClassMethods()
+    {
+        return $this->classMethods;
+    }
+
+    protected function _getClassProperties()
+    {
+        return $this->classProperties;
+    }
+
+    protected function _getConstructorInfo(\ReflectionMethod $parentConstructor = null)
+    {
+        if ($parentConstructor == null) {
+            $parameters = [[
+                'name' => 'scope',
+                'type' => Scope::class
+            ]];
+            $body = ["\$this->____scope = \$scope;"];
+        } else {
+            $parameters = $parentConstructor->getParameters();
+            $addScopeParam = true;
+            $scopeParamName = '____scope';
+            foreach ($parameters as $parameter) {
+                $parentCallParams[] = '$' . $parameter->getName();
+                if ($parameter->getType() == Scope::class) {
+                    $scopeParamName = $parameter->getName();
+                    $addScopeParam = false;
                 }
             }
+
+            $parameters = array_map(array($this, '_getMethodParameterInfo'), $parameters);
+            $addScopeParam && array_unshift($parameters, [
+                'name' => $scopeParamName,
+                'type' => Scope::class
+            ]);
+            $body = [
+                "\$this->____scope = \$$scopeParamName;",
+                "parent::__construct(" . implode(', ', $parentCallParams) .");"
+            ];
         }
 
-        return $methods;
+        return [
+            'name' => '__construct',
+            'parameters' => $parameters,
+            'body' => implode("\n", $body),
+            'docblock' => ['shortDescription' => '{@inheritdoc}'],
+        ];
     }
 
     private function addCodeSubBlock(&$body, $sub, $indent = 1)
@@ -117,8 +176,6 @@ protected function _getMethodSourceFromConfig(\ReflectionMethod $method, $conf,
         if (isset($conf[DefinitionInterface::LISTENER_BEFORE])) {
             foreach ($conf[DefinitionInterface::LISTENER_BEFORE] as $plugin) {
                 if ($first) $first = false; else $body[] = "";
-                //$body[] = "/** @var \\" . "{$plugin['class']} \$plugin {$plugin['code']} */";
-                //$body[] = "\$plugin = \$this->" . $this->getGetterName($plugin) . "();";
 
                 $call = "\$this->" . $this->getGetterName($plugin) . "()->before$capName(\$this$extraParams);";
 
@@ -136,11 +193,8 @@ protected function _getMethodSourceFromConfig(\ReflectionMethod $method, $conf,
         $main = [];
         if (isset($conf[DefinitionInterface::LISTENER_AROUND])) {
             $plugin = $conf[DefinitionInterface::LISTENER_AROUND];
-            //$body[] = "/** @var \\" . "{$plugin['class']} \$plugin {$plugin['code']} */";
-            //$body[] = "\$plugin = \$this->" . $this->getGetterName($plugin) . "();";
             $main[] = "\$this->" . $this->getGetterName($plugin) . "()->around$capName(\$this, function({$this->_getParameterListForNextCallback($parameters)}){";
             $this->addCodeSubBlock($main, $this->_getMethodSourceFromConfig($method, $plugin['next'] ?: [], $parameters, $returnVoid));
-            //$body[] = "\treturn \$result;";
             $main[] = "}$extraParams);";
         } else {
             $main[] = "parent::{$method->getName()}({$this->_getParameterList($parameters)});";
@@ -149,8 +203,6 @@ protected function _getMethodSourceFromConfig(\ReflectionMethod $method, $conf,
 
         if (isset($conf[DefinitionInterface::LISTENER_AFTER])) {
             foreach ($conf[DefinitionInterface::LISTENER_AFTER] as $plugin) {
-                //$body[] = "/** @var \\" . "{$plugin['class']} \$plugin {$plugin['code']} */";
-                //$body[] = "\$plugin = \$this->" . $this->getGetterName($plugin) . "();";
                 if ($returnVoid) {
                     $chain[] = ["((\$tmp = \$this->" . $this->getGetterName($plugin) . "()->after$capName(\$this, \$result$extraParams)) !== null) ? \$tmp : \$result;"];
                 } else {
@@ -206,16 +258,29 @@ protected function _getParameterList(array $parameters)
 
     protected function getGetterName($plugin)
     {
-        return '_get_plugin_' . preg_replace("/[^A-Za-z0-9_]/", '_', $plugin['code'] . $plugin['suffix']);
+        return '____plugin_' . $plugin['clean_name'];
+    }
+
+    protected function _getPluginPropertyInfo($plugin)
+    {
+        return [
+            'name' => '____plugin_' . $plugin['clean_name'],
+            'visibility' => 'private',
+            'docblock' => [
+                'tags' => [['name' => 'var', 'description' => '\\' . $plugin['class']]],
+            ]
+        ];
     }
 
     protected function _getPluginGetterInfo($plugin)
     {
         $body = [];
+        $varName = "\$this->____plugin_" . $plugin['clean_name'];
 
-        $body[] = "static \$cache = null;";
-        $body[] = "if (\$cache === null) \$cache = ObjectManager::getInstance()->get(\\" . "{$plugin['class']}::class);";
-        $body[] = "return \$cache;";
+        $body[] = "if ($varName === null) {";
+        $body[] = "\t$varName = ObjectManager::getInstance()->get(\\" . "{$plugin['class']}::class);";
+        $body[] = "}";
+        $body[] = "return $varName;";
 
         return [
             'name' => $this->getGetterName($plugin),
@@ -234,7 +299,7 @@ protected function _getCompiledMethodInfo(\ReflectionMethod $method, $config)
         $returnsVoid = ($method->hasReturnType() && $method->getReturnType()->getName() == 'void');
 
         $body = [
-            'switch(ObjectManager::getInstance()->get(Scope::class)->getCurrentScope()){'
+            'switch($this->____scope->getCurrentScope()){'
         ];
 
         $cases = [];
@@ -247,7 +312,7 @@ protected function _getCompiledMethodInfo(\ReflectionMethod $method, $config)
         //call parent method for scopes with no plugins (or when no scope is set)
         $cases[] = ['cases'=>["\tdefault:"], 'conf'=>[]];
 
-        foreach($cases as $case) {
+        foreach ($cases as $case) {
             $body = array_merge($body, $case['cases']);
             $this->addCodeSubBlock($body, $this->_getMethodSourceFromConfig($method, $case['conf'], $parameters, $returnsVoid), 2);
             //$body[] = "\t\tbreak;";
@@ -269,10 +334,11 @@ protected function _getPluginInfo(CompiledPluginList $plugins, $code, $className
         $className = $plugins->getPluginType($className, $code);
         if (!isset($allPlugins[$code])) $allPlugins[$code] = [];
         if (empty($allPlugins[$code][$className])) {
+            $suffix = count($allPlugins[$code]) ? count($allPlugins[$code]) + 1 : '';
             $allPlugins[$code][$className] = [
                 'code' => $code,
                 'class' => $className,
-                'suffix' => count($allPlugins[$code]) ? count($allPlugins[$code]) + 1 : ''
+                'clean_name' => preg_replace("/[^A-Za-z0-9_]/", '_', $code . $suffix)
             ];
         }
         $ret = $allPlugins[$code][$className];

lib/internal/Magento/Framework/CompiledInterception/README.md

@@ -13,16 +13,7 @@ Interceptors generated by this plugin are 100% compatible with ones generated by
 
 ### ENABLING
 
-to use in developer mode in `app/etc/di.xml` replace:
-```
-<item name="interceptor" xsi:type="string">\Magento\Framework\Interception\Code\Generator\Interceptor</item>
-```
-with:
-```
-<item name="interceptor" xsi:type="string">\Magento\Framework\CompiledInterception\Generator\CompiledInterceptor</item>
-```
-
-to use compiled interceptors in production mode please add following preference to your di.xml
+to use compiled interceptors in developer and production mode please add following preference to your di.xml
 ```
 <preference for="Magento\Framework\Interception\Code\Generator\Interceptor" type="Magento\Framework\CompiledInterception\Generator\CompiledInterceptor" />
 ```
@@ -33,7 +24,7 @@ clear generated files and cache:
 
 ### DISABLING
 
-Replace back the lines in `app/etc/di.xml`, remove module and clear cache and generated files.
+Replace remove preference from `app/etc/di.xml`, remove module and clear cache and generated files.
 
 ### TECHNICAL DETAILS 
 
@@ -80,7 +71,7 @@ public function methodX($arg) {
 
 * fastest response time (5%-15% faster in developer and production mode)
   * no redundant calls to `___callPlugins` in call stack.
-  * methods with no plugins are not overriden in parent at all.
+  * methods with no plugins are not overridden in parent at all.
 
 * implemented as a module and can be easily reverted to default `Generator\Interceptor`
 

lib/internal/Magento/Framework/CompiledInterception/Test/Unit/CompiledInterceptor/CompiledInterceptorTest.php

@@ -60,7 +60,6 @@ public function testGenerate($className, $resultClassName, $fileName)
         $interceptor->method('_validateData')->willReturn(true);
 
         $generated = $interceptor->generate();
-
         $this->assertEquals($fileName . '.php', $generated, 'Generated interceptor is invalid.');
     }