feat(Spanner): Support FGAC

Spanner/src/Batch/BatchClient.php

@@ -119,6 +119,11 @@ class BatchClient
      */
     private $databaseName;
 
+    /**
+     * @var string
+     */
+    private $databaseRole;
+
     /**
      * @var array
      */
@@ -131,11 +136,17 @@ class BatchClient
      * @param Operation $operation A Cloud Spanner Operations wrapper.
      * @param string $databaseName The database name to which the batch client
      *        instance is scoped.
+     * @param array $options  [optional] {
+     *     Configuration options.
+     *
+     *     @type string $databaseRole The user created database role which creates the session.
+     * }
      */
-    public function __construct(Operation $operation, $databaseName)
+    public function __construct(Operation $operation, $databaseName, array $options = [])
     {
         $this->operation = $operation;
         $this->databaseName = $databaseName;
+        $this->databaseRole = isset($options['databaseRole']) ? $options['databaseRole'] : null;
     }
 
     /**
@@ -168,6 +179,8 @@ public function snapshot(array $options = [])
             'transactionOptions' => [],
         ];
 
+        $sessionOptions = $this->pluck('sessionOptions', $options, false) ?: [];
+
         // Single Use transactions are not supported in batch mode.
         $options['transactionOptions']['singleUse'] = false;
 
@@ -176,9 +189,13 @@ public function snapshot(array $options = [])
 
         $transactionOptions = $this->configureSnapshotOptions($transactionOptions);
 
+        if ($this->databaseRole !== null) {
+            $sessionOptions['creator_role'] = $this->databaseRole;
+        }
+
         $session = $this->operation->createSession(
             $this->databaseName,
-            $this->pluck('sessionOptions', $options, false) ?: []
+            $sessionOptions
         );
 
         return $this->operation->snapshot($session, [

Spanner/src/Connection/Grpc.php

@@ -778,7 +778,15 @@ public function createSession(array $args)
 
         $session = $this->pluck('session', $args, false);
         if ($session) {
-            $args['session'] = $this->serializer->decodeMessage(new Session, $session);
+            $args['session'] = $this->serializer->decodeMessage(
+                new Session,
+                array_filter(
+                    $session,
+                    function ($value) {
+                        return !is_null($value);
+                    }
+                )
+            );
         }
 
         return $this->send([$this->spannerClient, 'createSession'], [

Spanner/src/Database.php

@@ -169,6 +169,11 @@ class Database
      */
     private $isRunningTransaction = false;
 
+    /**
+     * @var string
+     */
+    private $databaseRole;
+
     /**
      * Create an object representing a Database.
      *
@@ -185,6 +190,7 @@ class Database
      * @param bool $returnInt64AsObject [optional If true, 64 bit integers will
      *        be returned as a {@see Google\Cloud\Core\Int64} object for 32 bit
      *        platform compatibility. **Defaults to** false.
+     * @param string $databaseRole The user created database role which creates the session.
      */
     public function __construct(
         ConnectionInterface $connection,
@@ -195,7 +201,8 @@ public function __construct(
         $name,
         SessionPoolInterface $sessionPool = null,
         $returnInt64AsObject = false,
-        array $info = []
+        array $info = [],
+        $databaseRole = null
     ) {
         $this->connection = $connection;
         $this->instance = $instance;
@@ -210,6 +217,7 @@ public function __construct(
         }
 
         $this->setLroProperties($lroConnection, $lroCallables, $this->name);
+        $this->databaseRole = $databaseRole;
     }
 
     /**
@@ -2023,6 +2031,10 @@ private function selectSession($context = SessionPoolInterface::CONTEXT_READ, ar
             return $this->session = $this->sessionPool->acquire($context);
         }
 
+        if ($this->databaseRole !== null) {
+            $options['creator_role'] = $this->databaseRole;
+        }
+
         return $this->session = $this->operation->createSession($this->name, $options);
     }
 

Spanner/src/Instance.php

@@ -482,12 +482,19 @@ public function createDatabaseFromBackup($name, $backup, array $options = [])
      * $database = $instance->database('my-database');
      * ```
      *
+     * Database role configured on the database object
+     * will be applied to the session created by this object.
+     * ```
+     * $database = $instance->database('my-database', ['databaseRole' => 'Reader']);
+     * ```
+     *
      * @param string $name The database name
      * @param array $options [optional] {
      *     Configuration options.
      *
      *     @type SessionPoolInterface $sessionPool A pool used to manage
      *           sessions.
+     *     @type string $databaseRole The user created database role which creates the session.
      * }
      * @return Database
      */
@@ -502,7 +509,8 @@ public function database($name, array $options = [])
             $name,
             isset($options['sessionPool']) ? $options['sessionPool'] : null,
             $this->returnInt64AsObject,
-            isset($options['database']) ? $options['database'] : []
+            isset($options['database']) ? $options['database'] : [],
+            isset($options['databaseRole']) ? $options['databaseRole'] : null
         );
     }
 

