From df292cbf7d0b0d8185bffcf6cff090b9d3b79d9f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gr=C3=A9goire=20Pineau?= <lyrixx@lyrixx.info>
Date: Tue, 1 Aug 2023 14:56:42 +0200
Subject: [PATCH] [Workflow] Add a profiler

---
 .../FrameworkExtension.php                    |  5 ++
 .../Resources/config/workflow_debug.php       | 27 ++++++++
 .../views/Collector/workflow.html.twig        | 62 +++++++++++++++++++
 .../Resources/views/Icon/workflow.svg         |  1 +
 src/Symfony/Component/Workflow/CHANGELOG.md   |  1 +
 .../DataCollector/WorkflowDataCollector.php   | 60 ++++++++++++++++++
 6 files changed, 156 insertions(+)
 create mode 100644 src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow_debug.php
 create mode 100644 src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/workflow.html.twig
 create mode 100644 src/Symfony/Bundle/WebProfilerBundle/Resources/views/Icon/workflow.svg
 create mode 100644 src/Symfony/Component/Workflow/DataCollector/WorkflowDataCollector.php

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
index b1ae9e6d31aef..2610d4311f74f 100644
--- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
+++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -280,6 +280,7 @@ public function load(array $configs, ContainerBuilder $container)
         $this->readConfigEnabled('translator', $container, $config['translator']);
         $this->readConfigEnabled('property_access', $container, $config['property_access']);
         $this->readConfigEnabled('profiler', $container, $config['profiler']);
+        $this->readConfigEnabled('workflows', $container, $config['workflows']);
 
         // A translator must always be registered (as support is included by
         // default in the Form and Validator component). If disabled, an identity
@@ -876,6 +877,10 @@ private function registerProfilerConfiguration(array $config, ContainerBuilder $
             $loader->load('mailer_debug.php');
         }
 
