feat(symfony): debug profiler state provider and processor (#4677)

soyuka · emmanuel-averty · web-flow · commit 20f2f559c00c · 2022-03-11T16:18:33.000+01:00
* feat(metadata): Show state providers in profiler

* feat(metadata): test state provider tab in profiler

* test: fix cs + requires php 8

Co-authored-by: emmanuel &lt;emmanuel@les-tilleuls.coop&gt;
diff --git a/src/Symfony/Bundle/DataCollector/RequestDataCollector.php b/src/Symfony/Bundle/DataCollector/RequestDataCollector.php
@@ -26,7 +26,9 @@
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\State\ProcessorInterface;
+use ApiPlatform\State\ProviderInterface;
 use ApiPlatform\Symfony\Bundle\Processor\TraceableChainProcessor;
+use ApiPlatform\Symfony\Bundle\Provider\TraceableChainProvider;
 use ApiPlatform\Util\RequestAttributesExtractor;
 use PackageVersions\Versions;
 use Psr\Container\ContainerInterface;
@@ -51,16 +53,26 @@ final class RequestDataCollector extends DataCollector
     private $itemDataProvider;
     private $subresourceDataProvider;
     private $dataPersister;
+    private $provider;
     private $processor;
 
-    public function __construct($metadataFactory, ContainerInterface $filterLocator, CollectionDataProviderInterface $collectionDataProvider = null, ItemDataProviderInterface $itemDataProvider = null, SubresourceDataProviderInterface $subresourceDataProvider = null, DataPersisterInterface $dataPersister = null, ProcessorInterface $processor = null)
-    {
+    public function __construct(
+        $metadataFactory,
+        ContainerInterface $filterLocator,
+        CollectionDataProviderInterface $collectionDataProvider = null,
+        ItemDataProviderInterface $itemDataProvider = null,
+        SubresourceDataProviderInterface $subresourceDataProvider = null,
+        DataPersisterInterface $dataPersister = null,
+        ProviderInterface $provider = null,
+        ProcessorInterface $processor = null
+    ) {
         $this->metadataFactory = $metadataFactory;
         $this->filterLocator = $filterLocator;
         $this->collectionDataProvider = $collectionDataProvider;
         $this->itemDataProvider = $itemDataProvider;
         $this->subresourceDataProvider = $subresourceDataProvider;
         $this->dataPersister = $dataPersister;
+        $this->provider = $provider;
         $this->processor = $processor;
 
         if (!$metadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
@@ -103,6 +115,7 @@ public function collect(Request $request, Response $response, \Throwable $except
             'dataProviders' => [],
             'dataPersisters' => ['responses' => []],
             'request_attributes' => $requestAttributes,
+            'providers' => ['responses' => []],
             'processors' => ['responses' => []],
         ];
 
@@ -131,6 +144,13 @@ public function collect(Request $request, Response $response, \Throwable $except
             $this->data['dataPersisters']['responses'] = $this->dataPersister->getPersistersResponse();
         }
 
+        if ($this->provider instanceof TraceableChainProvider) {
+            $this->data['providers'] = [
+                'context' => $this->cloneVar($this->provider->getContext()),
+                'responses' => $this->provider->getProvidersResponse(),
+            ];
+        }
+
         if ($this->processor instanceof TraceableChainProcessor) {
             $this->data['processors']['responses'] = $this->processor->getProcessorsResponse();
         }
@@ -199,6 +219,11 @@ public function getDataPersisters(): array
         return $this->data['dataPersisters'] ?? ['responses' => []];
     }
 
+    public function getProviders(): array
+    {
+        return $this->data['providers'] ?? ['responses' => []];
+    }
+
     public function getProcessors(): array
     {
         return $this->data['processors'] ?? ['responses' => []];
diff --git a/src/Symfony/Bundle/Provider/TraceableChainProvider.php b/src/Symfony/Bundle/Provider/TraceableChainProvider.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Symfony\Bundle\Provider;
+
+use ApiPlatform\State\ChainProvider;
+use ApiPlatform\State\ProviderInterface;
+
+final class TraceableChainProvider implements ProviderInterface
+{
+    private $providers;
+    private $context;
+    private $providersResponse = [];
+    private $decorated;
+
+    public function __construct(ProviderInterface $provider)
+    {
+        if ($provider instanceof ChainProvider) {
+            $this->decorated = $provider;
+            $this->providers = $provider->providers;
+        }
+    }
+
+    public function getProvidersResponse()
+    {
+        return $this->providersResponse;
+    }
+
+    public function getContext()
+    {
+        return $this->context;
+    }
+
+    private function traceProviders(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = [])
+    {
+        foreach ($this->providers as $provider) {
+            $this->providersResponse[\get_class($provider)] = $provider->supports($resourceClass, $identifiers, $operationName, $context);
+        }
+    }
+
+    private function traceContext(array $context)
+    {
+        $this->context = $context;
+    }
+
+    public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = [])
+    {
+        $this->traceProviders($resourceClass, $identifiers, $operationName, $context);
+        $this->traceContext($context);
+
+        return $this->decorated->provide($resourceClass, $identifiers, $operationName, $context);
+    }
+
+    public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool
+    {
+        return $this->decorated->supports($resourceClass, $identifiers, $operationName, $context);
+    }
+}
diff --git a/src/Symfony/Bundle/Resources/config/v3/data_collector.xml b/src/Symfony/Bundle/Resources/config/v3/data_collector.xml
@@ -12,6 +12,7 @@
             <argument type="service" id="api_platform.item_data_provider" />
             <argument type="service" id="api_platform.subresource_data_provider" />
             <argument type="service" id="api_platform.data_persister" />
+            <argument type="service" id="api_platform.state_provider" />
             <argument type="service" id="api_platform.state_processor" />
             <tag
                 name="data_collector"
diff --git a/src/Symfony/Bundle/Resources/config/v3/debug.xml b/src/Symfony/Bundle/Resources/config/v3/debug.xml
@@ -12,6 +12,10 @@
             <argument type="service" id="debug.var_dumper.cli_dumper" />
         </service>
 
+        <service id="debug.api_platform.provider" class="ApiPlatform\Symfony\Bundle\Provider\TraceableChainProvider" decorates="api_platform.state_provider">
+            <argument type="service" id="debug.api_platform.provider.inner" />
+        </service>
+
         <service id="debug.api_platform.processor" class="ApiPlatform\Symfony\Bundle\Processor\TraceableChainProcessor" decorates="api_platform.state_processor">
             <argument type="service" id="debug.api_platform.processor.inner" />
         </service>
diff --git a/src/Symfony/Bundle/Resources/views/DataCollector/request.html.twig b/src/Symfony/Bundle/Resources/views/DataCollector/request.html.twig
@@ -41,18 +41,18 @@
             <thead>
             <tr>
                 <th>#</th>
-                <th>Answer</th>
+                <th>Used</th>
                 <th>{{ name|capitalize }}</th>
             </tr>
             </thead>
             <tbody>
-            {% for class, answer in object.responses %}
+            {% for class, used in object.responses %}
                 <tr>
                     <td class="font-normal text-small text-muted nowrap">{{ loop.index }}</td>
                     <td class="font-normal">
-                        {% if answer is same as(true) %}
+                        {% if used is same as(true) %}
                             <span class="label status-success same-width">TRUE</span>
-                        {% elseif answer is same as(false) %}
+                        {% elseif used is same as(false) %}
                             <span class="label status-error same-width">FALSE</span>
                         {% else %}
                             <span class="label status-info same-width">NOT USED</span>
@@ -202,8 +202,15 @@
             </div>
 
             <div class="tab">
-                <h3 class="tab-title data-processor-tab-title">Processors</h3>
-                <div class="tab-content data-processor-tab-content">
+                <h3 class="tab-title provider-tab-title">Providers</h3>
+                <div class="tab-content provider-tab-content">
+                    {{ apiPlatform.providerTable(collector.providers, 'provider') }}
+                </div>
+            </div>
+
+            <div class="tab">
+                <h3 class="tab-title processor-tab-title">Processors</h3>
+                <div class="tab-content processor-tab-content">
                     {{ apiPlatform.providerTable(collector.processors, 'processors') }}
                 </div>
             </div>
diff --git a/tests/Symfony/Bundle/Twig/ApiPlatformProfilerPanelTest.php b/tests/Symfony/Bundle/Twig/ApiPlatformProfilerPanelTest.php
@@ -162,7 +162,7 @@ public function testProfilerGeneralLayout()
         $this->assertCount(1, $metrics->filter('.metric'), 'The should be one metric displayed (resource class).');
         $this->assertSame('mongodb' === $this->env ? DocumentDummy::class : Dummy::class, $metrics->filter('span.value')->html());
 
-        $this->assertCount(7, $crawler->filter('.sf-tabs .tab-content'), 'Tabs must be presents on the panel.');
+        $this->assertCount(8, $crawler->filter('.sf-tabs .tab-content'), 'Tabs must be presents on the panel.');
 
         // Metadata tab
         $this->assertSame('Metadata', $crawler->filter('.tab:nth-of-type(1) .tab-title')->html());
@@ -178,9 +178,17 @@ public function testProfilerGeneralLayout()
         $this->assertSame('Data Providers', $crawler->filter('.data-provider-tab-title')->html());
         $this->assertNotEmpty($crawler->filter('.data-provider-tab-content'));
 
-        // Data processors tab
-        $this->assertSame('Processors', $crawler->filter('.data-processor-tab-title')->html());
-        $this->assertNotEmpty($crawler->filter('.data-processor-tab-content .empty'));
+        // Data persisters tab
+        $this->assertSame('Data Persisters', $crawler->filter('.data-persister-tab-title')->html());
+        $this->assertNotEmpty($crawler->filter('.data-persister-tab-content'));
+
+        // Providers tab
+        $this->assertSame('Providers', $crawler->filter('.provider-tab-title')->html());
+        $this->assertNotEmpty($crawler->filter('.provider-tab-content .empty'));
+
+        // Processors tab
+        $this->assertSame('Processors', $crawler->filter('.processor-tab-title')->html());
+        $this->assertNotEmpty($crawler->filter('.processor-tab-content .empty'));
     }
 
     /**
@@ -211,9 +219,32 @@ public function testPostCollectionProcessorProfiler()
         $this->assertStringContainsString('No calls to item data provider have been recorded.', $tabContent->html());
         $this->assertStringContainsString('No calls to subresource data provider have been recorded.', $tabContent->html());
 
-        // Data processors tab
-        $tabContent = $crawler->filter('.data-processor-tab-content');
+        // Processors tab
+        $tabContent = $crawler->filter('.processor-tab-content');
         $this->assertSame('TRUE', $tabContent->filter('table tbody .status-success')->html());
         $this->assertStringContainsString(Processor::class, $tabContent->html());
     }
+
+    /**
+     * @requires PHP 8.0
+     */
+    public function testStateProvidersProfiler()
+    {
+        if ($this->legacy) {
+            $this->markTestSkipped('Legacy test.');
+
+            return;
+        }
+
+        $client = static::createClient();
+        $client->enableProfiler();
+        // request to resource that uses state provider
+        $client->request('GET', '/attribute_resources/2', [], [], ['HTTP_ACCEPT' => 'application/ld+json']);
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $crawler = $client->request('GET', '/_profiler/latest?panel=api_platform.data_collector.request', [], [], []);
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+
+        // Providers tab
+        $this->assertNotEmpty($crawler->filter('.provider-tab-content table'));
+    }
 }
