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

Jump to bottom

Prune expires_at tokens #385

Merged
merged 5 commits into from Jul 29, 2022
Merged

Prune expires_at tokens #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71881ce
Prune expires_at tokens
iruoy Jul 28, 2022
8d6ca8a
Fix missing test for when expires_at is null
iruoy Jul 28, 2022
7f386c4
Always prune by expires_at
Jul 29, 2022
f99ee78
StyleCI fixes
Jul 29, 2022
67211a2
formatting
taylorotwell Jul 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 15 additions & 9 deletions src/Console/Commands/PruneExpired.php
View file
Open in desktop
Expand Up @@ -28,20 +28,26 @@ class PruneExpired extends Command
*/
public function handle()
{
if ($expiration = config('sanctum.expiration')) {
$model = Sanctum::$personalAccessTokenModel;

$hours = $this->option('hours');
$model = Sanctum::$personalAccessTokenModel;

$model::where('created_at', '<', now()->subMinutes($expiration + ($hours * 60)))->delete();
$hours = $this->option('hours');

$this->components->info("Tokens expired for more than [$hours hours] pruned successfully.");
$this->components->task(
'Pruning tokens with expired expires_at timestamps',
fn () => $model::where('expires_at', '<', now()->subHours($hours))->delete()
);

return 0;
if ($expiration = config('sanctum.expiration')) {
$this->components->task(
'Pruning tokens with expired expiration value based on configuration file',
fn () => $model::where('created_at', '<', now()->subMinutes($expiration + ($hours * 60)))->delete()
);
} else {
$this->components->warn('Expiration value not specified in configuration file.');
}

$this->components->warn('Expiration value not specified in configuration file.');
$this->components->info("Tokens expired for more than [$hours hours] pruned successfully.");

return 1;
return 0;
}
}
45 changes: 45 additions & 0 deletions tests/PruneExpiredTest.php
View file
Open in desktop
Expand Up @@ -94,6 +94,51 @@ public function test_cant_delete_expired_tokens_with_null_expiration()
$this->assertDatabaseHas('personal_access_tokens', ['name' => 'Test']);
}

public function test_can_delete_expired_tokens_with_expires_at_expiration()
{
$this->loadLaravelMigrations(['--database' => 'testbench']);
$this->artisan('migrate', ['--database' => 'testbench'])->run();

config(['sanctum.expiration' => 60]);

$user = UserForPruneExpiredTest::forceCreate([
'name' => 'Taylor Otwell',
'email' => 'taylor@laravel.com',
'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi',
]);

$token_1 = PersonalAccessToken::forceCreate([
'tokenable_id' => $user->id,
'tokenable_type' => get_class($user),
'name' => 'Test_1',
'token' => hash('sha256', 'test_1'),
'expires_at' => now()->subMinutes(121),
]);

$token_2 = PersonalAccessToken::forceCreate([
'tokenable_id' => $user->id,
'tokenable_type' => get_class($user),
'name' => 'Test_2',
'token' => hash('sha256', 'test_2'),
'expires_at' => now()->subMinutes(119),
]);

$token_3 = PersonalAccessToken::forceCreate([
'tokenable_id' => $user->id,
'tokenable_type' => get_class($user),
'name' => 'Test_3',
'token' => hash('sha256', 'test_3'),
'expires_at' => null,
]);

$this->artisan('sanctum:prune-expired --hours=2')
->expectsOutputToContain('Tokens expired for more than [2 hours] pruned successfully.');

$this->assertDatabaseMissing('personal_access_tokens', ['name' => 'Test_1']);
$this->assertDatabaseHas('personal_access_tokens', ['name' => 'Test_2']);
$this->assertDatabaseHas('personal_access_tokens', ['name' => 'Test_3']);
}

protected function getPackageProviders($app)
{
return [SanctumServiceProvider::class];
Expand Down