Merge pull request #8327 from mickaelandrieu/migration/hooks-system-c…

…ollector Added a new collector for Hooks
PrestaShop · Sep 18, 2017 · 9f785c6 · 9f785c6
2 parents aa5633f + f2d4cda
commit 9f785c6
Show file tree

Hide file tree

Showing 7 changed files with 516 additions and 2 deletions.
diff --git a/classes/Hook.php b/classes/Hook.php
@@ -25,6 +25,7 @@
  */
 
 use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
+use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
 
 class HookCore extends ObjectModel
 {
@@ -705,6 +706,14 @@ public static function exec(
             return;
         }
 
+        $hookRegistry = self::getHookRegistry();
+        $isRegistryEnabled = !is_null($hookRegistry);
+
+        if ($isRegistryEnabled) {
+            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
+            $hookRegistry->selectHook($hook_name, $hook_args, $backtrace[0]['file'], $backtrace[0]['line']);
+        }
+
         // $chain & $array_return are incompatible so if chained is set to true, we disable the array_return option
         if (true === $chain) {
             $array_return = false;
@@ -723,6 +732,9 @@ public static function exec(
         // If no modules associated to hook_name or recompatible hook name, we stop the function
 
         if (!$module_list = Hook::getHookModuleExecList($hook_name)) {
+            if ($isRegistryEnabled) {
+                $hookRegistry->collect();
+            }
             if ($array_return) {
                 return array();
             } else {
@@ -732,6 +744,9 @@ public static function exec(
 
         // Check if hook exists
         if (!$id_hook = Hook::getIdByName($hook_name)) {
+            if ($isRegistryEnabled) {
+                $hookRegistry->collect();
+            }
             if ($array_return) {
                 return array();
             } else {
@@ -827,6 +842,10 @@ public static function exec(
                 continue;
             }
 
+            if ($isRegistryEnabled) {
+                $hookRegistry->hookedByModule($moduleInstance);
+            }
+
             if (Hook::isHookCallableOn($moduleInstance, $hook_name)) {
                 $hook_args['altern'] = ++$altern;
 
@@ -849,6 +868,9 @@ public static function exec(
                         $output .= $display;
                     }
                 }
+                if ($isRegistryEnabled) {
+                    $hookRegistry->hookedByCallback($moduleInstance, $hook_args);
+                }
             } elseif (Hook::isDisplayHookName($hook_name)) {
                 if ($moduleInstance instanceof WidgetInterface) {
 
@@ -868,6 +890,10 @@ public static function exec(
                         }
                     }
                 }
+
+                if ($isRegistryEnabled) {
+                    $hookRegistry->hookedByWidget($moduleInstance, $hook_args);
+                }
             }
         }
 
@@ -885,6 +911,11 @@ public static function exec(
             }
         }
 
+        if ($isRegistryEnabled) {
+            $hookRegistry->hookWasCalled();
+            $hookRegistry->collect();
+        }
+
         return $output;
     }
 
@@ -897,4 +928,17 @@ public static function coreRenderWidget($module, $hook_name, $params)
     {
         return $module->renderWidget($hook_name, $params);
     }
+
+    /**
+     * @return null|\PrestaShopBundle\DataCollector\HookRegistry
+     */
+    private static function getHookRegistry()
+    {
+        $sfContainer = SymfonyContainer::getInstance();
+        if (!is_null($sfContainer) && "dev" === $sfContainer->getParameter('kernel.environment')) {
+            return $sfContainer->get('prestashop.hooks_registry');
+        }
+
+        return null;
+    }
 }
diff --git a/classes/module/Module.php b/classes/module/Module.php
@@ -28,8 +28,9 @@
 use PrestaShop\PrestaShop\Adapter\Module\ModuleDataProvider;
 use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
 use PrestaShop\PrestaShop\Adapter\ServiceLocator;
+use PrestaShop\PrestaShop\Core\Module\ModuleInterface;
 
-abstract class ModuleCore
+abstract class ModuleCore implements ModuleInterface
 {
     /** @var int Module ID */
     public $id = null;

diff --git a/src/Core/Module/ModuleInterface.php b/src/Core/Module/ModuleInterface.php
@@ -0,0 +1,35 @@
+<?php
+/**
+ * 2007-2017 PrestaShop
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to http://www.prestashop.com for more information.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2017 PrestaShop SA
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShop\PrestaShop\Core\Module;
+
+/**
+ * Define what should be a module.
+ * Note:We don't typeHint on old Module class to not create hard dependency with Legacy.
+ */
+interface ModuleInterface
+{
+}
diff --git a/src/PrestaShopBundle/DataCollector/HookDataCollector.php b/src/PrestaShopBundle/DataCollector/HookDataCollector.php
@@ -0,0 +1,120 @@
+<?php
+/**
+ * 2007-2017 PrestaShop
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to http://www.prestashop.com for more information.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2017 PrestaShop SA
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShopBundle\DataCollector;
+
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * Collect all information about Legacy hooks and make it available
+ * in the Symfony Web profiler.
+ */
+final class HookDataCollector extends DataCollector
+{
+    /**
+     * @var HookRegistry
+     */
+    private $registry;
+
+    public function __construct(HookRegistry $registry)
+    {
+        $this->registry = $registry;
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function collect(Request $request, Response $response, \Exception $exception = null)
+    {
+        $hooks = $this->registry->getHooks();
+        $calledHooks = $this->registry->getCalledHooks();
+        $notCalledHooks = $this->registry->getNotCalledHooks();
+        $this->data = array(
+            'hooks' => $this->stringifyHookArguments($hooks),
+            'calledHooks' => $this->stringifyHookArguments($calledHooks),
+            'notCalledHooks' => $this->stringifyHookArguments($notCalledHooks),
+        );
+    }
+
+    /**
+     * Return the list of every dispatched legacy hooks during one request.
+     * @return array
+     */
+    public function getHooks()
+    {
+        return $this->data['hooks'];
+    }
+
+    /**
+     * Return the list of every called legacy hooks during one request.
+     * @return array
+     */
+    public function getCalledHooks()
+    {
+        return $this->data['calledHooks'];
+    }
+
+    /**
+     * Return the list of every uncalled legacy hooks during oHookne request.
+     * @return array
+     */
+    public function getNotCalledHooks()
+    {
+        return $this->data['notCalledHooks'];
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function getName()
+    {
+        return 'ps.hooks_collector';
+    }
+
+    /**
+     * @param array $hooksList
+     * @return array a better representation of arguments for HTML rendering.
+     */
+    private function stringifyHookArguments(array &$hooksList)
+    {
+        foreach ($hooksList as &$hookList) {
+            foreach ($hookList as &$hook) {
+                $hook['args'] = $this->varToString($hook['args']);
+                foreach ($hook['modules'] as &$modulesByType) {
+                    foreach ($modulesByType as &$module) {
+                        if (array_key_exists('args', $module)) {
+                            $module['args'] = $this->varToString($module['args']);
+                        }
+                    }
+                }
+            }
+        }
+
+        return $hooksList;
+    }
+}