fix(laravel): allow serializer attributes through ApiProperty

src/Laravel/ApiPlatformProvider.php

@@ -165,6 +165,7 @@
 use ApiPlatform\Serializer\ItemNormalizer;
 use ApiPlatform\Serializer\JsonEncoder;
 use ApiPlatform\Serializer\Mapping\Factory\ClassMetadataFactory as SerializerClassMetadataFactory;
+use ApiPlatform\Serializer\Mapping\Loader\PropertyMetadataLoader;
 use ApiPlatform\Serializer\Parameter\SerializerFilterParameterProvider;
 use ApiPlatform\Serializer\SerializerContextBuilder;
 use ApiPlatform\State\CallableProcessor;
@@ -206,6 +207,7 @@
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
 use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
+use Symfony\Component\Serializer\Mapping\Loader\LoaderChain;
 use Symfony\Component\Serializer\Mapping\Loader\LoaderInterface;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
@@ -244,8 +246,15 @@ public function register(): void
 
         $this->app->bind(LoaderInterface::class, AttributeLoader::class);
         $this->app->bind(ClassMetadataFactoryInterface::class, ClassMetadataFactory::class);
-        $this->app->singleton(ClassMetadataFactory::class, function () {
-            return new ClassMetadataFactory(new AttributeLoader());
+        $this->app->singleton(ClassMetadataFactory::class, function (Application $app) {
+            return new ClassMetadataFactory(
+                new LoaderChain([
+                    new PropertyMetadataLoader(
+                        $app->make(PropertyNameCollectionFactoryInterface::class),
+                    ),
+                    new AttributeLoader(),
+                ])
+            );
         });
 
         $this->app->singleton(SerializerClassMetadataFactory::class, function (Application $app) {

src/Laravel/Eloquent/Metadata/Factory/Property/EloquentPropertyNameCollectionMetadataFactory.php

@@ -39,8 +39,12 @@ public function create(string $resourceClass, array $options = []): PropertyName
             return $this->decorated?->create($resourceClass, $options) ?? new PropertyNameCollection();
         }
 
-        $refl = new \ReflectionClass($resourceClass);
         try {
+            $refl = new \ReflectionClass($resourceClass);
+            if ($refl->isAbstract()) {
+                return $this->decorated?->create($resourceClass, $options) ?? new PropertyNameCollection();
+            }
+
             $model = $refl->newInstanceWithoutConstructor();
         } catch (\ReflectionException) {
             return $this->decorated?->create($resourceClass, $options) ?? new PropertyNameCollection();

src/Laravel/Tests/JsonApiTest.php

@@ -188,4 +188,13 @@ public function testDeleteBook(): void
         $response->assertStatus(204);
         $this->assertNull(Book::find($book->id));
     }
+
+    public function testRelationWithGroups(): void
+    {
+        $response = $this->get('/api/with_accessors/1', ['accept' => 'application/vnd.api+json']);
+        $content = $response->json();
+        $this->assertArrayHasKey('relationships', $content);
+        $this->assertArrayHasKey('relation', $content['relationships']);
+        $this->assertArrayHasKey('data', $content['relationships']['relation']);
+    }
 }

src/Laravel/Tests/JsonLdTest.php

@@ -298,4 +298,12 @@ public function testError(): void
         $content = $response->json();
         $this->assertArrayHasKey('trace', $content);
     }
+
+    public function testRelationWithGroups(): void
+    {
+        $response = $this->get('/api/with_accessors/1', ['accept' => 'application/ld+json']);
+        $content = $response->json();
+        $this->assertArrayHasKey('relation', $content);
+        $this->assertArrayHasKey('name', $content['relation']);
+    }
 }

src/Laravel/workbench/app/Models/WithAccessor.php

@@ -13,18 +13,27 @@
 
 namespace Workbench\App\Models;
 
+use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Symfony\Component\Serializer\Attribute\Groups;
 
-#[ApiResource]
+#[ApiResource(normalizationContext: ['groups' => ['read']])]
 class WithAccessor extends Model
 {
     use HasFactory;
 
     protected $hidden = ['created_at', 'updated_at', 'id'];
 
+    #[ApiProperty(serialize: [new Groups(['read'])])]
+    public function relation(): BelongsTo
+    {
+        return $this->belongsTo(WithAccessorRelation::class);
+    }
+
     protected function name(): Attribute
     {
         return Attribute::make(

src/Laravel/workbench/app/Models/WithAccessorRelation.php

@@ -0,0 +1,26 @@
+<?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 Workbench\App\Models;
+
+use ApiPlatform\Metadata\ApiResource;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Symfony\Component\Serializer\Attribute\Groups;
+
+#[Groups(['read'])]
+#[ApiResource(operations: [])]
+class WithAccessorRelation extends Model
+{
+    use HasFactory;
+}

src/Laravel/workbench/database/factories/WithAccessorFactory.php

@@ -39,6 +39,7 @@ public function definition(): array
     {
         return [
             'name' => strtolower(fake()->name()),
+            'relation_id' => WithAccessorRelationFactory::new(),
         ];
     }
 }

src/Laravel/workbench/database/factories/WithAccessorRelationFactory.php

@@ -0,0 +1,44 @@
+<?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 Workbench\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Workbench\App\Models\WithAccessorRelation;
+
+/**
+ * @template TModel of \Workbench\App\Models\WithAccessorRelation
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class WithAccessorRelationFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<TModel>
+     */
+    protected $model = WithAccessorRelation::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'name' => strtolower(fake()->name()),
+        ];
+    }
+}

