[Worflow] Add a TraceableWorkflow

lyrixx · lyrixx · commit 47482591cb6e · 2023-10-19T17:38:02.000+02:00
diff --git a/DataCollector/WorkflowDataCollector.php b/DataCollector/WorkflowDataCollector.php
@@ -15,7 +15,12 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
+use Symfony\Component\VarDumper\Caster\Caster;
+use Symfony\Component\VarDumper\Cloner\Stub;
+use Symfony\Component\Workflow\Debug\TraceableWorkflow;
 use Symfony\Component\Workflow\Dumper\MermaidDumper;
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\TransitionBlocker;
 
 /**
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
@@ -34,11 +39,17 @@ public function collect(Request $request, Response $response, \Throwable $except
     public function lateCollect(): void
     {
         foreach ($this->workflows as $workflow) {
+            $calls = [];
+            if ($workflow instanceof TraceableWorkflow) {
+                $calls = $this->cloneVar($workflow->getCalls());
+            }
+
             // We always use a workflow type because we want to mermaid to
             // create a node for transitions
             $dumper = new MermaidDumper(MermaidDumper::TRANSITION_TYPE_WORKFLOW);
             $this->data['workflows'][$workflow->getName()] = [
                 'dump' => $dumper->dump($workflow->getDefinition()),
+                'calls' => $calls,
             ];
         }
     }
@@ -57,4 +68,38 @@ public function getWorkflows(): array
     {
         return $this->data['workflows'] ?? [];
     }
+
+    public function getCallsCount(): int
+    {
+        $i = 0;
+        foreach ($this->getWorkflows() as $workflow) {
+            $i += \count($workflow['calls']);
+        }
+
+        return $i;
+    }
+
+    protected function getCasters(): array
+    {
+        $casters = [
+            ...parent::getCasters(),
+            TransitionBlocker::class => function ($v, array $a, Stub $s, $isNested) {
+                unset(
+                    $a[sprintf(Caster::PATTERN_PRIVATE, $v::class, 'code')],
+                    $a[sprintf(Caster::PATTERN_PRIVATE, $v::class, 'parameters')],
+                );
+
+                $s->cut += 2;
+
+                return $a;
+            },
+            Marking::class => function ($v, array $a, Stub $s, $isNested) {
+                $a[Caster::PREFIX_VIRTUAL.'.places'] = array_keys($v->getPlaces());
+
+                return $a;
+            },
+        ];
+
+        return $casters;
+    }
 }
diff --git a/Debug/TraceableWorkflow.php b/Debug/TraceableWorkflow.php
@@ -0,0 +1,122 @@
+<?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\Debug;
+
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Workflow\Definition;
+use Symfony\Component\Workflow\Marking;
+use Symfony\Component\Workflow\MarkingStore\MarkingStoreInterface;
+use Symfony\Component\Workflow\Metadata\MetadataStoreInterface;
+use Symfony\Component\Workflow\TransitionBlockerList;
+use Symfony\Component\Workflow\WorkflowInterface;
+
+/**
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+class TraceableWorkflow implements WorkflowInterface
+{
+    private array $calls = [];
+
+    public function __construct(
+        private readonly WorkflowInterface $workflow,
+        private readonly Stopwatch $stopwatch,
+    ) {
+    }
+
+    public function getMarking(object $subject, array $context = []): Marking
+    {
+        return $this->callInner(__FUNCTION__, \func_get_args());
+    }
+
+    public function can(object $subject, string $transitionName): bool
+    {
+        return $this->callInner(__FUNCTION__, \func_get_args());
+    }
+
+    public function buildTransitionBlockerList(object $subject, string $transitionName): TransitionBlockerList
+    {
+        return $this->callInner(__FUNCTION__, \func_get_args());
+    }
+
+    public function apply(object $subject, string $transitionName, array $context = []): Marking
+    {
+        return $this->callInner(__FUNCTION__, \func_get_args());
+    }
+
+    public function getEnabledTransitions(object $subject): array
+    {
+        return $this->callInner(__FUNCTION__, \func_get_args());
+    }
+
+    public function getName(): string
+    {
+        return $this->workflow->getName();
+    }
+
+    public function getDefinition(): Definition
+    {
+        return $this->workflow->getDefinition();
+    }
+
+    public function getMarkingStore(): MarkingStoreInterface
+    {
+        return $this->workflow->getMarkingStore();
+    }
+
+    public function getMetadataStore(): MetadataStoreInterface
+    {
+        return $this->workflow->getMetadataStore();
+    }
+
+    public function getCalls(): array
+    {
+        return $this->calls;
+    }
+
+    private function callInner(string $method, array $args): mixed
+    {
+        $sMethod = $this->workflow::class.'::'.$method;
+        $this->stopwatch->start($sMethod, 'workflow');
+
+        $previousMarking = null;
+        if ('apply' === $method) {
+            try {
+                $previousMarking = $this->workflow->getMarking($args[0]);
+            } catch (\Throwable) {
+            }
+        }
+
+        try {
+            $return = $this->workflow->{$method}(...$args);
+
+            $this->calls[] = [
+                'method' => $method,
+                'duration' => $this->stopwatch->stop($sMethod)->getDuration(),
+                'args' => $args,
+                'previousMarking' => $previousMarking ?? null,
+                'return' => $return,
+            ];
+
+            return $return;
+        } catch (\Throwable $exception) {
+            $this->calls[] = [
+                'method' => $method,
+                'duration' => $this->stopwatch->stop($sMethod)->getDuration(),
+                'args' => $args,
+                'previousMarking' => $previousMarking ?? null,
+                'exception' => $exception,
+            ];
+
+            throw $exception;
+        }
+    }
+}
diff --git a/DependencyInjection/WorkflowDebugPass.php b/DependencyInjection/WorkflowDebugPass.php
@@ -0,0 +1,37 @@
+<?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\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\Workflow\Debug\TraceableWorkflow;
+
+/**
+ * Adds all configured security voters to the access decision manager.
+ *
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+class WorkflowDebugPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        foreach ($container->findTaggedServiceIds('workflow') as $id => $attributes) {
+            $container->register("debug.{$id}", TraceableWorkflow::class)
+                ->setDecoratedService($id)
+                ->setArguments([
+                    new Reference("debug.{$id}.inner"),
+                    new Reference('debug.stopwatch'),
+                ]);
+        }
+    }
+}
diff --git a/Registry.php b/Registry.php
@@ -41,7 +41,7 @@ public function has(object $subject, string $workflowName = null): bool
         return false;
     }
 
-    public function get(object $subject, string $workflowName = null): Workflow
+    public function get(object $subject, string $workflowName = null): WorkflowInterface
     {
         $matched = [];
 

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function has(object $subject, string $workflowName = null): bool`
`41`	`41`	`return false;`
`42`	`42`	`}`
`43`	`43`
`44`		`- public function get(object $subject, string $workflowName = null): Workflow`
	`44`	`+ public function get(object $subject, string $workflowName = null): WorkflowInterface`
`45`	`45`	`{`
`46`	`46`	`$matched = [];`
`47`	`47`