ENGCOM-6133: Optimize config data traversal in Store/Config/Placeholder #25164

 - Merge Pull Request #25164 from ven-com/magento2:2.3-placeholder-optimization
 - Merged commits:
   1. 2a807f2

Author: magento-engcom-team

app/code/Magento/Store/Model/Config/Placeholder.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Store\Model\Config;
 
 /**
@@ -32,8 +33,8 @@ class Placeholder
      */
     public function __construct(\Magento\Framework\App\RequestInterface $request, $urlPaths, $urlPlaceholder)
     {
-        $this->request = $request;
-        $this->urlPaths = $urlPaths;
+        $this->request        = $request;
+        $this->urlPaths       = $urlPaths;
         $this->urlPlaceholder = $urlPlaceholder;
     }
 
@@ -45,15 +46,46 @@ public function __construct(\Magento\Framework\App\RequestInterface $request, $u
      */
     public function process(array $data = [])
     {
-        foreach (array_keys($data) as $key) {
-            $this->_processData($data, $key);
+        // check provided arguments
+        if (empty($data)) {
+            return [];
+        }
+
+        // initialize $pointer, $parents and $level variable
+        reset($data);
+        $pointer = &$data;
+        $parents = [];
+        $level   = 0;
+
+        while ($level >= 0) {
+            $current = &$pointer[key($pointer)];
+            if (is_array($current)) {
+                reset($current);
+                $parents[$level] = &$pointer;
+                $pointer         = &$current;
+                $level++;
+            } else {
+                $current = $this->_processPlaceholders($current, $data);
+
+                // move pointer of last queue layer to next element
+                // or remove layer if all path elements were processed
+                while ($level >= 0 && next($pointer) === false) {
+                    $level--;
+                    // removal of last element of $parents is skipped here for better performance
+                    // on next iteration that element will be overridden
+                    $pointer = &$parents[$level];
+                }
+            }
         }
+
         return $data;
     }
 
     /**
      * Process array data recursively
      *
+     * @deprecated This method isn't used in process() implementation anymore
+     *
      * @param array &$data
      * @param string $path
      * @return void
@@ -90,7 +122,7 @@ protected function _processPlaceholders($value, $data)
 
             if ($url) {
                 $value = str_replace('{{' . $placeholder . '}}', $url, $value);
-            } elseif (strpos($value, (string) $this->urlPlaceholder) !== false) {
+            } elseif (strpos($value, (string)$this->urlPlaceholder) !== false) {
                 $distroBaseUrl = $this->request->getDistroBaseUrl();
 
                 $value = str_replace($this->urlPlaceholder, $distroBaseUrl, $value);
@@ -113,10 +145,9 @@ protected function _getPlaceholder($value)
     {
         if (is_string($value) && preg_match('/{{(.*)}}.*/', $value, $matches)) {
             $placeholder = $matches[1];
-            if ($placeholder == 'unsecure_base_url' || $placeholder == 'secure_base_url' || strpos(
-                $value,
-                (string) $this->urlPlaceholder
-            ) !== false
+            if ($placeholder == 'unsecure_base_url' ||
+                $placeholder == 'secure_base_url' ||
+                strpos($value, (string)$this->urlPlaceholder) !== false
             ) {
                 return $placeholder;
             }
@@ -147,20 +178,22 @@ protected function _getValue($path, array $data)
     /**
      * Set array value by path
      *
+     * @deprecated This method isn't used in process() implementation anymore
+     *
      * @param array &$container
      * @param string $path
      * @param string $value
      * @return void
      */
     protected function _setValue(array &$container, $path, $value)
     {
-        $segments = explode('/', $path);
-        $currentPointer = & $container;
+        $segments       = explode('/', $path);
+        $currentPointer = &$container;
         foreach ($segments as $segment) {
             if (!isset($currentPointer[$segment])) {
                 $currentPointer[$segment] = [];
             }
-            $currentPointer = & $currentPointer[$segment];
+            $currentPointer = &$currentPointer[$segment];
         }
         $currentPointer = $value;
     }

app/code/Magento/Store/Test/Unit/Model/Config/PlaceholderTest.php

@@ -23,7 +23,7 @@ protected function setUp()
     {
         $this->_requestMock = $this->createMock(\Magento\Framework\App\Request\Http::class);
         $this->_requestMock->expects(
-            $this->once()
+            $this->any()
         )->method(
             'getDistroBaseUrl'
         )->will(
@@ -54,11 +54,27 @@ public function testProcess()
             ],
             'path' => 'value',
             'some_url' => '{{base_url}}some',
+            'level1' => [
+                'level2' => [
+                    'level3' => [
+                        // test that all levels are processed (i.e. implementation is not hardcoded to 3 levels)
+                        'level4' => '{{secure_base_url}}level4'
+                    ]
+                ]
+            ]
         ];
         $expectedResult = $data;
         $expectedResult['web']['unsecure']['base_link_url'] = 'http://localhost/website/de';
         $expectedResult['web']['secure']['base_link_url'] = 'https://localhost/website/de';
+        $expectedResult['level1']['level2']['level3']['level4'] = 'https://localhost/level4';
         $expectedResult['some_url'] = 'http://localhost/some';
         $this->assertEquals($expectedResult, $this->_model->process($data));
     }
+
+    public function testProcessEmptyArray()
+    {
+        $data = [];
+        $expectedResult = [];
+        $this->assertEquals($expectedResult, $this->_model->process($data));
+    }
 }