[Tests] Add tests for duplicate belongs-to-many inserts

See #580

Author: lindyhopchris

tests/dummy/app/Role.php

@@ -35,6 +35,6 @@ class Role extends Model
      */
     public function users(): BelongsToMany
     {
-        return $this->belongsToMany(User::class);
+        return $this->belongsToMany(User::class)->using(RoleUser::class);
     }
 }

tests/dummy/app/RoleUser.php

@@ -0,0 +1,33 @@
+<?php
+/*
+ * Copyright 2021 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace DummyApp;
+
+use Illuminate\Database\Eloquent\Relations\Pivot;
+
+class RoleUser extends Pivot
+{
+
+    /**
+     * Indicates if the IDs are auto-incrementing.
+     *
+     * @var bool
+     */
+    public $incrementing = true;
+}

tests/dummy/app/User.php

@@ -96,7 +96,7 @@ public function phone()
      */
     public function roles(): BelongsToMany
     {
-        return $this->belongsToMany(Role::class);
+        return $this->belongsToMany(Role::class)->using(RoleUser::class);
     }
 
     /**

tests/dummy/database/migrations/2018_02_11_1648_create_tables.php

@@ -47,9 +47,9 @@ public function up()
         });
 
         Schema::create('role_user', function (Blueprint $table) {
+            $table->increments('id');
             $table->unsignedInteger('user_id');
             $table->unsignedInteger('role_id');
-            $table->primary(['user_id', 'role_id']);
         });
 
         Schema::create('avatars', function (Blueprint $table) {

tests/lib/Integration/Eloquent/BelongsToManyTest.php

@@ -279,6 +279,49 @@ public function testUpdateChangesRelatedResources(): void
         }
     }
 
+    /**
+     * In this test we keep one existing role, and add two new ones.
+     */
+    public function testUpdateSyncsRelatedResources(): void
+    {
+        /** @var User $user */
+        $user = factory(User::class)->create();
+        $user->roles()->saveMany($existing = factory(Role::class, 2)->create());
+
+        $roles = factory(Role::class, 2)->create();
+
+        $expected = $roles->merge([$existing[0]]);
+
+        $data = [
+            'type' => 'users',
+            'id' => (string) $user->getRouteKey(),
+            'relationships' => [
+                'roles' => [
+                    'data' => $expected->map(function (Role $role) {
+                        return ['type' => 'roles', 'id' => (string) $role->getRouteKey()];
+                    })->sortBy('id')->values()->all(),
+                ],
+            ],
+        ];
+
+        $response = $this
+            ->jsonApi()
+            ->includePaths('roles')
+            ->withData($data)
+            ->patch(url('/api/v1/users', $user));
+
+        $response->assertFetchedOne($data);
+
+        $this->assertDatabaseCount('role_user', count($expected));
+
+        foreach ($expected as $role) {
+            $this->assertDatabaseHas('role_user', [
+                'user_id' => $user->getKey(),
+                'role_id' => $role->getKey(),
+            ]);
+        }
+    }
+
     public function testReadRelated(): void
     {
         /** @var User $user */
@@ -420,9 +463,12 @@ public function testReplaceRelationshipWithDifferentResources(): void
         $user->roles()->saveMany(factory(Role::class, 2)->create());
         $roles = factory(Role::class, 3)->create();
 
-        $data = $roles->map(function (Role $user) {
-            return ['type' => 'roles', 'id' => (string) $user->getRouteKey()];
-        })->all();
+        $data = $roles->map(function (Role $role) {
+            return ['type' => 'roles', 'id' => (string) $role->getRouteKey()];
+        });
+
+        /** Add a duplicate - expecting that resource to only be added once. */
+        $data->push(['type' => 'roles', 'id' => (string) $roles[1]->getRouteKey()]);
 
         $response = $this
             ->jsonApi()
@@ -452,6 +498,12 @@ public function testAddToRelationship(): void
             return ['type' => 'roles', 'id' => (string) $role->getRouteKey()];
         });
 
+        /** Add an existing role: this should not be added twice */
+        $data->push(['type' => 'roles', 'id' => (string) $existing[1]->getRouteKey()]);
+
+        /** Add a duplicate to add: this should only be added once. */
+        $data->push(['type' => 'roles', 'id' => (string) $add[0]->getRouteKey()]);
+
         $response = $this
             ->jsonApi()
             ->expects('roles')