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

[12.x] Fix purge command #1772

Merged
merged 10 commits into from
Jul 10, 2024
Merged

[12.x] Fix purge command #1772

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c31b04c
fix purge command
hafezdivandari Jul 9, 2024
b7d2bd6
add tests
hafezdivandari Jul 9, 2024
5767d3c
formatting
hafezdivandari Jul 9, 2024
9444a85
formatting
hafezdivandari Jul 9, 2024
86ae38b
formatting
hafezdivandari Jul 9, 2024
b6cdb30
formatting
hafezdivandari Jul 9, 2024
ad08ba6
formatting
hafezdivandari Jul 9, 2024
25a3889
formatting
hafezdivandari Jul 9, 2024
e15a0c2
formatting
hafezdivandari Jul 9, 2024
0eb22ca
formatting
taylorotwell Jul 10, 2024
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
60 changes: 36 additions & 24 deletions src/Console/PurgeCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
namespace Laravel\Passport\Console;

use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Carbon;
use Laravel\Passport\Passport;
use Symfony\Component\Console\Attribute\AsCommand;
Expand All @@ -18,7 +19,7 @@ class PurgeCommand extends Command
protected $signature = 'passport:purge
{--revoked : Only purge revoked tokens and authentication codes}
{--expired : Only purge expired tokens and authentication codes}
{--hours= : The number of hours to retain expired tokens}';
{--hours=168 : The number of hours to retain expired tokens}';

/**
* The console command description.
Expand All @@ -32,33 +33,44 @@ class PurgeCommand extends Command
*/
public function handle()
{
$expired = $this->option('hours')
$revoked = $this->option('revoked') || ! $this->option('expired');
$expired = $this->option('expired') || ! $this->option('revoked')
? Carbon::now()->subHours($this->option('hours'))
: Carbon::now()->subDays(7);
: false;

if (($this->option('revoked') && $this->option('expired')) ||
(! $this->option('revoked') && ! $this->option('expired'))) {
Passport::token()->where('revoked', 1)->orWhereDate('expires_at', '<', $expired)->delete();
Passport::authCode()->where('revoked', 1)->orWhereDate('expires_at', '<', $expired)->delete();
Passport::refreshToken()->where('revoked', 1)->orWhereDate('expires_at', '<', $expired)->delete();
Passport::token()->where(function (Builder $query) use ($revoked, $expired) {
hafezdivandari marked this conversation as resolved.
Show resolved Hide resolved
$query->when($revoked, function ($query) {
hafezdivandari marked this conversation as resolved.
Show resolved Hide resolved
$query->orWhere('revoked', true);
});

$this->option('hours')
? $this->components->info('Purged revoked items and items expired for more than '.$this->option('hours').' hours.')
: $this->components->info('Purged revoked items and items expired for more than seven days.');
} elseif ($this->option('revoked')) {
Passport::token()->where('revoked', 1)->delete();
Passport::authCode()->where('revoked', 1)->delete();
Passport::refreshToken()->where('revoked', 1)->delete();
$query->when($expired, function ($query, $expired) {
$query->orWhere('expires_at', '<', $expired);
});
})->delete();

$this->components->info('Purged revoked items.');
} elseif ($this->option('expired')) {
Passport::token()->whereDate('expires_at', '<', $expired)->delete();
Passport::authCode()->whereDate('expires_at', '<', $expired)->delete();
Passport::refreshToken()->whereDate('expires_at', '<', $expired)->delete();
Passport::authCode()->where(function (Builder $query) use ($revoked, $expired) {
$query->when($revoked, function ($query) {
$query->orWhere('revoked', true);
});

$this->option('hours')
? $this->components->info('Purged items expired for more than '.$this->option('hours').' hours.')
: $this->components->info('Purged items expired for more than seven days.');
}
$query->when($expired, function ($query, $expired) {
$query->orWhere('expires_at', '<', $expired);
});
})->delete();

Passport::refreshToken()->where(function (Builder $query) use ($revoked, $expired) {
$query->when($revoked, function ($query) {
$query->orWhere('revoked', true);
});

$query->when($expired, function ($query, $expired) {
$query->orWhere('expires_at', '<', $expired);
});
})->delete();

$this->components->info(sprintf('Purged %s.', implode(' and ', array_filter([
$revoked ? 'revoked items' : null,
$expired ? "items expired for more than {$expired->longAbsoluteDiffForHumans()}" : null,
]))));
}
}
91 changes: 91 additions & 0 deletions tests/Feature/Console/PurgeCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<?php

namespace Console;

use Illuminate\Support\Carbon;
use Illuminate\Support\Facades\DB;
use Orchestra\Testbench\Concerns\WithWorkbench;
use Orchestra\Testbench\TestCase;

class PurgeCommand extends TestCase
{
use WithWorkbench;

public function test_it_can_purge_tokens()
{
$this->travelTo(Carbon::create(2000, 1, 8));

$query = DB::pretend(function () {
$this->artisan('passport:purge')
->expectsOutputToContain('Purged revoked items and items expired for more than 1 week.');
});

$this->assertSame([
'delete from "oauth_access_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_auth_codes" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_refresh_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
], array_column($query, 'query'));
}

public function test_it_can_purge_revoked_tokens()
{
$query = DB::pretend(function () {
$this->artisan('passport:purge', ['--revoked' => true])
->expectsOutputToContain('Purged revoked items.');
});

$this->assertSame([
'delete from "oauth_access_tokens" where ("revoked" = 1)',
'delete from "oauth_auth_codes" where ("revoked" = 1)',
'delete from "oauth_refresh_tokens" where ("revoked" = 1)',
], array_column($query, 'query'));
}

public function test_it_can_purge_expired_tokens()
{
$this->travelTo(Carbon::create(2000, 1, 8));

$query = DB::pretend(function () {
$this->artisan('passport:purge', ['--expired' => true])
->expectsOutputToContain('Purged items expired for more than 1 week.');
});

$this->assertSame([
'delete from "oauth_access_tokens" where ("expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_auth_codes" where ("expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_refresh_tokens" where ("expires_at" < \'2000-01-01 00:00:00\')',
], array_column($query, 'query'));
}

public function test_it_can_purge_revoked_and_expired_tokens()
{
$this->travelTo(Carbon::create(2000, 1, 8));

$query = DB::pretend(function () {
$this->artisan('passport:purge', ['--revoked' => true, '--expired' => true])
->expectsOutputToContain('Purged revoked items and items expired for more than 1 week.');
});

$this->assertSame([
'delete from "oauth_access_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_auth_codes" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_refresh_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
], array_column($query, 'query'));
}

public function test_it_can_purge_tokens_by_hours()
{
$this->travelTo(Carbon::create(2000, 1, 1, 2));

$query = DB::pretend(function () {
$this->artisan('passport:purge', ['--hours' => 2])
->expectsOutputToContain('Purged revoked items and items expired for more than 2 hours.');
});

$this->assertSame([
'delete from "oauth_access_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_auth_codes" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
'delete from "oauth_refresh_tokens" where ("revoked" = 1 or "expires_at" < \'2000-01-01 00:00:00\')',
], array_column($query, 'query'));
}
}