Explicitly call loadMissing('permissions') when the relation is needed, and test with Model::preventLazyLoading() (spatie#2776)

* call loadMissing('permissions') when relation is referenced
* Test with `Model::preventLazyLoading()`
* Model::preventsLazyLoading() check added

---------

Co-authored-by: Chris Brown <[email protected]>

Author: erikn69

src/Models/Role.php

@@ -188,6 +188,7 @@ public function hasPermissionTo($permission, ?string $guardName = null): bool
             throw GuardDoesNotMatch::create($permission->guard_name, $guardName ? collect([$guardName]) : $this->getGuardNames());
         }
 
-        return $this->permissions->contains($permission->getKeyName(), $permission->getKey());
+        return $this->loadMissing('permissions')->permissions
+            ->contains($permission->getKeyName(), $permission->getKey());
     }
 }

src/Traits/HasPermissions.php

@@ -323,7 +323,8 @@ public function hasDirectPermission($permission): bool
     {
         $permission = $this->filterPermission($permission);
 
-        return $this->permissions->contains($permission->getKeyName(), $permission->getKey());
+        return $this->loadMissing('permissions')->permissions
+            ->contains($permission->getKeyName(), $permission->getKey());
     }
 
     /**

tests/HasPermissionsTest.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\Permission\Tests;
 
+use Illuminate\Database\Eloquent\Model;
 use DB;
 use Spatie\Permission\Contracts\Permission;
 use Spatie\Permission\Contracts\Role;
@@ -765,4 +766,37 @@ public function it_can_reject_permission_based_on_logged_in_user_guard()
             'status' => false,
         ]);
     }
+
+    /** @test */
+    public function it_can_be_given_a_permission_on_role_when_lazy_loading_is_restricted()
+    {
+        $this->assertTrue(Model::preventsLazyLoading());
+
+        try {
+            $testRole = app(Role::class)->with('permissions')->get()->first();
+
+            $testRole->givePermissionTo('edit-articles');
+
+            $this->assertTrue($testRole->hasPermissionTo('edit-articles'));
+        } catch (Exception $e) {
+            $this->fail('Lazy loading detected in the givePermissionTo method: ' . $e->getMessage());
+        }
+    }
+
+    /** @test */
+    public function it_can_be_given_a_permission_on_user_when_lazy_loading_is_restricted()
+    {
+        $this->assertTrue(Model::preventsLazyLoading());
+
+        try {
+            User::create(['email' => '[email protected]']);
+            $testUser = User::with('permissions')->get()->first();
+
+            $testUser->givePermissionTo('edit-articles');
+
+            $this->assertTrue($testUser->hasPermissionTo('edit-articles'));
+        } catch (Exception $e) {
+            $this->fail('Lazy loading detected in the givePermissionTo method: ' . $e->getMessage());
+        }
+    }
 }

tests/HasRolesTest.php

@@ -2,7 +2,9 @@
 
 namespace Spatie\Permission\Tests;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\DB;
+use Spatie\Permission\Contracts\Permission;
 use Spatie\Permission\Contracts\Role;
 use Spatie\Permission\Exceptions\GuardDoesNotMatch;
 use Spatie\Permission\Exceptions\RoleDoesNotExist;
@@ -856,4 +858,37 @@ public function it_does_not_detach_roles_when_user_soft_deleting()
 
         $this->assertTrue($user->hasRole('testRole'));
     }
+
+    /** @test */
+    public function it_can_be_given_a_role_on_permission_when_lazy_loading_is_restricted()
+    {
+        $this->assertTrue(Model::preventsLazyLoading());
+
+        try {
+            $testPermission = app(Permission::class)->with('roles')->get()->first();
+
+            $testPermission->assignRole('testRole');
+
+            $this->assertTrue($testPermission->hasRole('testRole'));
+        } catch (Exception $e) {
+            $this->fail('Lazy loading detected in the givePermissionTo method: ' . $e->getMessage());
+        }
+    }
+
+    /** @test */
+    public function it_can_be_given_a_role_on_user_when_lazy_loading_is_restricted()
+    {
+        $this->assertTrue(Model::preventsLazyLoading());
+
+        try {
+            User::create(['email' => '[email protected]']);
+            $user = User::with('roles')->get()->first();
+            $user->assignRole('testRole');
+
+            $this->assertTrue($user->hasRole('testRole'));
+        } catch (Exception $e) {
+            $this->fail('Lazy loading detected in the givePermissionTo method: ' . $e->getMessage());
+        }
+    }
+
 }

tests/TestCase.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\Permission\Tests;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Foundation\Console\AboutCommand;
 use Illuminate\Http\Request;
@@ -110,6 +111,7 @@ protected function getPackageProviders($app)
      */
     protected function getEnvironmentSetUp($app)
     {
+        Model::preventLazyLoading();
         $app['config']->set('permission.register_permission_check_method', true);
         $app['config']->set('permission.teams', $this->hasTeams);
         $app['config']->set('permission.testing', true); // fix sqlite