Check current model supports HasTeams before trying to access team information. (#1120)

* Check current model supports HasTeams before trying to access team
information.

This would be useful for application with multiple user providers and uses
Inertia. As an example, this will fixes laravel/nova-issues#4683

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

* formatting

Signed-off-by: Mior Muhammad Zaki <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: crynobone

Diff for: src/Http/Middleware/ShareInertiaData.php

@@ -21,10 +21,12 @@ public function handle($request, $next)
     {
         Inertia::share(array_filter([
             'jetstream' => function () use ($request) {
+                $user = $request->user();
+
                 return [
-                    'canCreateTeams' => $request->user() &&
-                                        Jetstream::hasTeamFeatures() &&
-                                        Gate::forUser($request->user())->check('create', Jetstream::newTeamModel()),
+                    'canCreateTeams' => $user &&
+                                        Jetstream::userHasTeamFeatures($user) &&
+                                        Gate::forUser($user)->check('create', Jetstream::newTeamModel()),
                     'canManageTwoFactorAuthentication' => Features::canManageTwoFactorAuthentication(),
                     'canUpdatePassword' => Features::enabled(Features::updatePasswords()),
                     'canUpdateProfileInformation' => Features::canUpdateProfileInformation(),
@@ -38,18 +40,20 @@ public function handle($request, $next)
                 ];
             },
             'user' => function () use ($request) {
-                if (! $request->user()) {
+                if (! $user = $request->user()) {
                     return;
                 }
 
-                if (Jetstream::hasTeamFeatures() && $request->user()) {
-                    $request->user()->currentTeam;
+                $userHasTeamFeatures = Jetstream::userHasTeamFeatures($user);
+
+                if ($user && $userHasTeamFeatures) {
+                    $user->currentTeam;
                 }
 
-                return array_merge($request->user()->toArray(), array_filter([
-                    'all_teams' => Jetstream::hasTeamFeatures() ? $request->user()->allTeams()->values() : null,
+                return array_merge($user->toArray(), array_filter([
+                    'all_teams' => $userHasTeamFeatures ? $user->allTeams()->values() : null,
                 ]), [
-                    'two_factor_enabled' => ! is_null($request->user()->two_factor_secret),
+                    'two_factor_enabled' => ! is_null($user->two_factor_secret),
                 ]);
             },
             'errorBags' => function () {

Diff for: src/Jetstream.php

@@ -2,6 +2,7 @@
 
 namespace Laravel\Jetstream;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Arr;
 use Laravel\Jetstream\Contracts\AddsTeamMembers;
 use Laravel\Jetstream\Contracts\CreatesTeams;
@@ -195,6 +196,19 @@ public static function hasTeamFeatures()
         return Features::hasTeamFeatures();
     }
 
+    /**
+     * Determine if a given user model utilizes the "HasTeams" trait.
+     *
+     * @param  \Illuminate\Database\Eloquent\Model
+     * @return bool
+     */
+    public static function userHasTeamFeatures($user)
+    {
+        return (array_key_exists(HasTeams::class, class_uses_recursive($user)) ||
+                method_exists($user, 'currentTeam')) &&
+                static::hasTeamFeatures();
+    }
+
     /**
      * Determine if the application is using the terms confirmation feature.
      *

Diff for: tests/Fixtures/Admin.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Laravel\Jetstream\Tests\Fixtures;
+
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use Laravel\Jetstream\HasProfilePhoto;
+use Laravel\Jetstream\HasTeams;
+use Laravel\Sanctum\HasApiTokens;
+
+class Admin extends Authenticatable
+{
+    use HasApiTokens, HasProfilePhoto;
+
+    /**
+     * The attributes that aren't mass assignable.
+     *
+     * @var array
+     */
+    protected $guarded = [];
+}

Diff for: tests/JetstreamTest.php

@@ -2,6 +2,7 @@
 
 namespace Laravel\Jetstream\Tests;
 
+use Laravel\Jetstream\Features;
 use Laravel\Jetstream\Jetstream;
 
 class JetstreamTest extends OrchestraTestCase
@@ -49,4 +50,21 @@ public function test_roles_can_be_json_serialized()
         $this->assertArrayHasKey('description', $serialized);
         $this->assertArrayHasKey('permissions', $serialized);
     }
+
+    public function test_has_team_feature_will_always_return_false_when_team_is_not_enabled()
+    {
+        $this->assertFalse(Jetstream::hasTeamFeatures());
+        $this->assertFalse(Jetstream::userHasTeamFeatures(new Fixtures\User));
+        $this->assertFalse(Jetstream::userHasTeamFeatures(new Fixtures\Admin));
+    }
+
+    /**
+     * @define-env defineHasTeamEnvironment
+     */
+    public function test_has_team_feature_can_be_determined_when_team_is_enabled()
+    {
+        $this->assertTrue(Jetstream::hasTeamFeatures());
+        $this->assertTrue(Jetstream::userHasTeamFeatures(new Fixtures\User));
+        $this->assertFalse(Jetstream::userHasTeamFeatures(new Fixtures\Admin));
+    }
 }

Diff for: tests/OrchestraTestCase.php

@@ -3,6 +3,7 @@
 namespace Laravel\Jetstream\Tests;
 
 use Laravel\Fortify\FortifyServiceProvider;
+use Laravel\Jetstream\Features;
 use Laravel\Jetstream\JetstreamServiceProvider;
 use Mockery;
 use Orchestra\Testbench\TestCase;
@@ -16,15 +17,15 @@ public function setUp(): void
 
     public function tearDown(): void
     {
-        Mockery::close();
+        parent::tearDown();
     }
 
     protected function getPackageProviders($app)
     {
         return [JetstreamServiceProvider::class, FortifyServiceProvider::class];
     }
 
-    protected function getEnvironmentSetUp($app)
+    protected function defineEnvironment($app)
     {
         $app['migrator']->path(__DIR__.'/../database/migrations');
 
@@ -36,4 +37,13 @@ protected function getEnvironmentSetUp($app)
             'prefix'   => '',
         ]);
     }
+
+    protected function defineHasTeamEnvironment($app)
+    {
+        $features = $app->config->get('jetstream.features', []);
+
+        $features[] = Features::teams(['invitations' => true]);
+
+        $app->config->set('jetstream.features', $features);
+    }
 }