Spanner/src/Operation.php

@@ -553,6 +553,7 @@ public function createSnapshot(Session $session, array $res = [], $className = S
      *           labels can be associated with a given session. See
      *           https://goo.gl/xmQnxf for more information on and examples of
      *           labels.
+     *     @type string $creator_role The user created database role which creates the session.
      * }
      * @return Session
      */
@@ -561,7 +562,8 @@ public function createSession($databaseName, array $options = [])
         $res = $this->connection->createSession([
             'database' => $databaseName,
             'session' => [
-                'labels' => $this->pluck('labels', $options, false) ?: []
+                'labels' => $this->pluck('labels', $options, false) ?: [],
+                'creator_role' => $this->pluck('creator_role', $options, false) ?: null
             ]
         ] + $options);
 

Spanner/src/Session/CacheSessionPool.php

@@ -104,6 +104,23 @@
  *     ]
  * ]);
  * ```
+ *
+ * Database role configured on the pool will be applied to each session created by the pool.
+ * ```
+ * use Google\Cloud\Spanner\SpannerClient;
+ * use Google\Cloud\Spanner\Session\CacheSessionPool;
+ * use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+ *
+ * $spanner = new SpannerClient();
+ * $cache = new FilesystemAdapter();
+ * $sessionPool = new CacheSessionPool($cache, [
+ *     'databaseRole' => 'Reader'
+ * ]);
+ *
+ * $database = $spanner->connect('my-instance', 'my-database', [
+ *     'sessionPool' => $sessionPool
+ * ]);
+ * ```
  */
 class CacheSessionPool implements SessionPoolInterface
 {
@@ -191,6 +208,8 @@ class CacheSessionPool implements SessionPoolInterface
      *           labels can be associated with a given session. See
      *           https://goo.gl/xmQnxf for more information on and examples of
      *           labels.
+     *     @type string $databaseRole The user created database role which creates the session.
+     * }
      * }
      * @throws \InvalidArgumentException
      */
@@ -660,7 +679,8 @@ private function createSessions($count)
                 $res = $this->database->connection()->batchCreateSessions([
                     'database' => $this->database->name(),
                     'sessionTemplate' => [
-                        'labels' => isset($this->config['labels']) ? $this->config['labels'] : []
+                        'labels' => isset($this->config['labels']) ? $this->config['labels'] : [],
+                        'creator_role' => isset($this->config['databaseRole']) ? $this->config['databaseRole'] : null
                     ],
                     'sessionCount' => $count - $created
                 ]);

Spanner/src/SpannerClient.php

@@ -252,11 +252,22 @@ public function __construct(array $config = [])
      * $batch = $spanner->batch('instance-id', 'database-id');
      * ```
      *
