add prune stale tags command for redis

Author: taylorotwell

src/Illuminate/Cache/Console/PruneStaleTagsCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Illuminate\Cache\Console;
+
+use Illuminate\Cache\CacheManager;
+use Illuminate\Cache\RedisStore;
+use Illuminate\Console\Command;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputArgument;
+
+#[AsCommand(name: 'cache:prune-stale-tags')]
+class PruneStaleTagsCommand extends Command
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'cache:prune-stale-tags';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Prune stale cache tags from the cache (Redis only)';
+
+    /**
+     * Execute the console command.
+     *
+     * @param  \Illuminate\Cache\CacheManager  $cache
+     * @return void
+     */
+    public function handle(CacheManager $cache)
+    {
+        $cache = $cache->store($this->argument('store'));
+
+        if (! $cache->getStore() instanceof RedisStore) {
+            $this->components->error('Pruning cache tags is only necessary when using Redis.');
+
+            return 1;
+        }
+
+        $cache->flushStaleTags();
+
+        $this->components->info('Stale cache tags pruned successfully.');
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [
+            ['store', InputArgument::OPTIONAL, 'The name of the store you would like to prune tags from'],
+        ];
+    }
+}

src/Illuminate/Cache/RedisStore.php

@@ -5,6 +5,9 @@
 use Illuminate\Contracts\Cache\LockProvider;
 use Illuminate\Contracts\Redis\Factory as Redis;
 use Illuminate\Redis\Connections\PhpRedisConnection;
+use Illuminate\Redis\Connections\PredisConnection;
+use Illuminate\Support\LazyCollection;
+use Illuminate\Support\Str;
 
 class RedisStore extends TaggableStore implements LockProvider
 {
@@ -235,6 +238,18 @@ public function flush()
         return true;
     }
 
+    /**
+     * Remove all expired tag set entries.
+     *
+     * @return bool
+     */
+    public function flushStaleTags()
+    {
+        foreach ($this->currentTags()->chunk(1000) as $tags) {
+            $this->tags($tags->all())->flushStale();
+        }
+    }
+
     /**
      * Begin executing a new tags operation.
      *
@@ -248,6 +263,51 @@ public function tags($names)
         );
     }
 
+    /**
+     * Get a collection of all of the cache tags currently being used.
+     *
+     * @param  int  $chunkSize
+     * @return \Illuminate\Support\LazyCollection
+     */
+    protected function currentTags($chunkSize = 1000)
+    {
+        $connection = $this->connection();
+
+        // Connections can have a global prefix...
+        $connectionPrefix = match (true) {
+            $connection instanceof PhpRedisConnection => $connection->_prefix(''),
+            $connection instanceof PredisConnection => $connection->getOptions()->prefix ?: '',
+            default => '',
+        };
+
+        $prefix = $connectionPrefix.$this->getPrefix();
+
+        return LazyCollection::make(function () use ($connection, $chunkSize, $prefix) {
+            $cursor = $defaultCursorValue = '0';
+
+            do {
+                [$cursor, $tagsChunk] = $connection->scan(
+                    $cursor,
+                    ['match' => $prefix.'tag:*:entries', 'count' => $chunkSize]
+                );
+
+                if (! is_array($tagsChunk)) {
+                    break;
+                }
+
+                $tagsChunk = array_unique($tagsChunk);
+
+                if (empty($tagsChunk)) {
+                    continue;
+                }
+
+                foreach ($tagsChunk as $tag) {
+                    yield $tag;
+                }
+            } while (((string) $cursor) !== $defaultCursorValue);
+        })->map(fn (string $tagKey) => Str::match('/^'.preg_quote($prefix).'tag:(.*):entries$/', $tagKey));
+    }
+
     /**
      * Get the Redis connection instance.
      *

src/Illuminate/Foundation/Providers/ArtisanServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Auth\Console\ClearResetsCommand;
 use Illuminate\Cache\Console\CacheTableCommand;
+use Illuminate\Cache\Console\PruneStaleTagsCommand;
 use Illuminate\Cache\Console\ClearCommand as CacheClearCommand;
 use Illuminate\Cache\Console\ForgetCommand as CacheForgetCommand;
 use Illuminate\Console\Scheduling\ScheduleClearCacheCommand;
@@ -124,6 +125,7 @@ class ArtisanServiceProvider extends ServiceProvider implements DeferrableProvid
         'Optimize' => OptimizeCommand::class,
         'OptimizeClear' => OptimizeClearCommand::class,
         'PackageDiscover' => PackageDiscoverCommand::class,
+        'PruneStaleTagsCommand' => PruneStaleTagsCommand::class,
         'QueueClear' => QueueClearCommand::class,
         'QueueFailed' => ListFailedQueueCommand::class,
         'QueueFlush' => FlushFailedQueueCommand::class,