Merge pull request #2869 from josedaian/josedaian/dispatch-role-detached-on-sync-roles

Dispatch RoleDetached on syncRoles when events are enabled

Author: drbyte

src/Traits/HasRoles.php

@@ -225,8 +225,15 @@ public function syncRoles(...$roles)
     {
         if ($this->getModel()->exists) {
             $this->collectRoles($roles);
-            $this->roles()->detach();
-            $this->setRelation('roles', collect());
+            if (config('permission.events_enabled')) {
+                $currentRoles = $this->roles()->get();
+                if ($currentRoles->isNotEmpty()) {
+                    $this->removeRole($currentRoles);
+                }
+            } else {
+                $this->roles()->detach();
+                $this->setRelation('roles', collect());
+            }
         }
 
         return $this->assignRole($roles);

tests/HasRolesTest.php

@@ -1042,4 +1042,43 @@ public function it_can_be_given_a_role_on_user_when_lazy_loading_is_restricted()
             $this->fail('Lazy loading detected in the givePermissionTo method: '.$e->getMessage());
         }
     }
+
+    /** @test */
+    #[Test]
+    public function it_fires_detach_event_when_syncing_roles()
+    {
+        Event::fake([RoleDetached::class, RoleAttached::class]);
+        app('config')->set('permission.events_enabled', true);
+
+        $this->testUser->assignRole('testRole', 'testRole2');
+
+        app(Role::class)->create(['name' => 'testRole3']);
+
+        $this->testUser->syncRoles('testRole3');
+
+        $this->assertFalse($this->testUser->hasRole('testRole'));
+        $this->assertFalse($this->testUser->hasRole('testRole2'));
+        $this->assertTrue($this->testUser->hasRole('testRole3'));
+
+        $removedRoleIds = app(Role::class)::whereIn('name', ['testRole', 'testRole2'])
+            ->pluck($this->testUserRole->getKeyName())
+            ->toArray();
+
+        Event::assertDispatched(RoleDetached::class, function ($event) use ($removedRoleIds) {
+            return $event->model instanceof User
+                && ! $event->model->hasRole('testRole')
+                && ! $event->model->hasRole('testRole2')
+                && $event->rolesOrIds === $removedRoleIds;
+        });
+
+        $attachedRoleIds = app(Role::class)::whereIn('name', ['testRole3'])
+            ->pluck($this->testUserRole->getKeyName())
+            ->toArray();
+
+        Event::assertDispatched(RoleAttached::class, function ($event) use ($attachedRoleIds) {
+            return $event->model instanceof User
+                && $event->model->hasRole('testRole3')
+                && $event->rolesOrIds === $attachedRoleIds;
+        });
+    }
 }