fix: use google/auth caches by default

Author: bshaffer

Spanner/composer.json

@@ -7,7 +7,7 @@
         "php": "^8.1",
         "ext-grpc": "*",
         "google/cloud-core": "^1.68",
-        "google/gax": "^1.38.0"
+        "google/gax": "^1.38.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6",
@@ -19,7 +19,6 @@
         "google/cloud-pubsub": "^2.0",
         "dg/bypass-finals": "^1.7",
         "dms/phpunit-arraysubset-asserts": "^0.5.0",
-        "symfony/cache": "^6.4",
         "symfony/process": "^6.4"
     },
     "suggest": {

Spanner/src/Session/SessionCache.php

@@ -93,7 +93,7 @@ public function __construct(
 
         $this->routeToLeader = $options['routeToLeader'] ?? false;
         $this->cacheItemPool = $options['cacheItemPool'] ?? (
-            extension_loaded('sysvshm')
+            extension_loaded('sysvshm') && extension_loaded('sysvsem')
                 ? new SysVCacheItemPool()
                 : new FileSystemCacheItemPool(sys_get_temp_dir() . '/spanner_cache/')
         );
@@ -207,6 +207,7 @@ public function __debugInfo()
     {
         return [
             'session' => $this->session,
+            'cacheKey' => $this->cacheKey,
             'cacheItemPool' => $this->cacheItemPool,
         ];
     }

Spanner/tests/System/SystemTestCaseTrait.php

@@ -23,7 +23,6 @@
 use Google\Cloud\Spanner\SpannerClient;
 use Google\Cloud\Spanner\V1\Client\SpannerClient as SpannerGapicClient;
 use Google\Cloud\Spanner\Admin\Database\V1\DatabaseDialect;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 
 trait SystemTestCaseTrait
 {
@@ -71,7 +70,6 @@ private static function getClient()
 
         $clientConfig = [
             'keyFilePath' => $keyFilePath,
-            'cacheItemPool' => self::getCacheItemPool(),
         ];
 
         $serviceAddress = getenv('SPANNER_SERVICE_ADDRESS');
@@ -192,11 +190,4 @@ private static function getDatabaseFromInstance($instance, $dbName, $options = [
         $instance = self::getClient()->instance($instance);
         return $instance->database($dbName, $options);
     }
-
-    private static function getCacheItemPool()
-    {
-        return new FilesystemAdapter(
-            directory: __DIR__ . '/../../../.cache'
-        );
-    }
 }

Spanner/tests/Unit/Session/SessionCacheTest.php

@@ -17,6 +17,7 @@
 
 namespace Google\Cloud\Spanner\Tests\Unit\Session;
 
+use Google\Auth\Cache\FileSystemCacheItemPool;
 use Google\Cloud\Spanner\Session\SessionCache;
 use Google\Cloud\Spanner\V1\Client\SpannerClient;
 use Google\Cloud\Spanner\V1\Session;
@@ -26,7 +27,6 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
-use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\Process\Process;
 
 /**
@@ -73,9 +73,7 @@ public function testEnsureValidSessionCacheHit()
         $session = new SessionCache(
             $this->spannerClient->reveal(),
             $this->databaseName,
-            [
-                'cacheItemPool' => $cacheItemPool->reveal(),
-            ]
+            ['cacheItemPool' => $cacheItemPool->reveal()]
         );
         $name = $session->name();
         $this->assertEquals($this->sessionName, $name);
@@ -177,13 +175,14 @@ public function testCacheLocking()
         // Use mt_rand to ensure the cache key is unique for each test run
         $databaseId = mt_rand();
         $databaseName = SpannerClient::databaseName(self::PROJECT, self::INSTANCE, $databaseId);
+        $cachePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'spannercache';
         $sessionCache = new SessionCache(
             $this->spannerClient->reveal(),
             $databaseName,
-            ['cacheItemPool' => new FilesystemAdapter($databaseId)]
+            ['cacheItemPool' => new FileSystemCacheItemPool($cachePath)],
         );
 
-        $process = new Process(['php', __DIR__ . '/lock_test_process.php', $databaseName]);
+        $process = new Process(['php', __DIR__ . '/lock_test_process.php', $databaseName, $cachePath]);
         $process->setTimeout(5);
 
         // Mock fetching the session from the API

Spanner/tests/Unit/Session/lock_test_process.php

@@ -3,6 +3,8 @@
 namespace Google\Cloud\Spanner\Tests\Unit\Session;
 
 use DG\BypassFinals;
+use Exception;
+use Google\Auth\Cache\FileSystemCacheItemPool;
 use Google\Cloud\Spanner\Session\SessionCache;
 use Google\Cloud\Spanner\V1\Client\SpannerClient;
 use Prophecy\Argument;
@@ -12,25 +14,38 @@
 /**
  * Runs a process which is designed to wait while a session is acquired.
  */
-if (count($argv) !== 2) {
-    die('Usage: lock_test_process.php DATABASE_NAME' . PHP_EOL);
+if (count($argv) !== 3) {
+    die('Usage: lock_test_process.php DATABASE_NAME CACHE_PATH' . PHP_EOL);
 }
 
-if (file_exists(__DIR__ . '/../../../vendor/autoload.php')) {
+$spannerAutoload = __DIR__ . '/../../../vendor/autoload.php';
+$googleCloudAutoload = __DIR__ . '/../../../../vendor/autoload.php';
+
+if (file_exists($spannerAutoload) && file_exists($googleCloudAutoload)) {
+    throw new Exception('Both autoloaders exist, please remove one');
+}
+
+if (file_exists($spannerAutoload)) {
     // google/cloud-spanner autoload
-    require __DIR__ . '/../../../vendor/autoload.php';
-} elseif (file_exists(__DIR__ . '/../../../../vendor/autoload.php')) {
+    require $spannerAutoload;
+} elseif (file_exists($googleCloudAutoload)) {
     // google/cloud autoload
-    require __DIR__ . '/../../../../vendor/autoload.php';
+    require $googleCloudAutoload;
+} else {
+    throw new Exception('no autoloader found');
 }
 
 BypassFinals::enable();
 
-$acquireSession = new class($argv[1]) {
+[$_cmd, $databaseName, $cachePath] = $argv;
+
+$acquireSession = new class($databaseName, $cachePath) {
     use ProphecyTrait;
 
-    public function __construct(private string $databaseName)
-    {
+    public function __construct(
+        private string $databaseName,
+        private string $cachePath
+    ) {
     }
 
     public function run(): string
@@ -41,11 +56,10 @@ public function run(): string
                 throw new \Exception('createSession called in child process - this shouldn\'t happen');
             });
 
-        $parts = explode('/', $this->databaseName);
         $sessionCache = new SessionCache(
             $spannerClient->reveal(),
             $this->databaseName,
-            ['cacheItemPool' => new FilesystemAdapter(array_pop($parts))]
+            ['cacheItemPool' => new FileSystemCacheItemPool($this->cachePath)]
         );
 
         return $sessionCache->name();

composer.json

@@ -64,7 +64,7 @@
         "psr/http-message": "^1.0|^2.0",
         "ramsey/uuid": "^4.0",
         "google/common-protos": "^4.4",
-        "google/gax": "^1.38.0",
+        "google/gax": "^1.38.1",
         "google/auth": "^1.42"
     },
     "require-dev": {
@@ -80,7 +80,6 @@
         "dg/bypass-finals": "^1.7",
         "squizlabs/php_codesniffer": "3.*",
         "dms/phpunit-arraysubset-asserts": "^0.5.0",
-        "symfony/cache": "^6.4",
         "symfony/process": "^6.4"
     },
     "replace": {