+     * Database role configured in the optional $options array
+     * will be applied to the session created by this object.
+     * ```
+     * $batch = $spanner->batch('instance-id', 'database-id', ['databaseRole' => 'Reader']);
+     * ```
+     *
      * @param string $instanceId The instance to connect to.
      * @param string $databaseId The database to connect to.
+     * @param array $options  [optional] {
+     *     Configuration options.
+     *
+     *     @type string $databaseRole The user created database role which creates the session.
+     * }
      * @return BatchClient
      */
-    public function batch($instanceId, $databaseId)
+    public function batch($instanceId, $databaseId, array $options = [])
     {
         $operation = new Operation(
             $this->connection,
@@ -269,7 +280,8 @@ public function batch($instanceId, $databaseId)
                 $this->projectId,
                 $instanceId,
                 $databaseId
-            )
+            ),
+            $options
         );
     }
 
@@ -566,6 +578,14 @@ function (array $instance) {
      * $database = $spanner->connect('instance-id', 'database-id');
      * ```
      *
+     * Database role configured on the $options parameter
+     * will be applied to the session created by this object.
+     * Note: When the databseRole and sessionPool both are present in the options,
+     * we prioritize the sessionPool.
+     * ```
+     * $database = $spanner->connect('instance-id', 'database-id', ['databaseRole' => 'Reader']);
+     * ```
+     *
      * @param Instance|string $instance The instance object or instance name.
      * @param string $name The database name.
      * @param array $options [optional] {

Spanner/tests/Snippet/InstanceTest.php

@@ -399,4 +399,14 @@ public function testLongRunningOperations()
         $this->assertInstanceOf(ItemIterator::class, $res->returnVal());
         $this->assertContainsOnlyInstancesOf(LongRunningOperation::class, $res->returnVal());
     }
+
+    public function testDatabaseWithDatabaseRole()
+    {
+        $snippet = $this->snippetFromMethod(Instance::class, 'database', 1);
+        $snippet->addLocal('instance', $this->instance);
+
+        $res = $snippet->invoke('database');
+        $this->assertInstanceOf(Database::class, $res->returnVal());
+        $this->assertEquals(self::DATABASE, DatabaseAdminClient::parseName($res->returnVal()->name())['database']);
+    }
 }

Spanner/tests/Snippet/Session/CacheSessionPoolTest.php

@@ -51,4 +51,17 @@ public function testClassLabels()
         $snippet->addLocal('cache', new MemoryCacheItemPool);
         $res = $snippet->invoke();
     }
+
+    public function testClassWithDatabaseRole()
+    {
+        if (!extension_loaded('grpc')) {
+            $this->markTestSkipped('Must have the grpc extension installed to run this test.');
+        }
+
+        $snippet = $this->snippetFromClass(CacheSessionPool::class, 2);
+        $snippet->replace('$cache =', '//$cache =');
+        $snippet->addLocal('cache', new MemoryCacheItemPool);
+        $res = $snippet->invoke('database');
+        $this->assertInstanceOf(Database::class, $res->returnVal());
+    }
 }

Spanner/tests/Snippet/SpannerClientTest.php

@@ -281,4 +281,21 @@ public function testEmulator()
         $this->assertInstanceOf(SpannerClient::class, $res->returnVal());
         $this->assertEquals('localhost:9010', getenv('SPANNER_EMULATOR_HOST'));
     }
+
+    public function testConnectWithDatabaseRole()
+    {
+        $snippet = $this->snippetFromMethod(SpannerClient::class, 'connect', 1);
+        $snippet->addLocal('spanner', $this->client);
+
+        $res = $snippet->invoke('database');
+        $this->assertInstanceOf(Database::class, $res->returnVal());
+    }
+
+    public function testBatchWithDatabaseRole()
+    {
+        $snippet = $this->snippetFromMethod(SpannerClient::class, 'batch', 1);
+        $snippet->addLocal('spanner', $this->client);
+        $res = $snippet->invoke('batch');
+        $this->assertInstanceOf(BatchClient::class, $res->returnVal());
+    }
 }