MC-31618: Move static config to files - PLUGIN_LIST

- Implement 2 interfaces by one plugin list generator;

Author: adifucan

app/etc/di.xml

@@ -209,8 +209,8 @@
     <preference for="Magento\Framework\MessageQueue\QueueFactoryInterface" type="Magento\Framework\MessageQueue\QueueFactory" />
     <preference for="Magento\Framework\Search\Request\IndexScopeResolverInterface" type="Magento\Framework\Indexer\ScopeResolver\IndexScopeResolver"/>
     <preference for="Magento\Framework\HTTP\ClientInterface" type="Magento\Framework\HTTP\Client\Curl" />
-    <preference for="Magento\Framework\Interception\ConfigLoaderInterface" type="Magento\Framework\Interception\ConfigLoader" />
-    <preference for="Magento\Framework\Interception\ConfigWriterInterface" type="Magento\Framework\Interception\ConfigWriter" />
+    <preference for="Magento\Framework\Interception\ConfigLoaderInterface" type="Magento\Framework\Interception\PluginListGenerator" />
+    <preference for="Magento\Framework\Interception\ConfigWriterInterface" type="Magento\Framework\Interception\PluginListGenerator" />
     <type name="Magento\Framework\Model\ResourceModel\Db\TransactionManager" shared="false" />
     <type name="Magento\Framework\Acl\Data\Cache">
         <arguments>
@@ -433,7 +433,7 @@
             </argument>
         </arguments>
     </type>
-    <type name="Magento\Framework\Interception\ConfigWriter">
+    <type name="Magento\Framework\Interception\PluginListGenerator">
         <arguments>
             <argument name="reader" xsi:type="object">Magento\Framework\ObjectManager\Config\Reader\Dom\Proxy</argument>
             <argument name="logger" xsi:type="object">\Psr\Log\LoggerInterface\Proxy</argument>

dev/tests/integration/framework/Magento/TestFramework/Interception/PluginList.php

@@ -6,7 +6,7 @@
 namespace Magento\TestFramework\Interception;
 
 use Magento\Framework\Interception\ConfigLoaderInterface;
-use Magento\Framework\Interception\ConfigWriterInterface;
+use Magento\Framework\Interception\PluginListGenerator;
 use Magento\Framework\Serialize\SerializerInterface;
 
 /**
@@ -34,7 +34,7 @@ class PluginList extends \Magento\Framework\Interception\PluginList\PluginList
      * @param string|null $cacheId
      * @param SerializerInterface|null $serializer
      * @param ConfigLoaderInterface|null $configLoader
-     * @param ConfigWriterInterface|null $configWriter
+     * @param PluginListGenerator|null $pluginListGenerator
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -50,7 +50,7 @@ public function __construct(
         $cacheId = 'plugins',
         SerializerInterface $serializer = null,
         ConfigLoaderInterface $configLoader = null,
-        ConfigWriterInterface $configWriter = null
+        PluginListGenerator $pluginListGenerator = null
     ) {
         parent::__construct(
             $reader,
@@ -65,7 +65,7 @@ public function __construct(
             $cacheId,
             $serializer,
             $configLoader,
-            $configWriter
+            $pluginListGenerator
         );
         $this->_originScopeScheme = $this->_scopePriorityScheme;
     }

dev/tests/integration/testsuite/Magento/Framework/Interception/AbstractPlugin.php

@@ -83,10 +83,10 @@ public function setUpInterceptionConfig($pluginConfig)
         $cacheManager->method('load')->willReturn(null);
         $definitions = new \Magento\Framework\ObjectManager\Definition\Runtime();
         $relations = new \Magento\Framework\ObjectManager\Relations\Runtime();
-        $dirList = new DirectoryList(DirectoryList::GENERATED_METADATA);
-        $configLoader = new \Magento\Framework\Interception\ConfigLoader($dirList);
+        $configLoader = $this->createMock(ConfigLoaderInterface::class);
         $logger = $this->createMock(\Psr\Log\LoggerInterface::class);
-        $configWriter = $this->createMock(\Magento\Framework\App\ObjectManager\ConfigWriterInterface::class);
+        $directoryList = $this->createMock(DirectoryList::class);
+        $configWriter = $this->createMock(PluginListGenerator::class);
         $interceptionConfig = new Config\Config(
             $this->_configReader,
             $configScope,
@@ -112,6 +112,7 @@ public function setUpInterceptionConfig($pluginConfig)
             \Magento\Framework\Serialize\SerializerInterface::class              => $json,
             \Magento\Framework\Interception\ConfigLoaderInterface::class         => $configLoader,
             \Psr\Log\LoggerInterface::class                                      => $logger,
+            \Magento\Framework\App\Filesystem\DirectoryList::class               => $directoryList,
             \Magento\Framework\App\ObjectManager\ConfigWriterInterface::class    => $configWriter
         ];
         $this->_objectManager = new \Magento\Framework\ObjectManager\ObjectManager(
@@ -128,7 +129,7 @@ public function setUpInterceptionConfig($pluginConfig)
                     \Magento\Framework\Interception\PluginListInterface::class =>
                         \Magento\Framework\Interception\PluginList\PluginList::class,
                     \Magento\Framework\Interception\ConfigWriterInterface::class =>
-                        \Magento\Framework\Interception\ConfigWriter::class
+                        \Magento\Framework\Interception\PluginListGenerator::class
                 ],
             ]
         );

lib/internal/Magento/Framework/Interception/ConfigLoader.php

@@ -10,8 +10,8 @@
 use Magento\Framework\Config\ReaderInterface;
 use Magento\Framework\Config\ScopeInterface;
 use Magento\Framework\Interception\ConfigLoaderInterface;
-use Magento\Framework\Interception\ConfigWriterInterface;
 use Magento\Framework\Interception\DefinitionInterface;
+use Magento\Framework\Interception\PluginListGenerator;
 use Magento\Framework\Interception\PluginListInterface as InterceptionPluginList;
 use Magento\Framework\Interception\ObjectManager\ConfigInterface;
 use Magento\Framework\ObjectManager\RelationsInterface;
@@ -88,9 +88,9 @@ class PluginList extends Scoped implements InterceptionPluginList
     private $configLoader;
 
     /**
-     * @var ConfigWriterInterface
+     * @var PluginListGenerator
      */
