MC-24057: Implement static dependency analysis for wildcard and API urls

- added implementation for checking controller wildcard urls

Author: Rrego6

dev/tests/static/framework/Magento/TestFramework/Dependency/PhpRule.php

@@ -113,7 +113,8 @@ public function __construct(
         array $pluginMap = [],
         array $whitelists = [],
         ClassScanner $classScanner = null
-    ) {
+    )
+    {
         $this->_mapRouters = $mapRouters;
         $this->_mapLayoutBlocks = $mapLayoutBlocks;
         $this->configReader = $configReader;
@@ -146,7 +147,7 @@ public function getDependencyInfo($currentModule, $fileType, $file, &$contents)
         );
         $dependenciesInfo = $this->considerCaseDependencies(
             $dependenciesInfo,
-            $this->_caseGetUrl($currentModule, $contents)
+            $this->_caseGetUrl($currentModule, $contents, $file)
         );
         $dependenciesInfo = $this->considerCaseDependencies(
             $dependenciesInfo,
@@ -304,12 +305,13 @@ private function isPluginDependency($dependent, $dependency)
      *
      * @param string $currentModule
      * @param string $contents
+     * @param string $file
      * @return array
      * @throws LocalizedException
      * @throws \Exception
      * @SuppressWarnings(PMD.CyclomaticComplexity)
      */
-    protected function _caseGetUrl(string $currentModule, string &$contents): array
+    protected function _caseGetUrl(string $currentModule, string &$contents, string $file): array
     {
         $dependencies = [];
         $pattern = '#(\->|:)(?<source>getUrl\(([\'"])(?<path>[a-zA-Z0-9\-_*\/]+)\3)\s*[,)]#';
@@ -321,11 +323,7 @@ protected function _caseGetUrl(string $currentModule, string &$contents): array
                 $path = $item['path'];
                 $returnedDependencies = [];
                 if (strpos($path, '*') !== false) {
-                    /**
-                     * Skip processing wildcard urls since they always resolve to the current
-                     * route_front_name/area_front_name/controller_name
-                     */
-                    continue;
+                    $returnedDependencies = $this->processWildcardUrl($path, $file);
                 } elseif (preg_match('#rest(?<service>/V1/\w+)#i', $path, $apiMatch)) {
                     $returnedDependencies = $this->processApiUrl($apiMatch['service']);
                 } else {
@@ -347,6 +345,66 @@ protected function _caseGetUrl(string $currentModule, string &$contents): array
         return $dependencies;
     }
 
+    /**
+     * Helper method to get module dependencies used by a wildcard Url
+     *
+     * @param string $urlPath
+     * @param string $filePath
+     * @return string[]
+     * @throws NoSuchActionException
+     */
+    private function processWildcardUrl(string $urlPath, string $filePath)
+    {
+        $filePath = strtolower($filePath);
+        $urlRoutePieces = explode('/', $urlPath);
+        $routeId = array_shift($urlRoutePieces);
+
+        //Skip route wildcard processing as this requires using the routeMapper
+        if ('*' === $routeId) {
+            return [];
+        }
+        $filePathInfo = pathinfo($filePath);
+        $fileActionName = $filePathInfo['filename'];
+        $filePathPieces = explode('/', $filePathInfo['dirname']);
+
+        /**
+         * Only handle Controllers. ie: Ignore Blocks, Templates, and Models due to complexity in static resolution
+         * of route
+         */
+        if (in_array('block', $filePathPieces)
+            || in_array('model', $filePathPieces)
+            || $filePathInfo['extension'] === 'phtml'
+        ) {
+            return [];
+        }
+        $fileControllerIndex = array_search('adminhtml', $filePathPieces)
+            ?? array_search('controller', $filePathPieces);
+
+        $controllerName = array_shift($urlRoutePieces);
+        if ('*' === $controllerName) {
+            $fileControllerName = implode("_", array_slice($filePathPieces, $fileControllerIndex + 1));
+            $controllerName = $fileControllerName;
+        }
+
+        if (empty($urlRoutePieces) || !$urlRoutePieces[0]) {
+            return $this->routeMapper->getDependencyByRoutePath(
+                $routeId,
+                $controllerName,
+                UrlInterface::DEFAULT_ACTION_NAME
+            );
+        }
+
+        $actionName = array_shift($urlRoutePieces);
+        if ('*' === $actionName) {
+            $actionName = $fileActionName;
+        }
+        return $this->routeMapper->getDependencyByRoutePath(
+            $routeId,
+            $controllerName,
+            $actionName
+        );
+    }
+
     /**
      * Helper method to get module dependencies used by a standard URL
      *
@@ -357,7 +415,7 @@ protected function _caseGetUrl(string $currentModule, string &$contents): array
     private function processStandardUrl(string $path)
     {
         $pattern = '#(?<route_id>[a-z0-9\-_]{3,})'
-                   . '\/?(?<controller_name>[a-z0-9\-_]+)?\/?(?<action_name>[a-z0-9\-_]+)?#i';
+            . '\/?(?<controller_name>[a-z0-9\-_]+)?\/?(?<action_name>[a-z0-9\-_]+)?#i';
         if (preg_match($pattern, $path, $match)) {
             $routeId = $match['route_id'];
             $controllerName = $match['controller_name'] ?? UrlInterface::DEFAULT_CONTROLLER_NAME;

dev/tests/static/testsuite/Magento/Test/Integrity/Dependency/Converter.php

@@ -13,22 +13,10 @@ class Converter implements \Magento\Framework\Config\ConverterInterface
     /**#@+
      * Array keys for config internal representation.
      */
-    const KEY_SERVICE_CLASS = 'class';
-    const KEY_URL = 'url';
-    const KEY_SERVICE_METHOD = 'method';
-    const KEY_SECURE = 'secure';
-    const KEY_ROUTES = 'routes';
-    const KEY_ACL_RESOURCES = 'resources';
-    const KEY_SERVICE = 'service';
-    const KEY_SERVICES = 'services';
-    const KEY_FORCE = 'force';
-    const KEY_VALUE = 'value';
-    const KEY_DATA_PARAMETERS = 'parameters';
-    const KEY_SOURCE = 'source';
-    const KEY_METHOD = 'method';
-    const KEY_METHODS = 'methods';
-    const KEY_DESCRIPTION = 'description';
-    const KEY_REAL_SERVICE_METHOD = 'realMethod';
+    private const KEY_SERVICE_CLASS = 'class';
+    private const KEY_SERVICE_METHOD = 'method';
+    private const KEY_ROUTES = 'routes';
+    private const KEY_SERVICE = 'service';
     /**#@-*/
 
     /**

dev/tests/static/testsuite/Magento/Test/Integrity/DependencyTest.php

@@ -26,6 +26,7 @@
 use Magento\TestFramework\Dependency\ReportsConfigRule;
 use Magento\TestFramework\Dependency\Route\RouteMapper;
 use Magento\TestFramework\Dependency\VirtualType\VirtualTypeMapper;
+use Magento\TestFramework\Workaround\Override\Config\ValidationState;
 
 /**
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
@@ -284,25 +285,17 @@ protected static function _initRules()
         // In case primary module declaring the table cannot be identified, use any module referencing this table
         $tableToModuleMap = array_merge($tableToAnyModuleMap, $tableToPrimaryModuleMap);
 
-        $objectManager = Bootstrap::create(BP, $_SERVER)->getObjectManager();
-
-        $webApiConfigReader = $objectManager->create(
-            Reader::class,
+        $webApiConfigReader = new Reader(
+            new WebapiFileResolver(self::getComponentRegistrar()),
+            new Converter(),
+            new SchemaLocator(self::getComponentRegistrar()),
+            new ValidationState(),
+            'webapi.xml',
             [
-                'fileResolver' => new WebapiFileResolver(
-                    self::getComponentRegistrar()
-                ),
-                'converter' => new Converter(),
-                'schemaLocator' => new SchemaLocator(
-                    self::getComponentRegistrar()
-                ),
-                'fileName' => 'webapi.xml',
-                'idAttributes' => [
-                        '/routes/route' => ['url', 'method'],
-                        '/routes/route/resources/resource' => 'ref',
-                        '/routes/route/data/parameter' => 'name'
-                    ],
-            ]
+                '/routes/route' => ['url', 'method'],
+                '/routes/route/resources/resource' => 'ref',
+                '/routes/route/data/parameter' => 'name'
+            ],
         );
 
         self::$_rulesInstances = [