Cache: Instance Scoped Cache Provider (#96)

* Cache: Instance Scoped Cache Provider

* Cache: register earlier

* Cache: merge for instance-scoped config

Co-authored-by: James Ritchie <[email protected]>

* Cache: add mixin for Repository

Co-authored-by: James Ritchie <[email protected]>

* Cache: configure instance-scoped path via config

Co-authored-by: Copilot <[email protected]>
Co-authored-by: James Ritchie <[email protected]>

---------

Co-authored-by: James Ritchie <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

src/AffordableMobiles/GServerlessSupportLaravel/Auth/Token/OIDC.php

@@ -6,10 +6,10 @@
 
 use AffordableMobiles\GServerlessSupportLaravel\Auth\Exception\InvalidTokenException;
 use AffordableMobiles\GServerlessSupportLaravel\Auth\Token\Type\JWT;
-use AffordableMobiles\GServerlessSupportLaravel\Cache\InstanceLocal as InstanceLocalCache;
 use AffordableMobiles\GServerlessSupportLaravel\Integration\Guzzle\Tools as GuzzleTools;
 use Google\Cloud\Core\ExponentialBackoff;
 use GuzzleHttp\Client;
+use Illuminate\Support\Facades\Cache;
 
 class OIDC
 {
@@ -103,7 +103,7 @@ public static function shouldRetry($ex, $retryAttempt = 1)
      */
     protected static function get_jwk_url()
     {
-        return InstanceLocalCache::remember('jwk_url__'.self::OPENID_CONFIGURATION_URI, 86400, static function () {
+        return Cache::store('instance-scoped')->remember('jwk_url__'.self::OPENID_CONFIGURATION_URI, 86400, static function () {
             $httpclient = new Client();
 
             $content = [

src/AffordableMobiles/GServerlessSupportLaravel/Auth/Token/Type/JWT.php

@@ -5,10 +5,10 @@
 namespace AffordableMobiles\GServerlessSupportLaravel\Auth\Token\Type;
 
 use AffordableMobiles\GServerlessSupportLaravel\Auth\Exception\InvalidTokenException;
-use AffordableMobiles\GServerlessSupportLaravel\Cache\InstanceLocal as InstanceLocalCache;
 use AffordableMobiles\GServerlessSupportLaravel\Integration\Guzzle\Tools as GuzzleTools;
 use Google\Cloud\Core\ExponentialBackoff;
 use GuzzleHttp\Client;
+use Illuminate\Support\Facades\Cache;
 use SimpleJWT\InvalidTokenException as JWTInvalidTokenException;
 use SimpleJWT\JWT as JWTValidator;
 use SimpleJWT\Keys\KeySet;
@@ -123,7 +123,7 @@ protected static function get_jwk_set($jwk_url)
     protected static function get_jwk_set_raw($jwk_url)
     {
         // get the public key JWK Set object (RFC7517)
-        return InstanceLocalCache::remember('jwk_set__'.$jwk_url, 86400, static function () use ($jwk_url) {
+        return Cache::store('instance-scoped')->remember('jwk_set__'.$jwk_url, 86400, static function () use ($jwk_url) {
             $httpclient = new Client();
 
             $content = [

src/AffordableMobiles/GServerlessSupportLaravel/Cache/InstanceLocal.php

@@ -6,30 +6,35 @@
 
 use Illuminate\Cache\CacheManager;
 use Illuminate\Contracts\Cache\Repository;
-
+use Illuminate\Support\Facades\Cache;
+
+/**
+ * @deprecated Use the 'instance-scoped' cache store instead.
+ * Example: Cache::store('instance-scoped')->get('key');
+ *
+ * @mixin \Illuminate\Contracts\Cache\Repository
+ */
 class InstanceLocal extends CacheManager
 {
     private static $instance;
 
-    private $driver;
-
     /**
-     * Dynamically call the default driver instance (statically).
+     * Handle static calls like InstanceLocal::get().
+     * Optimized to skip local instantiation.
      *
-     * @param string $method
-     * @param array  $parameters
-     *
-     * @return mixed
+     * @param mixed $method
+     * @param mixed $parameters
      */
     public static function __callStatic($method, $parameters)
     {
-        return self::getInstance()->store()->{$method}(...$parameters);
+        return Cache::store('instance-scoped')->{$method}(...$parameters);
     }
 
     /**
      * Get a singleton instance of this class.
+     * Keeps backward compatibility for code using InstanceLocal::getInstance()->get().
      *
-     * @return Repository
+     * @return static
      */
     public static function getInstance()
     {
@@ -41,28 +46,15 @@ public static function getInstance()
     }
 
     /**
-     * Get a cache store instance by name.
+     * Override the store method to redirect instance calls.
+     * This handles: $instance = new InstanceLocal(...); $instance->get(...);.
      *
      * @param null|string $name
      *
      * @return Repository
      */
     public function store($name = null)
     {
-        return $this->getDriver();
-    }
-
-    /**
-     * Get the driver instance.
-     *
-     * @return Repository
-     */
-    private function getDriver()
-    {
-        if (!$this->driver) {
-            $this->driver = $this->createFileDriver(['path' => '/tmp/cache/GServerlessSupportLaravel']);
-        }
-
-        return $this->driver;
+        return Cache::store('instance-scoped');
     }
 }

src/AffordableMobiles/GServerlessSupportLaravel/Database/Connectors/ConnectionFactory.php

@@ -4,10 +4,10 @@
 
 namespace AffordableMobiles\GServerlessSupportLaravel\Database\Connectors;
 
-use AffordableMobiles\GServerlessSupportLaravel\Cache\InstanceLocal as InstanceLocalCache;
 use AffordableMobiles\sqlcommenter\Connectors\ConnectionFactory as BaseConnectionFactory;
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Cache;
 
 class ConnectionFactory extends BaseConnectionFactory
 {
@@ -66,7 +66,7 @@ protected function createPdoResolverWithSockets(array $config)
             $cacheKey = 'GServerlessSupportLaravel-Database-ConnectionFactory-'.$config['name'];
             $sockets  = Arr::shuffle($this->parseSockets($config));
 
-            $current = is_g_serverless_development() ? null : InstanceLocalCache::get($cacheKey);
+            $current = is_g_serverless_development() ? null : Cache::store('instance-scoped')->get($cacheKey);
             if (!empty($current)) {
                 $sockets = array_filter($sockets, static fn ($socket) => $socket !== $current);
                 array_unshift($sockets, $current);
@@ -81,7 +81,7 @@ protected function createPdoResolverWithSockets(array $config)
                     $runtimeConfig = $this->resolveRuntimeConfig($config);
                     $connection    = $this->createConnector($runtimeConfig)->connect($runtimeConfig);
 
-                    InstanceLocalCache::forever($cacheKey, $socket);
+                    Cache::store('instance-scoped')->forever($cacheKey, $socket);
 
                     return $connection;
                 } catch (\PDOException $e) {

src/AffordableMobiles/GServerlessSupportLaravel/GServerlessSupportServiceProvider.php

@@ -34,6 +34,8 @@ public function register(): void
             __DIR__.'/../../config/gserverlesssupport.php',
             'gserverlesssupport'
         );
+
+        $this->registerInstanceScopedCache();
     }
 
     /**
@@ -87,6 +89,31 @@ public function provides()
         return ['g-serverless-support'];
     }
 
+    /**
+     * Registers the instance-scoped cache store configuration.
+     */
+    protected function registerInstanceScopedCache(): void
+    {
+        $config = $this->app->make('config');
+
+        $cachePath = $config->get(
+            'gserverlesssupport.system_cache_path',
+            '/tmp/cache/GServerlessSupportLaravel' // Fallback
+        );
+
+        $defaults = [
+            'driver' => 'file',
+            'path'   => $cachePath,
+        ];
+
+        $userConfig = $config->get('cache.stores.instance-scoped', []);
+
+        $config->set(
+            'cache.stores.instance-scoped',
+            array_merge($defaults, $userConfig)
+        );
+    }
+
     /**
      * Finds and shares the versioned asset paths from the Vite manifest.
      */

src/config/gserverlesssupport.php

@@ -23,4 +23,19 @@
             'logout_redirect'     => '/',
         ],
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Instance-Local Cache Path
+    |--------------------------------------------------------------------------
+    |
+    | Defines the storage path for the 'instance-scoped' cache store.
+    |
+    | This store provides a local, per-instance cache (living in /tmp) that
+    | is NOT shared between serverless instances. It is used internally
+    | by this package (for DB sockets, OIDC keys) and is available for
+    | your application via: Cache::store('instance-scoped')->get(...);
+    |
+    */
+    'system_cache_path' => env('G_SERVERLESS_SYSTEM_CACHE_PATH', '/tmp/cache/GServerlessSupportLaravel'),
 ];