-    private $configWriter;
+    private $pluginListGenerator;
 
     /**
      * Constructor
@@ -107,7 +107,7 @@ class PluginList extends Scoped implements InterceptionPluginList
      * @param string|null $cacheId
      * @param SerializerInterface|null $serializer
      * @param ConfigLoaderInterface|null $configLoader
-     * @param ConfigWriterInterface|null $configWriter
+     * @param PluginListGenerator|null $pluginListGenerator
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -123,7 +123,7 @@ public function __construct(
         $cacheId = 'plugins',
         SerializerInterface $serializer = null,
         ConfigLoaderInterface $configLoader = null,
-        ConfigWriterInterface $configWriter = null
+        PluginListGenerator $pluginListGenerator = null
     ) {
         $this->serializer = $serializer ?: $objectManager->get(Serialize::class);
         parent::__construct($reader, $configScope, $cache, $cacheId, $this->serializer);
@@ -134,7 +134,7 @@ public function __construct(
         $this->_scopePriorityScheme = $scopePriorityScheme;
         $this->_objectManager = $objectManager;
         $this->configLoader = $configLoader ?: $this->_objectManager->get(ConfigLoaderInterface::class);
-        $this->configWriter = $configWriter ?: $this->_objectManager->get(ConfigWriterInterface::class);
+        $this->pluginListGenerator = $pluginListGenerator ?: $this->_objectManager->get(PluginListGenerator::class);
     }
 
     /**
@@ -145,7 +145,7 @@ public function __construct(
      */
     protected function _inheritPlugins($type)
     {
-        return $this->configWriter->inheritPlugins($type, $this->_data, $this->_inherited, $this->_processed);
+        return $this->pluginListGenerator->inheritPlugins($type, $this->_data, $this->_inherited, $this->_processed);
     }
 
     /**
@@ -157,7 +157,7 @@ protected function _inheritPlugins($type)
      */
     protected function _sort($itemA, $itemB)
     {
-        return $this->configWriter->sort($itemA, $itemB);
+        return ($itemA['sortOrder'] ?? PHP_INT_MIN) - ($itemB['sortOrder'] ?? PHP_INT_MIN);
     }
 
     /**
@@ -238,7 +238,7 @@ protected function _loadScopedData()
                         $this->_data,
                         $this->_inherited,
                         $this->_processed
-                    ] = $this->configWriter->loadScopedVirtualTypes(
+                    ] = $this->pluginListGenerator->loadScopedVirtualTypes(
                         $this->_scopePriorityScheme,
                         $this->_loadedScopes,
                         $this->_data,
@@ -269,7 +269,7 @@ protected function _loadScopedData()
      */
     protected function isCurrentScope($scopeCode)
     {
-        return $this->configWriter->isCurrentScope($scopeCode);
+        return $this->_configScope->getCurrentScope() === $scopeCode;
     }
 
     /**
@@ -279,7 +279,7 @@ protected function isCurrentScope($scopeCode)
      */
     protected function getClassDefinitions()
     {
-        return $this->configWriter->getClassDefinitions();
+        return $this->_classDefinitions->getClasses();
     }
 
     /**
@@ -290,6 +290,6 @@ protected function getClassDefinitions()
      */
     public function merge(array $config)
     {
-        $this->_data = $this->configWriter->merge($config, $this->_data);
+        $this->_data = $this->pluginListGenerator->merge($config, $this->_data);
     }
 }

lib/internal/Magento/Framework/Interception/PluginList/PluginList.php

@@ -5,7 +5,7 @@
  */
 namespace Magento\Framework\Interception;
 
-use Magento\Framework\App\ObjectManager\ConfigWriterInterface as ObjectManagerConfigWriterInterface;
+use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Config\ReaderInterface;
 use Magento\Framework\Config\ScopeInterface;
 use Magento\Framework\Interception\ObjectManager\ConfigInterface;
