Merge 4.0

Author: soyuka

.github/workflows/guides.yaml

@@ -4,6 +4,10 @@ on:
     push:
     pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 env:
     COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     COVERAGE: '0'

CHANGELOG.md

@@ -47,6 +47,23 @@ On write operations, we added the [expectsHeader](https://www.hydra-cg.com/spec/
 * [d0a442786](https://github.com/api-platform/core/commit/d0a44278630d201b91cbba0774a09f4eeaac88f7) feat(doctrine): enhance getLinksHandler with method validation and typo suggestions (#6874)
 * [f67f6f1ac](https://github.com/api-platform/core/commit/f67f6f1acb6476182c18a3503f2a8bc80ae89a0b)  feat(doctrine): doctrine filters like laravel eloquent filters  (#6775)
 
+=======
+## v4.0.17
+
+### Bug fixes
+
+* [5124d8c57](https://github.com/api-platform/core/commit/5124d8c571bc4324aa060e4ff808d48f0ffa8d73) fix(laravel): Prevent overwriting existing routes on the router (#6941)
+* [5c7e0d2c0](https://github.com/api-platform/core/commit/5c7e0d2c015b5264b2f857abc7e6cb944582de21) fix(symfony): error wrongly inherit normalization context (#6939)
+* [af35d34d0](https://github.com/api-platform/core/commit/af35d34d01e62e96dd81dadde6a056ce67d47703) fix(laravel): mitigate property metadata read for Error (#6951)
+* [d5b48b1cd](https://github.com/api-platform/core/commit/d5b48b1cd6163ee755211476fdd3d4dd0bf6f7ae) fix(laravel): SwaggerUI custom CSS (#6937)
+* [da796b979](https://github.com/api-platform/core/commit/da796b979384663c3eaf4e4fe4d215b447800844) fix(metadata): allow serializer attribute object in ApiProperty::$serialize (#6946)
+* [de2d298e3](https://github.com/api-platform/core/commit/de2d298e306b196bce834af290aec242807ea39b) fix: ensure template files have a tpl file extension (#6826) (#6829)
+* [b6a67a197](https://github.com/api-platform/core/commit/b6a67a197a668ce15f216cffbcddc637f19c69c2) perf: various optimizations for Laravel/Symfony (#6954)
+
+To save some time during cache warmup we recommend to define uri variables such as: `uriVariables: ['id']`. More details at #6954.
+
+### Features
+
 ## v4.0.16
 
 ### Bug fixes

src/Laravel/ApiPlatformProvider.php

@@ -250,6 +250,7 @@ public function register(): void
             );
         });
 
+        $this->app->singleton(ModelMetadata::class);
         $this->app->bind(LoaderInterface::class, AttributeLoader::class);
         $this->app->bind(ClassMetadataFactoryInterface::class, ClassMetadataFactory::class);
         $this->app->singleton(ClassMetadataFactory::class, function (Application $app) {

src/Laravel/Eloquent/Metadata/ModelMetadata.php

@@ -16,7 +16,6 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Str;
 
 /**
@@ -26,6 +25,16 @@
  */
 final class ModelMetadata
 {
+    /**
+     * @var array<class-string, Collection<string, mixed>>
+     */
+    private $attributesLocalCache = [];
+
+    /**
+     * @var array<class-string, Collection<int, mixed>>
+     */
+    private $relationsLocalCache = [];
+
     /**
      * The methods that can be called in a model to indicate a relation.
      *
@@ -45,31 +54,25 @@ final class ModelMetadata
         'morphedByMany',
     ];
 
-    /**
-     * Gets the first policy associated with this model.
-     */
-    public function getPolicy(Model $model): ?string
-    {
-        $policy = Gate::getPolicyFor($model::class);
-
-        return $policy ? $policy::class : null;
-    }
-
     /**
      * Gets the column attributes for the given model.
      *
      * @return Collection<string, mixed>
      */
     public function getAttributes(Model $model): Collection
     {
+        if (isset($this->attributesLocalCache[$model::class])) {
+            return $this->attributesLocalCache[$model::class];
+        }
+
         $connection = $model->getConnection();
         $schema = $connection->getSchemaBuilder();
         $table = $model->getTable();
         $columns = $schema->getColumns($table);
         $indexes = $schema->getIndexes($table);
         $relations = $this->getRelations($model);
 
-        return collect($columns)
+        return $this->attributesLocalCache[$model::class] = collect($columns)
             ->reject(
                 fn ($column) => $relations->contains(
                     fn ($relation) => $relation['foreign_key'] === $column['name']
@@ -112,7 +115,7 @@ private function isColumnPrimaryKey(array $indexes, string $column): bool
      *
      * @return Collection<int, mixed>
      */
-    public function getVirtualAttributes(Model $model, array $columns): Collection
+    private function getVirtualAttributes(Model $model, array $columns): Collection
     {
         $class = new \ReflectionClass($model);
 
@@ -155,7 +158,11 @@ public function getVirtualAttributes(Model $model, array $columns): Collection
      */
     public function getRelations(Model $model): Collection
     {
-        return collect(get_class_methods($model))
+        if (isset($this->relationsLocalCache[$model::class])) {
+            return $this->relationsLocalCache[$model::class];
+        }
+
+        return $this->relationsLocalCache[$model::class] = collect(get_class_methods($model))
             ->map(fn ($method) => new \ReflectionMethod($model, $method))
             ->reject(
                 fn (\ReflectionMethod $method) => $method->isStatic()
@@ -207,20 +214,6 @@ public function getRelations(Model $model): Collection
             ->values();
     }
 
-    /**
-     * Gets the Events that the model dispatches.
-     *
-     * @return Collection<int, mixed>
-     */
-    public function getEvents(Model $model): Collection
-    {
-        return collect($model->dispatchesEvents())
-            ->map(fn (string $class, string $event) => [
-                'event' => $event,
-                'class' => $class,
-            ])->values();
-    }
-
     /**
      * Gets the cast type for the given column.
      */

src/Metadata/Resource/Factory/ConcernsResourceNameCollectionFactory.php

@@ -47,10 +47,14 @@ public function create(): ResourceNameCollection
         }
 
         foreach (ReflectionClassRecursiveIterator::getReflectionClassesFromDirectories($this->paths) as $className => $reflectionClass) {
+            if (!$reflectionClass->hasMethod('apiResource')) {
+                continue;
+            }
+
+            $m = $reflectionClass->getMethod('apiResource');
+
             if (
-                $reflectionClass->hasMethod('apiResource')
-                && ($m = $reflectionClass->getMethod('apiResource'))
-                && $m->isPublic()
+                $m->isPublic()
                 && $m->isStatic()
             ) {
                 $classes[$className] = true;

src/Metadata/Resource/Factory/LinkFactory.php

@@ -26,6 +26,11 @@
  */
 final class LinkFactory implements LinkFactoryInterface, PropertyLinkFactoryInterface
 {
+    /**
+     * @var array<class-string, string[]>
+     */
+    private $localIdentifiersPerResourceClassCache = [];
+
     public function __construct(private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, private readonly ResourceClassResolverInterface $resourceClassResolver)
     {
     }
@@ -138,8 +143,17 @@ public function completeLink(Link $link): Link
         return $link;
     }
 
+    /**
+     * @param class-string $resourceClass
+     *
+     * @return string[]
+     */
     private function getIdentifiersFromResourceClass(string $resourceClass): array
     {
+        if (isset($this->localIdentifiersPerResourceClassCache[$resourceClass])) {
+            return $this->localIdentifiersPerResourceClassCache[$resourceClass];
+        }
+
         $hasIdProperty = false;
         $identifiers = [];
         foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
@@ -155,14 +169,14 @@ private function getIdentifiersFromResourceClass(string $resourceClass): array
         }
 
         if ($hasIdProperty && !$identifiers) {
-            return ['id'];
+            return $this->localIdentifiersPerResourceClassCache[$resourceClass] = ['id'];
         }
 
         if (!$hasIdProperty && !$identifiers && enum_exists($resourceClass)) {
-            return ['value'];
+            return $this->localIdentifiersPerResourceClassCache[$resourceClass] = ['value'];
         }
 
-        return $identifiers;
+        return $this->localIdentifiersPerResourceClassCache[$resourceClass] = $identifiers;
     }
 
     /**

src/Metadata/Util/ReflectionClassRecursiveIterator.php

@@ -22,12 +22,26 @@
  */
 final class ReflectionClassRecursiveIterator
 {
+    /**
+     * @var array<string, array<class-string, \ReflectionClass>>
+     */
+    private static array $localCache;
+
     private function __construct()
     {
     }
 
-    public static function getReflectionClassesFromDirectories(array $directories): \Iterator
+    /**
+     * @return array<class-string, \ReflectionClass>
+     */
+    public static function getReflectionClassesFromDirectories(array $directories): array
     {
+        $id = hash('xxh3', implode('', $directories));
+        if (isset(self::$localCache[$id])) {
+            return self::$localCache[$id];
+        }
+
+        $includedFiles = [];
         foreach ($directories as $path) {
             $iterator = new \RegexIterator(
                 new \RecursiveIteratorIterator(
@@ -61,12 +75,15 @@ public static function getReflectionClassesFromDirectories(array $directories):
         $sortedInterfaces = get_declared_interfaces();
         sort($sortedInterfaces);
         $declared = [...$sortedClasses, ...$sortedInterfaces];
+        $ret = [];
         foreach ($declared as $className) {
             $reflectionClass = new \ReflectionClass($className);
             $sourceFile = $reflectionClass->getFileName();
             if (isset($includedFiles[$sourceFile])) {
-                yield $className => $reflectionClass;
+                $ret[$className] = $reflectionClass;
             }
         }
+
+        return self::$localCache[$id] = $ret;
     }
 }