feat(Spanner): Add the grpc keepalive configuration (#8863)

Author: Hectorhammett

Spanner/src/SpannerClient.php

@@ -118,6 +118,7 @@ class SpannerClient
 
     const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/spanner.data';
     const ADMIN_SCOPE = 'https://www.googleapis.com/auth/spanner.admin';
+    private const GRPC_KEEPALIVE_MILLISECONDS = 120 * 1000;
 
     private const SERVICE_NAME = 'google.spanner.v1.Spanner';
 
@@ -204,7 +205,7 @@ public function __construct(array $options = [])
             'directedReadOptions' => [],
             'isolationLevel' => IsolationLevel::ISOLATION_LEVEL_UNSPECIFIED,
             'routeToLeader' => true,
-            'cacheItemPool' => null,
+            'cacheItemPool' => null
         ];
 
         $this->returnInt64AsObject = $options['returnInt64AsObject'];
@@ -213,6 +214,8 @@ public function __construct(array $options = [])
         $this->defaultQueryOptions = $options['queryOptions'];
         $this->isolationLevel = $options['isolationLevel'];
 
+        $options = $this->configureKeepAlive($options);
+
         // Configure GAPIC client options
         $options = $this->buildClientOptions($options);
         if (isset($options['credentialsConfig']['scopes'])) {
@@ -1002,4 +1005,23 @@ private function getChannelId(array $options): int
         // We have seen this channel, get the ID assigned to the channel
         return self::$activeChannels[$channelObjectId];
     }
+
+    /**
+     * Configures the GRPC KeepAlive time
+     *
+     * @param array $config The Configuration array
+     * @return array<mixed>
+     */
+    private function configureKeepAlive(array $config): array
+    {
+        if (!isset($config['transportConfig']['grpc']['stubOpts'])) {
+            $config['transportConfig']['grpc']['stubOpts'] = [];
+        }
+
+        $config['transportConfig']['grpc']['stubOpts'] += [
+            'grpc.keepalive_time_ms' => self::GRPC_KEEPALIVE_MILLISECONDS
+        ];
+
+        return $config;
+    }
 }

Spanner/tests/Unit/SpannerClientTest.php

@@ -770,4 +770,44 @@ private function getTotalChannel(SpannerClient $client): int
 
         return $property->getValue($client);
     }
+
+    public function testConfigureKeepAlive()
+    {
+        $client = new SpannerClient([
+            'projectId' => 'test-project',
+            'credentials' => Fixtures::KEYFILE_STUB_FIXTURE(),
+        ]);
+        $reflection = new ReflectionClass($client);
+        $method = $reflection->getMethod('configureKeepAlive');
+        $method->setAccessible(true);
+
+        $config = [];
+        $newConfig = $method->invoke($client, $config);
+
+        $this->assertArrayHasKey('transportConfig', $newConfig);
+        $this->assertArrayHasKey('grpc', $newConfig['transportConfig']);
+        $this->assertArrayHasKey('stubOpts', $newConfig['transportConfig']['grpc']);
+        $this->assertArrayHasKey('grpc.keepalive_time_ms', $newConfig['transportConfig']['grpc']['stubOpts']);
+        $this->assertEquals(
+            120 * 1000, // 120 seconds x 1000
+            $newConfig['transportConfig']['grpc']['stubOpts']['grpc.keepalive_time_ms']
+        );
+
+        // Test that it doesn't overwrite existing config
+        $config = [
+            'transportConfig' => [
+                'grpc' => [
+                    'stubOpts' => [
+                        'foo' => 'bar'
+                    ]
+                ]
+            ]
+        ];
+        $newConfig = $method->invoke($client, $config);
+        $this->assertEquals('bar', $newConfig['transportConfig']['grpc']['stubOpts']['foo']);
+        $this->assertEquals(
+            120 * 1000, // 120 seconds x 1000
+            $newConfig['transportConfig']['grpc']['stubOpts']['grpc.keepalive_time_ms']
+        );
+    }
 }