Skip to content

A free open source IT asset/license management system

Better handle detaching groups and users on delete

snipe80e951b0ddb7
diff --git a/app/Models/Group.php b/app/Models/Group.php
index 589c980b1c..ff558862cf 100755
--- a/app/Models/Group.php
+++ b/app/Models/Group.php
@@ -61,6 +61,16 @@ class Group extends SnipeModel
'adminuser' => ['first_name', 'last_name', 'display_name'],
];
+ /**
+ * Detach all users_groups pivot rows when a group is deleted.
+ */
+ protected static function booted(): void
+ {
+ static::deleting(function (self $group) {
+ $group->users()->detach();
+ });
+ }
+
public function isDeletable()
{
return Gate::allows('delete', $this)
diff --git a/app/Models/User.php b/app/Models/User.php
index 9567761d6f..bf8682ede7 100644
--- a/app/Models/User.php
+++ b/app/Models/User.php
@@ -274,6 +274,10 @@ class User extends SnipeModel implements AuthenticatableContract, AuthorizableCo
static::forceDeleted(function (User $user) {
CheckoutRequest::where(['user_id' => $user->id])->forceDelete();
$user->purgeAssociatedPassportTokens();
+ // Soft-delete leaves pivot rows so a restore preserves group
+ // memberships. Force-delete removes the row entirely, so the
+ // pivot rows would point at nothing.
+ $user->groups()->detach();
});
static::softDeleted(function (User $user) {
diff --git a/tests/Unit/Models/GroupPivotCleanupTest.php b/tests/Unit/Models/GroupPivotCleanupTest.php
new file mode 100644
index 0000000000..43a27ecdad
--- /dev/null
+++ b/tests/Unit/Models/GroupPivotCleanupTest.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Tests\Unit\Models;
+
+use App\Models\Group;
+use App\Models\User;
+use Illuminate\Support\Facades\DB;
+use Tests\TestCase;
+
+class GroupPivotCleanupTest extends TestCase
+{
+ public function test_deleting_group_detaches_users_groups_pivot_rows()
+ {
+ $group = Group::factory()->create();
+ $users = User::factory()->count(3)->create();
+ $group->users()->attach($users->pluck('id')->all());
+
+ $this->assertEquals(3, DB::table('users_groups')->where('group_id', $group->id)->count());
+
+ $group->delete();
+
+ $this->assertEquals(0, DB::table('users_groups')->where('group_id', $group->id)->count());
+ }
+
+ public function test_deleting_group_does_not_delete_users()
+ {
+ $group = Group::factory()->create();
+ $users = User::factory()->count(2)->create();
+ $group->users()->attach($users->pluck('id')->all());
+
+ $group->delete();
+
+ foreach ($users as $user) {
+ $this->assertDatabaseHas('users', ['id' => $user->id]);
+ }
+ }
+}
diff --git a/tests/Unit/Models/UserGroupPivotCleanupTest.php b/tests/Unit/Models/UserGroupPivotCleanupTest.php
new file mode 100644
index 0000000000..f022b28f6a
--- /dev/null
+++ b/tests/Unit/Models/UserGroupPivotCleanupTest.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace Tests\Unit\Models;
+
+use App\Models\Group;
+use App\Models\User;
+use Illuminate\Support\Facades\DB;
+use Tests\TestCase;
+
+class UserGroupPivotCleanupTest extends TestCase
+{
+ public function test_force_deleting_user_detaches_users_groups_pivot_rows()
+ {
+ $user = User::factory()->create();
+ $groups = Group::factory()->count(2)->create();
+ $user->groups()->attach($groups->pluck('id')->all());
+
+ $this->assertEquals(2, DB::table('users_groups')->where('user_id', $user->id)->count());
+
+ $user->forceDelete();
+
+ $this->assertEquals(0, DB::table('users_groups')->where('user_id', $user->id)->count());
+ }
+
+ public function test_soft_deleting_user_preserves_users_groups_pivot_rows()
+ {
+ $user = User::factory()->create();
+ $groups = Group::factory()->count(2)->create();
+ $user->groups()->attach($groups->pluck('id')->all());
+
+ $user->delete();
+
+ $this->assertEquals(2, DB::table('users_groups')->where('user_id', $user->id)->count());
+ }
+
+ public function test_force_deleting_user_does_not_delete_groups()
+ {
+ $user = User::factory()->create();
+ $groups = Group::factory()->count(2)->create();
+ $user->groups()->attach($groups->pluck('id')->all());
+
+ $user->forceDelete();
+
+ foreach ($groups as $group) {
+ $this->assertDatabaseHas('permission_groups', ['id' => $group->id]);
+ }
+ }
+}