feat: refactor DI file handling for compatibility module registration

Author: dermatz

src/Service/VendorFileMapper.php

@@ -291,74 +291,112 @@ private function parseCompatModuleXml(string $moduleName): ?string
                 return null;
             }
 
-            // Check frontend/di.xml first, then global di.xml
-            $diFile = $path . '/etc/frontend/di.xml';
-            $globalDiFile = $path . '/etc/di.xml';
-
-            $filesToCheck = [];
-            if ($this->fileDriver->isExists($diFile)) {
-                $filesToCheck[] = $diFile;
-            }
-            if ($this->fileDriver->isExists($globalDiFile)) {
-                $filesToCheck[] = $globalDiFile;
-            }
+            $filesToCheck = $this->getDiFilesToCheck($path);
 
             foreach ($filesToCheck as $diPath) {
-                if (!$this->fileDriver->isFile($diPath)) { // Extra check for symlinks/is_file
-                    continue;
+                $originalModule = $this->parseDiFileForCompatModule($diPath, $moduleName);
+                if ($originalModule) {
+                    return $originalModule;
                 }
+            }
+        } catch (\Throwable $e) {
+            return null;
+        }
 
-                $content = $this->fileDriver->fileGetContents($diPath);
-                if (!$content) {
-                    continue;
-                }
+        return null;
+    }
 
-                $dom = new \DOMDocument();
-                // Suppress warnings for malformed XML or namespace issues
-                $libxmlState = libxml_use_internal_errors(true);
-                $dom->loadXML($content);
-                libxml_use_internal_errors($libxmlState);
+    /**
+     * Get DI files to check for compat module registration
+     *
+     * @param string $modulePath
+     * @return array<string>
+     */
+    private function getDiFilesToCheck(string $modulePath): array
+    {
+        $diFile = $modulePath . '/etc/frontend/di.xml';
+        $globalDiFile = $modulePath . '/etc/di.xml';
 
-                $xpath = new \DOMXPath($dom);
-                // Register namespace? Usually not needed if query is correct
-                // Try to find the compatModules argument node
-                $query = "//argument[@name='compatModules'][@xsi:type='array']/item[@xsi:type='array']";
-                $items = $xpath->query($query);
+        $filesToCheck = [];
+        if ($this->fileDriver->isExists($diFile)) {
+            $filesToCheck[] = $diFile;
+        }
+        if ($this->fileDriver->isExists($globalDiFile)) {
+            $filesToCheck[] = $globalDiFile;
+        }
 
-                if ($items === false || $items->length === 0) {
-                    continue;
-                }
+        return $filesToCheck;
+    }
 
-                foreach ($items as $item) {
-                    // Check children items for compat_module/original_module keys
-                    $compatModuleValue = null;
-                    $originalModuleValue = null;
+    /**
+     * Parse a single di.xml file for compat module registration
+     *
+     * @param string $diPath
+     * @param string $moduleName
+     * @return string|null
+     */
+    private function parseDiFileForCompatModule(string $diPath, string $moduleName): ?string
+    {
+        if (!$this->fileDriver->isFile($diPath)) {
+            return null;
+        }
 
-                    /** @var \DOMElement $item */
-                    $childNodes = $xpath->query('item', $item);
-                    if ($childNodes === false) {
-                        continue;
-                    }
+        $content = $this->fileDriver->fileGetContents($diPath);
+        if (!$content) {
+            return null;
+        }
 
-                    foreach ($childNodes as $childNode) {
-                        /** @var \DOMElement $childNode */
-                        $nameAttr = $childNode->getAttribute('name');
-                        $value = trim((string) $childNode->nodeValue);
+        $dom = new \DOMDocument();
+        $libxmlState = libxml_use_internal_errors(true);
+        $dom->loadXML($content);
+        libxml_use_internal_errors($libxmlState);
 
-                        if ($nameAttr === 'compat_module') {
-                            $compatModuleValue = $value;
-                        } elseif ($nameAttr === 'original_module') {
-                            $originalModuleValue = $value;
-                        }
-                    }
+        $xpath = new \DOMXPath($dom);
+        $query = "//argument[@name='compatModules'][@xsi:type='array']/item[@xsi:type='array']";
+        $items = $xpath->query($query);
 
-                    if ($compatModuleValue === $moduleName && $originalModuleValue) {
-                        return $originalModuleValue;
-                    }
+        if ($items === false || $items->length === 0) {
+            return null;
+        }
+
+        return $this->findOriginalModuleInXmlItems($items, $xpath, $moduleName);
+    }
+
+    /**
+     * Find original module in XML items
+     *
+     * @param \DOMNodeList<\DOMNode> $items
+     * @param \DOMXPath $xpath
+     * @param string $moduleName
+     * @return string|null
+     */
+    private function findOriginalModuleInXmlItems(\DOMNodeList $items, \DOMXPath $xpath, string $moduleName): ?string
+    {
+        foreach ($items as $item) {
+            $compatModuleValue = null;
+            $originalModuleValue = null;
+
+            /** @var \DOMElement $item */
+            $childNodes = $xpath->query('item', $item);
+            if ($childNodes === false) {
+                continue;
+            }
+
+            foreach ($childNodes as $childNode) {
+                /** @var \DOMElement $childNode */
+                $nameAttr = $childNode->getAttribute('name');
+                $value = trim((string) $childNode->nodeValue);
+
+                if ($nameAttr === 'compat_module') {
+                    $compatModuleValue = $value;
+                } elseif ($nameAttr === 'original_module') {
+                    $originalModuleValue = $value;
                 }
             }
-        } catch (\Throwable $e) {
-            return null;
+
+            if ($compatModuleValue === $moduleName && $originalModuleValue) {
+                return $originalModuleValue;
+            }
         }
 
         return null;