Fixed permissions; Added tests for permission store

This commit is contained in:
Constantin Graf
2024-04-24 15:07:39 +02:00
committed by Constantin Graf
parent 75a3404f46
commit 267adf52ca
6 changed files with 170 additions and 25 deletions

View File

@@ -24,9 +24,10 @@ class ShareInertiaData
*/ */
public function handle(Request $request, Closure $next): Response public function handle(Request $request, Closure $next): Response
{ {
/** @var PermissionStore $permissions */
$permissions = app(PermissionStore::class); $permissions = app(PermissionStore::class);
Inertia::share(array_filter([ Inertia::share(array_filter([
'permissions' => $request->user() !== null ? $permissions->permissions($request->user()->currentTeam) : [], 'permissions' => $request->user() !== null && $request->user()->currentTeam !== null ? $permissions->getPermissions($request->user()->currentTeam) : [],
'jetstream' => function () use ($request) { 'jetstream' => function () use ($request) {
/** @var User|null $user */ /** @var User|null $user */
$user = $request->user(); $user = $request->user();

View File

@@ -17,6 +17,11 @@ class PermissionStore
*/ */
private array $permissionCache = []; private array $permissionCache = [];
public function clear(): void
{
$this->permissionCache = [];
}
public function has(Organization $organization, string $permission): bool public function has(Organization $organization, string $permission): bool
{ {
/** @var User|null $user */ /** @var User|null $user */
@@ -26,15 +31,11 @@ class PermissionStore
} }
if (! isset($this->permissionCache[$user->getKey().'|'.$organization->getKey()])) { if (! isset($this->permissionCache[$user->getKey().'|'.$organization->getKey()])) {
if ($user->ownsTeam($organization)) {
return true;
}
if (! $user->belongsToTeam($organization)) { if (! $user->belongsToTeam($organization)) {
return false; return false;
} }
$permissions = $user->teamPermissions($organization); $permissions = $this->getPermissionsByUser($organization, $user);
$this->permissionCache[$user->getKey().'|'.$organization->getKey()] = $permissions; $this->permissionCache[$user->getKey().'|'.$organization->getKey()] = $permissions;
} else { } else {
$permissions = $this->permissionCache[$user->getKey().'|'.$organization->getKey()]; $permissions = $this->permissionCache[$user->getKey().'|'.$organization->getKey()];
@@ -46,14 +47,8 @@ class PermissionStore
/** /**
* @return array<string> * @return array<string>
*/ */
public function getPermissions(Organization $organization): array private function getPermissionsByUser(Organization $organization, User $user): array
{ {
/** @var User|null $user */
$user = Auth::user();
if ($user === null) {
return [];
}
if (! $user->belongsToTeam($organization)) { if (! $user->belongsToTeam($organization)) {
return []; return [];
} }
@@ -69,4 +64,18 @@ class PermissionStore
return $role !== null ? ($roleObj?->permissions ?? []) : []; return $role !== null ? ($roleObj?->permissions ?? []) : [];
} }
/**
* @return array<string>
*/
public function getPermissions(Organization $organization): array
{
/** @var User|null $user */
$user = Auth::user();
if ($user === null) {
return [];
}
return $this->getPermissionsByUser($organization, $user);
}
} }

View File

@@ -6,7 +6,6 @@ namespace Tests\Feature;
use App\Models\User; use App\Models\User;
use Illuminate\Foundation\Testing\RefreshDatabase; use Illuminate\Foundation\Testing\RefreshDatabase;
use Laravel\Jetstream\Features;
use Tests\TestCase; use Tests\TestCase;
class DeleteAccountTest extends TestCase class DeleteAccountTest extends TestCase
@@ -15,31 +14,32 @@ class DeleteAccountTest extends TestCase
public function test_user_accounts_can_be_deleted(): void public function test_user_accounts_can_be_deleted(): void
{ {
if (! Features::hasAccountDeletionFeatures()) { // Arrange
$this->markTestSkipped('Account deletion is not enabled.'); $user = User::factory()->create();
} $this->actingAs($user);
$this->actingAs($user = User::factory()->create());
// Act
$response = $this->delete('/user', [ $response = $this->delete('/user', [
'password' => 'password', 'password' => 'password',
]); ]);
// Assert
$response->assertStatus(302);
$this->assertNull($user->fresh()); $this->assertNull($user->fresh());
} }
public function test_correct_password_must_be_provided_before_account_can_be_deleted(): void public function test_correct_password_must_be_provided_before_account_can_be_deleted(): void
{ {
if (! Features::hasAccountDeletionFeatures()) { // Arrange
$this->markTestSkipped('Account deletion is not enabled.'); $user = User::factory()->create();
} $this->actingAs($user);
$this->actingAs($user = User::factory()->create());
// Act
$response = $this->delete('/user', [ $response = $this->delete('/user', [
'password' => 'wrong-password', 'password' => 'wrong-password',
]); ]);
// Assert
$this->assertNotNull($user->fresh()); $this->assertNotNull($user->fresh());
} }
} }

View File

@@ -4,6 +4,7 @@ declare(strict_types=1);
namespace Tests; namespace Tests;
use App\Service\PermissionStore;
use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Collection;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase; use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Illuminate\Support\Facades\Mail; use Illuminate\Support\Facades\Mail;
@@ -20,6 +21,13 @@ abstract class TestCase extends BaseTestCase
LogFake::bind(); LogFake::bind();
} }
protected function tearDown(): void
{
// Note: It is necessary to clear the permission cache after each test, since the "scoped singletons" are not reset between tests.
app(PermissionStore::class)->clear();
parent::tearDown();
}
protected function assertEqualsIdsOfEloquentCollection(array $ids, Collection $models): void protected function assertEqualsIdsOfEloquentCollection(array $ids, Collection $models): void
{ {
$this->assertEqualsCanonicalizing($ids, $models->pluck('id')->toArray()); $this->assertEqualsCanonicalizing($ids, $models->pluck('id')->toArray());

View File

@@ -107,7 +107,8 @@ class MemberEndpointTest extends ApiEndpointTestAbstract
{ {
$data = $this->createUserWithPermission([ $data = $this->createUserWithPermission([
'members:invite-placeholder', 'members:invite-placeholder',
], true); 'invitations:create',
]);
$user = User::factory()->create([ $user = User::factory()->create([
'is_placeholder' => true, 'is_placeholder' => true,
]); ]);
@@ -242,6 +243,7 @@ class MemberEndpointTest extends ApiEndpointTestAbstract
// Arrange // Arrange
$data = $this->createUserWithPermission([ $data = $this->createUserWithPermission([
'members:invite-placeholder', 'members:invite-placeholder',
'invitations:create',
]); ]);
$otherOrganization = Organization::factory()->create(); $otherOrganization = Organization::factory()->create();
$user = User::factory()->create([ $user = User::factory()->create([
@@ -265,6 +267,7 @@ class MemberEndpointTest extends ApiEndpointTestAbstract
// Arrange // Arrange
$data = $this->createUserWithPermission([ $data = $this->createUserWithPermission([
'members:invite-placeholder', 'members:invite-placeholder',
'invitations:create',
]); ]);
Passport::actingAs($data->user); Passport::actingAs($data->user);

View File

@@ -0,0 +1,124 @@
<?php
declare(strict_types=1);
namespace Tests\Unit\Service;
use App\Models\Organization;
use App\Models\User;
use App\Service\PermissionStore;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Laravel\Jetstream\Jetstream;
use Tests\TestCase;
class PermissionStoreTest extends TestCase
{
use RefreshDatabase;
public function test_has_method_returns_false_when_user_is_not_authenticated(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, ['role' => 'employee']);
$permissionStore = new PermissionStore();
// Act
$result = $permissionStore->has($organization, 'permission');
// Assert
$this->assertFalse($result);
}
public function test_has_method_returns_false_when_user_does_not_belong_to_organization(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$permissionStore = new PermissionStore();
$this->actingAs($user);
// Act
$result = $permissionStore->has($organization, 'permission');
// Assert
$this->assertFalse($result);
}
public function test_has_method_returns_false_when_user_does_not_have_permission(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, ['role' => 'employee']);
$permissionStore = new PermissionStore();
$this->actingAs($user);
// Act
$result = $permissionStore->has($organization, 'permission');
// Assert
$this->assertFalse($result);
}
public function test_has_method_returns_true_when_user_has_permission(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, ['role' => 'employee']);
$permissionStore = new PermissionStore();
$this->actingAs($user);
// Act
$result = $permissionStore->has($organization, 'time-entries:view:own');
// Assert
$this->assertTrue($result);
}
public function test_get_permissions_method_returns_empty_array_when_user_is_not_authenticated(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, ['role' => 'employee']);
$permissionStore = new PermissionStore();
// Act
$result = $permissionStore->getPermissions($organization);
// Assert
$this->assertEmpty($result);
}
public function test_get_permissions_method_returns_empty_array_when_user_does_not_belong_to_organization(): void
{
$organization = Organization::factory()->create();
$user = User::factory()->create();
$permissionStore = new PermissionStore();
$this->actingAs($user);
// Act
$result = $permissionStore->getPermissions($organization);
// Assert
$this->assertEmpty($result);
}
public function test_get_permissions_method_returns_permissions_when_user_belongs_to_organization(): void
{
// Arrange
$organization = Organization::factory()->create();
$user = User::factory()->create();
$organization->users()->attach($user, ['role' => 'employee']);
$permissionStore = new PermissionStore();
$this->actingAs($user);
// Act
$result = $permissionStore->getPermissions($organization);
// Assert
$this->assertSame(Jetstream::findRole('employee')->permissions, $result);
}
}