Fix base64 encoding

Author: Hectorhammett

Datastore/phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/Unit/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <coverage>
     <include>
       <directory suffix=".php">src</directory>

Datastore/src/DatastoreClient.php

@@ -149,8 +149,8 @@ class DatastoreClient
      *     @type bool $returnInt64AsObject If true, 64 bit integers will be
      *           returned as a {@see \Google\Cloud\Core\Int64} object for 32 bit
      *           platform compatibility. **Defaults to** false.
-     *     @type Google\Cloud\Datastore\V1\Client\DatastoreClient $datastoreClient A client that is of
-     *           type {@see \Google\Cloud\Datastore\V1\Client\DatastoreClient}
+     *     @type GapicDatastoreClient $datastoreClient A client that is of
+     *           type {@see GapicDatastoreClient}
      * }
      * @throws \InvalidArgumentException
      */
@@ -555,11 +555,6 @@ public function allocateIds(array $keys, array $options = [])
      */
     public function transaction(array $options = [])
     {
-        if (isset($options['transactionOptions']['previousTransaction'])) {
-            $options['transactionOptions']['previousTransaction'] = base64_encode(
-                $options['transactionOptions']['previousTransaction']
-            );
-        }
         $transaction = $this->operation->beginTransaction([
             // if empty, force request to encode as {} rather than [].
             'readWrite' => $this->pluck('transactionOptions', $options, false) ?: (object) []

Datastore/src/Operation.php

@@ -32,7 +32,8 @@
 use Google\Cloud\Datastore\V1\Client\DatastoreClient;
 use Google\Cloud\Datastore\V1\CommitRequest;
 use Google\Cloud\Datastore\V1\CommitRequest\Mode;
-use Google\Cloud\Datastore\V1\Key as GrpcKey;
+use Google\Cloud\Datastore\V1\EntityResult;
+use Google\Cloud\Datastore\V1\Key as ProtobufKey;
 use Google\Cloud\Datastore\V1\LookupRequest;
 use Google\Cloud\Datastore\V1\Mutation;
 use Google\Cloud\Datastore\V1\ReadOptions;
@@ -41,6 +42,7 @@
 use Google\Cloud\Datastore\V1\RunAggregationQueryRequest;
 use Google\Cloud\Datastore\V1\RunQueryRequest;
 use Google\Cloud\Datastore\V1\TransactionOptions;
+use Google\Protobuf\RepeatedField;
 use Google\Protobuf\Timestamp as ProtobufTimestamp;
 use InvalidArgumentException;
 
@@ -310,10 +312,10 @@ public function beginTransaction($transactionOptions, array $options = [])
         $protoTransactionOptions = new TransactionOptions();
         $protoTransactionOptions->mergeFromJsonString(json_encode($transactionOptions));
 
-        $beginTransactionRequest = new BeginTransactionRequest();
-        $beginTransactionRequest->setProjectId($this->projectId);
-        $beginTransactionRequest->setDatabaseId($options['databaseId'] ?? $this->databaseId);
-        $beginTransactionRequest->setTransactionOptions($protoTransactionOptions);
+        $beginTransactionRequest = (new BeginTransactionRequest())
+            ->setProjectId($this->projectId)
+            ->setDatabaseId($options['databaseId'] ?? $this->databaseId)
+            ->setTransactionOptions($protoTransactionOptions);
 
         $res = $this->gapicClient->beginTransaction($beginTransactionRequest, $options);
 
@@ -353,19 +355,19 @@ public function allocateIds(array $keys, array $options = [])
 
         $serviceKeys = [];
         foreach ($keys as $key) {
-            $keyMessage = new GrpcKey();
+            $keyMessage = new protobufKey();
             $keyMessage->mergeFromJsonString(json_encode($key->keyObject()));
             $serviceKeys[] = $keyMessage;
         }
 
-        $request = new AllocateIdsRequest();
-        $request->setProjectId($this->projectId);
-        $request->setDatabaseId($options['databaseId'] ?? $this->databaseId);
-        $request->setKeys($serviceKeys);
+        $request = (new AllocateIdsRequest())
+            ->setProjectId($this->projectId)
+            ->setDatabaseId($options['databaseId'] ?? $this->databaseId)
+            ->setKeys($serviceKeys);
 
         $allocateIdsResponse = $this->gapicClient->allocateIds($request, $options);
 
-        /** @var GrpcKey $responseKey */
+        /** @var protobufKey $responseKey */
         foreach ($allocateIdsResponse->getKeys() as $index => $responseKey) {
             $path = $responseKey->getPath();
 
@@ -425,17 +427,16 @@ public function lookup(array $keys, array $options = [])
                 ));
             }
 
-            $grpcKey = new GrpcKey();
-            $grpcKey->mergeFromJsonString(json_encode($key->keyObject()));
-            $serviceKeys[] = $grpcKey;
+            $protobufKey = new protobufKey();
+            $protobufKey->mergeFromJsonString(json_encode($key->keyObject()));
+            $serviceKeys[] = $protobufKey;
         });
 