src/Laravel/workbench/database/migrations/2024_09_24_065934_create_with_accessors_table.php

@@ -21,9 +21,17 @@
      */
     public function up(): void
     {
+        Schema::create('with_accessor_relations', function (Blueprint $table): void {
+            $table->id();
+            $table->string('name');
+            $table->timestamps();
+        });
+
         Schema::create('with_accessors', function (Blueprint $table): void {
             $table->id();
             $table->string('name');
+            $table->integer('relation_id')->unsigned();
+            $table->foreign('relation_id')->references('id')->on('with_accessor_relations');
             $table->timestamps();
         });
     }
@@ -34,5 +42,6 @@ public function up(): void
     public function down(): void
     {
         Schema::dropIfExists('with_accessors');
+        Schema::dropIfExists('with_accessors_relation');
     }
 };

src/Metadata/ApiProperty.php

@@ -14,6 +14,12 @@
 namespace ApiPlatform\Metadata;
 
 use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\Serializer\Attribute\Context;
+use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Serializer\Attribute\Ignore;
+use Symfony\Component\Serializer\Attribute\MaxDepth;
+use Symfony\Component\Serializer\Attribute\SerializedName;
+use Symfony\Component\Serializer\Attribute\SerializedPath;
 
 /**
  * ApiProperty annotation.
@@ -24,23 +30,24 @@
 final class ApiProperty
 {
     /**
-     * @param bool|null               $readableLink            https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
-     * @param bool|null               $writableLink            https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
-     * @param bool|null               $required                https://api-platform.com/docs/admin/validation/#client-side-validation
-     * @param bool|null               $identifier              https://api-platform.com/docs/core/identifiers/
-     * @param mixed                   $example                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
-     * @param string|null             $deprecationReason       https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
-     * @param bool|null               $fetchEager              https://api-platform.com/docs/core/performance/#eager-loading
-     * @param array|null              $jsonldContext           https://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
-     * @param array|null              $openapiContext          https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
-     * @param bool|null               $push                    https://api-platform.com/docs/core/push-relations/
-     * @param string|\Stringable|null $security                https://api-platform.com/docs/core/security
-     * @param string|\Stringable|null $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
-     * @param string[]                $types                   the RDF types of this property
-     * @param string[]                $iris
-     * @param Type[]                  $builtinTypes
-     * @param string|null             $uriTemplate             (experimental) whether to return the subRessource collection IRI instead of an iterable of IRI
-     * @param string|null             $property                The property name
+     * @param bool|null                                                                $readableLink            https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
+     * @param bool|null                                                                $writableLink            https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
+     * @param bool|null                                                                $required                https://api-platform.com/docs/admin/validation/#client-side-validation
+     * @param bool|null                                                                $identifier              https://api-platform.com/docs/core/identifiers/
+     * @param mixed                                                                    $example                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
+     * @param string|null                                                              $deprecationReason       https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
+     * @param bool|null                                                                $fetchEager              https://api-platform.com/docs/core/performance/#eager-loading
+     * @param array|null                                                               $jsonldContext           https://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
+     * @param array|null                                                               $openapiContext          https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
+     * @param bool|null                                                                $push                    https://api-platform.com/docs/core/push-relations/
+     * @param string|\Stringable|null                                                  $security                https://api-platform.com/docs/core/security
+     * @param string|\Stringable|null                                                  $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
+     * @param string[]                                                                 $types                   the RDF types of this property
+     * @param string[]                                                                 $iris
+     * @param Type[]                                                                   $builtinTypes
+     * @param string|null                                                              $uriTemplate             (experimental) whether to return the subRessource collection IRI instead of an iterable of IRI
+     * @param string|null                                                              $property                The property name
+     * @param array<int, Groups|SerializedName|SerializedPath|MaxDepth|Ignore|Context> $serialize
      */
     public function __construct(
         private ?string $description = null,
@@ -205,6 +212,7 @@ public function __construct(
         private ?string $uriTemplate = null,
         private ?string $property = null,
         private ?string $policy = null,
+        private ?array $serialize = null,
         private array $extraProperties = [],
     ) {
         if (\is_string($types)) {
@@ -600,4 +608,20 @@ public function withPolicy(?string $policy): static
 
         return $self;
     }
+
+    public function getSerialize(): ?array
+    {
+        return $this->serialize;
+    }
+
+    /**
+     * @param array<int, Groups|SerializedName|SerializedPath|MaxDepth|Ignore|Context> $serialize
+     */
+    public function withSerialize(array $serialize): static
+    {
+        $self = clone $this;
+        $self->serialize = $serialize;
+
+        return $self;
+    }
 }