+        if ($this->isInitializedConfigEnabled('workflows')) {
+            $loader->load('workflow_debug.php');
+        }
+
         if ($this->isInitializedConfigEnabled('http_client')) {
             $loader->load('http_client_debug.php');
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow_debug.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow_debug.php
new file mode 100644
index 0000000000000..c37373e0f605a
--- /dev/null
+++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/workflow_debug.php
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Symfony\Component\Workflow\DataCollector\WorkflowDataCollector;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('data_collector.workflow', WorkflowDataCollector::class)
+            ->tag('data_collector', [
+                'template' => '@WebProfiler/Collector/workflow.html.twig',
+                'id' => 'workflow',
+            ])
+            ->args([
+                tagged_iterator('workflow', 'name'),
+            ])
+    ;
+};
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/workflow.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/workflow.html.twig
new file mode 100644
index 0000000000000..5fba10fbb48ac
--- /dev/null
+++ b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/workflow.html.twig
@@ -0,0 +1,62 @@
+{% extends '@WebProfiler/Profiler/layout.html.twig' %}
+
+{% block menu %}
+    <span class="label {{ collector.workflows|length == 0 ? 'disabled' }}">
+        <span class="icon">
+            {{ source('@WebProfiler/Icon/workflow.svg') }}
+        </span>
+        <strong>Workflow</strong>
+    </span>
+{% endblock %}
+
+{% block panel %}
+    <h2>Workflow</h2>
+
+    {% if collector.workflows|length == 0 %}
+        <div class="empty empty-panel">
+            <p>There are no workflows configured.</p>
+        </div>
+    {% else %}
+        <script type="module">
+            import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
+            mermaid.initialize({
+                flowchart: { useMaxWidth: false },
+                securityLevel: 'loose',
+            });
+            // We do not load all mermaid diagrams at once, but only when the tab is opened
+            // This is because mermaid diagrams are in a tab, and cannot be renderer with a
+            // "good size" if they are not visible
+            document.addEventListener('DOMContentLoaded', () => {
+                document.querySelectorAll('.tab').forEach((el) => {
+                    const observer = new MutationObserver(() => {
+                        if (!el.classList.contains('block')) {
+                            return;
+                        }
+                        const mEl = el.querySelector('.sf-mermaid');
+                        if (mEl.dataset.processed) {
+                            return;
+                        }
+                        mermaid.run({
+                            nodes: [mEl],
+                        });
+                    });
+                    observer.observe(el, { attributeFilter: ['class'] });
+                });
+            });
+        </script>
+
+        <h2>Definitions</h2>
+        <div class="sf-tabs js-tabs">
+            {% for name, data in collector.workflows %}
+                <div class="tab">
+                    <h3 class="tab-title">{{ name }}</h3>
+                    <div class="tab-content">
+                        <pre class="sf-mermaid">
+                            {{ data.dump|raw }}
+                        </pre>
+                    </div>
+                </div>
+            {% endfor %}
+        </div>
+    {% endif %}
+{% endblock %}
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Icon/workflow.svg b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Icon/workflow.svg
new file mode 100644
index 0000000000000..c6b9886f94f34
--- /dev/null
+++ b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Icon/workflow.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="800" height="800" class="icon" viewBox="0 0 1024 1024"><path fill="currentColor" d="M149.333 661.333h213.334v213.334H149.333zm603.734-249.6L633.6 292.267c-8.533-8.534-8.533-21.334 0-29.867l119.467-119.467c8.533-8.533 21.333-8.533 29.866 0L902.4 262.4c8.533 8.533 8.533 21.333 0 29.867L782.933 411.733c-8.533 8.534-21.333 8.534-29.866 0zM128 277.333a128 128 0 1 0 256 0 128 128 0 1 0-256 0ZM640 768a128 128 0 1 0 256 0 128 128 0 1 0-256 0ZM234.667 512h42.666v106.667h-42.666z"/><path fill="currentColor" d="m256 448-64 85.333h128zM426.667 256h106.666v42.667H426.667z"/><path fill="currentColor" d="m597.333 277.333-85.333-64v128zM746.667 448h42.666v106.667h-42.666z"/><path fill="currentColor" d="m768 618.667 64-85.334H704z"/></svg>
diff --git a/src/Symfony/Component/Workflow/CHANGELOG.md b/src/Symfony/Component/Workflow/CHANGELOG.md
index 1fc1373198bbd..e1656d6118e78 100644
--- a/src/Symfony/Component/Workflow/CHANGELOG.md
+++ b/src/Symfony/Component/Workflow/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Add `with-metadata` option to the `workflow:dump` command to include places,
    transitions and workflow's metadata into dumped graph
  * Add support for storing marking in a property
+ * Add a profiler
 
 6.2
 ---
diff --git a/src/Symfony/Component/Workflow/DataCollector/WorkflowDataCollector.php b/src/Symfony/Component/Workflow/DataCollector/WorkflowDataCollector.php
new file mode 100644
index 0000000000000..a708b268289a3
--- /dev/null
+++ b/src/Symfony/Component/Workflow/DataCollector/WorkflowDataCollector.php
@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Workflow\DataCollector;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
+use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
+use Symfony\Component\Workflow\Dumper\MermaidDumper;
+use Symfony\Component\Workflow\StateMachine;
+
+/**
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+final class WorkflowDataCollector extends DataCollector implements LateDataCollectorInterface
+{
+    public function __construct(
+        private readonly iterable $workflows,
+    ) {
+    }
+
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
+    {
+    }
+
+    public function lateCollect(): void
+    {
+        foreach ($this->workflows as $workflow) {
+            $type = $workflow instanceof StateMachine ? MermaidDumper::TRANSITION_TYPE_STATEMACHINE : MermaidDumper::TRANSITION_TYPE_WORKFLOW;
+            $dumper = new MermaidDumper($type);
+            $this->data['workflows'][$workflow->getName()] = [
+                'dump' => $dumper->dump($workflow->getDefinition()),
+            ];
+        }
+    }
+
+    public function getName(): string
+    {
+        return 'workflow';
+    }
+
+    public function reset(): void
+    {
+        $this->data = [];
+    }
+
+    public function getWorkflows(): array
+    {
+        return $this->data['workflows'] ?? [];
+    }
+}