add validateOptions for options arrays

Author: bshaffer

Core/src/ApiHelperTrait.php

@@ -19,8 +19,8 @@
 
 use Google\ApiCore\ArrayTrait;
 use Google\ApiCore\Options\CallOptions;
-use Google\Protobuf\NullValue;
 use Google\Protobuf\Internal\Message;
+use Google\Protobuf\NullValue;
 
 /**
  * @internal
@@ -272,25 +272,28 @@ private function splitOptionalArgs(array $input, array $extraAllowedKeys = []):
      * the CallOptions classname. Parameters are split and returned in the order
      * that the options types are provided.
      */
-    private function validateOptions(array $options, array|string ...$optionTypes): array
+    private function validateOptions(array $options, array|Message|string ...$optionTypes): array
     {
         $splitOptions = [];
         foreach ($optionTypes as $optionType) {
             if (is_array($optionType)) {
                 $splitOptions[] = $this->pluckArray($optionType, $options);
-            } elseif (is_string($optionType)) {
-                if (is_subclass_of($optionType, Message::class)) {
+            } else {
+                if ($optionType === CallOptions::class) {
+                    $callOptionKeys = array_keys((new CallOptions([]))->toArray());
+                    $splitOptions[] = $this->pluckArray($callOptionKeys, $options);
+                } else {
                     $messageKeys = array_map(
                         fn ($method) => lcfirst(substr($method, 3)),
                         array_filter(
                             get_class_methods($optionType),
                             fn ($m) => 0 === strpos($m, 'get')
                         )
                     );
-                    $splitOptions[] = $this->pluckArray($messageKeys, $options);
-                } elseif ($optionType === CallOptions::class) {
-                    $callOptionKeys = array_keys((new CallOptions([]))->toArray());
-                    $splitOptions[] = $this->pluckArray($callOptionKeys, $options);
+                    $messageOptions = $this->pluckArray($messageKeys, $options);
+                    $splitOptions[] = $optionType instanceof Message
+                        ? $this->serializer->decodeMessage($optionType, $messageOptions)
+                        : $messageOptions;
                 }
             }
         }

Core/tests/Unit/ApiHelperTraitTest.php

@@ -18,10 +18,11 @@
 namespace Google\Cloud\Core\Tests\Unit;
 
 use Google\ApiCore\Options\CallOptions;
+use Google\ApiCore\Serializer;
+use Google\ApiCore\Testing\MockRequest;
 use Google\Cloud\Core\Duration;
 use Google\Cloud\Core\Testing\GrpcTestTrait;
 use Google\Cloud\Core\Tests\Unit\Stubs\ApiHelpersTraitImpl;
-use Google\Cloud\Core\Tests\Unit\Stubs\TestMessage;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 
@@ -38,6 +39,7 @@ class ApiHelperTraitTest extends TestCase
     public function setUp(): void
     {
         $this->implementation = new ApiHelpersTraitImpl();
+        $this->implementation->serializer = new Serializer();
     }
 
     public function testFormatsTimestamp()
@@ -294,18 +296,18 @@ public function validateOptionsProvider()
             ],
             [
                 [
-                    'baz' => 'bat',
+                    'pageToken' => 'bat',
                     'qux' => 'quux',
                     'timeoutMillis' => 123,
                 ],
                 [
                     CallOptions::class,
-                    TestMessage::class,
+                    MockRequest::class,
                     ['qux'],
                 ],
                 [
                     ['timeoutMillis' => 123],
-                    ['baz' => 'bat'],
+                    ['pageToken' => 'bat'],
                     ['qux' => 'quux'],
                 ]
             ],
@@ -315,7 +317,7 @@ public function validateOptionsProvider()
                 ],
                 [
                     ['baz'],
-                    TestMessage::class,
+                    MockRequest::class,
                     CallOptions::class,
                 ],
                 [
@@ -324,6 +326,20 @@ public function validateOptionsProvider()
                     [],
                 ]
             ],
+            [
+                [
+                    'baz' => 'bat',
+                    'pageToken' => 'foo1',
+                ],
+                [
+                    ['baz'],
+                    new MockRequest(),
+                ],
+                [
+                    ['baz' => 'bat'],
+                    (new MockRequest())->setPageToken('foo1'),
+                ]
+            ],
         ];
     }
 

Core/tests/Unit/Stubs/ApiHelpersTraitImpl.php

@@ -33,4 +33,6 @@ class ApiHelpersTraitImpl
         unpackValue as public;
         validateOptions as public;
     }
+
+    public $serializer;
 }

Spanner/MIGRATING.md

@@ -113,3 +113,8 @@ $lro->pollUntilComplete();
 $lro->cancel();
 $lro->delete();
 ```
+
+### Removed Methods
+
+ - `Operation::createTransaction` => use `Operation::transaction` instead
+ - `Operation::createSnapshot` => use `Operation::snapshot` instead

Spanner/src/Batch/BatchClient.php

@@ -219,11 +219,20 @@ public function snapshotFromString($identifier)
 
         $session = $this->operation->session($data['sessionName']);
 
-        /** @var BatchSnapshot */
-        return $this->operation->createSnapshot($session, [
-            'id' => $data['transactionId'],
-            'readTimestamp' => $data['readTimestamp']
-        ], BatchSnapshot::class);
+        if ($data['readTimestamp']) {
+            if (!($data['readTimestamp'] instanceof Timestamp)) {
+                $time = $this->parseTimeString($data['readTimestamp']);
+                $data['readTimestamp'] = new Timestamp($time[0], $time[1]);
+            }
+        }
+        return new BatchSnapshot(
+            $this->operation,
+            $session,
+            [
+                'id' => $data['transactionId'],
+                'readTimestamp' => $data['readTimestamp']
+            ]
+        );
     }
 
     /**

Spanner/src/Database.php

@@ -805,7 +805,7 @@ public function transaction(array $options = []): Transaction
             throw new \BadMethodCallException('Nested transactions are not supported by this client.');
         }
 
-        $options['transactionOptions'] = $this->configureReadWriteTransactionOptions();
+        $options['transactionOptions'] = $this->initReadWriteTransactionOptions();
 
         $session = $this->selectSession(
             SessionPoolInterface::CONTEXT_READWRITE,
@@ -920,7 +920,7 @@ public function runTransaction(callable $operation, array $options = []): mixed
             $maxRetries = $retrySettings['maxRetries'];
         }
 
-        // There isn't anything configurable here.
+        // Configure necessary readWrite nested and base options
         $options['transactionOptions'] = $this->configureReadWriteTransactionOptions(
             $options['transactionOptions'] ?? []
         );
@@ -932,7 +932,6 @@ public function runTransaction(callable $operation, array $options = []): mixed
 
         $attempt = 0;
         $startTransactionFn = function ($session, $options) use (&$attempt) {
-
             // Initial attempt requires to set `begin` options (ILB).
             if ($attempt === 0) {
                 // Partitioned DML does not support ILB.