Specify identifying columns on nested mutation upserts

CHANGELOG.md

@@ -9,6 +9,10 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+### Added
+
+- Add support for identifyingColumns on upserts
+
 ## v6.15.0
 
 ### Added
@@ -524,7 +528,7 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ### Fixed
 
-- Distinguish between client-safe and non-client-safe errors in `TestResponse::assertGraphQLError()` 
+- Distinguish between client-safe and non-client-safe errors in `TestResponse::assertGraphQLError()`
 
 ## v5.46.0
 
@@ -831,7 +835,7 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ### Fixed
 
-- Avoid PHP 8.1 deprecation warning by implementing `__serialize()` and `__unserialize()` https://github.com/nuwave/lighthouse/pull/1987 
+- Avoid PHP 8.1 deprecation warning by implementing `__serialize()` and `__unserialize()` https://github.com/nuwave/lighthouse/pull/1987
 
 ### Deprecated
 
@@ -1107,7 +1111,7 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ### Changed
 
-- Improve performance through [`graphql-php` lazy field definitions](https://github.com/webonyx/graphql-php/pull/861) https://github.com/nuwave/lighthouse/pull/1851 
+- Improve performance through [`graphql-php` lazy field definitions](https://github.com/webonyx/graphql-php/pull/861) https://github.com/nuwave/lighthouse/pull/1851
 - Load individual subscription fields lazily instead of loading them all eagerly https://github.com/nuwave/lighthouse/pull/1851
 - Require `webonyx/graphql-php:^14.7` https://github.com/nuwave/lighthouse/pull/1851
 

src/Execution/Arguments/UpsertModel.php

@@ -9,10 +9,14 @@ class UpsertModel implements ArgResolver
     /** @var callable|\Nuwave\Lighthouse\Support\Contracts\ArgResolver */
     protected $previous;
 
+    /** @var array<string> */
+    protected array $identifyingColumns;
+
     /** @param  callable|\Nuwave\Lighthouse\Support\Contracts\ArgResolver  $previous */
-    public function __construct(callable $previous)
+    public function __construct(callable $previous, ?array $identifyingColumns)
     {
         $this->previous = $previous;
+        $this->identifyingColumns = $identifyingColumns ?? [];
     }
 
     /**
@@ -22,20 +26,39 @@ public function __construct(callable $previous)
     public function __invoke($model, $args): mixed
     {
         // TODO consider Laravel native ->upsert(), available from 8.10
-        $id = $args->arguments['id']
-            ?? $args->arguments[$model->getKeyName()]
-            ?? null;
+        $existingModel = null;
 
-        if ($id !== null) {
+        if (! empty($this->identifyingColumns)) {
             $existingModel = $model
                 ->newQuery()
-                ->find($id->value);
+                ->firstWhere(
+                    array_intersect_key(
+                        $args->toArray(),
+                        array_flip($this->identifyingColumns),
+                    ),
+                );
 
             if ($existingModel !== null) {
                 $model = $existingModel;
             }
         }
 
+        if ($existingModel === null) {
+            $id = $args->arguments['id']
+                ?? $args->arguments[$model->getKeyName()]
+                ?? null;
+
+            if ($id !== null) {
+                $existingModel = $model
+                    ->newQuery()
+                    ->find($id->value);
+
+                if ($existingModel !== null) {
+                    $model = $existingModel;
+                }
+            }
+        }
+
         return ($this->previous)($model, $args);
     }
 }

src/Schema/Directives/UpsertDirective.php

@@ -21,6 +21,12 @@ public static function definition(): string
   """
   model: String
 
+  """
+  Specify the columns by which to upsert the model.
+  This is optional, defaults to the ID or model Key.
+  """
+  identifyingColumns: [String!] = []
+
   """
   Specify the name of the relation on the parent model.
   This is only needed when using this directive as a nested arg
@@ -33,6 +39,9 @@ public static function definition(): string
 
     protected function makeExecutionFunction(Relation $parentRelation = null): callable
     {
-        return new UpsertModel(new SaveModel($parentRelation));
+        return new UpsertModel(
+            new SaveModel($parentRelation),
+            $this->directiveArgValue('identifyingColumns'),
+        );
     }
 }

tests/Integration/Schema/Directives/UpsertDirectiveTest.php

@@ -6,6 +6,7 @@
 use Illuminate\Container\Container;
 use Nuwave\Lighthouse\Schema\TypeRegistry;
 use Tests\DBTestCase;
+use Tests\Utils\Models\Company;
 use Tests\Utils\Models\Task;
 use Tests\Utils\Models\User;
 
@@ -198,6 +199,150 @@ interface IUser
         ]);
     }
 
+    public function testDirectUpsertByIdentifyingColumn(): void
+    {
+        $this->schema .= /** @lang GraphQL */ '
+        type User {
+            id: ID!
+            email: String!
+            name: String!
+        }
+
+        type Mutation {
+            upsertUser(name: String!, email: String!): User @upsert(identifyingColumns: ["email"])
+        }
+        ';
+
+        $this->graphQL(/** @lang GraphQL */ '
+        mutation {
+            upsertUser(
+                email: "[email protected]"
+                name: "bar"
+            ) {
+                name
+                email
+            }
+        }
+        ')->assertJson([
+            'data' => [
+                'upsertUser' => [
+                    'email' => '[email protected]',
+                    'name' => 'bar',
+                ],
+            ],
+        ]);
+
+        $user = User::firstOrFail();
+
+        $this->assertSame('bar', $user->name);
+        $this->assertSame('[email protected]', $user->email);
+
+        $this->graphQL(/** @lang GraphQL */ '
+        mutation {
+            upsertUser(
+                email: "[email protected]"
+                name: "foo"
+            ) {
+                name
+                email
+            }
+        }
+        ')->assertJson([
+            'data' => [
+                'upsertUser' => [
+                    'email' => '[email protected]',
+                    'name' => 'foo',
+                ],
+            ],
+        ]);
+
+        $user->refresh();
+
+        $this->assertSame('foo', $user->name);
+        $this->assertSame('[email protected]', $user->email);
+    }
+
+    public function testDirectUpsertByIdentifyingColumns(): void
+    {
+        $company = factory(Company::class)->create(['id' => 1]);
+
+        $this->schema
+            /** @lang GraphQL */
+            .= '
+        type User {
+            id: ID!
+            email: String!
+            name: String!
+            company_id: ID!
+        }
+
+        type Mutation {
+            upsertUser(name: String!, email: String!, company_id:ID!): User @upsert(identifyingColumns: ["name", "company_id"])
+        }
+        ';
+
+        $this->graphQL(
+            /** @lang GraphQL */
+            '
+        mutation {
+            upsertUser(
+                email: "[email protected]"
+                name: "bar"
+                company_id: 1
+            ) {
+                name
+                email
+                company_id
+            }
+        }
+        ',
+        )->assertJson([
+            'data' => [
+                'upsertUser' => [
+                    'email' => '[email protected]',
+                    'name' => 'bar',
+                    'company_id' => 1,
+                ],
+            ],
+        ]);
+
+        $user = User::firstOrFail();
+
+        $this->assertSame('bar', $user->name);
+        $this->assertSame('[email protected]', $user->email);
+        $this->assertSame(1, $user->company_id);
+
+        $this->graphQL(
+            /** @lang GraphQL */
+            '
+        mutation {
+            upsertUser(
+                email: "[email protected]"
+                name: "bar"
+                company_id: 1
+            ) {
+                name
+                email
+                company_id
+            }
+        }
+        ',
+        )->assertJson([
+            'data' => [
+                'upsertUser' => [
+                    'email' => '[email protected]',
+                    'name' => 'bar',
+                    'company_id' => $company->id,
+                ],
+            ],
+        ]);
+
+        $user->refresh();
+
+        $this->assertSame('bar', $user->name);
+        $this->assertSame('[email protected]', $user->email);
+    }
+
     public static function resolveType(): Type
     {
         $typeRegistry = Container::getInstance()->make(TypeRegistry::class);