cache tags.

Author: overtrue

.gitignore

@@ -7,3 +7,5 @@ sftp-config.json
 composer.lock
 .subsplit
 .php_cs.cache
+.php-cs-fixer.cache
+.phpunit.result.cache

.php_cs renamed to .php-cs-fixer.php

@@ -1,19 +1,19 @@
 <?php
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRules([
-        '@PSR2' => true,
+        '@PSR12' => true,
         'binary_operator_spaces' => true,
         'blank_line_after_opening_tag' => true,
         'compact_nullable_typehint' => true,
         'declare_equal_normalize' => true,
         'lowercase_cast' => true,
         'lowercase_static_reference' => true,
         'new_with_braces' => true,
-        'no_unused_imports' => true,
         'no_blank_lines_after_class_opening' => true,
         'no_leading_import_slash' => true,
         'no_whitespace_in_blank_line' => true,
+        'no_unused_imports' => true,
         'ordered_class_elements' => [
             'order' => [
                 'use_trait',

README.md

@@ -21,7 +21,7 @@ return [
     //...
     'cache' => [
         // Cache key prefix
-        'prefix' => 'passport_token_',
+        'prefix' => 'passport_',
 
         // The lifetime of token cache,
         // Unit: second

composer.json

@@ -14,10 +14,10 @@
     },
     "require-dev": {
         "brainmaestro/composer-git-hooks": "^2.7",
-        "friendsofphp/php-cs-fixer": "^2.15",
-        "orchestra/testbench": "^4.16|^5.3",
+        "friendsofphp/php-cs-fixer": "^3.0",
+        "orchestra/testbench": "^5.3",
         "mockery/mockery": "^1.0",
-        "phpunit/phpunit": "^8.0|^9.0"
+        "phpunit/phpunit": "^9.0"
     },
     "autoload": {
         "psr-4": {
@@ -56,8 +56,8 @@
             "cghooks update"
         ],
         "cghooks": "vendor/bin/cghooks",
-        "check-style": "php-cs-fixer fix --using-cache=no --diff --config=.php_cs --dry-run --ansi",
-        "fix-style": "php-cs-fixer fix --using-cache=no --config=.php_cs --ansi",
+        "check-style": "php-cs-fixer fix --using-cache=no --diff --dry-run --ansi",
+        "fix-style": "php-cs-fixer fix --using-cache=no --ansi",
         "test": "vendor/bin/phpunit"
     },
     "scripts-descriptions": {

src/CacheTokenRepository.php

@@ -13,7 +13,7 @@ class CacheTokenRepository extends TokenRepository
     /**
      * @var string
      */
-    protected $cacheKey;
+    protected $cacheKeyPrefix;
 
     /**
      * @var int
@@ -31,13 +31,14 @@ class CacheTokenRepository extends TokenRepository
     protected $cacheStore;
 
     /**
-     * @param string $cacheKey
-     * @param int    $expiresInSeconds
-     * @param array  $tags
+     * @param string|null $cacheKeyPrefix
+     * @param int|null    $expiresInSeconds
+     * @param array       $tags
+     * @param string|null $store
      */
-    public function __construct(string $cacheKey = null, int $expiresInSeconds = null, array $tags = [], ?string $store = null)
+    public function __construct(string $cacheKeyPrefix = null, int $expiresInSeconds = null, array $tags = [], ?string $store = null)
     {
-        $this->cacheKey = $cacheKey ?? 'passport_token_';
+        $this->cacheKeyPrefix = sprintf('%s_token_', $cacheKeyPrefix ?? 'passport');
         $this->expiresInSeconds = $expiresInSeconds ?? 5 * 60;
         $this->cacheTags = $tags;
         $this->cacheStore = $store ?? \config('cache.default');
@@ -52,9 +53,13 @@ public function __construct(string $cacheKey = null, int $expiresInSeconds = nul
      */
     public function find($id)
     {
-        return Cache::store($this->cacheStore)->remember($this->cacheKey . $id, \now()->addSeconds($this->expiresInSeconds), function () use ($id) {
-            return Passport::token()->where('id', $id)->first();
-        });
+        return Cache::store($this->cacheStore)->tags($this->cacheTags)->remember(
+            $this->itemKey($id),
+            \now()->addSeconds($this->expiresInSeconds),
+            function () use ($id) {
+                return Passport::token()->where('id', $id)->first();
+            }
+        );
     }
 
     /**
@@ -67,9 +72,13 @@ public function find($id)
      */
     public function findForUser($id, $userId)
     {
-        return Cache::store($this->cacheStore)->remember($this->cacheKey . $id, \now()->addSeconds($this->expiresInSeconds), function () use ($id, $userId) {
-            return Passport::token()->where('id', $id)->where('user_id', $userId)->first();
-        });
+        return Cache::store($this->cacheStore)->tags($this->cacheTags)->remember(
+            $this->itemKey($id),
+            \now()->addSeconds($this->expiresInSeconds),
+            function () use ($id, $userId) {
+                return Passport::token()->where('id', $id)->where('user_id', $userId)->first();
+            }
+        );
     }
 
     /**
@@ -81,9 +90,13 @@ public function findForUser($id, $userId)
      */
     public function forUser($userId): Collection
     {
-        return Cache::store($this->cacheStore)->remember($this->cacheKey . $userId, \now()->addSeconds($this->expiresInSeconds), function () use ($userId) {
-            return Passport::token()->where('user_id', $userId)->get();
-        });
+        return Cache::store($this->cacheStore)->tags($this->cacheTags)->remember(
+            $this->itemKey($userId),
+            \now()->addSeconds($this->expiresInSeconds),
+            function () use ($userId) {
+                return Passport::token()->where('user_id', $userId)->get();
+            }
+        );
     }
 
     /**
@@ -96,12 +109,21 @@ public function forUser($userId): Collection
      */
     public function getValidToken($user, $client)
     {
-        return Cache::store($this->cacheStore)->remember($this->cacheKey . $user->getKey(), \now()->addSeconds($this->expiresInSeconds), function () use ($client, $user) {
-            return $client->tokens()
-                ->whereUserId($user->getKey())
-                ->where('revoked', 0)
-                ->where('expires_at', '>', \now())
-                ->first();
-        });
+        return Cache::store($this->cacheStore)->tags($this->cacheTags)->remember(
+            $this->itemKey($user->getKey()),
+            \now()->addSeconds($this->expiresInSeconds),
+            function () use ($client, $user) {
+                return $client->tokens()
+                    ->whereUserId($user->getKey())
+                    ->where('revoked', 0)
+                    ->where('expires_at', '>', \now())
+                    ->first();
+            }
+        );
+    }
+
+    public function itemKey(string $key)
+    {
+        return $this->cacheKeyPrefix . $key;
     }
 }