@@ -14,9 +14,9 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * Interception configuration writer for scopes.
+ * Plugin list configuration writer and loader for scopes.
  */
-class ConfigWriter implements ConfigWriterInterface
+class PluginListGenerator implements ConfigWriterInterface, ConfigLoaderInterface
 {
     /**
      * @var ScopeInterface
@@ -78,9 +78,9 @@ class ConfigWriter implements ConfigWriterInterface
     private $logger;
 
     /**
-     * @var ObjectManagerConfigWriterInterface
+     * @var DirectoryList
      */
-    private $configWriter;
+    private $directoryList;
 
     /**
      * @var array
@@ -117,7 +117,7 @@ class ConfigWriter implements ConfigWriterInterface
      * @param DefinitionInterface $definitions
      * @param ClassDefinitions $classDefinitions
      * @param LoggerInterface $logger
-     * @param ObjectManagerConfigWriterInterface $configWriter
+     * @param DirectoryList $directoryList
      * @param array $scopePriorityScheme
      */
     public function __construct(
@@ -128,7 +128,7 @@ public function __construct(
         DefinitionInterface $definitions,
         ClassDefinitions $classDefinitions,
         LoggerInterface $logger,
-        ObjectManagerConfigWriterInterface $configWriter,
+        DirectoryList $directoryList,
         array $scopePriorityScheme = ['global']
     ) {
         $this->reader = $reader;
@@ -138,7 +138,7 @@ public function __construct(
         $this->definitions = $definitions;
         $this->classDefinitions = $classDefinitions;
         $this->logger = $logger;
-        $this->configWriter = $configWriter;
+        $this->directoryList = $directoryList;
         $this->scopePriorityScheme = $scopePriorityScheme;
     }
 
@@ -180,7 +180,7 @@ public function write($scopes)
                 foreach ($this->getClassDefinitions() as $class) {
                     $this->inheritPlugins($class, $this->pluginData, $this->inherited, $this->processed);
                 }
-                $this->configWriter->write(
+                $this->writeConfig(
                     $cacheId,
                     [$this->pluginData, $this->inherited, $this->processed]
                 );
@@ -197,6 +197,23 @@ public function write($scopes)
         }
     }
 
+    /**
+     * Load interception configuration data per scope.
+     *
+     * @param string $cacheId
+     * @return array
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function load($cacheId)
+    {
+        $file = $this->directoryList->getPath(DirectoryList::GENERATED_METADATA) . '/' . $cacheId . '.' . 'php';
+        if (file_exists($file)) {
+            return include $file;
+        }
+
+        return [];
+    }
+
     /**
      * Load virtual types for current scope
      *
@@ -238,7 +255,7 @@ public function loadScopedVirtualTypes($scopePriorityScheme, $loadedScopes, $plu
      *
      * @return array
      */
-    public function getClassDefinitions()
+    private function getClassDefinitions()
     {
         return $this->classDefinitions->getClasses();
     }
@@ -249,7 +266,7 @@ public function getClassDefinitions()
      * @param string $scopeCode
      * @return bool
      */
-    public function isCurrentScope($scopeCode)
+    private function isCurrentScope($scopeCode)
     {
         return $this->scopeConfig->getCurrentScope() === $scopeCode;
     }
@@ -297,7 +314,9 @@ public function inheritPlugins($type, &$pluginData, &$inherited, &$processed)
             $inherited[$type] = null;
             if (is_array($plugins) && count($plugins)) {
                 $this->filterPlugins($plugins);
-                uasort($plugins, [$this, 'sort']);
+                uasort($plugins, function ($itemA, $itemB) {
+                    return ($itemA['sortOrder'] ?? PHP_INT_MIN) - ($itemB['sortOrder'] ?? PHP_INT_MIN);
+                });
                 $this->trimInstanceStartingBackslash($plugins);
                 $inherited[$type] = $plugins;
                 $lastPerMethod = [];
@@ -385,14 +404,33 @@ public function merge(array $config, $pluginData)
     }
 
     /**
-     * Sort items
+     * Writes config in storage
      *
-     * @param array $itemA
-     * @param array $itemB
-     * @return int
+     * @param string $key
+     * @param array $config
+     * @return void
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function sort($itemA, $itemB)
+    private function writeConfig(string $key, array $config)
     {
-        return ($itemA['sortOrder'] ?? PHP_INT_MIN) - ($itemB['sortOrder'] ?? PHP_INT_MIN);
+        $this->initialize();
+        $configuration = sprintf('<?php return %s;', var_export($config, true));
+        file_put_contents(
+            $this->directoryList->getPath(DirectoryList::GENERATED_METADATA) . '/' . $key  . '.php',
+            $configuration
+        );
+    }
+
+    /**
+     * Initializes writer
+     *
+     * @return void
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    private function initialize()
+    {
+        if (!file_exists($this->directoryList->getPath(DirectoryList::GENERATED_METADATA))) {
+            mkdir($this->directoryList->getPath(DirectoryList::GENERATED_METADATA));
+        }
     }
 }