-        $lookupRequest = new LookupRequest();
-        $lookupRequest->setDatabaseId($options['databaseId'] ?? $this->databaseId);
-        $lookupRequest->setProjectId($this->projectId);
-        $lookupRequest->setKeys($serviceKeys);
-
-        $lookupRequest->setReadOptions($this->createReadOptions($options));
+        $lookupRequest = (new LookupRequest())
+            ->setDatabaseId($options['databaseId'] ?? $this->databaseId)
+            ->setProjectId($this->projectId)
+            ->setKeys($serviceKeys)
+            ->setReadOptions($this->createReadOptions($options));
 
         $lookupResponse = $this->gapicClient->lookup($lookupRequest, $options);
 
@@ -445,7 +446,7 @@ public function lookup(array $keys, array $options = [])
             'deferred' => [],
         ];
 
-        /** @var GrpcEntity $found */
+        /** @var protoEntity $found */
         foreach ($lookupResponse->getFound() as $found) {
             $result['found'][] = $this->mapEntityResult(
                 $this->serializer->encodeMessage($found), $options['className']
@@ -456,15 +457,15 @@ public function lookup(array $keys, array $options = [])
             $result['found'] = $this->sortEntities($result['found'], $keys);
         }
 
-        /** @var GrpcEntity $missing */
+        /** @var entityResult $missing*/
         foreach ($lookupResponse->getMissing() as $missing) {
             $result['missing'][] = $this->key(
                 $missing->getEntity()->getKey()->getPath(),
                 $missing->getEntity()->getKey()->getPartitionId()
             );
         }
 
-        /** @var GrpcKey $deferred */
+        /** @var protobufKey $deferred */
         foreach ($lookupResponse->getDeferred() as $deferred) {
             $result['deferred'][] = $this->key(
                 $deferred->getPath(),
@@ -615,6 +616,8 @@ function (array $entityResult) use ($options) {
      *           [ReadConsistency](https://cloud.google.com/datastore/reference/rest/v1/ReadOptions#ReadConsistency).
      *     @type string $databaseId ID of the database to which the entities belong.
      *     @type Timestamp $readTime Reads entities as they were at the given timestamp.
+     *     @type ExplainOptions $explainOptions An ExplainOptions object to get the execution stats
+     *           {@see ExplainOptions}
      * }
      * @return AggregationQueryResult
      */
@@ -692,11 +695,12 @@ public function commit(array $mutations, array $options = [])
             $protoMutations[] = $protoMutation;
         }
 
-        $commitRequest = new CommitRequest();
-        $commitRequest->setMutations($protoMutations);
-        $commitRequest->setDatabaseId($options['databaseId']);
-        $commitRequest->setProjectId($this->projectId);
-        $commitRequest->setMode($transactionMode);
+        $commitRequest = (new CommitRequest())
+            ->setMutations($protoMutations)
+            ->setDatabaseId($options['databaseId'])
+            ->setProjectId($this->projectId)
+            ->setMode($transactionMode);
+
         if ($transactionMode === Mode::TRANSACTIONAL) {
             $commitRequest->setTransaction(base64_decode($options['transaction']));
         }
@@ -793,10 +797,10 @@ public function mutation(
      */
     public function rollback($transactionId)
     {
-        $rollbackRequest = new RollbackRequest();
-        $rollbackRequest->setProjectId($this->projectId);
-        $rollbackRequest->setDatabaseId($this->databaseId);
-        $rollbackRequest->setTransaction(base64_decode($transactionId));
+        $rollbackRequest = (new RollbackRequest())
+            ->setProjectId($this->projectId)
+            ->setDatabaseId($this->databaseId)
+            ->setTransaction(base64_decode($transactionId));
 
         $this->gapicClient->rollback($rollbackRequest);
     }
@@ -885,7 +889,7 @@ private function mapEntityResult(array $result, $class)
         }
 
         return $this->entity($key, $properties, [
-            'cursor' => (isset($result['cursor']) && $result['cursor'] !== '')
+            'cursor' => !empty($result['cursor'])
                 ? $result['cursor']
                 : null,
             'baseVersion' => (isset($result['version']))

Datastore/tests/System/bootstrap.php

@@ -1,9 +1,10 @@
 <?php
 
+use DG\BypassFinals;
 use Google\Cloud\Core\Testing\TestHelpers;
 use Google\Cloud\Datastore\Tests\System\DatastoreTestCase;
 
 TestHelpers::requireKeyfile('GOOGLE_CLOUD_PHP_TESTS_KEY_PATH');
 TestHelpers::systemTestShutdown(function () {
     DatastoreTestCase::tearDownFixtures();
-});
+});

Datastore/tests/Unit/DatastoreClientTest.php

@@ -49,7 +49,6 @@
 use Google\Cloud\Datastore\V1\LookupRequest;
 use Google\Cloud\Datastore\V1\LookupResponse;
 use Prophecy\PhpUnit\ProphecyTrait;
-use DG\BypassFinals;
 use Google\Cloud\Datastore\V1\AllocateIdsRequest;
 use Google\Cloud\Datastore\V1\AllocateIdsResponse;
 use Google\Cloud\Datastore\V1\BeginTransactionRequest;
@@ -81,10 +80,6 @@ class DatastoreClientTest extends TestCase
 
     public function setUp(): void
     {
-        if (class_exists(BypassFinals::class)) {
-            BypassFinals::enable(true);
-        }
-
         $this->gapicClient = $this->prophesize(GapicClient::class);
         $this->client = new DatastoreClient([
             'projectId' => self::PROJECT,
@@ -323,7 +318,7 @@ public function testTransactionWithOptions()
                 ->getReadWrite()
                 ->getPreviousTransaction();
             $this->assertNotEmpty($previousTransaction);
-            $this->assertEquals($previousTransaction, 'previousId');
+            $this->assertEquals(base64_decode('previousId'), $previousTransaction);
             return true;
         }), [])->shouldBeCalled(1)->willReturn(
             $response

Datastore/tests/Unit/OperationTest.php

@@ -17,7 +17,6 @@
 
 namespace Google\Cloud\Datastore\Tests\Unit;
 
-use DG\BypassFinals;
 use Google\Cloud\Core\Testing\TestHelpers;
 use Google\Cloud\Core\Timestamp;
 use Google\Cloud\Datastore\Entity;
@@ -68,9 +67,6 @@ class OperationTest extends TestCase
 
     public function setUp(): void
     {
-        if (class_exists(BypassFinals::class)) {
-            BypassFinals::enable(true);
-        }
         $this->gapicClient = $this->prophesize(DatastoreClient::class);
         $this->operation = TestHelpers::stub(Operation::class, [
             $this->gapicClient->reveal(),

Datastore/tests/Unit/ProtoEncodeTrait.php

@@ -36,4 +36,4 @@ public static function generateProto(string $message, array $data): Message
 
         return $message;
     }
-}
+}

Datastore/tests/Unit/TransactionTest.php

@@ -17,7 +17,6 @@
 
 namespace Google\Cloud\Datastore\Tests\Unit;
 
-use DG\BypassFinals;
 use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait;
 use Google\Cloud\Core\Testing\TestHelpers;
 use Google\Cloud\Core\Timestamp;
@@ -74,9 +73,6 @@ class TransactionTest extends TestCase
 
     public function setUp(): void
     {
-         if (class_exists(BypassFinals::class)) {
-            BypassFinals::enable(true);
-        }
         $this->gapicClient = $this->prophesize(DatastoreClient::class);
 
         $this->operation = new Operation(

Datastore/tests/Unit/bootstrap.php

@@ -0,0 +1,9 @@
+<?php
+
+use DG\BypassFinals;
+
+BypassFinals::allowPaths([
+    '*/src/V1/Client/*',
+]);
+
+BypassFinals::enable(true);