fix(laravel): cache metadata, add trace on debug mode (#6555)

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -59,6 +59,11 @@
 )]
 class Error extends \Exception implements ProblemExceptionInterface, HttpExceptionInterface
 {
+    /**
+     * @var array<int, mixed>
+     */
+    private array $originalTrace;
+
     /**
      * @param array<string, string> $headers
      * @param array<int, mixed>     $originalTrace
@@ -67,12 +72,18 @@ public function __construct(
         private readonly string $title,
         private readonly string $detail,
         #[ApiProperty(identifier: true)] private int $status,
-        private readonly array $originalTrace,
+        array $originalTrace,
         private readonly ?string $instance = null,
         private string $type = 'about:blank',
         private array $headers = []
     ) {
         parent::__construct();
+
+        $this->originalTrace = [];
+        foreach ($originalTrace as $i => $t) {
+            unset($t['args']); // we don't want arguments in our JSON traces, especially with xdebug
+            $this->originalTrace[$i] = $t;
+        }
     }
 
     /**

src/Laravel/ApiResource/Error.php

@@ -50,7 +50,8 @@ public function __construct(
         private readonly ?IdentifiersExtractorInterface $identifiersExtractor = null,
         private readonly ?ResourceClassResolverInterface $resourceClassResolver = null,
         ?Negotiator $negotiator = null,
-        private readonly ?array $exceptionToStatus = null
+        private readonly ?array $exceptionToStatus = null,
+        private readonly ?bool $debug = false
     ) {
         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
         $this->negotiator = $negotiator;
@@ -135,7 +136,7 @@ public function register(): void
             }
 
             if (!isset($normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES])) {
-                $normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = ['trace', 'file', 'line', 'code', 'message', 'originalTrace'];
+                $normalizationContext[AbstractObjectNormalizer::IGNORED_ATTRIBUTES] = true === $this->debug ? [] : ['originalTrace'];
             }
 
             $operation = $operation->withNormalizationContext($normalizationContext);

src/Laravel/Exception/ErrorHandler.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Laravel\Metadata;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
+use Illuminate\Support\Facades\Cache;
+
+final readonly class CachePropertyMetadataFactory implements PropertyMetadataFactoryInterface
+{
+    public function __construct(
+        private PropertyMetadataFactoryInterface $decorated,
+        private string $cacheStore
+    ) {
+    }
+
+    public function create(string $resourceClass, string $property, array $options = []): ApiProperty
+    {
+        $key = hash('xxh3', serialize(['resource_class' => $resourceClass, 'property' => $property] + $options));
+
+        return Cache::store($this->cacheStore)->rememberForever($key, function () use ($resourceClass, $property, $options) {
+            return $this->decorated->create($resourceClass, $property, $options);
+        });
+    }
+}

src/Laravel/Metadata/CachePropertyMetadataFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Laravel\Metadata;
+
+use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
+use ApiPlatform\Metadata\Property\PropertyNameCollection;
+use Illuminate\Support\Facades\Cache;
+
+final readonly class CachePropertyNameCollectionMetadataFactory implements PropertyNameCollectionFactoryInterface
+{
+    public function __construct(
+        private PropertyNameCollectionFactoryInterface $decorated,
+        private string $cacheStore
+    ) {
+    }
+
+    public function create(string $resourceClass, array $options = []): PropertyNameCollection
+    {
+        $key = hash('xxh3', serialize(['resource_class' => $resourceClass] + $options));
+
+        return Cache::store($this->cacheStore)->rememberForever($key, function () use ($resourceClass, $options) {
+            return $this->decorated->create($resourceClass, $options);
+        });
+    }
+}

src/Laravel/Metadata/CachePropertyNameCollectionMetadataFactory.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Laravel\Metadata;
+
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
+use Illuminate\Support\Facades\Cache;
+
+final readonly class CacheResourceCollectionMetadataFactory implements ResourceMetadataCollectionFactoryInterface
+{
+    public function __construct(
+        private ResourceMetadataCollectionFactoryInterface $decorated,
+        private string $cacheStore
+    ) {
+    }
+
+    public function create(string $resourceClass): ResourceMetadataCollection
+    {
+        return Cache::store($this->cacheStore)->rememberForever($resourceClass, function () use ($resourceClass) {
+            return $this->decorated->create($resourceClass);
+        });
+    }
+}

src/Laravel/Metadata/CacheResourceCollectionMetadataFactory.php

@@ -291,4 +291,12 @@ public function testVisible(): void
         $response->assertHeader('content-type', 'application/ld+json; charset=utf-8');
         $this->assertStringNotContainsString('internalNote', (string) $response->getContent());
     }
+
+    public function testError(): void
+    {
+        $response = $this->post('/api/books', ['content-type' => 'application/vnd.api+json']);
+        $response->assertStatus(415);
+        $content = $response->json();
+        $this->assertArrayHasKey('trace', $content);
+    }
 }

src/Laravel/Tests/JsonLdTest.php

@@ -13,7 +13,9 @@
 
 namespace ApiPlatform\Laravel\Tests;
 
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use Orchestra\Testbench\Attributes\DefineEnvironment;
 use Orchestra\Testbench\Concerns\WithWorkbench;
 use Orchestra\Testbench\TestCase;
 
@@ -37,4 +39,23 @@ public function testNotFound(): void
             'detail' => 'Not Found',
         ]);
     }
+
+    /**
+     * @param Application $app
+     */
+    protected function useProductionMode($app): void
+    {
+        $app['config']->set('app.debug', false);
+    }
+
+    #[DefineEnvironment('useProductionMode')]
+    public function testProductionError(): void
+    {
+        $response = $this->post('/api/books', ['content-type' => 'application/vnd.api+json']);
+        $response->assertStatus(415);
+        $content = $response->json();
+        $this->assertArrayNotHasKey('trace', $content);
+        $this->assertArrayNotHasKey('line', $content);
+        $this->assertArrayNotHasKey('file', $content);
+    }
 }