Cache Laravel Package

Getting Started

Minimal Setup

1. Installation (if still needed for legacy projects):

   composer require gpupo/cache
   

   (Note: Avoid new projects—use symfony/cache instead.)

2. Basic PSR-6 Cache Pool Initialization:

   use Gpupo\Cache\CachePool;
   use Gpupo\Cache\CacheItem;
   
   $cache = new CachePool(new \Gpupo\Cache\Storage\FileStorage('/path/to/cache'));
   

3. First Use Case:

   $item = $cache->getItem('key');
   if (!$item->isHit()) {
       $item->set('value');
       $cache->save($item);
   }
   

Where to Look First

• PSR-6 Compliance: Follow the PSR-6 spec for cache item/pool methods.
• Storage Adapters: Check Gpupo\Cache\Storage for available backends (e.g., FileStorage, RedisStorage).
• Legacy Code: Search for gpupo/cache usages in your project’s composer.json or vendor/ to audit dependencies.

Implementation Patterns

Common Workflows

1. Cache Warming:

   $cache = new CachePool($storage);
   $items = $cache->getItems(['key1', 'key2']);
   foreach ($items as $item) {
       if (!$item->isHit()) {
           $item->set(fetchExpensiveData($item->getKey()));
       }
   }
   $cache->saveDeferred(); // Batch save
   

2. TTL Management:

   $item = $cache->getItem('user:123');
   $item->expiresAfter(3600); // 1 hour TTL
   $item->set($userData);
   $cache->save($item);
   

3. Tag-Based Invalidation (if supported by storage):

   $cache->deleteItemsMatchingTag('user:*'); // Hypothetical; verify adapter support.
   

Integration Tips

• Laravel Integration (if forced to use): Bind the pool to the container:

  $app->singleton(\Psr\Cache\CacheItemPoolInterface::class, function ($app) {
      return new CachePool(new FileStorage(storage_path('framework/cache')));
  });
  

• Fallback to Symfony Cache: Replace gpupo/cache with symfony/cache and update imports:

  use Symfony\Contracts\Cache\CacheInterface;
  $cache = new CacheInterface(new \Symfony\Component\Cache\Adapter\FilesystemAdapter());
  

Gotchas and Tips

Pitfalls

1. Abandoned Package:

   • No security updates or bug fixes since 2017. Avoid in production.
   • Migration Path: Use symfony/cache (PSR-6 compliant) or Laravel’s built-in cache (Illuminate\Cache).

2. Storage Adapter Quirks:

   • FileStorage may lock files during writes, causing race conditions.
   • Redis/other adapters may not be fully implemented or tested.

3. PSR-6 Inconsistencies:

   • Some methods (e.g., deleteItemsMatchingTag) may not be supported by all storage backends.
   • Verify CacheItem::isHit() behavior with empty/null values.

4. No Laravel-Specific Features:

   • Lacks integration with Laravel’s cache tags, events, or Cache::remember() helpers.

Debugging Tips

• Check Storage Backend: Inspect /path/to/cache/ for files or Redis keys to verify writes.
• Enable Logging: Wrap pool operations in try-catch to log exceptions:

  try {
      $cache->save($item);
  } catch (\Psr\Cache\InvalidArgumentException $e) {
      Log::error("Cache save failed: " . $e->getMessage());
  }
  

Extension Points

• Custom Storage: Implement Gpupo\Cache\Storage\StorageInterface for new backends (e.g., database).

  class DbStorage implements StorageInterface { ... }
  

• Decorators: Wrap the pool to add logging/metrics:

  class LoggingPool implements CacheItemPoolInterface {
      public function __construct(private CacheItemPoolInterface $pool) {}
      public function getItem($key) {
          Log::debug("Cache get: $key");
          return $this->pool->getItem($key);
      }
      // ...
  }
  

Proactive Fixes

1. Audit Dependencies: Run composer why gpupo/cache to find direct/indirect usages.
2. Replace in composer.json:

   "require": {
       "symfony/cache": "^6.0"
   }
   

3. Update Code: Replace gpupo/cache imports with symfony/cache or Laravel’s cache facade. Example:

   // Before
   use Gpupo\Cache\CachePool;
   // After
   use Symfony\Contracts\Cache\CacheInterface;