Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[4.x] Fix: GateWatcher shows allowed when it is denied via Response class #1010

Merged
merged 3 commits into from
Feb 8, 2021
Merged

[4.x] Fix: GateWatcher shows allowed when it is denied via Response class #1010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d4fdeb
fix: GateWatcher saves denied response as allowed
ReeceM Feb 8, 2021
2751d64
tests for gatewatcher changes
ReeceM Feb 8, 2021
d9e1875
Update GateWatcher.php
taylorotwell Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/Watchers/GateWatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Laravel\Telescope\Watchers;

use Illuminate\Auth\Access\Response;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Gate;
Expand Down Expand Up @@ -44,7 +45,7 @@ public function recordGateCheck(?Authenticatable $user, $ability, $result, $argu

Telescope::recordGate(IncomingEntry::make([
'ability' => $ability,
'result' => $result ? 'allowed' : 'denied',
'result' => $this->gateResult($result),
'arguments' => $this->formatArguments($arguments),
'file' => $caller['file'],
'line' => $caller['line'],
Expand All @@ -64,6 +65,21 @@ private function shouldIgnore($ability)
return Str::is($this->options['ignore_abilities'] ?? [], $ability);
}

/**
* Determine if the gate result is denied or allowed.
*
* @param bool|\Illuminate\Auth\Access\Response $result
* @return string
*/
private function gateResult($result)
{
if ($result instanceof Response) {
return $result->allowed() ? 'allowed' : 'denied';
}

return $result ? 'allowed' : 'denied';
}

/**
* Format the given arguments.
*
Expand Down
73 changes: 67 additions & 6 deletions tests/Watchers/GateWatcherTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Laravel\Telescope\Tests\Watchers;

use Illuminate\Auth\Access\Response;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Support\Facades\Gate;
Expand Down Expand Up @@ -43,7 +44,7 @@ public function test_gate_watcher_registers_allowed_entries()
$this->assertTrue($check);
$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(39, $entry->content['line']);
$this->assertSame(40, $entry->content['line']);
$this->assertSame('potato', $entry->content['ability']);
$this->assertSame('allowed', $entry->content['result']);
$this->assertEmpty($entry->content['arguments']);
Expand All @@ -58,7 +59,7 @@ public function test_gate_watcher_registers_denied_entries()
$this->assertFalse($check);
$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(54, $entry->content['line']);
$this->assertSame(55, $entry->content['line']);
$this->assertSame('potato', $entry->content['ability']);
$this->assertSame('denied', $entry->content['result']);
$this->assertSame(['banana'], $entry->content['arguments']);
Expand All @@ -73,7 +74,7 @@ public function test_gate_watcher_registers_allowed_guest_entries()
$this->assertTrue($check);
$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(69, $entry->content['line']);
$this->assertSame(70, $entry->content['line']);
$this->assertSame('guest potato', $entry->content['ability']);
$this->assertSame('allowed', $entry->content['result']);
$this->assertEmpty($entry->content['arguments']);
Expand All @@ -88,7 +89,7 @@ public function test_gate_watcher_registers_denied_guest_entries()
$this->assertFalse($check);
$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(84, $entry->content['line']);
$this->assertSame(85, $entry->content['line']);
$this->assertSame('deny potato', $entry->content['ability']);
$this->assertSame('denied', $entry->content['result']);
$this->assertSame(['gelato'], $entry->content['arguments']);
Expand All @@ -104,7 +105,7 @@ public function test_gate_watcher_registers_allowed_policy_entries()

$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(185, $entry->content['line']);
$this->assertSame(231, $entry->content['line']);
$this->assertSame('create', $entry->content['ability']);
$this->assertSame('allowed', $entry->content['result']);
$this->assertSame([[]], $entry->content['arguments']);
Expand All @@ -124,11 +125,51 @@ public function test_gate_watcher_registers_denied_policy_entries()

$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(190, $entry->content['line']);
$this->assertSame(236, $entry->content['line']);
$this->assertSame('update', $entry->content['ability']);
$this->assertSame('denied', $entry->content['result']);
$this->assertSame([[]], $entry->content['arguments']);
}

public function test_gate_watcher_registers_allowed_response_policy_entries()
{
Gate::policy(TestResource::class, TestPolicy::class);

try {
(new TestController())->view(new TestResource());
} catch (\Exception $ex) {
// ignore
}

$entry = $this->loadTelescopeEntries()->first();

$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(226, $entry->content['line']);
$this->assertSame('view', $entry->content['ability']);
$this->assertSame('allowed', $entry->content['result']);
$this->assertSame([[]], $entry->content['arguments']);
}

public function test_gate_watcher_registers_denied_response_policy_entries()
{
Gate::policy(TestResource::class, TestPolicy::class);

try {
(new TestController())->delete(new TestResource());
} catch (\Exception $ex) {
// ignore
}

$entry = $this->loadTelescopeEntries()->first();

$this->assertSame(EntryType::GATE, $entry->type);
$this->assertSame(__FILE__, $entry->content['file']);
$this->assertSame(241, $entry->content['line']);
$this->assertSame('delete', $entry->content['ability']);
$this->assertSame('denied', $entry->content['result']);
$this->assertSame([[]], $entry->content['arguments']);
}
}

class User implements Authenticatable
Expand Down Expand Up @@ -180,6 +221,11 @@ class TestController
{
use AuthorizesRequests;

public function view($object)
{
$this->authorize($object);
}

public function create($object)
{
$this->authorize($object);
Expand All @@ -189,10 +235,20 @@ public function update($object)
{
$this->authorize($object);
}

public function delete($object)
{
$this->authorize($object);
}
}

class TestPolicy
{
public function view(?User $user)
{
return Response::allow('this action is allowed');
}

public function create(?User $user)
{
return true;
Expand All @@ -202,4 +258,9 @@ public function update(?User $user)
{
return false;
}

public function delete(?User $user)
{
return Response::deny('this action is denied');
}
}