vendor/shopware/core/Framework/Script/Debugging/ScriptTraces.php line 63

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Script\Debugging;
  5. use Shopware\Core\Framework\Script\Execution\FunctionHook;
  6. use Shopware\Core\Framework\Script\Execution\Hook;
  7. use Shopware\Core\Framework\Script\Execution\Script;
  8. use Symfony\Bundle\FrameworkBundle\DataCollector\AbstractDataCollector;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\Response;
  11. use Symfony\Component\VarDumper\Cloner\Data;
  12. use Symfony\Contracts\Service\ResetInterface;
  14. /**
  15.  * @deprecated tag:v6.5.0 - reason:becomes-internal - will be internal
  16.  */
  17. class ScriptTraces extends AbstractDataCollector implements ResetInterface
  18. {
  19.     /**
  20.      * @var array<string, mixed>
  21.      */
  22.     protected array $traces = [];
  24.     protected static array $deprecationNotices = [];
  26.     public static function addDeprecationNotice(string $deprecationNotice): void
  27.     {
  28.         static::$deprecationNotices[] = $deprecationNotice;
  29.     }
  31.     public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
  32.     {
  33.         $this->data = $this->traces;
  34.     }
  36.     /**
  37.      * @deprecated tag:v6.5.0 will be removed, use `initHook` instead
  38.      */
  39.     public function init(string $hook): void
  40.     {
  41.         // dummy implementation to not break
  42.     }
  44.     public function initHook(Hook $hook): void
  45.     {
  46.         $name = $this->getHookName($hook);
  48.         if (\array_key_exists($name, $this->traces)) {
  49.             // don't overwrite existing traces
  50.             return;
  51.         }
  53.         $this->traces[$name] = [];
  54.     }
  56.     public function trace(Hook $hook, Script $script, \Closure $execute): void
  57.     {
  58.         $time = microtime(true);
  60.         $debug = new Debug();
  62.         static::$deprecationNotices = [];
  63.         $execute($debug);
  64.         $deprecations = static::$deprecationNotices;
  65.         static::$deprecationNotices = [];
  67.         $took = round(microtime(true) - $time, 3);
  69.         $name = explode('/', $script->getName());
  70.         $name = array_pop($name);
  72.         $this->add($hook, $name, $took, $debug, $deprecations);
  73.     }
  75.     public function getHookCount(): int
  76.     {
  77.         if ($this->data instanceof Data) {
  78.             return $this->data->count();
  79.         }
  81.         return \count($this->data);
  82.     }
  84.     public function getHooks(): array
  85.     {
  86.         if ($this->data instanceof Data) {
  87.             return [];
  88.         }
  90.         return array_keys($this->data);
  91.     }
  93.     public function getScripts(string $hook): array
  94.     {
  95.         return $this->data[$hook] ?? [];
  96.     }
  98.     public function getTook(): float
  99.     {
  100.         $data = $this->data instanceof Data ? $this->data->getIterator() : $this->data;
  102.         $took = 0.0;
  103.         foreach ($data as $scripts) {
  104.             $took += array_sum(array_column($scripts, 'took'));
  105.         }
  107.         return $took;
  108.     }
  110.     public function getScriptCount(): int
  111.     {
  112.         $count = 0;
  113.         foreach ($this->data as $scripts) {
  114.             $count += \count($scripts);
  115.         }
  117.         return $count;
  118.     }
  120.     public function getDeprecationCount(): int
  121.     {
  122.         $count = 0;
  123.         foreach ($this->data as $scripts) {
  124.             foreach ($scripts as $script) {
  125.                 foreach ($script['deprecations'] as $deprecationCount) {
  126.                     $count += $deprecationCount;
  127.                 }
  128.             }
  129.         }
  131.         return $count;
  132.     }
  134.     public static function getTemplate(): ?string
  135.     {
  136.         return '@Profiling/Collector/script_traces.html.twig';
  137.     }
  139.     /**
  140.      * @return array|Data
  141.      */
  142.     public function getData()
  143.     {
  144.         return $this->data;
  145.     }
  147.     /**
  148.      * @return array<string, mixed>
  149.      */
  150.     public function getTraces(): array
  151.     {
  152.         return $this->traces;
  153.     }
  155.     public function reset(): void
  156.     {
  157.         parent::reset();
  158.         $this->traces = [];
  159.     }
  161.     private function add(Hook $hook, string $name, float $took, Debug $output, array $deprecations): void
  162.     {
  163.         $deprecations = array_count_values($deprecations);
  164.         arsort($deprecations);
  166.         $this->traces[$this->getHookName($hook)][] = [
  167.             'name' => $name,
  168.             'took' => $took,
  169.             'output' => $output->all(),
  170.             'deprecations' => $deprecations,
  171.         ];
  172.     }
  174.     private function getHookName(Hook $hook): string
  175.     {
  176.         if (!$hook instanceof FunctionHook) {
  177.             return $hook->getName();
  178.         }
  180.         return $hook->getName() . '::' . $hook->getFunctionName();
  181.     }
  182. }