fix(laravel): persist embeded relations with groups

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -256,30 +256,26 @@ public function register(): void
         });
 
         $this->app->singleton(PropertyMetadataFactoryInterface::class, function (Application $app) {
-            return new PropertyInfoPropertyMetadataFactory(
-                $app->make(PropertyInfoExtractorInterface::class),
-                new EloquentPropertyMetadataFactory(
-                    $app->make(ModelMetadata::class),
-                )
-            );
-        });
-
-        $this->app->extend(PropertyMetadataFactoryInterface::class, function (PropertyInfoPropertyMetadataFactory $inner, Application $app) {
             /** @var ConfigRepository $config */
             $config = $app['config'];
 
             return new CachePropertyMetadataFactory(
                 new SchemaPropertyMetadataFactory(
                     $app->make(ResourceClassResolverInterface::class),
-                    new SerializerPropertyMetadataFactory(
-                        $app->make(SerializerClassMetadataFactory::class),
-                        new AttributePropertyMetadataFactory(
-                            new EloquentAttributePropertyMetadataFactory(
-                                $inner,
-                            )
+                    new PropertyInfoPropertyMetadataFactory(
+                        $app->make(PropertyInfoExtractorInterface::class),
+                        new SerializerPropertyMetadataFactory(
+                            $app->make(SerializerClassMetadataFactory::class),
+                            new AttributePropertyMetadataFactory(
+                                new EloquentAttributePropertyMetadataFactory(
+                                    new EloquentPropertyMetadataFactory(
+                                        $app->make(ModelMetadata::class),
+                                    ),
+                                )
+                            ),
+                            $app->make(ResourceClassResolverInterface::class)
                         ),
-                        $app->make(ResourceClassResolverInterface::class)
-                    ),
+                    )
                 ),
                 true === $config->get('app.debug') ? 'array' : $config->get('api-platform.cache', 'file')
             );

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

@@ -86,10 +86,21 @@ public function create(string $resourceClass, string $property, array $options =
                 default => new Type(\in_array($builtinType, Type::$builtinTypes, true) ? $builtinType : Type::BUILTIN_TYPE_STRING, $p['nullable'] ?? true),
             };
 
-            return $propertyMetadata
-                ->withBuiltinTypes([$type])
-                ->withWritable($propertyMetadata->isWritable() ?? true === $p['fillable'])
-                ->withReadable($propertyMetadata->isReadable() ?? false === $p['hidden']);
+            $propertyMetadata = $propertyMetadata
+                ->withBuiltinTypes([$type]);
+
+            // If these are set let the SerializerPropertyMetadataFactory do the work
+            if (!isset($options['denormalization_groups'])) {
+                $propertyMetadata = $propertyMetadata
+                    ->withWritable($propertyMetadata->isWritable() ?? true === $p['fillable']);
+            }
+
+            if (!isset($options['normalization_groups'])) {
+                $propertyMetadata = $propertyMetadata
+                    ->withReadable($propertyMetadata->isReadable() ?? false === $p['hidden']);
+            }
+
+            return $propertyMetadata;
         }
 
         foreach ($this->modelMetadata->getRelations($model) as $relation) {
@@ -110,8 +121,6 @@ public function create(string $resourceClass, string $property, array $options =
 
             return $propertyMetadata
                 ->withBuiltinTypes([$type])
-                ->withWritable($propertyMetadata->isWritable() ?? true)
-                ->withReadable($propertyMetadata->isReadable() ?? true)
                 ->withExtraProperties(['eloquent_relation' => $relation] + $propertyMetadata->getExtraProperties());
         }
 

src/Laravel/Eloquent/Metadata/ModelMetadata.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Laravel\Eloquent\Metadata;
 
+use ApiPlatform\Metadata\Util\CamelCaseToSnakeCaseNameConverter;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Support\Collection;
@@ -25,6 +26,8 @@
  */
 final class ModelMetadata
 {
+    private CamelCaseToSnakeCaseNameConverter $relationNameConverter;
+
     /**
      * @var array<class-string, Collection<string, mixed>>
      */
@@ -54,6 +57,11 @@ final class ModelMetadata
         'morphedByMany',
     ];
 
+    public function __construct()
+    {
+        $this->relationNameConverter = new CamelCaseToSnakeCaseNameConverter();
+    }
+
     /**
      * Gets the column attributes for the given model.
      *
@@ -172,8 +180,10 @@ public function getRelations(Model $model): Collection
                     || $this->attributeIsHidden($method->getName(), $model)
             )
             ->filter(function (\ReflectionMethod $method) {
-                if ($method->getReturnType() instanceof \ReflectionNamedType
-                    && is_subclass_of($method->getReturnType()->getName(), Relation::class)) {
+                if (
+                    $method->getReturnType() instanceof \ReflectionNamedType
+                    && is_subclass_of($method->getReturnType()->getName(), Relation::class)
+                ) {
                     return true;
                 }
 
@@ -204,7 +214,8 @@ public function getRelations(Model $model): Collection
                 }
 
                 return [
-                    'name' => $method->getName(),
+                    'name' => $this->relationNameConverter->normalize($method->getName()),
+                    'method_name' => $method->getName(),
                     'type' => $relation::class,
                     'related' => \get_class($relation->getRelated()),
                     'foreign_key' => method_exists($relation, 'getForeignKeyName') ? $relation->getForeignKeyName() : null,

src/Laravel/Eloquent/State/PersistProcessor.php

@@ -14,31 +14,59 @@
 namespace ApiPlatform\Laravel\Eloquent\State;
 
 use ApiPlatform\Laravel\Eloquent\Metadata\ModelMetadata;
+use ApiPlatform\Metadata\Exception\RuntimeException;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Operation;
 use ApiPlatform\State\ProcessorInterface;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 
 /**
  * @implements ProcessorInterface<\Illuminate\Database\Eloquent\Model, \Illuminate\Database\Eloquent\Model>
  */
 final class PersistProcessor implements ProcessorInterface
 {
+    /**
+     * @var array<string, string>
+     */
+    private array $relations;
+
     public function __construct(
         private readonly ModelMetadata $modelMetadata,
     ) {
     }
 
     public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
     {
+        $toMany = [];
+
         foreach ($this->modelMetadata->getRelations($data) as $relation) {
             if (!isset($data->{$relation['name']})) {
                 continue;
             }
 
             if (BelongsTo::class === $relation['type']) {
-                $data->{$relation['name']}()->associate($data->{$relation['name']});
+                $rel = $data->{$relation['name']};
+
+                if (!$rel->exists) {
+                    $rel->save();
+                }
+
+                $data->{$relation['method_name']}()->associate($data->{$relation['name']});
+                unset($data->{$relation['name']});
+                $this->relations[$relation['method_name']] = $relation['name'];
+            }
+
+            if (HasMany::class === $relation['type']) {
+                $rel = $data->{$relation['name']};
+
+                if (!\is_array($rel)) {
+                    throw new RuntimeException('To-Many relationship is not a collection.');
+                }
+
+                $toMany[$relation['method_name']] = $rel;
                 unset($data->{$relation['name']});
+                $this->relations[$relation['method_name']] = $relation['name'];
             }
         }
 
@@ -54,6 +82,18 @@ public function process(mixed $data, Operation $operation, array $uriVariables =
         $data->saveOrFail();
         $data->refresh();
 
+        foreach ($data->getRelations() as $methodName => $obj) {
+            if (isset($this->relations[$methodName])) {
+                $data->{$this->relations[$methodName]} = $obj;
+            }
+        }
+
+        foreach ($toMany as $methodName => $relations) {
+            $data->{$methodName}()->saveMany($relations);
+            $data->{$this->relations[$methodName]} = $relations;
+            unset($toMany[$methodName]);
+        }
+
         return $data;
     }
 }

src/Laravel/Tests/EloquentTest.php

@@ -16,6 +16,7 @@
 use ApiPlatform\Laravel\Test\ApiTestAssertionsTrait;
 use ApiPlatform\Laravel\workbench\app\Enums\BookStatus;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Str;
 use Orchestra\Testbench\Concerns\WithWorkbench;
 use Orchestra\Testbench\TestCase;
 use Workbench\Database\Factories\AuthorFactory;
@@ -442,4 +443,84 @@ public function testBelongsTo(): void
         $this->assertEquals($json['@id'], '/api/grand_sons/1/grand_father');
         $this->assertEquals($json['sons'][0], '/api/grand_sons/1');
     }
+
+    public function testRelationIsHandledOnCreateWithNestedData(): void
+    {
+        $cartData = [
+            'productSku' => 'SKU_TEST_001',
+            'quantity' => 2,
+            'priceAtAddition' => '19.99',
+            'shoppingCart' => [
+                'userIdentifier' => 'user-'.Str::uuid()->toString(),
+                'status' => 'active',
+            ],
+        ];
+
+        $response = $this->postJson('/api/cart_items', $cartData, ['accept' => 'application/ld+json', 'content-type' => 'application/ld+json']);
+        $response->assertStatus(201);
+
+        $response
+            ->assertJson([
+                '@context' => '/api/contexts/CartItem',
+                '@id' => '/api/cart_items/1',
+                '@type' => 'CartItem',
+                'id' => 1,
+                'productSku' => 'SKU_TEST_001',
+                'quantity' => 2,
+                'priceAtAddition' => 19.99,
+                'shoppingCart' => [
+                    '@id' => '/api/shopping_carts/1',
+                    '@type' => 'ShoppingCart',
+                    'userIdentifier' => $cartData['shoppingCart']['userIdentifier'],
+                    'status' => 'active',
+                ],
+            ]);
+    }
+
+    public function testRelationIsHandledOnCreateWithNestedDataToMany(): void
+    {
+        $cartData = [
+            'userIdentifier' => 'user-'.Str::uuid()->toString(),
+            'status' => 'active',
+            'cartItems' => [
+                [
+                    'productSku' => 'SKU_TEST_001',
+                    'quantity' => 2,
+                    'priceAtAddition' => '19.99',
+                ],
+                [
+                    'productSku' => 'SKU_TEST_002',
+                    'quantity' => 1,
+                    'priceAtAddition' => '25.50',
+                ],
+            ],
+        ];
+
+        $response = $this->postJson('/api/shopping_carts', $cartData, ['accept' => 'application/ld+json', 'content-type' => 'application/ld+json']);
+        $response->assertStatus(201);
+        $response->assertJson([
+            '@context' => '/api/contexts/ShoppingCart',
+            '@id' => '/api/shopping_carts/1',
+            '@type' => 'ShoppingCart',
+            'id' => 1,
+            'userIdentifier' => $cartData['userIdentifier'],
+            'status' => 'active',
+            'cartItems' => [
+                [
+                    '@id' => '/api/cart_items/1',
+                    '@type' => 'CartItem',
+                    'productSku' => 'SKU_TEST_001',
+                    'quantity' => 2,
+                    'priceAtAddition' => '19.99',
+                ],
+                [
+                    '@id' => '/api/cart_items/2',
+                    '@type' => 'CartItem',
+                    'productSku' => 'SKU_TEST_002',
+                    'quantity' => 1,
+                    'priceAtAddition' => '25.50',
+                ],
+            ],
+        ]);
+    }
 }

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

@@ -0,0 +1,43 @@
+<?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 Workbench\App\Models;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Symfony\Component\Serializer\Attribute\Groups;
+
+// #[ApiResource(denormalizationContext: ['groups' => ['cart_item.write']], normalizationContext: ['groups' => ['cart_item.write']])]
+#[ApiResource(denormalizationContext: ['groups' => ['cart_item.write']], normalizationContext: ['groups' => ['cart_item.write']])]
+#[Groups('cart_item.write')]
+#[ApiProperty(serialize: new Groups(['shopping_cart.write']), property: 'product_sku')]
+#[ApiProperty(serialize: new Groups(['shopping_cart.write']), property: 'price_at_addition')]
+#[ApiProperty(serialize: new Groups(['shopping_cart.write']), property: 'quantity')]
+class CartItem extends Model
+{
+    use HasFactory;
+
+    protected $fillable = [
+        'product_sku',
+        'quantity',
+        'price_at_addition',
+    ];
+
+    public function shoppingCart(): BelongsTo
+    {
+        return $this->belongsTo(ShoppingCart::class);
+    }
+}

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

@@ -0,0 +1,41 @@
+<?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 Workbench\App\Models;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Symfony\Component\Serializer\Attribute\Groups;
+
+#[ApiResource(denormalizationContext: ['groups' => ['shopping_cart.write']], normalizationContext: ['groups' => ['shopping_cart.write']])]
+#[Groups(['shopping_cart.write'])]
+// We do not want to set the group on `cartItems` because it will lead to a circular reference
+#[ApiProperty(serialize: new Groups(['cart_item.write']), property: 'user_identifier')]
+#[ApiProperty(serialize: new Groups(['cart_item.write']), property: 'status')]
+class ShoppingCart extends Model
+{
+    use HasFactory;
+
+    protected $fillable = [
+        'user_identifier',
+        'status',
+    ];
+
+    public function cartItems(): HasMany
+    {
+        return $this->hasMany(CartItem::class);
+    }
+}