From 0baef28aada57f5f0ea698a83c31d94a10835ebc Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 08:26:42 +0000 Subject: [PATCH 01/31] feat!: [Datastore] Upgrade to PHP v2 From 7215b2e1d5122e03707e6667ef84449bbbfd093f Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 09:35:36 +0000 Subject: [PATCH 02/31] Enable Gapic Client support for Request Handler. --- .gitignore | 3 +++ Datastore/src/DatastoreClient.php | 18 ++++++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 87c5820d73ce..4ffcd0b6a8eb 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,6 @@ keys/ .testing .split __pycache__ + +# VS Code local workspace settings +.vscode diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index be00366fbc97..7296e17b6bed 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -18,8 +18,9 @@ namespace Google\Cloud\Datastore; use DomainException; +use Google\ApiCore\ArrayTrait; +use Google\ApiCore\ClientOptionsTrait; use Google\Auth\FetchAuthTokenInterface; -use Google\Cloud\Core\ArrayTrait; use Google\Cloud\Core\ClientTrait; use Google\Cloud\Core\Int64; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -30,6 +31,7 @@ use Google\Cloud\Datastore\Query\GqlQuery; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; use InvalidArgumentException; use Psr\Cache\CacheItemPoolInterface; use Psr\Http\Message\StreamInterface; @@ -90,12 +92,17 @@ class DatastoreClient { use ArrayTrait; use ClientTrait; + use ClientOptionsTrait; use DatastoreTrait; const VERSION = '1.28.0'; const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; + private const GAPIC_KEYS = [ + DatastoreGapicClient::class + ]; + /** * @deprecated * @var ConnectionInterface @@ -166,8 +173,15 @@ public function __construct(array $config = []) 'scopes' => [self::FULL_CONTROL_SCOPE], 'projectIdRequired' => true, 'hasEmulator' => (bool) $emulatorHost, - 'emulatorHost' => $emulatorHost + 'emulatorHost' => $emulatorHost, + 'transportConfig' => [ + 'grpc' => [ + // increase default limit to 4MB to prevent metadata exhausted errors + 'stubOpts' => ['grpc.max_metadata_size' => 4 * 1024 * 1024,] + ], + ], ]; + $config = $this->buildClientOptions($config); $config = $this->configureAuthentication($config); $this->connection = $connectionType === 'grpc' From 237531f488ac98f37a67de99b509151f7ce6f339 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 09:48:46 +0000 Subject: [PATCH 03/31] Add credentials wrapper support in DatastoreClient --- Datastore/src/DatastoreClient.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 7296e17b6bed..6498deb496d1 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -182,6 +182,11 @@ public function __construct(array $config = []) ], ]; $config = $this->buildClientOptions($config); + $config['credentials'] = $this->createCredentialsWrapper( + $config['credentials'], + $config['credentialsConfig'], + $config['universeDomain'], + ); $config = $this->configureAuthentication($config); $this->connection = $connectionType === 'grpc' From cac76f1a08e21c7c897a38841012fb322add0afe Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 12:59:42 +0000 Subject: [PATCH 04/31] Add request handler and serializer in DatastoreClient --- Core/src/GrpcTrait.php | 1 + Datastore/src/DatastoreClient.php | 50 +++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) diff --git a/Core/src/GrpcTrait.php b/Core/src/GrpcTrait.php index bab9d6d325d2..86d8ef159e15 100644 --- a/Core/src/GrpcTrait.php +++ b/Core/src/GrpcTrait.php @@ -18,6 +18,7 @@ namespace Google\Cloud\Core; use Google\Auth\GetUniverseDomainInterface; +use Google\ApiCore\ArrayTrait; use Google\ApiCore\CredentialsWrapper; use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Core\Exception\ServiceException; diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 6498deb496d1..bcc5591f3e44 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -20,9 +20,12 @@ use DomainException; use Google\ApiCore\ArrayTrait; use Google\ApiCore\ClientOptionsTrait; +use Google\ApiCore\Serializer; use Google\Auth\FetchAuthTokenInterface; use Google\Cloud\Core\ClientTrait; +use Google\Cloud\Core\GrpcTrait; use Google\Cloud\Core\Int64; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Connection\Grpc; use Google\Cloud\Datastore\Connection\Rest; @@ -91,9 +94,13 @@ class DatastoreClient { use ArrayTrait; + // TODO: + // [START] Replace ClientTrait with DetectProjectIdTrait use ClientTrait; + // [END] Replace ClientTrait with DetectProjectIdTrait use ClientOptionsTrait; use DatastoreTrait; + use GrpcTrait; const VERSION = '1.28.0'; @@ -103,6 +110,18 @@ class DatastoreClient DatastoreGapicClient::class ]; + /** + * @var RequestHandler + * @internal + * The request handler responsible for sending requests and serializing responses into relevant classes. + */ + private $requestHandler; + + /** + * @var Serializer + */ + private Serializer $serializer; + /** * @deprecated * @var ConnectionInterface @@ -164,7 +183,10 @@ public function __construct(array $config = []) { $emulatorHost = getenv('DATASTORE_EMULATOR_HOST'); + // TODO: + // [START] remove once upgraded to V2 $connectionType = $this->getConnectionType($config); + // [END] remove once upgraded to V2 $config += [ 'namespaceId' => null, @@ -188,10 +210,38 @@ public function __construct(array $config = []) $config['universeDomain'], ); + $this->projectId = $this->detectProjectId($config); + + // TODO: + // [START] remove once upgraded to V2 $config = $this->configureAuthentication($config); $this->connection = $connectionType === 'grpc' ? new Grpc($config) : new Rest($config); + // [END] remove once upgraded to V2 + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + + $this->requestHandler = new RequestHandler( + $this->serializer, + self::GAPIC_KEYS, + $config + ); // The second parameter here should change to a variable // when gRPC support is added for variable encoding. From f39189f126490865f22b10183ba23e0b6cd4108e Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:11:20 +0000 Subject: [PATCH 05/31] Update Resource classes to add serializer and requesthandler in their constructor. --- Datastore/src/DatastoreClient.php | 3 ++- Datastore/src/Operation.php | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index bcc5591f3e44..c33436579133 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -113,7 +113,8 @@ class DatastoreClient /** * @var RequestHandler * @internal - * The request handler responsible for sending requests and serializing responses into relevant classes. + * The request handler responsible for sending requests and + * serializing responses into relevant classes. */ private $requestHandler; diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 2b68f566ce8d..ed356727ec8c 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Timestamp; use Google\Cloud\Core\TimestampTrait; use Google\Cloud\Core\ValidateTrait; @@ -40,6 +43,7 @@ */ class Operation { + use ApiHelperTrait; use DatastoreTrait; use ValidateTrait; use TimestampTrait; @@ -50,6 +54,19 @@ class Operation */ protected $connection; + /** + * @var RequestHandler + * @internal + * The request handler responsible for sending requests and + * serializing responses into relevant classes. + */ + private RequestHandler $requestHandler; + + /** + * @var Serializer + */ + private Serializer $serializer; + /** * @var string */ @@ -76,6 +93,9 @@ class Operation * @param ConnectionInterface $connection A connection to Google Cloud Platform's Datastore API. * This object is created by DatastoreClient, * and should not be instantiated outside of this client. + * @param RequestHandler $requestHandler The request handler responsible for sending + * requests and serializing responses into relevant classes. + * @param Serializer $serializer The serializer instance to encode/decode messages. * @param string $projectId The Google Cloud Platform project ID. * @param string $namespaceId The namespace to use for all service requests. * @param EntityMapper $entityMapper A Datastore Entity Mapper instance. @@ -83,6 +103,8 @@ class Operation */ public function __construct( ConnectionInterface $connection, + RequestHandler $requestHandler, + Serializer $serializer, $projectId, $namespaceId, EntityMapper $entityMapper, @@ -93,6 +115,8 @@ public function __construct( $this->namespaceId = $namespaceId; $this->databaseId = $databaseId; $this->entityMapper = $entityMapper; + $this->requestHandler = $requestHandler; + $this->serializer = $serializer; } /** From be2533c5dd2b102c9e40da10e6c4154db08c3df8 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 26 Mar 2024 17:28:37 +0000 Subject: [PATCH 06/31] Update snippet and unit tests to add request handler and serializer. --- .../DatastoreOperationRefreshTrait.php | 24 ++++++- Datastore/src/DatastoreClient.php | 4 +- Datastore/src/Operation.php | 2 +- .../tests/Snippet/DatastoreClientTest.php | 36 ++++++----- .../Snippet/DatastoreSessionHandlerTest.php | 7 ++- Datastore/tests/Snippet/EntityTest.php | 27 ++++++++ .../Snippet/Query/AggregationQueryTest.php | 26 ++++++++ .../tests/Snippet/Query/GqlQueryTest.php | 25 ++++++++ Datastore/tests/Snippet/Query/QueryTest.php | 25 ++++++++ .../tests/Snippet/ReadOnlyTransactionTest.php | 39 ++++++++++-- Datastore/tests/Snippet/TransactionTest.php | 51 +++++++++++---- Datastore/tests/Unit/DatastoreClientTest.php | 62 +++++++++++++------ Datastore/tests/Unit/OperationTest.php | 25 ++++++++ Datastore/tests/Unit/TransactionTest.php | 57 ++++++++++++----- 14 files changed, 337 insertions(+), 73 deletions(-) diff --git a/Core/src/Testing/DatastoreOperationRefreshTrait.php b/Core/src/Testing/DatastoreOperationRefreshTrait.php index d3e65d35d5fc..bc9e943bdb2c 100644 --- a/Core/src/Testing/DatastoreOperationRefreshTrait.php +++ b/Core/src/Testing/DatastoreOperationRefreshTrait.php @@ -17,6 +17,8 @@ namespace Google\Cloud\Core\Testing; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Operation; @@ -34,6 +36,7 @@ trait DatastoreOperationRefreshTrait * * @param mixed $stub * @param ConnectionInterface $connection + * @param RequestHandler $requestHandler * @param array $options { * Configuration Options * @@ -43,7 +46,7 @@ trait DatastoreOperationRefreshTrait * } * @return mixed */ - public function refreshOperation($stub, ConnectionInterface $connection, array $options = []) + public function refreshOperation($stub, ConnectionInterface $connection, RequestHandler $requestHandler, array $options = []) { $options += [ 'projectId' => null, @@ -57,8 +60,27 @@ public function refreshOperation($stub, ConnectionInterface $connection, array $ $options['returnInt64AsObject'] ); + $serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + $stub->___setProperty('operation', new Operation( $connection, + $requestHandler, + $serializer, $options['projectId'], $options['returnInt64AsObject'], $mapper diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index c33436579133..da3e106d5d5a 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -116,7 +116,7 @@ class DatastoreClient * The request handler responsible for sending requests and * serializing responses into relevant classes. */ - private $requestHandler; + protected $requestHandler; /** * @var Serializer @@ -254,6 +254,8 @@ public function __construct(array $config = []) ); $this->operation = new Operation( $this->connection, + $this->requestHandler, + $this->serializer, $this->projectId, $config['namespaceId'], $this->entityMapper, diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index ed356727ec8c..6daa367f005d 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -60,7 +60,7 @@ class Operation * The request handler responsible for sending requests and * serializing responses into relevant classes. */ - private RequestHandler $requestHandler; + protected RequestHandler $requestHandler; /** * @var Serializer diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 197487d5923f..ce010f2ca8a4 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -18,6 +18,7 @@ namespace Google\Cloud\Datastore\Tests\Snippet; use Google\Cloud\Core\Int64; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -52,6 +53,7 @@ class DatastoreClientTest extends SnippetTestCase private $operation; private $client; private $key; + private $requestHandler; public function setUp(): void { @@ -65,6 +67,8 @@ public function setUp(): void ] ] ]); + + $this->requestHandler = $this->prophesize(RequestHandler::class); } public function testClass() @@ -313,7 +317,7 @@ public function testAllocateId() $snippet->addLocal('datastore', $this->client); $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -330,7 +334,7 @@ public function testAllocateIdsBatch() $snippet->addLocal('datastore', $this->client); $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -353,7 +357,7 @@ public function testTransaction() 'transaction' => 'foo' ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -370,7 +374,7 @@ public function testReadOnlyTransaction() ->willReturn([ 'transaction' => 'foo' ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); $res = $snippet->invoke('transaction'); @@ -398,7 +402,7 @@ public function testInsert() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -419,7 +423,7 @@ public function testInsertBatch() $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -446,7 +450,7 @@ public function testUpdate() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -466,7 +470,7 @@ public function testUpdateBatch() return array_keys($args['mutations'][0])[0] === 'update'; }))->shouldBeCalled(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -488,7 +492,7 @@ public function testUpsert() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -504,7 +508,7 @@ public function testUpsertBatch() return array_keys($args['mutations'][0])[0] === 'upsert'; }))->shouldBeCalled(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -526,7 +530,7 @@ public function testDelete() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -542,7 +546,7 @@ public function testDeleteBatch() return array_keys($args['mutations'][0])[0] === 'delete'; }))->shouldBeCalled(); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -575,7 +579,7 @@ public function testLookup() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -629,7 +633,7 @@ public function testLookupBatch() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -708,7 +712,7 @@ public function testRunQuery() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -747,7 +751,7 @@ public function testRunAggregationQuery() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php index 336c41d45778..8e09b3fe00ae 100644 --- a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php +++ b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php @@ -17,6 +17,7 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -40,6 +41,7 @@ class DatastoreSessionHandlerTest extends SnippetTestCase private $connection; private $client; + private $requestHandler; public static function setUpBeforeClass(): void { @@ -59,6 +61,7 @@ public function setUp(): void $this->client = TestHelpers::stub(DatastoreClient::class, [], [ 'operation', ]); + $this->requestHandler = $this->prophesize(RequestHandler::class); } public function testClass() @@ -96,7 +99,7 @@ public function testClass() }) ))->shouldBeCalled()->willReturn([]); - $this->refreshOperation($this->client, $this->connection->reveal()); + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal()); $snippet->addLocal('datastore', $this->client); $res = $snippet->invoke(); @@ -134,7 +137,7 @@ public function testClassErrorHandler() trigger_error('oops!', E_USER_WARNING); }); - $this->refreshOperation($this->client, $this->connection->reveal()); + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal()); $snippet->addLocal('datastore', $this->client); $res = $snippet->invoke(); diff --git a/Datastore/tests/Snippet/EntityTest.php b/Datastore/tests/Snippet/EntityTest.php index c01d4b0a1203..f2e084eafaba 100644 --- a/Datastore/tests/Snippet/EntityTest.php +++ b/Datastore/tests/Snippet/EntityTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -34,10 +37,13 @@ class EntityTest extends SnippetTestCase { use ProphecyTrait; + use ApiHelperTrait; private $options; private $entity; private $key; + private $serializer; + private $requestHandler; public function setUp(): void { @@ -56,6 +62,25 @@ public function setUp(): void ]); $this->entity = new Entity($this->key, [], $this->options); + + $this->requestHandler = $this->prophesize(RequestHandler::class); + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); } public function testClass() @@ -102,6 +127,8 @@ public function testClassEntityType() $operation = new Operation( $connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, 'example_project', 'foo', new EntityMapper('example_project', false, false) diff --git a/Datastore/tests/Snippet/Query/AggregationQueryTest.php b/Datastore/tests/Snippet/Query/AggregationQueryTest.php index 83dd92a87d1c..78568ba149fc 100644 --- a/Datastore/tests/Snippet/Query/AggregationQueryTest.php +++ b/Datastore/tests/Snippet/Query/AggregationQueryTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet\Query; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -34,18 +37,41 @@ class AggregationQueryTest extends SnippetTestCase { use ProphecyTrait; + use ApiHelperTrait; private $datastore; private $connection; private $operation; + private $requestHandler; + private $serializer; public function setUp(): void { $mapper = new EntityMapper('my-awesome-project', true, false); $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + $this->operation = TestHelpers::stub(Operation::class, [ $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, 'my-awesome-project', '', $mapper diff --git a/Datastore/tests/Snippet/Query/GqlQueryTest.php b/Datastore/tests/Snippet/Query/GqlQueryTest.php index b04a152c3618..6fa69b2a2c66 100644 --- a/Datastore/tests/Snippet/Query/GqlQueryTest.php +++ b/Datastore/tests/Snippet/Query/GqlQueryTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet\Query; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\Snippet\Parser\Snippet; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -35,17 +38,39 @@ class GqlQueryTest extends SnippetTestCase { use ProphecyTrait; + use ApiHelperTrait; private $datastore; private $connection; private $operation; + private $requestHandler; + private $serializer; public function setUp(): void { $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); $this->operation = TestHelpers::stub(Operation::class, [ $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, 'my-awesome-project', '', new EntityMapper('my-awesome-project', true, false) diff --git a/Datastore/tests/Snippet/Query/QueryTest.php b/Datastore/tests/Snippet/Query/QueryTest.php index 8c6c5bb7af62..e4da47712f53 100644 --- a/Datastore/tests/Snippet/Query/QueryTest.php +++ b/Datastore/tests/Snippet/Query/QueryTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet\Query; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -36,11 +39,14 @@ class QueryTest extends SnippetTestCase { use ProphecyTrait; + use ApiHelperTrait; private $datastore; private $connection; private $operation; private $query; + private $requestHandler; + private $serializer; public function setUp(): void { @@ -48,8 +54,27 @@ public function setUp(): void $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); $this->operation = TestHelpers::stub(Operation::class, [ $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, 'my-awesome-project', '', $mapper diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index a9edf0b3aac2..022a49225b6d 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -38,6 +41,7 @@ class ReadOnlyTransactionTest extends SnippetTestCase { use DatastoreOperationRefreshTrait; use ProphecyTrait; + use ApiHelperTrait; const PROJECT = 'my-awesome-project'; const TRANSACTION = 'transaction-id'; @@ -46,13 +50,36 @@ class ReadOnlyTransactionTest extends SnippetTestCase private $transaction; private $client; private $key; + private $serializer; + private $requestHandler; public function setUp(): void { $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + $operation = new Operation( $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, self::PROJECT, '', new EntityMapper(self::PROJECT, false, false) @@ -83,7 +110,7 @@ public function testClass() 'transaction' => 'foo' ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -110,7 +137,7 @@ public function testClassRollback() $snippet = $this->snippetFromClass(ReadOnlyTransaction::class, 1); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -149,7 +176,7 @@ public function testLookup() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -198,7 +225,7 @@ public function testLookupBatch() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -241,7 +268,7 @@ public function testRunQuery() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -257,7 +284,7 @@ public function testRollback() $this->connection->rollback(Argument::any()) ->shouldBeCalled(); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index 02c8137c488d..bc14c638611d 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -38,6 +41,7 @@ class TransactionTest extends SnippetTestCase { use DatastoreOperationRefreshTrait; use ProphecyTrait; + use ApiHelperTrait; const PROJECT = 'my-awesome-project'; const TRANSACTION = 'transaction-id'; @@ -47,13 +51,36 @@ class TransactionTest extends SnippetTestCase private $transaction; private $client; private $key; + private $serializer; + private $requestHandler; public function setUp(): void { $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + $operation = new Operation( $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, self::PROJECT, '', new EntityMapper(self::PROJECT, false, false) @@ -84,7 +111,7 @@ public function testClass() 'transaction' => 'foo' ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -113,7 +140,7 @@ public function testInsert() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -139,7 +166,7 @@ public function testInsertBatch() $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -166,7 +193,7 @@ public function testUpdate() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -215,7 +242,7 @@ public function testUpsert() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -262,7 +289,7 @@ public function testDelete() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -312,7 +339,7 @@ public function testLookup() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -361,7 +388,7 @@ public function testLookupBatch() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -404,7 +431,7 @@ public function testRunQuery() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -437,7 +464,7 @@ public function testRunAggregationQuery() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -453,7 +480,7 @@ public function testCommit() $this->connection->commit(Argument::any()) ->shouldBeCalled(); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -468,7 +495,7 @@ public function testRollback() $this->connection->rollback(Argument::any()) ->shouldBeCalled(); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index d0dc09156c86..3a2898eb4fe1 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -17,7 +17,10 @@ namespace Google\Cloud\Datastore\Tests\Unit; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\Int64; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\GrpcTestTrait; use Google\Cloud\Core\Testing\TestHelpers; @@ -51,12 +54,15 @@ class DatastoreClientTest extends TestCase use DatastoreOperationRefreshTrait; use GrpcTestTrait; use ProphecyTrait; + use ApiHelperTrait; const PROJECT = 'example-project'; const TRANSACTION = 'transaction-id'; private $connection; private $client; + private $requestHandler; + private $serializer; public function setUp(): void { @@ -66,6 +72,24 @@ public function setUp(): void ], [ 'operation' ]); + $this->requestHandler = $this->prophesize(RequestHandler::class); + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); } public function testGrpcConnection() @@ -199,7 +223,7 @@ public function testAllocateId($method, $batch = false) ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -243,7 +267,7 @@ public function testTransaction($method, $type, $key) 'transaction' => self::TRANSACTION ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -272,7 +296,7 @@ public function testTransactionWithOptions($method, $type, $key) ->shouldBeCalled() ->willReturn([]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -301,7 +325,7 @@ public function testEntityMutations($method, $mutation, $key) Argument::withEntry('mutations', [[$method => $mutation]]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -322,7 +346,7 @@ public function testEntityMutationsBatch($method, $mutation, $key) Argument::withEntry('mutations', [[$method => $mutation]]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -360,7 +384,7 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -389,7 +413,7 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -420,7 +444,7 @@ public function testSingleMutationConflict() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -442,7 +466,7 @@ public function testDelete() ]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -465,7 +489,7 @@ public function testDeleteBatch() ]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -488,7 +512,7 @@ public function testLookup() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -512,7 +536,7 @@ public function testLookupMissing() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -543,7 +567,7 @@ public function testLookupBatch() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -569,7 +593,7 @@ public function testLookupBatchWithReadTime() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -593,7 +617,7 @@ public function testLookupWithReadTime() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -634,7 +658,7 @@ public function testRunQuery() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -664,7 +688,7 @@ public function testRunAggregationQuery() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -700,7 +724,7 @@ public function testAggregationQueryWithDifferentReturnTypes($response, $expecte ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -735,7 +759,7 @@ public function testRunQueryWithReadTime() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), [ + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 308f06a9c840..7765e1238077 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Unit; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Entity; @@ -39,6 +42,7 @@ class OperationTest extends TestCase { use ProphecyTrait; + use ApiHelperTrait; const PROJECT = 'example-project'; const NAMESPACEID = 'namespace-id'; @@ -46,12 +50,33 @@ class OperationTest extends TestCase private $operation; private $connection; + private $requestHandler; + private $serializer; public function setUp(): void { $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); $this->operation = TestHelpers::stub(Operation::class, [ $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, self::PROJECT, null, new EntityMapper('foo', true, false), diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index 382dcfc0f454..68f4ee37f3ed 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -17,6 +17,9 @@ namespace Google\Cloud\Datastore\Tests\Unit; +use Google\ApiCore\Serializer; +use Google\Cloud\Core\ApiHelperTrait; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Core\Timestamp; @@ -45,6 +48,7 @@ class TransactionTest extends TestCase { use DatastoreOperationRefreshTrait; use ProphecyTrait; + use ApiHelperTrait; const PROJECT = 'example-project'; const TRANSACTION = 'transaction-id'; @@ -54,13 +58,36 @@ class TransactionTest extends TestCase private $readOnly; private $key; private $entity; + private $serializer; + private $requestHandler; public function setUp(): void { $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); + + $this->serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + $op = new Operation( $this->connection->reveal(), + $this->requestHandler->reveal(), + $this->serializer, self::PROJECT, null, new EntityMapper(self::PROJECT, false, false) @@ -95,7 +122,7 @@ public function testLookup(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -120,7 +147,7 @@ public function testLookupWithReadTime() ]); $transaction = $this->readOnly; - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -144,7 +171,7 @@ public function testLookupMissing(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -176,7 +203,7 @@ public function testLookupBatch(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -203,7 +230,7 @@ public function testLookupBatchWithReadTime(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -229,7 +256,7 @@ public function testRunQuery(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -263,7 +290,7 @@ public function testRunAggregationQuery(callable $transaction) ]); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -296,7 +323,7 @@ public function testRunQueryWithReadTime() ]); $transaction = $this->readOnly; - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -317,7 +344,7 @@ public function testRollback(callable $transaction) ->shouldBeCalled(); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), [ + $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -335,7 +362,7 @@ public function testEntityMutations($method, $mutation, $key) Argument::withEntry('mutations', [[$method => $mutation]]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -356,7 +383,7 @@ public function testEntityMutationsBatch($method, $mutation, $key) Argument::withEntry('mutations', [[$method => $mutation]]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -394,7 +421,7 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -426,7 +453,7 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -458,7 +485,7 @@ public function testDelete() ]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -481,7 +508,7 @@ public function testDeleteBatch() ]) ))->shouldBeCalled()->willReturn($this->commitResponse()); - $this->refreshOperation($this->transaction, $this->connection->reveal(), [ + $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); From d06abf7abcfe6b71e292fbf1122c3698ce05cc34 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Sun, 31 Mar 2024 18:44:58 +0000 Subject: [PATCH 07/31] Update beginTransaction and allocateIds rpc + unit + snippet tests --- .../DatastoreOperationRefreshTrait.php | 70 +++++++++++++++ Datastore/src/Operation.php | 42 ++++++++- .../tests/Snippet/DatastoreClientTest.php | 62 +++++++------ .../Snippet/DatastoreSessionHandlerTest.php | 33 ++++--- .../tests/Snippet/ReadOnlyTransactionTest.php | 22 ++--- Datastore/tests/Snippet/TransactionTest.php | 52 +++++------ Datastore/tests/Unit/DatastoreClientTest.php | 86 ++++++++----------- Datastore/tests/Unit/OperationTest.php | 64 +++++++------- Datastore/tests/Unit/TransactionTest.php | 24 +++--- 9 files changed, 279 insertions(+), 176 deletions(-) diff --git a/Core/src/Testing/DatastoreOperationRefreshTrait.php b/Core/src/Testing/DatastoreOperationRefreshTrait.php index bc9e943bdb2c..dc0035a52d7b 100644 --- a/Core/src/Testing/DatastoreOperationRefreshTrait.php +++ b/Core/src/Testing/DatastoreOperationRefreshTrait.php @@ -22,6 +22,8 @@ use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Operation; +use Google\Cloud\Datastore\V1\Client\DatastoreClient; +use Prophecy\Argument; /** * Refresh Datastore operation class @@ -88,4 +90,72 @@ public function refreshOperation($stub, ConnectionInterface $connection, Request return $stub; } + + /** + * Helper method for Unit and Snippet test classes. This mocks the + * $requestHandler class property present in the Test Class with + * given arguments. + * + * @param string $methodName The method name to mock in RequestHandler::sendRequest + * @param array $params The parameters to look for in the + * array equivalent of rpc request. + * @param mixed $returnValue The value to be returned by sendRequest mock. + * @param null|int $shouldBeCalledTimes Adds a shouldBeCalled prophecy. Defaults to `null`, implying nothing is added. + * [ + * `0` => `shouldBeCalled`, + * Non zero positive integer $x => `shouldBeCalledTimes($x)` + * ] + */ + private function mockSendRequest($methodName, $params, $returnValue, $shouldBeCalledTimes = null) + { + if (isset($this->serializer)) { + $serializer = $this->serializer; + } else { + $serializer = new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + } + + $prophecy = $this->requestHandler->sendRequest( + DatastoreClient::class, + $methodName, + Argument::that(function ($arg) use ($methodName, $params, $serializer) { + $requestName = ucfirst($methodName . 'Request'); + $x = explode('\\', get_class($arg)); + $argName = end($x); + + if ($requestName != $argName) { + return false; + } + $data = $serializer->encodeMessage($arg); + // $z = array_replace_recursive($data, $params) == $data; + return array_replace_recursive($data, $params) == $data; + // return array_merge($params, $data) == $data; + }), + Argument::cetera() + ); + + if (!is_null($shouldBeCalledTimes)) { + if ($shouldBeCalledTimes == 0) { + $prophecy->shouldBeCalled(); + } else { + $prophecy->shouldBeCalledTimes($shouldBeCalledTimes); + } + } + + $prophecy->willReturn($returnValue); + } } diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 6daa367f005d..a3ae3a5285a9 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -28,7 +28,11 @@ use Google\Cloud\Datastore\Query\AggregationQueryResult; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; +use Google\Cloud\Datastore\V1\AllocateIdsRequest; +use Google\Cloud\Datastore\V1\BeginTransactionRequest; +use Google\Cloud\Datastore\V1\Client\DatastoreClient; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; +use Google\Cloud\Datastore\V1\TransactionOptions; /** * Run lookups and queries and commit changes. @@ -304,11 +308,30 @@ public function beginTransaction($transactionOptions, array $options = []) $transactionOptions['readOnly'] ); } - $res = $this->connection->beginTransaction($options + [ + + array_walk($transactionOptions, function (&$item) { + if ($item instanceof \stdClass) { + $item = []; + } + }); + + list($data, $optionalArgs) = $this->splitOptionalArgs($options); + + $data += [ 'projectId' => $this->projectId, 'databaseId' => $this->databaseId, 'transactionOptions' => $transactionOptions, - ]); + ]; + + $data = $this->convertDataToProtos($data, ['transactionOptions' => TransactionOptions::class]); + $request = $this->serializer->decodeMessage(new BeginTransactionRequest(), $data); + + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'beginTransaction', + $request, + $optionalArgs + ); return $res['transaction']; } @@ -349,11 +372,22 @@ public function allocateIds(array $keys, array $options = []) $serviceKeys[] = $key->keyObject(); } - $res = $this->connection->allocateIds($options + [ + list($data, $optionalArgs) = $this->splitOptionalArgs($options); + + $data += [ 'projectId' => $this->projectId, 'databaseId' => $this->databaseId, 'keys' => $serviceKeys, - ]); + ]; + + $request = $this->serializer->decodeMessage(new AllocateIdsRequest(), $data); + + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'allocateIds', + $request, + $optionalArgs + ); if (isset($res['keys'])) { foreach ($res['keys'] as $index => $key) { diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index ce010f2ca8a4..9e61b90fc4ad 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -17,6 +17,7 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\Int64; use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; @@ -36,6 +37,7 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\ReadOnlyTransaction; use Google\Cloud\Datastore\Transaction; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -44,6 +46,7 @@ */ class DatastoreClientTest extends SnippetTestCase { + use ApiHelperTrait; use DatastoreOperationRefreshTrait; use ProphecyTrait; @@ -58,6 +61,7 @@ class DatastoreClientTest extends SnippetTestCase public function setUp(): void { $this->connection = $this->prophesize(ConnectionInterface::class); + $this->client = TestHelpers::stub(DatastoreClient::class, [], ['operation']); $this->key = new Key('my-awesome-project', [ @@ -351,11 +355,11 @@ public function testTransaction() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'transaction'); $snippet->addLocal('datastore', $this->client); - $this->connection->beginTransaction($this->validateTransactionOptions('readWrite')) - ->shouldBeCalled() - ->willReturn([ - 'transaction' => 'foo' - ]); + $this->mockSendRequest( + 'beginTransaction', + ['transactionOptions' => ['readWrite' => []]], + ['transaction' => 'foo'] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -369,11 +373,11 @@ public function testReadOnlyTransaction() { $snippet = $this->snippetFromMethod(DatastoreClient::class, 'readOnlyTransaction'); $snippet->addLocal('datastore', $this->client); - $this->connection->beginTransaction($this->validateTransactionOptions('readOnly')) - ->shouldBeCalled() - ->willReturn([ - 'transaction' => 'foo' - ]); + $this->mockSendRequest( + 'beginTransaction', + ['transactionOptions' => ['readOnly' => []]], + ['transaction' => 'foo'] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -770,28 +774,30 @@ public function testRunAggregationQuery() private function allocateIdsConnectionMock() { - $this->connection->allocateIds(Argument::any()) - ->shouldBeCalled() - ->willReturn([ - 'keys' => [ - [ - 'path' => [ - [ - 'kind' => 'Person', - 'id' => '4682475895' - ] + $this->requestHandler->sendRequest( + DatastoreGapicClient::class, + 'allocateIds', + Argument::cetera() + )->shouldBeCalled()->willReturn([ + 'keys' => [ + [ + 'path' => [ + [ + 'kind' => 'Person', + 'id' => '4682475895' ] - ], - [ - 'path' => [ - [ - 'kind' => 'Person', - 'id' => '4682475896' - ] + ] + ], + [ + 'path' => [ + [ + 'kind' => 'Person', + 'id' => '4682475896' ] ] ] - ]); + ] + ]); } private function validateTransactionOptions($type, array $options = []) diff --git a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php index 8e09b3fe00ae..ada15639d968 100644 --- a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php +++ b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php @@ -17,6 +17,7 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; @@ -36,8 +37,10 @@ class DatastoreSessionHandlerTest extends SnippetTestCase { use DatastoreOperationRefreshTrait; use ProphecyTrait; + use ApiHelperTrait; const TRANSACTION = 'transaction-id'; + const PROJECT = 'example-project'; private $connection; private $client; @@ -78,12 +81,11 @@ public function testClass() }) ))->shouldBeCalled()->willReturn([]); - $this->connection->beginTransaction(Argument::withEntry( - 'transactionOptions', - ['readWrite' => (object) []] - ))->shouldBeCalled()->willReturn([ - 'transaction' => self::TRANSACTION, - ]); + $this->mockSendRequest( + 'beginTransaction', + ['transactionOptions' => ['readWrite' => []]], + ['transaction' => self::TRANSACTION] + ); $this->connection->commit(Argument::allOf( Argument::withEntry('transaction', self::TRANSACTION), @@ -99,7 +101,9 @@ public function testClass() }) ))->shouldBeCalled()->willReturn([]); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal()); + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + 'projectId' => self::PROJECT + ]); $snippet->addLocal('datastore', $this->client); $res = $snippet->invoke(); @@ -124,12 +128,11 @@ public function testClassErrorHandler() }) ))->shouldBeCalled()->willReturn([]); - $this->connection->beginTransaction(Argument::withEntry( - 'transactionOptions', - ['readWrite' => (object) []] - ))->shouldBeCalled()->willReturn([ - 'transaction' => self::TRANSACTION, - ]); + $this->mockSendRequest( + 'beginTransaction', + ['transactionOptions' => ['readWrite' => []]], + ['transaction' => self::TRANSACTION] + ); $this->connection->commit(Argument::any()) ->shouldBeCalled() @@ -137,7 +140,9 @@ public function testClassErrorHandler() trigger_error('oops!', E_USER_WARNING); }); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal()); + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + 'projectId' => self::PROJECT + ]); $snippet->addLocal('datastore', $this->client); $res = $snippet->invoke(); diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index 022a49225b6d..b4bd041eae12 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -104,11 +104,12 @@ public function setUp(): void public function testClass() { - $this->connection->beginTransaction(Argument::any()) - ->shouldBeCalled() - ->willReturn([ - 'transaction' => 'foo' - ]); + $this->mockSendRequest( + 'beginTransaction', + [], + ['transaction' => 'foo'], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -124,11 +125,12 @@ public function testClass() public function testClassRollback() { - $this->connection->beginTransaction(Argument::any()) - ->shouldBeCalled() - ->willReturn([ - 'transaction' => 'foo' - ]); + $this->mockSendRequest( + 'beginTransaction', + [], + ['transaction' => 'foo'], + 0 + ); $this->connection->lookup(Argument::any()) ->shouldBeCalled() ->willReturn([]); diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index bc14c638611d..3f00669260a5 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -31,6 +31,7 @@ use Google\Cloud\Datastore\Query\AggregationQuery; use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\Transaction; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -105,11 +106,12 @@ public function setUp(): void public function testClass() { - $this->connection->beginTransaction(Argument::any()) - ->shouldBeCalled() - ->willReturn([ - 'transaction' => 'foo' - ]); + $this->mockSendRequest( + 'beginTransaction', + [], + ['transaction' => 'foo'], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -506,29 +508,31 @@ public function testRollback() private function allocateIdsConnectionMock() { - $this->connection->allocateIds(Argument::any()) - ->shouldBeCalled() - ->willReturn([ - 'keys' => [ - [ - 'path' => [ - [ - 'kind' => 'Person', - 'id' => '4682475895' - ] + $this->requestHandler->sendRequest( + DatastoreGapicClient::class, + 'allocateIds', + Argument::cetera() + )->shouldBeCalled()->willReturn([ + 'keys' => [ + [ + 'path' => [ + [ + 'kind' => 'Person', + 'id' => '4682475895' ] - ], - [ - 'path' => [ - [ - 'kind' => 'Person', - 'id' => '4682475896' - ] + ] + ], + [ + 'path' => [ + [ + 'kind' => 'Person', + 'id' => '4682475896' ] ] ] - ]); + ] + ]); - return $this->connection->reveal(); + return $this->requestHandler->reveal(); } } diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index 3a2898eb4fe1..eb3d55bc3786 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -215,13 +215,12 @@ public function testAllocateId($method, $batch = false) $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::withEntry('keys', [ - $key->keyObject() - ]))->shouldBeCalled()->willReturn([ - 'keys' => [ - $keyWithId->keyObject() - ] - ]); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -249,23 +248,14 @@ public function allocateIdProvider() */ public function testTransaction($method, $type, $key) { - $this->connection->beginTransaction(Argument::allOf( - Argument::withEntry('projectId', self::PROJECT), - // can't do direct comparisons between (object)[]. - Argument::that(function ($arg) use ($key) { - if (!($arg['transactionOptions'][$key] instanceof \stdClass)) { - return false; - } - - if ((array) $arg['transactionOptions'][$key]) { - return false; - } - - return true; - }) - ))->shouldBeCalled()->willReturn([ - 'transaction' => self::TRANSACTION - ]); + $this->mockSendRequest( + 'beginTransaction', + [ + 'projectId' => self::PROJECT, + 'transactionOptions' => ['readTime' => []] + ], + ['transaction' => self::TRANSACTION] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -280,16 +270,14 @@ public function testTransaction($method, $type, $key) */ public function testTransactionWithOptions($method, $type, $key) { - $options = ['foo' => 'bar']; - - $this->connection->beginTransaction(Argument::allOf( - Argument::withEntry('projectId', self::PROJECT), - Argument::withEntry('transactionOptions', [ - $key => $options - ]) - ))->shouldBeCalled()->willReturn([ - 'transaction' => self::TRANSACTION - ]); + $this->mockSendRequest( + 'beginTransaction', + [ + 'projectId' => self::PROJECT, + 'transactionOptions' => [$key => []] + ], + ['transaction' => self::TRANSACTION] + ); // Make sure the correct transaction ID was injected. $this->connection->runQuery(Argument::withEntry('transaction', self::TRANSACTION)) @@ -300,7 +288,7 @@ public function testTransactionWithOptions($method, $type, $key) 'projectId' => self::PROJECT ]); - $res = $this->client->$method(['transactionOptions' => $options]); + $res = $this->client->$method(['transactionOptions' => []]); $this->assertInstanceOf($type, $res); iterator_to_array($res->runQuery($this->client->gqlQuery('SELECT 1=1'))); @@ -376,13 +364,11 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::allOf( - Argument::withEntry('keys', [$key->keyObject()]) - ))->shouldBeCalled()->willReturn([ - 'keys' => [ - $keyWithId->keyObject() - ] - ]); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -405,13 +391,11 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::allOf( - Argument::withEntry('keys', [$key->keyObject()]) - ))->shouldBeCalled()->willReturn([ - 'keys' => [ - $keyWithId->keyObject() - ] - ]); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -684,7 +668,7 @@ public function testRunAggregationQuery() 'aggregateProperties' => ['property_1' => 1] ] ], - 'readTime' => (new \DateTime)->format('Y-m-d\TH:i:s') .'.000001Z' + 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' ] ]); @@ -720,7 +704,7 @@ public function testAggregationQueryWithDifferentReturnTypes($response, $expecte 'aggregateProperties' => ['property_1' => $response] ] ], - 'readTime' => (new \DateTime)->format('Y-m-d\TH:i:s') .'.000001Z' + 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' ] ]); diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 7765e1238077..9782dcc59af5 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -20,6 +20,7 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; +use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Entity; @@ -43,10 +44,11 @@ class OperationTest extends TestCase { use ProphecyTrait; use ApiHelperTrait; + use DatastoreOperationRefreshTrait; - const PROJECT = 'example-project'; - const NAMESPACEID = 'namespace-id'; - const DATABASEID = 'database-id'; + public const PROJECT = 'example-project'; + public const NAMESPACEID = 'namespace-id'; + public const DATABASEID = 'database-id'; private $operation; private $connection; @@ -81,7 +83,7 @@ public function setUp(): void null, new EntityMapper('foo', true, false), self::DATABASEID, - ], ['connection', 'namespaceId']); + ], ['connection', 'requestHandler', 'namespaceId']); } public function testKey() @@ -251,15 +253,14 @@ public function testAllocateIds() $id = 12345; $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::withEntry('keys', [$key->keyObject()])) - ->shouldBeCalled() - ->willReturn([ - 'keys' => [ - $keyWithId->keyObject(), - ], - ]); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); + + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->allocateIds([$key]); @@ -724,15 +725,14 @@ public function testAllocateIdsToEntities() $id = 12345; $keyWithId = clone $partialKey; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::withEntry('keys', [$partialKey->keyObject()])) - ->shouldBeCalled() - ->willReturn([ - 'keys' => [ - $keyWithId->keyObject(), - ], - ]); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$partialKey->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); + + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $entities = [ $this->operation->entity($completeKey), @@ -988,11 +988,11 @@ public function testInvalidBatchType() public function testBeginTransactionWithDatabaseIdOverride() { - $this->connection - ->beginTransaction( - Argument::withEntry('databaseId', 'otherDatabaseId') - ) - ->willReturn(['transaction' => 'valid_test_transaction']); + $this->mockSendRequest( + 'beginTransaction', + ['databaseId' => 'otherDatabaseId'], + ['transaction' => 'valid_test_transaction'] + ); $transactionId = $this->operation->beginTransaction( [], @@ -1004,12 +1004,14 @@ public function testBeginTransactionWithDatabaseIdOverride() public function testAllocateIdsWithDatabaseIdOverride() { - $this->connection - ->allocateIds( - Argument::withEntry('databaseId', 'otherDatabaseId') - ) - ->shouldBeCalledTimes(1) - ->willReturn([]); + $this->mockSendRequest( + 'allocateIds', + ['databaseId' => 'otherDatabaseId'], + [], + 1 + ); + + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->operation->allocateIds( [], diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index 68f4ee37f3ed..fc3a55412df1 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -413,13 +413,11 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::allOf( - Argument::withEntry('keys', [$key->keyObject()]) - ))->shouldBeCalled()->willReturn([ - 'keys' => [ - $keyWithId->keyObject() - ] - ]); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -445,13 +443,11 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); - $this->connection->allocateIds(Argument::allOf( - Argument::withEntry('keys', [$key->keyObject()]) - ))->shouldBeCalled()->willReturn([ - 'keys' => [ - $keyWithId->keyObject() - ] - ]); + $this->mockSendRequest( + 'allocateIds', + ['keys' => [$key->keyObject()]], + ['keys' => [$keyWithId->keyObject()]] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT From cee1539e8bdd218dcca4f281b4f291783476c69a Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Mon, 1 Apr 2024 06:11:27 +0000 Subject: [PATCH 08/31] Update lookup rpc + unit + snippet tests --- .../DatastoreOperationRefreshTrait.php | 2 - Datastore/src/Operation.php | 61 ++++- .../tests/Snippet/DatastoreClientTest.php | 20 +- .../Snippet/DatastoreSessionHandlerTest.php | 48 ++-- .../tests/Snippet/ReadOnlyTransactionTest.php | 29 ++- Datastore/tests/Snippet/TransactionTest.php | 20 +- Datastore/tests/Unit/DatastoreClientTest.php | 118 ++++++---- Datastore/tests/Unit/OperationTest.php | 219 +++++++++++------- Datastore/tests/Unit/TransactionTest.php | 122 ++++++---- 9 files changed, 401 insertions(+), 238 deletions(-) diff --git a/Core/src/Testing/DatastoreOperationRefreshTrait.php b/Core/src/Testing/DatastoreOperationRefreshTrait.php index dc0035a52d7b..dd6793bf5c30 100644 --- a/Core/src/Testing/DatastoreOperationRefreshTrait.php +++ b/Core/src/Testing/DatastoreOperationRefreshTrait.php @@ -141,9 +141,7 @@ private function mockSendRequest($methodName, $params, $returnValue, $shouldBeCa return false; } $data = $serializer->encodeMessage($arg); - // $z = array_replace_recursive($data, $params) == $data; return array_replace_recursive($data, $params) == $data; - // return array_merge($params, $data) == $data; }), Argument::cetera() ); diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index a3ae3a5285a9..80cd0fa30ce1 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -31,6 +31,9 @@ use Google\Cloud\Datastore\V1\AllocateIdsRequest; use Google\Cloud\Datastore\V1\BeginTransactionRequest; use Google\Cloud\Datastore\V1\Client\DatastoreClient; +use Google\Cloud\Datastore\V1\Key\PathElement; +use Google\Cloud\Datastore\V1\LookupRequest; +use Google\Cloud\Datastore\V1\PartitionId; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; use Google\Cloud\Datastore\V1\TransactionOptions; @@ -453,11 +456,22 @@ public function lookup(array $keys, array $options = []) $serviceKeys[] = $key->keyObject(); }); - $res = $this->connection->lookup($options + $this->readOptions($options) + [ + list($data, $optionalArgs) = $this->splitOptionalArgs($options, ['transaction', 'className', 'sort', 'readTime', 'readConsistency']); + $data += $this->readOptions($options) + [ 'projectId' => $this->projectId, 'databaseId' => $this->databaseId, - 'keys' => $serviceKeys, - ]); + 'keys' => $this->keysList($serviceKeys), + ]; + + $request = $this->serializer->decodeMessage(new LookupRequest(), $data); + $x = $this->serializer->encodeMessage($request); + + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'lookup', + $request, + $optionalArgs + ); $result = []; if (isset($res['found'])) { @@ -929,4 +943,45 @@ private function sortEntities(array $entities, array $keys) return $ret; } + + /** + * Convert a list of keys to a list of {@see Google\Cloud\Datastore\V1\Key}. + * + * @param array[] $keys + * @return Key[] + */ + private function keysList(array $keys) + { + $out = []; + foreach ($keys as $key) { + $local = []; + + if (isset($key['partitionId'])) { + $p = $this->arrayFilterRemoveNull([ + 'project_id' => isset($key['partitionId']['projectId']) + ? $key['partitionId']['projectId'] + : null, + 'namespace_id' => isset($key['partitionId']['namespaceId']) + ? $key['partitionId']['namespaceId'] + : null, + 'database_id' => isset($key['partitionId']['databaseId']) + ? $key['partitionId']['databaseId'] + : null, + ]); + + $local['partition_id'] = new PartitionId($p); + } + + $local['path'] = []; + if (isset($key['path'])) { + foreach ($key['path'] as $element) { + $local['path'][] = new PathElement($element); + } + } + + $out[] = $local; + } + + return $out; + } } diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 9e61b90fc4ad..7939beb36460 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -562,9 +562,10 @@ public function testLookup() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'lookup'); $snippet->addLocal('datastore', $this->client); - $this->connection->lookup(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + [], + [ 'found' => [ [ 'entity' => [ @@ -581,7 +582,8 @@ public function testLookup() ] ] ] - ]); + ] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -602,9 +604,10 @@ public function testLookupBatch() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'lookupBatch'); $snippet->addLocal('datastore', $this->client); - $this->connection->lookup(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + [], + [ 'found' => [ [ 'entity' => [ @@ -635,7 +638,8 @@ public function testLookupBatch() ] ] ] - ]); + ] + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php index ada15639d968..b00886e949c1 100644 --- a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php +++ b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php @@ -72,14 +72,22 @@ public function testClass() $snippet = $this->snippetFromClass(DatastoreSessionHandler::class); $snippet->replace('$datastore = new DatastoreClient();', ''); - $this->connection->lookup(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return $args['keys'][0]['partitionId']['namespaceId'] === 'sessions' - && $args['keys'][0]['path'][0]['kind'] === 'PHPSESSID' - && isset($args['keys'][0]['path'][0]['name']); - }) - ))->shouldBeCalled()->willReturn([]); + $this->mockSendRequest( + 'lookup', + [ + 'keys' => [ + [ + 'partitionId' => ['namespaceId' => 'sessions'], + 'path' => [ + ['kind' => 'PHPSESSID'] + ] + ] + ], + 'readOptions' => ['transaction' => self::TRANSACTION] + ], + [], + 0 + ); $this->mockSendRequest( 'beginTransaction', @@ -119,14 +127,22 @@ public function testClassErrorHandler() $snippet = $this->snippetFromClass(DatastoreSessionHandler::class, 1); $snippet->replace('$datastore = new DatastoreClient();', ''); - $this->connection->lookup(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return $args['keys'][0]['partitionId']['namespaceId'] === 'sessions' - && $args['keys'][0]['path'][0]['kind'] === 'PHPSESSID' - && isset($args['keys'][0]['path'][0]['name']); - }) - ))->shouldBeCalled()->willReturn([]); + $this->mockSendRequest( + 'lookup', + [ + 'keys' => [ + [ + 'partitionId' => ['namespaceId' => 'sessions'], + 'path' => [ + ['kind' => 'PHPSESSID'] + ] + ] + ], + 'readOptions' => ['transaction' => self::TRANSACTION] + ], + [], + 0 + ); $this->mockSendRequest( 'beginTransaction', diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index b4bd041eae12..a6a5e0c458f3 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -131,9 +131,12 @@ public function testClassRollback() ['transaction' => 'foo'], 0 ); - $this->connection->lookup(Argument::any()) - ->shouldBeCalled() - ->willReturn([]); + $this->mockSendRequest( + 'lookup', + [], + [], + 0 + ); $this->connection->rollback(Argument::any()) ->shouldBeCalled(); @@ -157,9 +160,10 @@ public function testLookup() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->lookup(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'found' => [ [ 'entity' => [ @@ -176,7 +180,8 @@ public function testLookup() ] ] ] - ]); + ] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -192,9 +197,10 @@ public function testLookupBatch() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->lookup(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'found' => [ [ 'entity' => [ @@ -225,7 +231,8 @@ public function testLookupBatch() ] ] ] - ]); + ] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index 3f00669260a5..bdaa68fb709d 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -320,9 +320,10 @@ public function testLookup() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->lookup(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'found' => [ [ 'entity' => [ @@ -339,7 +340,8 @@ public function testLookup() ] ] ] - ]); + ] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -355,9 +357,10 @@ public function testLookupBatch() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->lookup(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'found' => [ [ 'entity' => [ @@ -388,7 +391,8 @@ public function testLookupBatch() ] ] ] - ]); + ] + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index eb3d55bc3786..82170cc6a34a 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -248,11 +248,11 @@ public function allocateIdProvider() */ public function testTransaction($method, $type, $key) { - $this->mockSendRequest( + $this->mockSendRequest( 'beginTransaction', [ 'projectId' => self::PROJECT, - 'transactionOptions' => ['readTime' => []] + 'transactionOptions' => [($method == 'transaction' ? 'readWrite' : 'readOnly') => []] ], ['transaction' => self::TRANSACTION] ); @@ -260,7 +260,6 @@ public function testTransaction($method, $type, $key) $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); - $res = $this->client->$method(); $this->assertInstanceOf($type, $res); } @@ -486,15 +485,18 @@ public function testLookup() { $key = $this->client->key('Person', 'John'); - $this->connection->lookup( - Argument::withEntry('keys', [$key->keyObject()]) - )->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'lookup', + ['keys' => [$key->keyObject()]], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($key) + ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -510,15 +512,18 @@ public function testLookupMissing() { $key = $this->client->key('Person', 'John'); - $this->connection->lookup( - Argument::withEntry('keys', [$key->keyObject()]) - )->shouldBeCalled()->willReturn([ - 'missing' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'lookup', + ['keys' => [$key->keyObject()]], + [ + 'missing' => [ + [ + 'entity' => $this->entityArray($key) + ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -533,23 +538,26 @@ public function testLookupBatch() { $key = $this->client->key('Person', 'John'); - $this->connection->lookup( - Argument::withEntry('keys', [$key->keyObject()]) - )->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($key) - ] - ], - 'missing' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'lookup', + ['keys' => [$key->keyObject()]], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($key) + ] + ], + 'missing' => [ + [ + 'entity' => $this->entityArray($key) + ] + ], + 'deferred' => [ + $key->keyObject() ] ], - 'deferred' => [ - $key->keyObject() - ] - ]); + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -567,15 +575,18 @@ public function testLookupBatchWithReadTime() $key = $this->client->key('Person', 'John'); $time = new Timestamp(new \DateTime()); - $this->connection->lookup( - Argument::withEntry('readTime', $time) - )->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['readTime' => $time]], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($key) + ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -590,16 +601,21 @@ public function testLookupWithReadTime() $key = $this->client->key('Person', 'John'); $time = new Timestamp(new \DateTime()); - $this->connection->lookup(Argument::allOf( - Argument::withEntry('keys', [$key->keyObject()]), - Argument::withEntry('readTime', $time) - ))->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'lookup', + [ + 'keys' => [$key->keyObject()], + 'readOptions' => ['readTime' => $time] + ], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($key) + ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 9782dcc59af5..9de9dae9f782 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -31,6 +31,7 @@ use Google\Cloud\Datastore\Query\GqlQuery; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; +use Google\Cloud\Datastore\V1\LookupRequest; use InvalidArgumentException; use PHPUnit\Framework\TestCase; use Prophecy\Argument; @@ -281,9 +282,12 @@ public function testLookup() { $key = $this->operation->key('foo', 'Bar'); - $this->connection->lookup(Argument::type('array')) - ->shouldBeCalled() - ->willReturn([]); + $this->mockSendRequest( + 'lookup', + [], + [], + 0 + ); $this->operation->___setProperty('connection', $this->connection->reveal()); @@ -295,9 +299,11 @@ public function testLookup() public function testLookupFound() { $body = json_decode(file_get_contents(Fixtures::ENTITY_BATCH_LOOKUP_FIXTURE()), true); - $this->connection->lookup(Argument::any())->willReturn([ - 'found' => $body, - ]); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $body,] + ); $this->operation->___setProperty('connection', $this->connection->reveal()); @@ -317,9 +323,12 @@ public function testLookupFound() public function testLookupMissing() { $body = json_decode(file_get_contents(Fixtures::ENTITY_BATCH_LOOKUP_FIXTURE()), true); - $this->connection->lookup(Argument::any())->willReturn([ - 'missing' => $body, - ]); + + $this->mockSendRequest( + 'lookup', + [], + ['missing' => $body,] + ); $this->operation->___setProperty('connection', $this->connection->reveal()); @@ -337,9 +346,12 @@ public function testLookupMissing() public function testLookupDeferred() { $body = json_decode(file_get_contents(Fixtures::ENTITY_BATCH_LOOKUP_FIXTURE()), true); - $this->connection->lookup(Argument::any())->willReturn([ - 'deferred' => [$body[0]['entity']['key']], - ]); + + $this->mockSendRequest( + 'lookup', + [], + ['deferred' => [$body[0]['entity']['key']]] + ); $this->operation->___setProperty('connection', $this->connection->reveal()); @@ -354,9 +366,13 @@ public function testLookupDeferred() public function testLookupWithReadOptionsFromTransaction() { - $this->connection->lookup(Argument::withKey('readOptions'))->shouldBeCalled()->willReturn([]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => 'foo']], + [], + 0 + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $k = new Key('test-project', [ 'path' => [['kind' => 'kind', 'id' => '123']], @@ -367,24 +383,32 @@ public function testLookupWithReadOptionsFromTransaction() public function testLookupWithReadOptionsFromReadConsistency() { - $this->connection->lookup(Argument::withKey('readOptions'))->shouldBeCalled()->willReturn([]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['readConsistency' => 123]], + [], + 0 + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $k = new Key('test-project', [ 'path' => [['kind' => 'kind', 'id' => '123']], ]); - $this->operation->lookup([$k], ['readConsistency' => 'foo']); + $this->operation->lookup([$k], ['readConsistency' => 123]); } public function testLookupWithoutReadOptions() { - $this->connection->lookup(Argument::that(function ($args) { - return !isset($args['readOptions']); - }))->shouldBeCalled()->willReturn([]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->requestHandler->sendRequest( + Argument::any(), + Argument::any(), + Argument::that(function (LookupRequest $arg) { + return !$arg->hasReadOptions(); + }), + Argument::cetera() + )->shouldBeCalled()->willReturn([]); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $k = new Key('test-project', [ 'path' => [['kind' => 'kind', 'id' => '123']], @@ -404,11 +428,12 @@ public function testLookupWithSort() ]); } - $this->connection->lookup(Argument::any())->willReturn([ - 'found' => $data['entities'], - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $data['entities']] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->lookup($keys, [ 'sort' => true, @@ -432,12 +457,15 @@ public function testLookupWithoutSort() ]); } - $this->connection->lookup(Argument::any())->willReturn([ - 'found' => $data['entities'], - 'missing' => $data['missing'], - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + [ + 'found' => $data['entities'], + 'missing' => $data['missing'], + ] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->lookup($keys); @@ -464,11 +492,12 @@ public function testLookupWithSortAndMissingKey() ]); } - $this->connection->lookup(Argument::any())->willReturn([ - 'found' => $data['entities'], - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $data['entities'],] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->lookup($keys, [ 'sort' => true, @@ -854,12 +883,12 @@ public function testMapEntityResult() { $res = json_decode(file_get_contents(Fixtures::ENTITY_RESULT_FIXTURE()), true); - $this->connection->lookup(Argument::type('array')) - ->willReturn([ - 'found' => $res, - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $res,] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); @@ -875,12 +904,12 @@ public function testMapEntityResultWithoutProperties() { $res = json_decode(file_get_contents(Fixtures::ENTITY_RESULT_NO_PROPERTIES_FIXTURE()), true); - $this->connection->lookup(Argument::type('array')) - ->willReturn([ - 'found' => $res, - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $res,] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); @@ -895,12 +924,12 @@ public function testMapEntityResultArrayOfClassNames() { $res = json_decode(file_get_contents(Fixtures::ENTITY_RESULT_FIXTURE()), true); - $this->connection->lookup(Argument::type('array')) - ->willReturn([ - 'found' => $res, - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $res,] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); @@ -919,12 +948,12 @@ public function testMapEntityResultArrayOfClassNamesMissingKindMapItem() $res = json_decode(file_get_contents(Fixtures::ENTITY_RESULT_FIXTURE()), true); - $this->connection->lookup(Argument::type('array')) - ->willReturn([ - 'found' => $res, - ]); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + [], + ['found' => $res,] + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); @@ -937,13 +966,13 @@ public function testMapEntityResultArrayOfClassNamesMissingKindMapItem() public function testTransactionInReadOptions() { - $this->connection->lookup(Argument::that(function ($arg) { - return isset($arg['readOptions']['transaction']); - })) - ->willReturn([]) - ->shouldBeCalled(); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['transaction' => '1234']], + [], + 0 + ); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); $this->operation->lookup([$key], [ @@ -953,13 +982,15 @@ public function testTransactionInReadOptions() public function testNonTransactionalReadOptions() { - $this->connection->lookup(Argument::that(function ($arg) { - return !isset($arg['readOptions']['transaction']); - })) - ->willReturn([]) - ->shouldBeCalled(); - - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->requestHandler->sendRequest( + Argument::any(), + Argument::any(), + Argument::that(function (LookupRequest $arg) { + return (!$arg->hasReadOptions()) || (!$arg->getReadOptions()->hasTransaction()); + }), + Argument::cetera() + )->shouldBeCalled()->willReturn([]); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); $this->operation->lookup([$key]); @@ -967,15 +998,18 @@ public function testNonTransactionalReadOptions() public function testReadConsistencyInReadOptions() { - $this->connection->lookup(Argument::withEntry('readOptions', ['readConsistency' => 'test'])) - ->willReturn([]) - ->shouldBeCalled(); + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['readConsistency' => 123]], + [], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', 12345); $this->operation->lookup([$key], [ - 'readConsistency' => 'test', + 'readConsistency' => 123, ]); } @@ -1021,12 +1055,19 @@ public function testAllocateIdsWithDatabaseIdOverride() public function testLookupWithDatabaseIdOverride() { - $this->connection - ->lookup( - Argument::withEntry('databaseId', 'otherDatabaseId') - ) - ->shouldBeCalledTimes(1) - ->willReturn([]); + // $this->connection + // ->lookup( + // Argument::withEntry('databaseId', 'otherDatabaseId') + // ) + // ->shouldBeCalledTimes(1) + // ->willReturn([]); + + $this->mockSendRequest( + 'lookup', + ['databaseId' => 'otherDatabaseId'], + [], + 1 + ); $this->operation->lookup( [], diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index fc3a55412df1..2d4646f1cb55 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -110,16 +110,21 @@ public function setUp(): void */ public function testLookup(callable $transaction) { - $this->connection->lookup(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('keys', [$this->key->keyObject()]) - ))->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($this->key) + $this->mockSendRequest( + 'lookup', + [ + 'readOptions' => ['transaction' => self::TRANSACTION], + 'keys' => [$this->key->keyObject()], + ], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] - ] - ]); + ], + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ @@ -134,17 +139,25 @@ public function testLookup(callable $transaction) public function testLookupWithReadTime() { $time = new Timestamp(new \DateTime()); - $this->connection->lookup(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('keys', [$this->key->keyObject()]), - Argument::withEntry('readTime', $time) - ))->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($this->key) + + $this->mockSendRequest( + 'lookup', + [ + 'readOptions' => [ + 'readTime' => $time, + 'transaction' => self::TRANSACTION, + ], + 'keys' => [$this->key->keyObject()], + ], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] - ] - ]); + ], + 0 + ); $transaction = $this->readOnly; $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ @@ -160,15 +173,18 @@ public function testLookupWithReadTime() */ public function testLookupMissing(callable $transaction) { - $this->connection->lookup( - Argument::withEntry('keys', [$this->key->keyObject()]) - )->shouldBeCalled()->willReturn([ - 'missing' => [ - [ - 'entity' => $this->entityArray($this->key) + $this->mockSendRequest( + 'lookup', + ['keys' => [$this->key->keyObject()]], + [ + 'missing' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] - ] - ]); + ], + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ @@ -184,23 +200,26 @@ public function testLookupMissing(callable $transaction) */ public function testLookupBatch(callable $transaction) { - $this->connection->lookup( - Argument::withEntry('keys', [$this->key->keyObject()]) - )->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($this->key) - ] - ], - 'missing' => [ - [ - 'entity' => $this->entityArray($this->key) + $this->mockSendRequest( + 'lookup', + ['keys' => [$this->key->keyObject()]], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($this->key) + ] + ], + 'missing' => [ + [ + 'entity' => $this->entityArray($this->key) + ] + ], + 'deferred' => [ + $this->key->keyObject() ] ], - 'deferred' => [ - $this->key->keyObject() - ] - ]); + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ @@ -219,15 +238,18 @@ public function testLookupBatch(callable $transaction) public function testLookupBatchWithReadTime(callable $transaction) { $time = new Timestamp(new \DateTime()); - $this->connection->lookup( - Argument::withEntry('readTime', $time) - )->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => $this->entityArray($this->key) + $this->mockSendRequest( + 'lookup', + ['readOptions' => ['readTime' => $time]], + [ + 'found' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] - ] - ]); + ], + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ From 927d510be68b6232ed555fa5ee94b0663cbeb228 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Wed, 3 Apr 2024 10:50:38 +0000 Subject: [PATCH 09/31] Update RunQuery rpc + unit + snippet tests --- Datastore/src/Operation.php | 190 +++++++++++++++++- .../tests/Snippet/DatastoreClientTest.php | 11 +- Datastore/tests/Snippet/FilterTest.php | 16 +- .../tests/Snippet/Query/GqlQueryTest.php | 17 +- Datastore/tests/Snippet/Query/QueryTest.php | 17 +- .../tests/Snippet/ReadOnlyTransactionTest.php | 11 +- Datastore/tests/Snippet/TransactionTest.php | 11 +- Datastore/tests/Unit/DatastoreClientTest.php | 61 +++--- Datastore/tests/Unit/OperationTest.php | 99 ++++++--- Datastore/tests/Unit/TransactionTest.php | 53 +++-- .../tests/Unit/fixtures/query-results.json | 2 +- 11 files changed, 379 insertions(+), 109 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 80cd0fa30ce1..25746d1d7c11 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -31,11 +31,20 @@ use Google\Cloud\Datastore\V1\AllocateIdsRequest; use Google\Cloud\Datastore\V1\BeginTransactionRequest; use Google\Cloud\Datastore\V1\Client\DatastoreClient; +use Google\Cloud\Datastore\V1\ExplainOptions; +use Google\Cloud\Datastore\V1\GqlQuery; use Google\Cloud\Datastore\V1\Key\PathElement; use Google\Cloud\Datastore\V1\LookupRequest; use Google\Cloud\Datastore\V1\PartitionId; +use Google\Cloud\Datastore\V1\PropertyFilter\Operator as PropertyFilterOperator; +use Google\Cloud\Datastore\V1\CompositeFilter\Operator as CompositeFilterOperator; +use Google\Cloud\Datastore\V1\PropertyOrder\Direction; +use Google\Cloud\Datastore\V1\Query as V1Query; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; +use Google\Cloud\Datastore\V1\ReadOptions; +use Google\Cloud\Datastore\V1\RunQueryRequest; use Google\Cloud\Datastore\V1\TransactionOptions; +use Google\Protobuf\NullValue; /** * Run lookups and queries and commit changes. @@ -572,7 +581,7 @@ public function runQuery(QueryInterface $query, array $options = []) if (isset($remainingLimit)) { $requestQueryArr['limit'] = $remainingLimit; } - $request = [ + $req = [ 'projectId' => $this->projectId, 'partitionId' => $this->partitionId( $this->projectId, @@ -582,7 +591,31 @@ public function runQuery(QueryInterface $query, array $options = []) $runQueryObj->queryKey() => $requestQueryArr, ] + $this->readOptions($options) + $options; - $res = $this->connection->runQuery($request); + list($data, $optionalArgs) = $this->splitOptionalArgs($req, [ + 'className', + 'namespaceId', + 'readTime', + 'readConsistency', + 'transaction' + ]); + $data = $this->convertDataToProtos($data, [ + 'partitionId' => PartitionId::class, + 'readOptions' => ReadOptions::class, + 'explainOptions' => ExplainOptions::class + ]); + if (isset($data['query'])) { + $data['query'] = $this->parseQuery($data['query']); + } + if (isset($data['gqlQuery'])) { + $data['gqlQuery'] = $this->parseGqlQuery($data['gqlQuery']); + } + $request = $this->serializer->decodeMessage(new RunQueryRequest(), $data); + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'runQuery', + $request, + $optionalArgs + ); // When executing a GQL Query, the server will compute a query object // and return it with the first response batch. @@ -984,4 +1017,157 @@ private function keysList(array $keys) return $out; } + + /** + * Convert array representation of Query to {@see Google\Cloud\Datastore\V1\Query}. + * + * @param array $query + * @return V1Query + */ + private function parseQuery(array $query) + { + if (isset($query['order'])) { + foreach ($query['order'] as &$order) { + $order['direction'] = $order['direction'] === 'ASCENDING' + ? Direction::ASCENDING + : Direction::DESCENDING; + } + } + + if (isset($query['filter'])) { + $query['filter'] = $this->convertFilterProps($query['filter']); + } + + if (isset($query['limit']) && !is_array($query['limit'])) { + $query['limit'] = [ + 'value' => $query['limit'] + ]; + } + + $parsedQuery = $this->serializer->decodeMessage( + new V1Query, + $query + ); + return $parsedQuery; + } + + /** + * Convert array representation of GqlQuery to {@see Google\Cloud\Datastore\V1\GqlQuery}. + * + * @param array $gqlQuery + * @return GqlQuery + */ + private function parseGqlQuery(array $gqlQuery) + { + if (isset($gqlQuery['namedBindings'])) { + foreach ($gqlQuery['namedBindings'] as $name => &$binding) { + if (!isset($binding['value'])) { + continue; + } + + $binding = $this->prepareQueryBinding($binding); + } + } + + if (isset($gqlQuery['positionalBindings'])) { + foreach ($gqlQuery['positionalBindings'] as &$binding) { + if (!isset($binding['value'])) { + continue; + } + + $binding = $this->prepareQueryBinding($binding); + } + } + + $parsedGqlQuery = $this->serializer->decodeMessage( + new GqlQuery, + $gqlQuery + ); + + return $parsedGqlQuery; + } + + /** + * Convert Query filters to an API-compatible value. + * + * @param array $filter The input filter data + * @return array + */ + private function convertFilterProps(array $filter) + { + if (isset($filter['propertyFilter'])) { + $operator = $filter['propertyFilter']['op']; + + try { + if (is_int($operator)) { + // verify that the operator, given as enum value, exists. + PropertyFilterOperator::name($operator); + } else { + // convert the operator, given as a string, to a grpc value. + $operator = PropertyFilterOperator::value($operator); + } + } catch (\UnexpectedValueException $e) { + throw new \InvalidArgumentException($e->getMessage()); + } + + $filter['propertyFilter']['op'] = $operator; + } + + if (isset($filter['compositeFilter'])) { + if ($filter['compositeFilter']['op'] == 'AND') { + $filter['compositeFilter']['op'] = CompositeFilterOperator::PBAND; + } elseif ($filter['compositeFilter']['op'] == 'OR') { + $filter['compositeFilter']['op'] = CompositeFilterOperator::PBOR; + } else { + $filter['compositeFilter']['op'] = CompositeFilterOperator::OPERATOR_UNSPECIFIED; + } + foreach ($filter['compositeFilter']['filters'] as &$nested) { + $nested = $this->convertFilterProps($nested); + } + } + + return $filter; + } + + /** + * Convert a query binding to an API-compatible value. + * + * @param array $binding The input binding data + * @return array + */ + private function prepareQueryBinding(array $binding) + { + $value = $binding['value']; + + list ($type, $val) = $this->toGrpcValue($value); + + $binding['value'][$type] = $val; + + return $binding; + } + + /** + * Convert a property value to a gRPC value. + * + * @param array $property The input property. + * @return array + */ + private function toGrpcValue(array $property) + { + $type = array_keys($property)[0]; + $val = $property[$type]; + if ($val === null) { + $val = NullValue::NULL_VALUE; + } + + if ($type === 'timestampValue') { + $val = $this->formatTimestampForApi($val); + } + + if ($type === 'geoPointValue') { + $val = $this->arrayFilterRemoveNull($val); + } + + return [$type, $val]; + } } diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 7939beb36460..831da9751ddb 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -697,9 +697,10 @@ public function testRunQuery() $query->queryKey()->willReturn('query'); $snippet->addLocal('query', $query->reveal()); - $this->connection->runQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runQuery', + [], + [ 'batch' => [ 'entityResults' => [ [ @@ -718,7 +719,9 @@ public function testRunQuery() ] ] ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/FilterTest.php b/Datastore/tests/Snippet/FilterTest.php index a4156b002d37..94a875c01ae8 100644 --- a/Datastore/tests/Snippet/FilterTest.php +++ b/Datastore/tests/Snippet/FilterTest.php @@ -2,6 +2,7 @@ namespace Google\Cloud\Datastore\Tests\Snippet; +use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -26,12 +27,14 @@ class FilterTest extends SnippetTestCase private $operation; private $query; private $filter; + private $requestHandler; public function setUp(): void { $entityMapper = new EntityMapper(self::PROJECT, false, false); $this->connection = $this->prophesize(ConnectionInterface::class); + $this->requestHandler = $this->prophesize(RequestHandler::class); $this->datastore = TestHelpers::stub( DatastoreClient::class, @@ -87,9 +90,10 @@ public function getCompositeFilterTypes() private function createConnectionProphecy() { - $this->connection->runQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + '', + [], + [ 'batch' => [ 'entityResults' => [ [ @@ -105,9 +109,11 @@ private function createConnectionProphecy() ], 'moreResults' => 'no' ] - ]); + ], + 0 + ); - $this->refreshOperation($this->datastore, $this->connection->reveal(), [ + $this->refreshOperation($this->datastore, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); } diff --git a/Datastore/tests/Snippet/Query/GqlQueryTest.php b/Datastore/tests/Snippet/Query/GqlQueryTest.php index 6fa69b2a2c66..4461bd368067 100644 --- a/Datastore/tests/Snippet/Query/GqlQueryTest.php +++ b/Datastore/tests/Snippet/Query/GqlQueryTest.php @@ -20,6 +20,7 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; +use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\Parser\Snippet; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; @@ -39,6 +40,7 @@ class GqlQueryTest extends SnippetTestCase { use ProphecyTrait; use ApiHelperTrait; + use DatastoreOperationRefreshTrait; private $datastore; private $connection; @@ -74,14 +76,15 @@ public function setUp(): void 'my-awesome-project', '', new EntityMapper('my-awesome-project', true, false) - ]); + ], ['requestHandler']); } public function testClass() { - $this->connection->runQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runQuery', + [], + [ 'batch' => [ 'entityResults' => [ [ @@ -98,9 +101,11 @@ public function testClass() ] ] ] - ]); + ], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->datastore->___setProperty('operation', $this->operation); diff --git a/Datastore/tests/Snippet/Query/QueryTest.php b/Datastore/tests/Snippet/Query/QueryTest.php index e4da47712f53..5ac648b42020 100644 --- a/Datastore/tests/Snippet/Query/QueryTest.php +++ b/Datastore/tests/Snippet/Query/QueryTest.php @@ -20,6 +20,7 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; +use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -40,6 +41,7 @@ class QueryTest extends SnippetTestCase { use ProphecyTrait; use ApiHelperTrait; + use DatastoreOperationRefreshTrait; private $datastore; private $connection; @@ -78,16 +80,17 @@ public function setUp(): void 'my-awesome-project', '', $mapper - ]); + ], ['requestHandler']); $this->query = new Query($mapper); } public function testClass() { - $this->connection->runQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runQuery', + [], + [ 'batch' => [ 'entityResults' => [ [ @@ -105,9 +108,11 @@ public function testClass() ], 'moreResults' => 'no' ] - ]); + ], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->datastore->___setProperty('operation', $this->operation); diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index a6a5e0c458f3..c698beafb234 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -254,9 +254,10 @@ public function testRunQuery() $query->queryKey()->willReturn('query'); $snippet->addLocal('query', $query->reveal()); - $this->connection->runQuery(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runQuery', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'batch' => [ 'entityResults' => [ [ @@ -275,7 +276,9 @@ public function testRunQuery() ] ] ] - ]); + ], + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index bdaa68fb709d..c2e9877aaf94 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -414,9 +414,10 @@ public function testRunQuery() $query->queryKey()->willReturn('query'); $snippet->addLocal('query', $query->reveal()); - $this->connection->runQuery(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runQuery', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'batch' => [ 'entityResults' => [ [ @@ -435,7 +436,9 @@ public function testRunQuery() ] ] ] - ]); + ], + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index 82170cc6a34a..e145d4c2eb03 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -279,9 +279,12 @@ public function testTransactionWithOptions($method, $type, $key) ); // Make sure the correct transaction ID was injected. - $this->connection->runQuery(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([]); + $this->mockSendRequest( + 'runQuery', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -645,18 +648,23 @@ public function testRunQuery() { $key = $this->client->key('Person', 'John'); - $this->connection->runQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', ['queryString' => 'SELECT 1=1']) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'entityResults' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'runQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'SELECT 1=1'] + ], + [ + 'batch' => [ + 'entityResults' => [ + [ + 'entity' => $this->entityArray($key) + ] ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -745,19 +753,24 @@ public function testRunQueryWithReadTime() $key = $this->client->key('Person', 'John'); $time = new Timestamp(new \DateTime()); - $this->connection->runQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', ['queryString' => 'SELECT 1=1']), - Argument::withEntry('readTime', $time) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'entityResults' => [ - [ - 'entity' => $this->entityArray($key) + $this->mockSendRequest( + 'runQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'SELECT 1=1'], + 'readOptions' => ['readTime' => $time] + ], + [ + 'batch' => [ + 'entityResults' => [ + [ + 'entity' => $this->entityArray($key) + ] ] ] - ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 9de9dae9f782..5f877385872e 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -31,6 +31,7 @@ use Google\Cloud\Datastore\Query\GqlQuery; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; +use Google\Cloud\Datastore\V1\Client\DatastoreClient; use Google\Cloud\Datastore\V1\LookupRequest; use InvalidArgumentException; use PHPUnit\Framework\TestCase; @@ -529,10 +530,13 @@ public function testLookupInvalidKey() public function testRunQuery() { $queryResult = json_decode(file_get_contents(Fixtures::QUERY_RESULTS_FIXTURE()), true); - $this->connection->runQuery(Argument::type('array')) - ->willReturn($queryResult['notPaged']); + $this->mockSendRequest( + 'runQuery', + [], + $queryResult['notPaged'] + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $q = $this->prophesize(QueryInterface::class); $q->queryKey()->shouldBeCalled()->willReturn('query'); @@ -555,17 +559,28 @@ public function testRunQuery() public function testRunQueryPaged($query) { $queryResult = json_decode(file_get_contents(Fixtures::QUERY_RESULTS_FIXTURE()), true); - $this->connection->runQuery(Argument::type('array')) - ->will(function ($args, $mock) use ($queryResult) { - // The 2nd call will return the 2nd page of results! - $mock->runQuery(Argument::that(function ($arg) use ($queryResult) { - return $arg['query']['startCursor'] === $queryResult['paged'][0]['batch']['endCursor']; - }))->willReturn($queryResult['paged'][1]); - return $queryResult['paged'][0]; - }); + $outerThis = $this; + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'runQuery', + Argument::cetera() + )->will(function ($args, $mock) use ($queryResult, $outerThis) { + // The 2nd call will return the 2nd page of results! + $mock->sendRequest( + DatastoreClient::class, + 'runQuery', + Argument::that(function ($arg) use ($queryResult, $outerThis) { + $data = $outerThis->serializer->encodeMessage($arg); + $x = $data['query']['startCursor'] === $queryResult['paged'][0]['batch']['endCursor']; + return $data['query']['startCursor'] === $queryResult['paged'][0]['batch']['endCursor']; + }), + Argument::any() + )->willReturn($queryResult['paged'][1]); + return $queryResult['paged'][0]; + }); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->runQuery($query); @@ -590,10 +605,13 @@ public function queries() public function testRunQueryNoResults() { $queryResult = json_decode(file_get_contents(Fixtures::QUERY_RESULTS_FIXTURE()), true); - $this->connection->runQuery(Argument::type('array')) - ->willReturn($queryResult['noResults']); + $this->mockSendRequest( + 'runQuery', + [], + $queryResult['noResults'] + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $q = $this->prophesize(QueryInterface::class); $q->queryKey()->shouldBeCalled()->willReturn('query'); @@ -610,10 +628,14 @@ public function testRunQueryNoResults() public function testRunQueryWithReadOptionsFromTransaction() { - $this->connection->runQuery(Argument::withKey('readOptions'))->willReturn([]) - ->shouldBeCalled(); + $this->mockSendRequest( + 'runQuery', + [], + [], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $q = $this->prophesize(QueryInterface::class); $q->queryKey()->willReturn('query'); @@ -625,26 +647,33 @@ public function testRunQueryWithReadOptionsFromTransaction() public function testRunQueryWithReadOptionsFromReadConsistency() { - $this->connection->runQuery(Argument::withKey('readOptions'))->willReturn([]) - ->shouldBeCalled(); + $this->mockSendRequest( + 'runQuery', + [], + [], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $q = $this->prophesize(QueryInterface::class); $q->queryKey()->willReturn('query'); $q->queryObject()->willReturn([]); - $res = $this->operation->runQuery($q->reveal(), ['readConsistency' => 'foo']); + $res = $this->operation->runQuery($q->reveal(), ['readConsistency' => 123]); iterator_to_array($res); } public function testRunQueryWithoutReadOptions() { - $this->connection->runQuery(Argument::that(function ($args) { - return !isset($args['readOptions']); - }))->willReturn([])->shouldBeCalled(); + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'runQuery', + Argument::that(function ($req) {return !$req->hasReadOptions();}), + Argument::cetera() + )->willReturn([])->shouldBeCalled(); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $q = $this->prophesize(QueryInterface::class); $q->queryKey()->willReturn('query'); @@ -656,12 +685,18 @@ public function testRunQueryWithoutReadOptions() public function testRunQueryWithDatabaseIdOverride() { - $this->connection - ->runQuery( - Argument::withEntry('databaseId', 'otherDatabaseId') - ) - ->shouldBeCalledTimes(1) - ->willReturn([]); + // $this->connection + // ->runQuery( + // Argument::withEntry('databaseId', 'otherDatabaseId') + // ) + // ->shouldBeCalledTimes(1) + // ->willReturn([]); + $this->mockSendRequest( + 'runQuery', + ['databaseId' => 'otherDatabaseId'], + [], + 1 + ); $mapper = new EntityMapper('foo', true, false); $query = new Query($mapper); diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index 2d4646f1cb55..b550c432a7af 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -264,18 +264,23 @@ public function testLookupBatchWithReadTime(callable $transaction) */ public function testRunQuery(callable $transaction) { - $this->connection->runQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', ['queryString' => 'SELECT 1=1']) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'entityResults' => [ - [ - 'entity' => $this->entityArray($this->key) + $this->mockSendRequest( + 'runQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'SELECT 1=1'] + ], + [ + 'batch' => [ + 'entityResults' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] ] - ] - ]); + ], + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ @@ -330,19 +335,25 @@ public function testRunAggregationQuery(callable $transaction) public function testRunQueryWithReadTime() { $time = new Timestamp(new \DateTime()); - $this->connection->runQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', ['queryString' => 'SELECT 1=1']), - Argument::withEntry('readTime', $time) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'entityResults' => [ - [ - 'entity' => $this->entityArray($this->key) + + $this->mockSendRequest( + 'runQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'SELECT 1=1'], + 'readOptions' => ['readTime' => $time] + ], + [ + 'batch' => [ + 'entityResults' => [ + [ + 'entity' => $this->entityArray($this->key) + ] ] ] - ] - ]); + ], + 0 + ); $transaction = $this->readOnly; $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ diff --git a/Datastore/tests/Unit/fixtures/query-results.json b/Datastore/tests/Unit/fixtures/query-results.json index cb82074e5f6e..da037f36c781 100644 --- a/Datastore/tests/Unit/fixtures/query-results.json +++ b/Datastore/tests/Unit/fixtures/query-results.json @@ -48,7 +48,7 @@ "paged": [ { "query": { - "kind": ["Person"] + "kind": [{"name": "Person"}] }, "batch": { "entityResults": [ From c9d2186af045c6fcc361d88f0bbbfc7698876361 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Wed, 3 Apr 2024 11:13:14 +0000 Subject: [PATCH 10/31] Update RunAggregationQuery rpc + unit + snippet tests --- Datastore/src/Operation.php | 36 +++++++++- .../tests/Snippet/DatastoreClientTest.php | 11 ++-- .../Snippet/Query/AggregationQueryTest.php | 28 +++++--- Datastore/tests/Snippet/TransactionTest.php | 11 ++-- Datastore/tests/Unit/DatastoreClientTest.php | 66 ++++++++++--------- Datastore/tests/Unit/TransactionTest.php | 33 +++++----- 6 files changed, 120 insertions(+), 65 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 25746d1d7c11..d00637922b8a 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -28,6 +28,7 @@ use Google\Cloud\Datastore\Query\AggregationQueryResult; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; +use Google\Cloud\Datastore\V1\AggregationQuery as V1AggregationQuery; use Google\Cloud\Datastore\V1\AllocateIdsRequest; use Google\Cloud\Datastore\V1\BeginTransactionRequest; use Google\Cloud\Datastore\V1\Client\DatastoreClient; @@ -42,6 +43,7 @@ use Google\Cloud\Datastore\V1\Query as V1Query; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; use Google\Cloud\Datastore\V1\ReadOptions; +use Google\Cloud\Datastore\V1\RunAggregationQueryRequest; use Google\Cloud\Datastore\V1\RunQueryRequest; use Google\Cloud\Datastore\V1\TransactionOptions; use Google\Protobuf\NullValue; @@ -681,7 +683,7 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option 'query' => [], ]; $requestQueryArr = $args['query'] + $runQueryObj->queryObject(); - $request = [ + $req = [ 'projectId' => $this->projectId, 'partitionId' => $this->partitionId( $this->projectId, @@ -690,7 +692,37 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option ), ] + $requestQueryArr + $this->readOptions($options) + $options; - $res = $this->connection->runAggregationQuery($request); + list($data, $optionalArgs) = $this->splitOptionalArgs($req, [ + 'namespaceId', + 'readTime', + 'readConsistency', + 'transaction' + ]); + + if (isset($data['aggregationQuery'])) { + if (isset($data['aggregationQuery']['nestedQuery'])) { + $data['aggregationQuery']['nestedQuery'] = $this->parseQuery( + $data['aggregationQuery']['nestedQuery'] + ); + } + + $data['aggregationQuery'] = $this->serializer->decodeMessage( + new V1AggregationQuery(), + $data['aggregationQuery'] + ); + } + + if (isset($data['gqlQuery'])) { + $data['gqlQuery'] = $this->parseGqlQuery($data['gqlQuery']); + } + + $request = $this->serializer->decodeMessage(new RunAggregationQueryRequest(), $data); + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'runAggregationQuery', + $request, + $optionalArgs + ); return new AggregationQueryResult($res, $this->entityMapper); } diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 831da9751ddb..84ce8aba7c79 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -747,9 +747,10 @@ public function testRunAggregationQuery() $query->queryObject()->willReturn([]); $snippet->addLocal('query', $query->reveal()); - $this->connection->runAggregationQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runAggregationQuery', + [], + [ 'batch' => [ 'aggregationResults' => [ [ @@ -760,7 +761,9 @@ public function testRunAggregationQuery() ], 'readTime' => (new \DateTime)->format('Y-m-d\TH:i:s') .'.000001Z' ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/Query/AggregationQueryTest.php b/Datastore/tests/Snippet/Query/AggregationQueryTest.php index 78568ba149fc..542cba94df86 100644 --- a/Datastore/tests/Snippet/Query/AggregationQueryTest.php +++ b/Datastore/tests/Snippet/Query/AggregationQueryTest.php @@ -20,6 +20,7 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; +use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Datastore\Connection\ConnectionInterface; @@ -38,6 +39,7 @@ class AggregationQueryTest extends SnippetTestCase { use ProphecyTrait; use ApiHelperTrait; + use DatastoreOperationRefreshTrait; private $datastore; private $connection; @@ -80,9 +82,10 @@ public function setUp(): void public function testClass() { - $this->connection->runAggregationQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runAggregationQuery', + [], + [ 'batch' => [ 'aggregationResults' => [ [ @@ -93,9 +96,11 @@ public function testClass() ], 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' ] - ]); + ], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->datastore->___setProperty('operation', $this->operation); @@ -110,9 +115,10 @@ public function testClass() public function testClassWithOverAggregation() { - $this->connection->runAggregationQuery(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runAggregationQuery', + [], + [ 'batch' => [ 'aggregationResults' => [ [ @@ -123,9 +129,11 @@ public function testClassWithOverAggregation() ], 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' ] - ]); + ], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->datastore->___setProperty('operation', $this->operation); diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index c2e9877aaf94..c988c0d9318a 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -458,9 +458,10 @@ public function testRunAggregationQuery() $query->queryObject()->willReturn([]); $snippet->addLocal('query', $query->reveal()); - $this->connection->runAggregationQuery(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'runAggregationQuery', + ['readOptions' => ['transaction' => self::TRANSACTION]], + [ 'batch' => [ 'aggregationResults' => [ [ @@ -471,7 +472,9 @@ public function testRunAggregationQuery() ], 'readTime' => (new \DateTime)->format('Y-m-d\TH:i:s') .'.000001Z' ] - ]); + ], + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index e145d4c2eb03..0e676d35a4fe 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -680,21 +680,24 @@ public function testRunQuery() public function testRunAggregationQuery() { - $this->connection->runAggregationQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', [ - 'queryString' => 'AGGREGATE (COUNT(*)) over (SELECT 1=1)' - ]) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'aggregationResults' => [ - [ - 'aggregateProperties' => ['property_1' => 1] - ] - ], - 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' - ] - ]); + $this->mockSendRequest( + 'runAggregationQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'AGGREGATE (COUNT(*)) over (SELECT 1=1)'], + ], + [ + 'batch' => [ + 'aggregationResults' => [ + [ + 'aggregateProperties' => ['property_1' => 1] + ] + ], + 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' + ] + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -716,21 +719,24 @@ public function testRunAggregationQuery() */ public function testAggregationQueryWithDifferentReturnTypes($response, $expected) { - $this->connection->runAggregationQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', [ - 'queryString' => 'foo bar' - ]) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'aggregationResults' => [ - [ - 'aggregateProperties' => ['property_1' => $response] - ] - ], - 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' - ] - ]); + $this->mockSendRequest( + 'runAggregationQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'foo bar'], + ], + [ + 'batch' => [ + 'aggregationResults' => [ + [ + 'aggregateProperties' => ['property_1' => $response] + ] + ], + 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' + ] + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index b550c432a7af..e232dc81086e 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -300,21 +300,24 @@ public function testRunQuery(callable $transaction) */ public function testRunAggregationQuery(callable $transaction) { - $this->connection->runAggregationQuery(Argument::allOf( - Argument::withEntry('partitionId', ['projectId' => self::PROJECT]), - Argument::withEntry('gqlQuery', [ - 'queryString' => 'AGGREGATE (COUNT(*)) over (SELECT 1=1)' - ]) - ))->shouldBeCalled()->willReturn([ - 'batch' => [ - 'aggregationResults' => [ - [ - 'aggregateProperties' => ['property_1' => 1] - ] - ], - 'readTime' => (new \DateTime)->format('Y-m-d\TH:i:s') .'.000001Z' - ] - ]); + $this->mockSendRequest( + 'runAggregationQuery', + [ + 'partitionId' => ['projectId' => self::PROJECT], + 'gqlQuery' => ['queryString' => 'AGGREGATE (COUNT(*)) over (SELECT 1=1)'], + ], + [ + 'batch' => [ + 'aggregationResults' => [ + [ + 'aggregateProperties' => ['property_1' => 1] + ] + ], + 'readTime' => (new \DateTime())->format('Y-m-d\TH:i:s') .'.000001Z' + ] + ], + 0 + ); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ From 82716bdcb2e14bd323f2a1e06120760bfc04abe5 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Wed, 3 Apr 2024 14:15:43 +0000 Subject: [PATCH 11/31] Update Commit rpc + unit + snippet tests --- Datastore/src/DatastoreClient.php | 4 +- Datastore/src/Operation.php | 37 +++++- .../tests/Snippet/DatastoreClientTest.php | 90 ++++++-------- .../Snippet/DatastoreSessionHandlerTest.php | 42 ++++--- Datastore/tests/Snippet/TransactionTest.php | 101 +++++---------- Datastore/tests/Unit/DatastoreClientTest.php | 104 +++++++++------- Datastore/tests/Unit/OperationTest.php | 117 ++++++++++-------- Datastore/tests/Unit/TransactionTest.php | 99 +++++++++------ 8 files changed, 318 insertions(+), 276 deletions(-) diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index da3e106d5d5a..6c08f3aaea85 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -34,7 +34,7 @@ use Google\Cloud\Datastore\Query\GqlQuery; use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; -use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; use InvalidArgumentException; use Psr\Cache\CacheItemPoolInterface; use Psr\Http\Message\StreamInterface; @@ -107,7 +107,7 @@ class DatastoreClient const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; private const GAPIC_KEYS = [ - DatastoreGapicClient::class + V1DatastoreClient::class ]; /** diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index d00637922b8a..1e7dc7d43cd9 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -32,6 +32,8 @@ use Google\Cloud\Datastore\V1\AllocateIdsRequest; use Google\Cloud\Datastore\V1\BeginTransactionRequest; 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\ExplainOptions; use Google\Cloud\Datastore\V1\GqlQuery; use Google\Cloud\Datastore\V1\Key\PathElement; @@ -39,6 +41,7 @@ use Google\Cloud\Datastore\V1\PartitionId; use Google\Cloud\Datastore\V1\PropertyFilter\Operator as PropertyFilterOperator; use Google\Cloud\Datastore\V1\CompositeFilter\Operator as CompositeFilterOperator; +use Google\Cloud\Datastore\V1\Mutation; use Google\Cloud\Datastore\V1\PropertyOrder\Direction; use Google\Cloud\Datastore\V1\Query as V1Query; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; @@ -751,12 +754,40 @@ public function commit(array $mutations, array $options = []) 'databaseId' => $this->databaseId, ]; - $res = $this->connection->commit($options + [ - 'mode' => ($options['transaction']) ? 'TRANSACTIONAL' : 'NON_TRANSACTIONAL', + foreach ($mutations as &$mutation) { + $mutationType = array_keys($mutation)[0]; + $data = $mutation[$mutationType]; + if (isset($data['properties'])) { + foreach ($data['properties'] as &$property) { + list ($type, $val) = $this->toGrpcValue($property); + + $property[$type] = $val; + } + } + + $mutation[$mutationType] = $data; + + $mutation = $this->serializer->decodeMessage(new Mutation, $mutation); + } + + $options += [ + 'mode' => ($options['transaction']) ? Mode::TRANSACTIONAL : Mode::NON_TRANSACTIONAL, 'mutations' => $mutations, 'projectId' => $this->projectId, - ]); + ]; + if (is_null($options['transaction'])) { + // Remove 'transaction' if `null` to avoid serialization error + unset($options['transaction']); + } + list($data, $optionalArgs) = $this->splitOptionalArgs($options, ['allowOverwrite', 'baseVersion']); + $request = $this->serializer->decodeMessage(new CommitRequest(), $data); + $res = $this->requestHandler->sendRequest( + DatastoreClient::class, + 'commit', + $request, + $optionalArgs + ); return $res; } diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 84ce8aba7c79..8de36503d633 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -37,7 +37,7 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\ReadOnlyTransaction; use Google\Cloud\Datastore\Transaction; -use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -396,15 +396,11 @@ public function testInsert() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'insert'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'insert'; - })) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('insert', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -420,10 +416,7 @@ public function testInsertBatch() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'insertBatch'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'insert'; - })) - ->shouldBeCalled(); + $this->mockSendRequestForCommit('insert', []); $this->allocateIdsConnectionMock(); @@ -444,15 +437,11 @@ public function testUpdate() 'populatedByService' => true ])); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'update'; - })) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('update', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -470,9 +459,7 @@ public function testUpdateBatch() $this->client->entity($this->client->key('Person', 'John'), [], ['populatedByService' => true]) ]); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'update'; - }))->shouldBeCalled(); + $this->mockSendRequestForCommit('update', []); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -486,21 +473,17 @@ public function testUpsert() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'upsert'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'upsert'; - })) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('upsert', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); - $res = $snippet->invoke(); + $snippet->invoke(); } public function testUpsertBatch() @@ -508,9 +491,7 @@ public function testUpsertBatch() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'upsertBatch'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'upsert'; - }))->shouldBeCalled(); + $this->mockSendRequestForCommit('upsert', []); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -524,15 +505,11 @@ public function testDelete() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'delete'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'delete'; - })) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('delete', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -546,9 +523,7 @@ public function testDeleteBatch() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'deleteBatch'); $snippet->addLocal('datastore', $this->client); - $this->connection->commit(Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'delete'; - }))->shouldBeCalled(); + $this->mockSendRequestForCommit('delete', []); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -785,7 +760,7 @@ public function testRunAggregationQuery() private function allocateIdsConnectionMock() { $this->requestHandler->sendRequest( - DatastoreGapicClient::class, + V1DatastoreClient::class, 'allocateIds', Argument::cetera() )->shouldBeCalled()->willReturn([ @@ -836,4 +811,15 @@ private function validateTransactionOptions($type, array $options = []) return true; }); } + + private function mockSendRequestForCommit($mutationType, $returnValue) + { + $hazzer = 'has' . ucfirst($mutationType); + $this->requestHandler->sendRequest( + V1DatastoreClient::class, + 'commit', + Argument::that(fn ($arg) => $arg->getMutations()[0]->$hazzer()), + Argument::any() + )->shouldBeCalled()->willReturn($returnValue); + } } diff --git a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php index b00886e949c1..4ec352334f09 100644 --- a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php +++ b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php @@ -25,6 +25,8 @@ use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\DatastoreSessionHandler; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; +use Google\Cloud\Datastore\V1\CommitRequest\Mode; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -95,19 +97,22 @@ public function testClass() ['transaction' => self::TRANSACTION] ); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::that(function ($args) { - $value = 'name|'.serialize('Bob'); - - return $args['mutations'][0]['upsert']['key']['partitionId']['namespaceId'] === 'sessions' - && $args['mutations'][0]['upsert']['key']['path'][0]['kind'] === 'PHPSESSID' - && isset($args['mutations'][0]['upsert']['key']['path'][0]['name']) - && $args['mutations'][0]['upsert']['properties']['data']['stringValue'] === $value - && isset($args['mutations'][0]['upsert']['properties']['t']); - }) - ))->shouldBeCalled()->willReturn([]); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [['upsert' => [ + 'key' => [ + 'path' => [['kind' => 'PHPSESSID']], + 'partitionId' => ['namespaceId' => 'sessions'] + ], + 'properties' => ['data' => ['stringValue' => 'name|'.serialize('Bob')]] + ]]] + ], + [], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -150,11 +155,12 @@ public function testClassErrorHandler() ['transaction' => self::TRANSACTION] ); - $this->connection->commit(Argument::any()) - ->shouldBeCalled() - ->will(function () { - trigger_error('oops!', E_USER_WARNING); - }); + $this->requestHandler->sendRequest( + V1DatastoreClient::class, + 'commit', + Argument::cetera() + )->shouldBeCalled()->will(fn () => trigger_error('oops!', E_USER_WARNING)); + $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index c988c0d9318a..5ca8b6249a08 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -31,7 +31,7 @@ use Google\Cloud\Datastore\Query\AggregationQuery; use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\Transaction; -use Google\Cloud\Datastore\V1\Client\DatastoreClient as DatastoreGapicClient; +use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -131,12 +131,7 @@ public function testInsert() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'insert'; - }) - ))->shouldBeCalled()->willReturn([ + $this->mockSendRequestForCommit('insert', [ 'mutationResults' => [ ['version' => 1] ] @@ -155,12 +150,7 @@ public function testInsertBatch() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'insert'; - }) - ))->shouldBeCalled()->willReturn([ + $this->mockSendRequestForCommit('insert', [ 'mutationResults' => [ ['version' => 1] ] @@ -184,12 +174,7 @@ public function testUpdate() 'populatedByService' => true ])); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'update'; - }) - ))->shouldBeCalled()->willReturn([ + $this->mockSendRequestForCommit('update', [ 'mutationResults' => [ ['version' => 1] ] @@ -212,14 +197,9 @@ public function testUpdateBatch() $this->client->entity($this->client->key('Person', 'John'), [], ['populatedByService' => true]) ]); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'update'; - }) - ))->shouldBeCalled(); + $this->mockSendRequestForCommit('update', []); - $res = $snippet->invoke(); + $snippet->invoke(); } public function testUpsert() @@ -231,18 +211,11 @@ public function testUpsert() 'populatedByService' => true ])); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'upsert'; - }) - )) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('upsert', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -261,15 +234,9 @@ public function testUpsertBatch() $this->client->entity($this->client->key('Person', 'John'), [], ['populatedByService' => true]) ]); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'upsert'; - }) - )) - ->shouldBeCalled(); + $this->mockSendRequestForCommit('upsert', []); - $res = $snippet->invoke(); + $snippet->invoke(); } public function testDelete() @@ -278,18 +245,11 @@ public function testDelete() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'delete'; - }) - )) - ->shouldBeCalled() - ->willReturn([ - 'mutationResults' => [ - ['version' => 1] - ] - ]); + $this->mockSendRequestForCommit('delete', [ + 'mutationResults' => [ + ['version' => 1] + ] + ]); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -304,12 +264,7 @@ public function testDeleteBatch() $snippet->addLocal('datastore', $this->client); $snippet->addLocal('transaction', $this->transaction); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::that(function ($args) { - return array_keys($args['mutations'][0])[0] === 'delete'; - }) - ))->shouldBeCalled(); + $this->mockSendRequestForCommit('delete', []); $res = $snippet->invoke(); } @@ -489,8 +444,7 @@ public function testCommit() $snippet = $this->snippetFromMethod(Transaction::class, 'commit'); $snippet->addLocal('transaction', $this->transaction); - $this->connection->commit(Argument::any()) - ->shouldBeCalled(); + $this->mockSendRequest('commit', [], [], 0); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -519,7 +473,7 @@ public function testRollback() private function allocateIdsConnectionMock() { $this->requestHandler->sendRequest( - DatastoreGapicClient::class, + V1DatastoreClient::class, 'allocateIds', Argument::cetera() )->shouldBeCalled()->willReturn([ @@ -545,4 +499,17 @@ private function allocateIdsConnectionMock() return $this->requestHandler->reveal(); } + + private function mockSendRequestForCommit($mutationType, $returnValue) + { + $hazzer = 'has' . ucfirst($mutationType); + $this->requestHandler->sendRequest( + V1DatastoreClient::class, + 'commit', + Argument::that( + fn ($arg) => $arg->getTransaction() == self::TRANSACTION && $arg->getMutations()[0]->$hazzer() + ), + Argument::any() + )->shouldBeCalled()->willReturn($returnValue); + } } diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index 0e676d35a4fe..20457eb5e2d5 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -41,6 +41,7 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\ReadOnlyTransaction; use Google\Cloud\Datastore\Transaction; +use Google\Cloud\Datastore\V1\CommitRequest\Mode; use PHPUnit\Framework\TestCase; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -309,11 +310,15 @@ public function transactionProvider() */ public function testEntityMutations($method, $mutation, $key) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -330,11 +335,15 @@ public function testEntityMutations($method, $mutation, $key) */ public function testEntityMutationsBatch($method, $mutation, $key) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -358,11 +367,15 @@ public function mutationsProvider() */ public function testMutationsWithPartialKey($method, $mutation, $key, $id) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); @@ -385,11 +398,15 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) */ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); @@ -420,15 +437,18 @@ public function testSingleMutationConflict() { $this->expectException(\DomainException::class); - $this->connection->commit(Argument::any()) - ->shouldBeCalled() - ->willReturn([ + $this->mockSendRequest( + 'commit', + [], + [ 'mutationResults' => [ [ 'conflictDetected' => true ] ] - ]); + ], + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -442,15 +462,15 @@ public function testDelete() { $key = $this->client->key('Person', 'John'); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [ - [ - 'delete' => $key->keyObject() - ] - ]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [['delete' => $key->keyObject()]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -465,15 +485,15 @@ public function testDeleteBatch() { $key = $this->client->key('Person', 'John'); - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', null), - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::withEntry('mutations', [ - [ - 'delete' => $key->keyObject() - ] - ]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [['delete' => $key->keyObject()]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 5f877385872e..6244a64de720 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -32,6 +32,7 @@ use Google\Cloud\Datastore\Query\Query; use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\V1\Client\DatastoreClient; +use Google\Cloud\Datastore\V1\CommitRequest\Mode; use Google\Cloud\Datastore\V1\LookupRequest; use InvalidArgumentException; use PHPUnit\Framework\TestCase; @@ -710,28 +711,34 @@ public function testRunQueryWithDatabaseIdOverride() public function testCommit() { - $this->connection->commit(Argument::allOf( - Argument::withEntry('mode', 'NON_TRANSACTIONAL'), - Argument::that(function ($arg) { - return count($arg['mutations']) === 0; - }) - ))->shouldBeCalled()->willReturn(['foo']); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::NON_TRANSACTIONAL, + 'mutations' => [] + ], + ['foo'], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->assertEquals(['foo'], $this->operation->commit([])); } public function testCommitInTransaction() { - $this->connection->commit(Argument::allOf( - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::that(function ($arg) { - return count($arg['mutations']) === 0; - }) - ))->shouldBeCalled()->willReturn(['foo']); + $this->mockSendRequest( + 'commit', + [ + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [] + ], + ['foo'], + 0 + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->operation->commit([], [ 'transaction' => '1234', @@ -740,11 +747,14 @@ public function testCommitInTransaction() public function testCommitWithMutation() { - $this->connection->commit(Argument::that(function ($arg) { - return count($arg['mutations']) === 1; - }))->shouldBeCalled()->willReturn(['foo']); + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'commit', + Argument::that(fn ($arg) => (count($arg->getMutations()) == 1)), + Argument::any() + )->shouldBeCalled()->willReturn(['foo']); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person'); $e = new Entity($key); @@ -756,14 +766,14 @@ public function testCommitWithMutation() public function testCommitWithDatabaseIdOverride() { - $this->connection - ->commit( - Argument::withEntry('databaseId', 'otherDatabaseId') - ) - ->shouldBeCalledTimes(1) - ->willReturn([]); - - $iterator = $this->operation->commit( + $this->mockSendRequest( + 'commit', + ['databaseId' => 'otherDatabaseId'], + [], + 1 + ); + + $this->operation->commit( [], ['databaseId' => 'otherDatabaseId'] ); @@ -816,19 +826,16 @@ public function testMutate() { $id = 12345; - $this->connection->commit(Argument::that(function ($arg) { - if (count($arg['mutations']) !== 1) { - return false; - } - - if (!isset($arg['mutations'][0]['insert'])) { - return false; - } - - return true; - }))->shouldBeCalled(); + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'commit', + Argument::that( + fn ($arg) => (count($arg->getMutations()) == 1 && $arg->getMutations()[0]->hasInsert()) + ), + Argument::any() + )->shouldBeCalled(); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Person', $id); $e = new Entity($key); @@ -839,11 +846,13 @@ public function testMutate() public function testMutateWithBaseVersion() { - $this->connection->commit(Argument::that(function ($arg) { - return $arg['mutations'][0]['baseVersion'] === 1; - }))->willReturn('foo'); + $this->mockSendRequest( + 'commit', + ['mutations' => [['baseVersion' => 1]]], + 'foo' + ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->prophesize(Key::class); $e = new Entity($key->reveal(), [], [ @@ -857,19 +866,19 @@ public function testMutateWithBaseVersion() public function testMutateWithKey() { - $this->connection->commit(Argument::that(function ($arg) { - if (!isset($arg['mutations'][0]['delete'])) { - return false; - } - - if (!isset($arg['mutations'][0]['delete']['path'])) { - return false; - } - - return true; - }))->willReturn('foo'); + $otherThis = $this; + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'commit', + Argument::that(function ($arg) use ($otherThis){ + $data = $otherThis->serializer->encodeMessage($arg); + $x = isset($data['mutations'][0]['delete']['path']); + return isset($data['mutations'][0]['delete']['path']); + }), + Argument::any() + )->shouldBeCalled()->willReturn('foo'); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = new Key('foo', [ 'path' => [['kind' => 'foo', 'id' => 1]], diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index e232dc81086e..b0fb6ea96e98 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -34,6 +34,7 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\ReadOnlyTransaction; use Google\Cloud\Datastore\Transaction; +use Google\Cloud\Datastore\V1\CommitRequest\Mode; use PHPUnit\Framework\TestCase; use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; @@ -392,11 +393,16 @@ public function testRollback(callable $transaction) */ public function testEntityMutations($method, $mutation, $key) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -413,11 +419,16 @@ public function testEntityMutations($method, $mutation, $key) */ public function testEntityMutationsBatch($method, $mutation, $key) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -441,11 +452,16 @@ public function mutationsProvider() */ public function testMutationsWithPartialKey($method, $mutation, $key, $id) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); @@ -471,11 +487,16 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) */ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [[$method => $mutation]]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [[$method => $mutation]] + ], + $this->commitResponse(), + 0 + ); $keyWithId = clone $key; $keyWithId->setLastElementIdentifier($id); @@ -507,15 +528,16 @@ public function partialKeyMutationsProvider() public function testDelete() { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [ - [ - 'delete' => $this->key->keyObject() - ] - ]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [['delete' => $this->key->keyObject()]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT @@ -530,15 +552,16 @@ public function testDelete() public function testDeleteBatch() { - $this->connection->commit(Argument::allOf( - Argument::withEntry('transaction', self::TRANSACTION), - Argument::withEntry('mode', 'TRANSACTIONAL'), - Argument::withEntry('mutations', [ - [ - 'delete' => $this->key->keyObject() - ] - ]) - ))->shouldBeCalled()->willReturn($this->commitResponse()); + $this->mockSendRequest( + 'commit', + [ + 'transaction' => self::TRANSACTION, + 'mode' => Mode::TRANSACTIONAL, + 'mutations' => [['delete' => $this->key->keyObject()]] + ], + $this->commitResponse(), + 0 + ); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT From fcdcf9bdf3d03cf57989fc03b2376bfe3838e22b Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Wed, 3 Apr 2024 14:25:22 +0000 Subject: [PATCH 12/31] Update Rollback rpc + unit + snippet tests --- Datastore/src/Operation.php | 10 +++++++++- Datastore/tests/Snippet/ReadOnlyTransactionTest.php | 6 ++---- Datastore/tests/Snippet/TransactionTest.php | 3 +-- Datastore/tests/Unit/OperationTest.php | 10 ++++++---- Datastore/tests/Unit/TransactionTest.php | 3 +-- 5 files changed, 19 insertions(+), 13 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 1e7dc7d43cd9..b550334ba6fe 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -46,6 +46,7 @@ use Google\Cloud\Datastore\V1\Query as V1Query; use Google\Cloud\Datastore\V1\QueryResultBatch\MoreResultsType; use Google\Cloud\Datastore\V1\ReadOptions; +use Google\Cloud\Datastore\V1\RollbackRequest; use Google\Cloud\Datastore\V1\RunAggregationQueryRequest; use Google\Cloud\Datastore\V1\RunQueryRequest; use Google\Cloud\Datastore\V1\TransactionOptions; @@ -878,11 +879,18 @@ public function mutation( */ public function rollback($transactionId) { - $this->connection->rollback([ + list($data, $optionalArgs) = $this->splitOptionalArgs([ 'projectId' => $this->projectId, 'transaction' => $transactionId, 'databaseId' => $this->databaseId, ]); + $request = $this->serializer->decodeMessage(new RollbackRequest(), $data); + $this->requestHandler->sendRequest( + DatastoreClient::class, + 'rollback', + $request, + $optionalArgs + ); } /** diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index c698beafb234..b349525675e3 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -137,8 +137,7 @@ public function testClassRollback() [], 0 ); - $this->connection->rollback(Argument::any()) - ->shouldBeCalled(); + $this->mockSendRequest('rollback', [], [], 0); $snippet = $this->snippetFromClass(ReadOnlyTransaction::class, 1); @@ -293,8 +292,7 @@ public function testRollback() $snippet = $this->snippetFromMethod(ReadOnlyTransaction::class, 'rollback'); $snippet->addLocal('transaction', $this->transaction); - $this->connection->rollback(Argument::any()) - ->shouldBeCalled(); + $this->mockSendRequest('rollback', [], [], 0); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index 5ca8b6249a08..95cdeb9eca5b 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -458,8 +458,7 @@ public function testRollback() $snippet = $this->snippetFromMethod(Transaction::class, 'rollback'); $snippet->addLocal('transaction', $this->transaction); - $this->connection->rollback(Argument::any()) - ->shouldBeCalled(); + $this->mockSendRequest('rollback', [], [], 0); $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 6244a64de720..294da7aebcaa 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -781,10 +781,12 @@ public function testCommitWithDatabaseIdOverride() public function testRollback() { - $this->connection->rollback(Argument::allOf( - Argument::withEntry('projectId', self::PROJECT), - Argument::withEntry('transaction', 'bar') - ))->shouldBeCalled()->willReturn(null); + $this->mockSendRequest( + 'rollback', + ['projectId' => self::PROJECT, 'transaction' => 'bar'], + null, + 0 + ); $this->operation->___setProperty('connection', $this->connection->reveal()); diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index b0fb6ea96e98..110583ab6543 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -377,8 +377,7 @@ public function testRunQueryWithReadTime() */ public function testRollback(callable $transaction) { - $this->connection->rollback(Argument::withEntry('transaction', self::TRANSACTION)) - ->shouldBeCalled(); + $this->mockSendRequest('rollback', ['transaction' => self::TRANSACTION], [], 0); $transaction = $transaction(); $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ From 4c32fc97dc19c022c32a7f1ecb812ebc94846319 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Wed, 3 Apr 2024 15:18:12 +0000 Subject: [PATCH 13/31] Remove all connection classes and references --- .../DatastoreOperationRefreshTrait.php | 5 +- .../src/Connection/ConnectionInterface.php | 62 - Datastore/src/Connection/Grpc.php | 509 ---- Datastore/src/Connection/Rest.php | 162 -- .../ServiceDefinition/datastore-v1.json | 2522 ----------------- Datastore/src/DatastoreClient.php | 39 +- Datastore/src/EntityMapper.php | 40 - Datastore/src/Operation.php | 12 - .../tests/Snippet/DatastoreClientTest.php | 44 +- .../Snippet/DatastoreSessionHandlerTest.php | 7 +- Datastore/tests/Snippet/EntityTest.php | 51 +- Datastore/tests/Snippet/FilterTest.php | 16 +- .../Snippet/Query/AggregationQueryTest.php | 4 - .../tests/Snippet/Query/GqlQueryTest.php | 4 - Datastore/tests/Snippet/Query/QueryTest.php | 4 - .../tests/Snippet/ReadOnlyTransactionTest.php | 19 +- Datastore/tests/Snippet/TransactionTest.php | 33 +- Datastore/tests/Unit/Connection/GrpcTest.php | 556 ---- Datastore/tests/Unit/Connection/RestTest.php | 161 -- Datastore/tests/Unit/DatastoreClientTest.php | 77 +- Datastore/tests/Unit/EntityMapperTest.php | 27 - Datastore/tests/Unit/OperationTest.php | 29 +- Datastore/tests/Unit/TransactionTest.php | 35 +- 23 files changed, 125 insertions(+), 4293 deletions(-) delete mode 100644 Datastore/src/Connection/ConnectionInterface.php delete mode 100644 Datastore/src/Connection/Grpc.php delete mode 100644 Datastore/src/Connection/Rest.php delete mode 100644 Datastore/src/Connection/ServiceDefinition/datastore-v1.json delete mode 100644 Datastore/tests/Unit/Connection/GrpcTest.php delete mode 100644 Datastore/tests/Unit/Connection/RestTest.php diff --git a/Core/src/Testing/DatastoreOperationRefreshTrait.php b/Core/src/Testing/DatastoreOperationRefreshTrait.php index dd6793bf5c30..b94b9bf8a75a 100644 --- a/Core/src/Testing/DatastoreOperationRefreshTrait.php +++ b/Core/src/Testing/DatastoreOperationRefreshTrait.php @@ -19,7 +19,6 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\RequestHandler; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Operation; use Google\Cloud\Datastore\V1\Client\DatastoreClient; @@ -37,7 +36,6 @@ trait DatastoreOperationRefreshTrait * Refresh the operation property of a given stubbed class. * * @param mixed $stub - * @param ConnectionInterface $connection * @param RequestHandler $requestHandler * @param array $options { * Configuration Options @@ -48,7 +46,7 @@ trait DatastoreOperationRefreshTrait * } * @return mixed */ - public function refreshOperation($stub, ConnectionInterface $connection, RequestHandler $requestHandler, array $options = []) + public function refreshOperation($stub, RequestHandler $requestHandler, array $options = []) { $options += [ 'projectId' => null, @@ -80,7 +78,6 @@ public function refreshOperation($stub, ConnectionInterface $connection, Request ]); $stub->___setProperty('operation', new Operation( - $connection, $requestHandler, $serializer, $options['projectId'], diff --git a/Datastore/src/Connection/ConnectionInterface.php b/Datastore/src/Connection/ConnectionInterface.php deleted file mode 100644 index 6a1a9ebbd3fa..000000000000 --- a/Datastore/src/Connection/ConnectionInterface.php +++ /dev/null @@ -1,62 +0,0 @@ - null - ]; - - //@codeCoverageIgnoreStart - $this->serializer = new Serializer([], [ - 'google.protobuf.Value' => function ($v) { - return $this->flattenValue($v); - }, - 'google.protobuf.Timestamp' => function ($v) { - return $this->formatTimestampFromApi($v); - } - ], [], [ - 'google.protobuf.Timestamp' => function ($v) { - if (is_string($v)) { - $dt = new \DateTime($v); - return ['seconds' => $dt->format('U')]; - } - return $v; - } - ]); - //@codeCoverageIgnoreEnd - - $config['serializer'] = $this->serializer; - $this->setRequestWrapper(new GrpcRequestWrapper($config)); - $grpcConfig = $this->getGaxConfig( - ManualDatastoreClient::VERSION, - isset($config['authHttpHandler']) - ? $config['authHttpHandler'] - : null - ); - - if (isset($config['apiEndpoint'])) { - $grpcConfig['apiEndpoint'] = $config['apiEndpoint']; - } - - if ((bool) $config['emulatorHost']) { - $grpcConfig = array_merge( - $grpcConfig, - $this->emulatorGapicConfig($config['emulatorHost']) - ); - } - - $this->datastoreClient = $config['gapicDatastoreClient'] - ?? $this->constructGapic(DatastoreClient::class, $grpcConfig); - } - - /** - * @param array $args - */ - public function allocateIds(array $args) - { - $keys = $this->pluck('keys', $args); - - return $this->send([$this->datastoreClient, 'allocateIds'], [ - $this->pluck('projectId', $args), - $this->keysList($keys), - $args - ]); - } - - /** - * @param array $args - */ - public function beginTransaction(array $args) - { - if (isset($args['transactionOptions'])) { - array_walk($args['transactionOptions'], function (&$item) { - if ($item instanceof \stdClass) { - $item = []; - } - }); - - $args['transactionOptions'] = $this->serializer->decodeMessage( - new TransactionOptions, - $args['transactionOptions'] - ); - } - - return $this->send([$this->datastoreClient, 'beginTransaction'], [ - $this->pluck('projectId', $args), - $args - ]); - } - - /** - * @param array $args - */ - public function commit(array $args) - { - $mode = $this->pluck('mode', $args) === 'TRANSACTIONAL' - ? Mode::TRANSACTIONAL - : Mode::NON_TRANSACTIONAL; - - $mutations = $this->pluck('mutations', $args); - foreach ($mutations as &$mutation) { - $mutationType = array_keys($mutation)[0]; - $data = $mutation[$mutationType]; - if (isset($data['properties'])) { - foreach ($data['properties'] as &$property) { - list ($type, $val) = $this->toGrpcValue($property); - - $property[$type] = $val; - } - } - - $mutation[$mutationType] = $data; - - $mutation = $this->serializer->decodeMessage(new Mutation, $mutation); - } - - return $this->send([$this->datastoreClient, 'commit'], [ - $this->pluck('projectId', $args), - $mode, - $mutations, - $args - ]); - } - - /** - * @param array $args - */ - public function lookup(array $args) - { - $keys = $this->pluck('keys', $args); - - if (isset($args['readOptions'])) { - $args['readOptions'] = $this->readOptions($args['readOptions']); - } - - return $this->send([$this->datastoreClient, 'lookup'], [ - $this->pluck('projectId', $args), - $this->keysList($keys), - $args - ]); - } - - /** - * @param array $args - */ - public function rollback(array $args) - { - return $this->send([$this->datastoreClient, 'rollback'], [ - $this->pluck('projectId', $args), - $this->pluck('transaction', $args), - $args - ]); - } - - /** - * @param array $args - */ - public function runAggregationQuery(array $args) - { - $partitionId = $this->serializer->decodeMessage( - new PartitionId(), - $this->pluck('partitionId', $args) - ); - $args['partitionId'] = $partitionId; - - if (isset($args['readOptions'])) { - $args['readOptions'] = $this->readOptions($args['readOptions']); - } - - if (isset($args['aggregationQuery'])) { - if (isset($args['aggregationQuery']['nestedQuery'])) { - $args['aggregationQuery']['nestedQuery'] = $this->parseQuery( - $args['aggregationQuery']['nestedQuery'] - ); - } - - $args['aggregationQuery'] = $this->serializer->decodeMessage( - new AggregationQuery, - $args['aggregationQuery'] - ); - } - - if (isset($args['gqlQuery'])) { - $args['gqlQuery'] = $this->parseGqlQuery($args['gqlQuery']); - } - - return $this->send([$this->datastoreClient, 'runAggregationQuery'], [ - $this->pluck('projectId', $args), - $args - ]); - } - - /** - * @param array $args - */ - public function runQuery(array $args) - { - $partitionId = $this->serializer->decodeMessage( - new PartitionId, - $this->pluck('partitionId', $args) - ); - - if (isset($args['readOptions'])) { - $args['readOptions'] = $this->readOptions($args['readOptions']); - } - - if (isset($args['query'])) { - $args['query'] = $this->parseQuery($args['query']); - } - - if (isset($args['gqlQuery'])) { - $args['gqlQuery'] = $this->parseGqlQuery($args['gqlQuery']); - } - - return $this->send([$this->datastoreClient, 'runQuery'], [ - $this->pluck('projectId', $args), - $partitionId, - $args - ]); - } - - /** - * Convert array representation of Query to {@see Google\Cloud\Datastore\V1\Query}. - * - * @param array $query - * @return Query - */ - private function parseQuery(array $query) - { - if (isset($query['order'])) { - foreach ($query['order'] as &$order) { - $order['direction'] = $order['direction'] === 'ASCENDING' - ? Direction::ASCENDING - : Direction::DESCENDING; - } - } - - if (isset($query['filter'])) { - $query['filter'] = $this->convertFilterProps($query['filter']); - } - - if (isset($query['limit']) && !is_array($query['limit'])) { - $query['limit'] = [ - 'value' => $query['limit'] - ]; - } - - $parsedQuery = $this->serializer->decodeMessage( - new Query, - $query - ); - return $parsedQuery; - } - - /** - * Convert array representation of GqlQuery to {@see Google\Cloud\Datastore\V1\GqlQuery}. - * - * @param array $gqlQuery - * @return GqlQuery - */ - private function parseGqlQuery(array $gqlQuery) - { - if (isset($gqlQuery['namedBindings'])) { - foreach ($gqlQuery['namedBindings'] as $name => &$binding) { - if (!isset($binding['value'])) { - continue; - } - - $binding = $this->prepareQueryBinding($binding); - } - } - - if (isset($gqlQuery['positionalBindings'])) { - foreach ($gqlQuery['positionalBindings'] as &$binding) { - if (!isset($binding['value'])) { - continue; - } - - $binding = $this->prepareQueryBinding($binding); - } - } - - $parsedGqlQuery = $this->serializer->decodeMessage( - new GqlQuery, - $gqlQuery - ); - - return $parsedGqlQuery; - } - - /** - * Convert a list of keys to a list of {@see Google\Cloud\Datastore\V1\Key}. - * - * @param array[] $keys - * @return Key[] - */ - private function keysList(array $keys) - { - $out = []; - foreach ($keys as $key) { - $local = []; - - if (isset($key['partitionId'])) { - $p = $this->arrayFilterRemoveNull([ - 'project_id' => isset($key['partitionId']['projectId']) - ? $key['partitionId']['projectId'] - : null, - 'namespace_id' => isset($key['partitionId']['namespaceId']) - ? $key['partitionId']['namespaceId'] - : null, - 'database_id' => isset($key['partitionId']['databaseId']) - ? $key['partitionId']['databaseId'] - : null, - ]); - - $local['partition_id'] = new PartitionId($p); - } - - $local['path'] = []; - if (isset($key['path'])) { - foreach ($key['path'] as $element) { - $local['path'][] = new PathElement($element); - } - } - - $out[] = new Key($local); - } - - return $out; - } - - /** - * Convert a query binding to an API-compatible value. - * - * @param array $binding The input binding data - * @return array - */ - private function prepareQueryBinding(array $binding) - { - $value = $binding['value']; - - list ($type, $val) = $this->toGrpcValue($value); - - $binding['value'][$type] = $val; - - return $binding; - } - - /** - * Convert read options into an API-compatible value. - * - * @param array $readOptions The input readOptions data. - * @return array - */ - private function readOptions(array $readOptions) - { - if (isset($readOptions['readConsistency'])) { - switch ($readOptions['readConsistency']) { - case 'STRONG': - $readOptions['readConsistency'] = ReadConsistency::STRONG; - break; - - case 'EVENTUAL': - $readOptions['readConsistency'] = ReadConsistency::EVENTUAL; - break; - - default: - //@codeCoverageIgnoreStart - throw new \InvalidArgumentException('Invalid value for Read Consistency.'); - break; - //@codeCoverageIgnoreEnd - } - } - - return $this->serializer->decodeMessage( - new ReadOptions, - $readOptions - ); - } - - /** - * Convert Query filters to an API-compatible value. - * - * @param array $filter The input filter data - * @return array - */ - private function convertFilterProps(array $filter) - { - if (isset($filter['propertyFilter'])) { - $operator = $filter['propertyFilter']['op']; - - try { - if (is_int($operator)) { - // verify that the operator, given as enum value, exists. - PropertyFilterOperator::name($operator); - } else { - // convert the operator, given as a string, to a grpc value. - $operator = PropertyFilterOperator::value($operator); - } - } catch (\UnexpectedValueException $e) { - throw new \InvalidArgumentException($e->getMessage()); - } - - $filter['propertyFilter']['op'] = $operator; - } - - if (isset($filter['compositeFilter'])) { - if ($filter['compositeFilter']['op'] == 'AND') { - $filter['compositeFilter']['op'] = CompositeFilterOperator::PBAND; - } elseif ($filter['compositeFilter']['op'] == 'OR') { - $filter['compositeFilter']['op'] = CompositeFilterOperator::PBOR; - } else { - $filter['compositeFilter']['op'] = CompositeFilterOperator::OPERATOR_UNSPECIFIED; - } - foreach ($filter['compositeFilter']['filters'] as &$nested) { - $nested = $this->convertFilterProps($nested); - } - } - - return $filter; - } - - /** - * Convert a property value to a gRPC value. - * - * @param array $property The input property. - * @return array - */ - private function toGrpcValue(array $property) - { - $type = array_keys($property)[0]; - $val = $property[$type]; - if ($val === null) { - $val = NullValue::NULL_VALUE; - } - - if ($type === 'timestampValue') { - $val = $this->formatTimestampForApi($val); - } - - if ($type === 'geoPointValue') { - $val = $this->arrayFilterRemoveNull($val); - } - - return [$type, $val]; - } -} diff --git a/Datastore/src/Connection/Rest.php b/Datastore/src/Connection/Rest.php deleted file mode 100644 index 69e47c27a7ca..000000000000 --- a/Datastore/src/Connection/Rest.php +++ /dev/null @@ -1,162 +0,0 @@ - null]; - - $baseUri = $this->getApiEndpoint(self::BASE_URI, $config); - if ((bool) $config['emulatorHost']) { - // @codeCoverageIgnoreStart - $baseUri = $this->emulatorBaseUri($config['emulatorHost']); - $config['shouldSignRequest'] = false; - // @codeCoverageIgnoreEnd - } - - $config += [ - 'serviceDefinitionPath' => __DIR__ . '/ServiceDefinition/datastore-v1.json', - 'componentVersion' => DatastoreClient::VERSION - ]; - - $this->setRequestWrapper(new RequestWrapper($config)); - $this->setRequestBuilder(new RequestBuilder( - $config['serviceDefinitionPath'], - $baseUri - )); - } - - /** - * @param array $args - * @return array - */ - public function allocateIds(array $args) - { - return $this->sendWithHeaders('projects', 'allocateIds', $args); - } - - /** - * @param array $args - * @return array - */ - public function beginTransaction(array $args) - { - return $this->sendWithHeaders('projects', 'beginTransaction', $args); - } - - /** - * @param array $args - * @return array - */ - public function commit(array $args) - { - return $this->sendWithHeaders('projects', 'commit', $args); - } - - /** - * @param array $args - * @return array - */ - public function lookup(array $args) - { - return $this->sendWithHeaders('projects', 'lookup', $args); - } - - /** - * @param array $args - * @return array - */ - public function rollback(array $args) - { - return $this->sendWithHeaders('projects', 'rollback', $args); - } - - /** - * @param array $args - * @return array - */ - public function runQuery(array $args) - { - return $this->sendWithHeaders('projects', 'runQuery', $args); - } - - /** - * @param array $args - * @return array - */ - public function runAggregationQuery(array $args) - { - if (isset($args['aggregationQuery']['aggregations'])) { - foreach ($args['aggregationQuery']['aggregations'] as &$aggregation) { - $aggregation = array_map( - fn ($item) => is_array($item) && count($item) === 0 - ? new \stdClass - : $item, - $aggregation - ); - } - } - return $this->sendWithHeaders('projects', 'runAggregationQuery', $args); - } - - /** - * Deliver the request built from serice definition. - * Also apply the `x-goog-request-params` header to the request. This header - * is required for operations involving a non-default databases. - * - * @param string $resource The resource type used for the request. - * @param string $method The method used for the request. - * @param array $args Options used to build out the request. - */ - private function sendWithHeaders($resource, $method, $args) - { - if (isset($args['projectId']) && isset($args['databaseId'])) { - $args['restOptions']['headers']['x-goog-request-params'] = sprintf( - 'project_id=%s&database_id=%s', - $args['projectId'], - $args['databaseId'] - ); - } - - return $this->send($resource, $method, $args); - } -} diff --git a/Datastore/src/Connection/ServiceDefinition/datastore-v1.json b/Datastore/src/Connection/ServiceDefinition/datastore-v1.json deleted file mode 100644 index 625ea41bff5b..000000000000 --- a/Datastore/src/Connection/ServiceDefinition/datastore-v1.json +++ /dev/null @@ -1,2522 +0,0 @@ -{ - "mtlsRootUrl": "https://datastore.mtls.googleapis.com/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "servicePath": "", - "schemas": { - "GoogleLongrunningListOperationsResponse": { - "id": "GoogleLongrunningListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "GoogleLongrunningOperation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - } - }, - "GoogleLongrunningOperation": { - "id": "GoogleLongrunningOperation", - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object", - "properties": { - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } - }, - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "response": { - "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } - } - } - }, - "Status": { - "id": "Status", - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "type": "object", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "type": "integer", - "format": "int32" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } - } - } - } - }, - "Empty": { - "id": "Empty", - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "type": "object", - "properties": {} - }, - "GoogleDatastoreAdminV1ExportEntitiesRequest": { - "id": "GoogleDatastoreAdminV1ExportEntitiesRequest", - "description": "The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.", - "type": "object", - "properties": { - "labels": { - "description": "Client-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "entityFilter": { - "description": "Description of what data from the project is included in the export.", - "$ref": "GoogleDatastoreAdminV1EntityFilter" - }, - "outputUrlPrefix": { - "description": "Required. Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1EntityFilter": { - "id": "GoogleDatastoreAdminV1EntityFilter", - "description": "Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']", - "type": "object", - "properties": { - "kinds": { - "description": "If empty, then this represents all kinds.", - "type": "array", - "items": { - "type": "string" - } - }, - "namespaceIds": { - "description": "An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleDatastoreAdminV1ImportEntitiesRequest": { - "id": "GoogleDatastoreAdminV1ImportEntitiesRequest", - "description": "The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.", - "type": "object", - "properties": { - "labels": { - "description": "Client-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "inputUrl": { - "description": "Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.", - "type": "string" - }, - "entityFilter": { - "description": "Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.", - "$ref": "GoogleDatastoreAdminV1EntityFilter" - } - } - }, - "GoogleDatastoreAdminV1Index": { - "id": "GoogleDatastoreAdminV1Index", - "description": "Datastore composite index definition.", - "type": "object", - "properties": { - "projectId": { - "description": "Output only. Project ID.", - "readOnly": true, - "type": "string" - }, - "indexId": { - "description": "Output only. The resource ID of the index.", - "readOnly": true, - "type": "string" - }, - "kind": { - "description": "Required. The entity kind to which this index applies.", - "type": "string" - }, - "ancestor": { - "description": "Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.", - "type": "string", - "enumDescriptions": [ - "The ancestor mode is unspecified.", - "Do not include the entity's ancestors in the index.", - "Include all the entity's ancestors in the index." - ], - "enum": [ - "ANCESTOR_MODE_UNSPECIFIED", - "NONE", - "ALL_ANCESTORS" - ] - }, - "properties": { - "description": "Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.", - "type": "array", - "items": { - "$ref": "GoogleDatastoreAdminV1IndexedProperty" - } - }, - "state": { - "description": "Output only. The state of the index.", - "readOnly": true, - "type": "string", - "enumDescriptions": [ - "The state is unspecified.", - "The index is being created, and cannot be used by queries. There is an active long-running operation for the index. The index is updated when writing an entity. Some index data may exist.", - "The index is ready to be used. The index is updated when writing an entity. The index is fully populated from all stored entities it applies to.", - "The index is being deleted, and cannot be used by queries. There is an active long-running operation for the index. The index is not updated when writing an entity. Some index data may exist.", - "The index was being created or deleted, but something went wrong. The index cannot by used by queries. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing an entity. Some index data may exist." - ], - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "READY", - "DELETING", - "ERROR" - ] - } - } - }, - "GoogleDatastoreAdminV1IndexedProperty": { - "id": "GoogleDatastoreAdminV1IndexedProperty", - "description": "A property of an index.", - "type": "object", - "properties": { - "name": { - "description": "Required. The property name to index.", - "type": "string" - }, - "direction": { - "description": "Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.", - "type": "string", - "enumDescriptions": [ - "The direction is unspecified.", - "The property's values are indexed so as to support sequencing in ascending order and also query by \u003c, \u003e, \u003c=, \u003e=, and =.", - "The property's values are indexed so as to support sequencing in descending order and also query by \u003c, \u003e, \u003c=, \u003e=, and =." - ], - "enum": [ - "DIRECTION_UNSPECIFIED", - "ASCENDING", - "DESCENDING" - ] - } - } - }, - "GoogleDatastoreAdminV1ListIndexesResponse": { - "id": "GoogleDatastoreAdminV1ListIndexesResponse", - "description": "The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.", - "type": "object", - "properties": { - "indexes": { - "description": "The indexes.", - "type": "array", - "items": { - "$ref": "GoogleDatastoreAdminV1Index" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - } - }, - "LookupRequest": { - "id": "LookupRequest", - "description": "The request for Datastore.Lookup.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "readOptions": { - "description": "The options for this lookup request.", - "$ref": "ReadOptions" - }, - "keys": { - "description": "Required. Keys of entities to look up.", - "type": "array", - "items": { - "$ref": "Key" - } - } - } - }, - "ReadOptions": { - "id": "ReadOptions", - "description": "The options shared by read requests.", - "type": "object", - "properties": { - "readConsistency": { - "description": "The non-transactional read consistency to use.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Strong consistency.", - "Eventual consistency." - ], - "enum": [ - "READ_CONSISTENCY_UNSPECIFIED", - "STRONG", - "EVENTUAL" - ] - }, - "transaction": { - "description": "The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.", - "type": "string", - "format": "byte" - }, - "newTransaction": { - "description": "Options for beginning a new transaction for this request. The new transaction identifier will be returned in the corresponding response as either LookupResponse.transaction or RunQueryResponse.transaction.", - "$ref": "TransactionOptions" - }, - "readTime": { - "description": "Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", - "type": "string", - "format": "google-datetime" - } - } - }, - "TransactionOptions": { - "id": "TransactionOptions", - "description": "Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.", - "type": "object", - "properties": { - "readWrite": { - "description": "The transaction should allow both reads and writes.", - "$ref": "ReadWrite" - }, - "readOnly": { - "description": "The transaction should only allow reads.", - "$ref": "ReadOnly" - } - } - }, - "ReadWrite": { - "id": "ReadWrite", - "description": "Options specific to read / write transactions.", - "type": "object", - "properties": { - "previousTransaction": { - "description": "The transaction identifier of the transaction being retried.", - "type": "string", - "format": "byte" - } - } - }, - "ReadOnly": { - "id": "ReadOnly", - "description": "Options specific to read-only transactions.", - "type": "object", - "properties": { - "readTime": { - "description": "Reads entities at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", - "type": "string", - "format": "google-datetime" - } - } - }, - "Key": { - "id": "Key", - "description": "A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.", - "type": "object", - "properties": { - "partitionId": { - "description": "Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.", - "$ref": "PartitionId" - }, - "path": { - "description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.", - "type": "array", - "items": { - "$ref": "PathElement" - } - } - } - }, - "PartitionId": { - "id": "PartitionId", - "description": "A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `\"\"`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.", - "type": "object", - "properties": { - "projectId": { - "description": "The ID of the project to which the entities belong.", - "type": "string" - }, - "databaseId": { - "description": "If not empty, the ID of the database to which the entities belong.", - "type": "string" - }, - "namespaceId": { - "description": "If not empty, the ID of the namespace to which the entities belong.", - "type": "string" - } - } - }, - "PathElement": { - "id": "PathElement", - "description": "A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.", - "type": "object", - "properties": { - "kind": { - "description": "The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes.", - "type": "string" - }, - "id": { - "description": "The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.", - "type": "string", - "format": "int64" - }, - "name": { - "description": "The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes.", - "type": "string" - } - } - }, - "LookupResponse": { - "id": "LookupResponse", - "description": "The response for Datastore.Lookup.", - "type": "object", - "properties": { - "found": { - "description": "Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.", - "type": "array", - "items": { - "$ref": "EntityResult" - } - }, - "missing": { - "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.", - "type": "array", - "items": { - "$ref": "EntityResult" - } - }, - "deferred": { - "description": "A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.", - "type": "array", - "items": { - "$ref": "Key" - } - }, - "transaction": { - "description": "The identifier of the transaction that was started as part of this Lookup request. Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.", - "type": "string", - "format": "byte" - }, - "readTime": { - "description": "The time at which these entities were read or found missing.", - "type": "string", - "format": "google-datetime" - } - } - }, - "EntityResult": { - "id": "EntityResult", - "description": "The result of fetching an entity from Datastore.", - "type": "object", - "properties": { - "entity": { - "description": "The resulting entity.", - "$ref": "Entity" - }, - "version": { - "description": "The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.", - "type": "string", - "format": "int64" - }, - "createTime": { - "description": "The time at which the entity was created. This field is set for `FULL` entity results. If this entity is missing, this field will not be set.", - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set.", - "type": "string", - "format": "google-datetime" - }, - "cursor": { - "description": "A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.", - "type": "string", - "format": "byte" - } - } - }, - "Entity": { - "id": "Entity", - "description": "A Datastore data object. Must not exceed 1 MiB - 4 bytes.", - "type": "object", - "properties": { - "key": { - "description": "The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.", - "$ref": "Key" - }, - "properties": { - "description": "The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.", - "type": "object", - "additionalProperties": { - "$ref": "Value" - } - } - } - }, - "Value": { - "id": "Value", - "description": "A message that can hold any of the supported value types and associated metadata.", - "type": "object", - "properties": { - "nullValue": { - "description": "A null value.", - "type": "string", - "enumDescriptions": [ - "Null value." - ], - "enum": [ - "NULL_VALUE" - ] - }, - "booleanValue": { - "description": "A boolean value.", - "type": "boolean" - }, - "integerValue": { - "description": "An integer value.", - "type": "string", - "format": "int64" - }, - "doubleValue": { - "description": "A double value.", - "type": "number", - "format": "double" - }, - "timestampValue": { - "description": "A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.", - "type": "string", - "format": "google-datetime" - }, - "keyValue": { - "description": "A key value.", - "$ref": "Key" - }, - "stringValue": { - "description": "A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.", - "type": "string" - }, - "blobValue": { - "description": "A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.", - "type": "string", - "format": "byte" - }, - "geoPointValue": { - "description": "A geo point value representing a point on the surface of Earth.", - "$ref": "LatLng" - }, - "entityValue": { - "description": "An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.", - "$ref": "Entity" - }, - "arrayValue": { - "description": "An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.", - "$ref": "ArrayValue" - }, - "meaning": { - "description": "The `meaning` field should only be populated for backwards compatibility.", - "type": "integer", - "format": "int32" - }, - "excludeFromIndexes": { - "description": "If the value should be excluded from all indexes including those defined explicitly.", - "type": "boolean" - } - } - }, - "LatLng": { - "id": "LatLng", - "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.", - "type": "object", - "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "type": "number", - "format": "double" - }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "type": "number", - "format": "double" - } - } - }, - "ArrayValue": { - "id": "ArrayValue", - "description": "An array value.", - "type": "object", - "properties": { - "values": { - "description": "Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.", - "type": "array", - "items": { - "$ref": "Value" - } - } - } - }, - "RunQueryRequest": { - "id": "RunQueryRequest", - "description": "The request for Datastore.RunQuery.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "partitionId": { - "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.", - "$ref": "PartitionId" - }, - "readOptions": { - "description": "The options for this query.", - "$ref": "ReadOptions" - }, - "query": { - "description": "The query to run.", - "$ref": "Query" - }, - "gqlQuery": { - "description": "The GQL query to run. This query must be a non-aggregation query.", - "$ref": "GqlQuery" - } - } - }, - "Query": { - "id": "Query", - "description": "A query for entities.", - "type": "object", - "properties": { - "projection": { - "description": "The projection to return. Defaults to returning all properties.", - "type": "array", - "items": { - "$ref": "Projection" - } - }, - "kind": { - "description": "The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.", - "type": "array", - "items": { - "$ref": "KindExpression" - } - }, - "filter": { - "description": "The filter to apply.", - "$ref": "Filter" - }, - "order": { - "description": "The order to apply to the query results (if empty, order is unspecified).", - "type": "array", - "items": { - "$ref": "PropertyOrder" - } - }, - "distinctOn": { - "description": "The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.", - "type": "array", - "items": { - "$ref": "PropertyReference" - } - }, - "startCursor": { - "description": "A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).", - "type": "string", - "format": "byte" - }, - "endCursor": { - "description": "An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).", - "type": "string", - "format": "byte" - }, - "offset": { - "description": "The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be \u003e= 0 if specified.", - "type": "integer", - "format": "int32" - }, - "limit": { - "description": "The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be \u003e= 0 if specified.", - "type": "integer", - "format": "int32" - } - } - }, - "Projection": { - "id": "Projection", - "description": "A representation of a property in a projection.", - "type": "object", - "properties": { - "property": { - "description": "The property to project.", - "$ref": "PropertyReference" - } - } - }, - "PropertyReference": { - "id": "PropertyReference", - "description": "A reference to a property relative to the kind expressions.", - "type": "object", - "properties": { - "name": { - "description": "A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations.", - "type": "string" - } - } - }, - "KindExpression": { - "id": "KindExpression", - "description": "A representation of a kind.", - "type": "object", - "properties": { - "name": { - "description": "The name of the kind.", - "type": "string" - } - } - }, - "Filter": { - "id": "Filter", - "description": "A holder for any type of filter.", - "type": "object", - "properties": { - "compositeFilter": { - "description": "A composite filter.", - "$ref": "CompositeFilter" - }, - "propertyFilter": { - "description": "A filter on a property.", - "$ref": "PropertyFilter" - } - } - }, - "CompositeFilter": { - "id": "CompositeFilter", - "description": "A filter that merges multiple other filters using the given operator.", - "type": "object", - "properties": { - "op": { - "description": "The operator for combining multiple filters.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "The results are required to satisfy each of the combined filters.", - "Documents are required to satisfy at least one of the combined filters." - ], - "enum": [ - "OPERATOR_UNSPECIFIED", - "AND", - "OR" - ] - }, - "filters": { - "description": "The list of filters to combine. Requires: * At least one filter is present.", - "type": "array", - "items": { - "$ref": "Filter" - } - } - } - }, - "PropertyFilter": { - "id": "PropertyFilter", - "description": "A filter on a specific property.", - "type": "object", - "properties": { - "property": { - "description": "The property to filter by.", - "$ref": "PropertyReference" - }, - "op": { - "description": "The operator to filter by.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "The given `property` is less than the given `value`. Requires: * That `property` comes first in `order_by`.", - "The given `property` is less than or equal to the given `value`. Requires: * That `property` comes first in `order_by`.", - "The given `property` is greater than the given `value`. Requires: * That `property` comes first in `order_by`.", - "The given `property` is greater than or equal to the given `value`. Requires: * That `property` comes first in `order_by`.", - "The given `property` is equal to the given `value`.", - "The given `property` is equal to at least one value in the given array. Requires: * That `value` is a non-empty `ArrayValue`, subject to disjunction limits. * No `NOT_IN` is in the same query.", - "The given `property` is not equal to the given `value`. Requires: * No other `NOT_EQUAL` or `NOT_IN` is in the same query. * That `property` comes first in the `order_by`.", - "Limit the result set to the given entity and its descendants. Requires: * That `value` is an entity key. * All evaluated disjunctions must have the same `HAS_ANCESTOR` filter.", - "The value of the `property` is not in the given array. Requires: * That `value` is a non-empty `ArrayValue` with at most 10 values. * No other `OR`, `IN`, `NOT_IN`, `NOT_EQUAL` is in the same query. * That `field` comes first in the `order_by`." - ], - "enum": [ - "OPERATOR_UNSPECIFIED", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "EQUAL", - "IN", - "NOT_EQUAL", - "HAS_ANCESTOR", - "NOT_IN" - ] - }, - "value": { - "description": "The value to compare the property to.", - "$ref": "Value" - } - } - }, - "PropertyOrder": { - "id": "PropertyOrder", - "description": "The desired order for a specific property.", - "type": "object", - "properties": { - "property": { - "description": "The property to order by.", - "$ref": "PropertyReference" - }, - "direction": { - "description": "The direction to order by. Defaults to `ASCENDING`.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Ascending.", - "Descending." - ], - "enum": [ - "DIRECTION_UNSPECIFIED", - "ASCENDING", - "DESCENDING" - ] - } - } - }, - "GqlQuery": { - "id": "GqlQuery", - "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", - "type": "object", - "properties": { - "queryString": { - "description": "A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", - "type": "string" - }, - "allowLiterals": { - "description": "When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.", - "type": "boolean" - }, - "namedBindings": { - "description": "For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `\"\"`.", - "type": "object", - "additionalProperties": { - "$ref": "GqlQueryParameter" - } - }, - "positionalBindings": { - "description": "Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.", - "type": "array", - "items": { - "$ref": "GqlQueryParameter" - } - } - } - }, - "GqlQueryParameter": { - "id": "GqlQueryParameter", - "description": "A binding parameter for a GQL query.", - "type": "object", - "properties": { - "value": { - "description": "A value parameter.", - "$ref": "Value" - }, - "cursor": { - "description": "A query cursor. Query cursors are returned in query result batches.", - "type": "string", - "format": "byte" - } - } - }, - "RunQueryResponse": { - "id": "RunQueryResponse", - "description": "The response for Datastore.RunQuery.", - "type": "object", - "properties": { - "batch": { - "description": "A batch of query results (always present).", - "$ref": "QueryResultBatch" - }, - "query": { - "description": "The parsed form of the `GqlQuery` from the request, if it was set.", - "$ref": "Query" - }, - "transaction": { - "description": "The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.", - "type": "string", - "format": "byte" - } - } - }, - "QueryResultBatch": { - "id": "QueryResultBatch", - "description": "A batch of results produced by a query.", - "type": "object", - "properties": { - "skippedResults": { - "description": "The number of results skipped, typically because of an offset.", - "type": "integer", - "format": "int32" - }, - "skippedCursor": { - "description": "A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.", - "type": "string", - "format": "byte" - }, - "entityResultType": { - "description": "The result type for every entity in `entity_results`.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value is never used.", - "The key and properties.", - "A projected subset of properties. The entity may have no key.", - "Only the key." - ], - "enum": [ - "RESULT_TYPE_UNSPECIFIED", - "FULL", - "PROJECTION", - "KEY_ONLY" - ] - }, - "entityResults": { - "description": "The results for this batch.", - "type": "array", - "items": { - "$ref": "EntityResult" - } - }, - "endCursor": { - "description": "A cursor that points to the position after the last result in the batch.", - "type": "string", - "format": "byte" - }, - "moreResults": { - "description": "The state of the query after the current batch.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value is never used.", - "There may be additional batches to fetch from this query.", - "The query is finished, but there may be more results after the limit.", - "The query is finished, but there may be more results after the end cursor.", - "The query is finished, and there are no more results." - ], - "enum": [ - "MORE_RESULTS_TYPE_UNSPECIFIED", - "NOT_FINISHED", - "MORE_RESULTS_AFTER_LIMIT", - "MORE_RESULTS_AFTER_CURSOR", - "NO_MORE_RESULTS" - ] - }, - "snapshotVersion": { - "description": "The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.", - "type": "string", - "format": "int64" - }, - "readTime": { - "description": "Read timestamp this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.", - "type": "string", - "format": "google-datetime" - } - } - }, - "RunAggregationQueryRequest": { - "id": "RunAggregationQueryRequest", - "description": "The request for Datastore.RunAggregationQuery.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "partitionId": { - "description": "Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.", - "$ref": "PartitionId" - }, - "readOptions": { - "description": "The options for this query.", - "$ref": "ReadOptions" - }, - "aggregationQuery": { - "description": "The query to run.", - "$ref": "AggregationQuery" - }, - "gqlQuery": { - "description": "The GQL query to run. This query must be an aggregation query.", - "$ref": "GqlQuery" - } - } - }, - "AggregationQuery": { - "id": "AggregationQuery", - "description": "Datastore query for running an aggregation over a Query.", - "type": "object", - "properties": { - "nestedQuery": { - "description": "Nested query for aggregation", - "$ref": "Query" - }, - "aggregations": { - "description": "Optional. Series of aggregations to apply over the results of the `nested_query`. Requires: * A minimum of one and maximum of five aggregations per query.", - "type": "array", - "items": { - "$ref": "Aggregation" - } - } - } - }, - "Aggregation": { - "id": "Aggregation", - "description": "Defines an aggregation that produces a single result.", - "type": "object", - "properties": { - "count": { - "description": "Count aggregator.", - "$ref": "Count" - }, - "sum": { - "description": "Sum aggregator.", - "$ref": "Sum" - }, - "avg": { - "description": "Average aggregator.", - "$ref": "Avg" - }, - "alias": { - "description": "Optional. Optional name of the property to store the result of the aggregation. If not provided, Datastore will pick a default name following the format `property_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation aliases. * Conform to entity property name limitations.", - "type": "string" - } - } - }, - "Count": { - "id": "Count", - "description": "Count of entities that match the query. The `COUNT(*)` aggregation function operates on the entire entity so it does not require a field reference.", - "type": "object", - "properties": { - "upTo": { - "description": "Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be non-negative when present.", - "type": "string", - "format": "int64" - } - } - }, - "Sum": { - "id": "Sum", - "description": "Sum of the values of the requested property. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns 0. * Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision. * When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.", - "type": "object", - "properties": { - "property": { - "description": "The property to aggregate on.", - "$ref": "PropertyReference" - } - } - }, - "Avg": { - "id": "Avg", - "description": "Average of the values of the requested property. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns `NULL`. * Always returns the result as a double.", - "type": "object", - "properties": { - "property": { - "description": "The property to aggregate on.", - "$ref": "PropertyReference" - } - } - }, - "RunAggregationQueryResponse": { - "id": "RunAggregationQueryResponse", - "description": "The response for Datastore.RunAggregationQuery.", - "type": "object", - "properties": { - "batch": { - "description": "A batch of aggregation results. Always present.", - "$ref": "AggregationResultBatch" - }, - "query": { - "description": "The parsed form of the `GqlQuery` from the request, if it was set.", - "$ref": "AggregationQuery" - }, - "transaction": { - "description": "The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.", - "type": "string", - "format": "byte" - } - } - }, - "AggregationResultBatch": { - "id": "AggregationResultBatch", - "description": "A batch of aggregation results produced by an aggregation query.", - "type": "object", - "properties": { - "aggregationResults": { - "description": "The aggregation results for this batch.", - "type": "array", - "items": { - "$ref": "AggregationResult" - } - }, - "moreResults": { - "description": "The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to `NO_MORE_RESULTS`.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value is never used.", - "There may be additional batches to fetch from this query.", - "The query is finished, but there may be more results after the limit.", - "The query is finished, but there may be more results after the end cursor.", - "The query is finished, and there are no more results." - ], - "enum": [ - "MORE_RESULTS_TYPE_UNSPECIFIED", - "NOT_FINISHED", - "MORE_RESULTS_AFTER_LIMIT", - "MORE_RESULTS_AFTER_CURSOR", - "NO_MORE_RESULTS" - ] - }, - "readTime": { - "description": "Read timestamp this batch was returned from. In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.", - "type": "string", - "format": "google-datetime" - } - } - }, - "AggregationResult": { - "id": "AggregationResult", - "description": "The result of a single bucket from a Datastore aggregation query. The keys of `aggregate_properties` are the same for all results in an aggregation query, unlike entity queries which can have different fields present for each result.", - "type": "object", - "properties": { - "aggregateProperties": { - "description": "The result of the aggregation functions, ex: `COUNT(*) AS total_entities`. The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.", - "type": "object", - "additionalProperties": { - "$ref": "Value" - } - } - } - }, - "BeginTransactionRequest": { - "id": "BeginTransactionRequest", - "description": "The request for Datastore.BeginTransaction.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "transactionOptions": { - "description": "Options for a new transaction.", - "$ref": "TransactionOptions" - } - } - }, - "BeginTransactionResponse": { - "id": "BeginTransactionResponse", - "description": "The response for Datastore.BeginTransaction.", - "type": "object", - "properties": { - "transaction": { - "description": "The transaction identifier (always present).", - "type": "string", - "format": "byte" - } - } - }, - "CommitRequest": { - "id": "CommitRequest", - "description": "The request for Datastore.Commit.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "mode": { - "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Transactional: The mutations are either all applied, or none are applied. Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).", - "Non-transactional: The mutations may not apply as all or none." - ], - "enum": [ - "MODE_UNSPECIFIED", - "TRANSACTIONAL", - "NON_TRANSACTIONAL" - ] - }, - "transaction": { - "description": "The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.", - "type": "string", - "format": "byte" - }, - "singleUseTransaction": { - "description": "Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.", - "$ref": "TransactionOptions" - }, - "mutations": { - "description": "The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.", - "type": "array", - "items": { - "$ref": "Mutation" - } - } - } - }, - "Mutation": { - "id": "Mutation", - "description": "A mutation to apply to an entity.", - "type": "object", - "properties": { - "insert": { - "description": "The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.", - "$ref": "Entity" - }, - "update": { - "description": "The entity to update. The entity must already exist. Must have a complete key path.", - "$ref": "Entity" - }, - "upsert": { - "description": "The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.", - "$ref": "Entity" - }, - "delete": { - "description": "The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.", - "$ref": "Key" - }, - "baseVersion": { - "description": "The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.", - "type": "string", - "format": "int64" - }, - "updateTime": { - "description": "The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.", - "type": "string", - "format": "google-datetime" - } - } - }, - "CommitResponse": { - "id": "CommitResponse", - "description": "The response for Datastore.Commit.", - "type": "object", - "properties": { - "mutationResults": { - "description": "The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.", - "type": "array", - "items": { - "$ref": "MutationResult" - } - }, - "indexUpdates": { - "description": "The number of index entries updated during the commit, or zero if none were updated.", - "type": "integer", - "format": "int32" - }, - "commitTime": { - "description": "The transaction commit timestamp. Not set for non-transactional commits.", - "type": "string", - "format": "google-datetime" - } - } - }, - "MutationResult": { - "id": "MutationResult", - "description": "The result of applying a mutation.", - "type": "object", - "properties": { - "key": { - "description": "The automatically allocated key. Set only when the mutation allocated a key.", - "$ref": "Key" - }, - "version": { - "description": "The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.", - "type": "string", - "format": "int64" - }, - "createTime": { - "description": "The create time of the entity. This field will not be set after a 'delete'.", - "type": "string", - "format": "google-datetime" - }, - "updateTime": { - "description": "The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'.", - "type": "string", - "format": "google-datetime" - }, - "conflictDetected": { - "description": "Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.", - "type": "boolean" - } - } - }, - "RollbackRequest": { - "id": "RollbackRequest", - "description": "The request for Datastore.Rollback.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "transaction": { - "description": "Required. The transaction identifier, returned by a call to Datastore.BeginTransaction.", - "type": "string", - "format": "byte" - } - } - }, - "RollbackResponse": { - "id": "RollbackResponse", - "description": "The response for Datastore.Rollback. (an empty message).", - "type": "object", - "properties": {} - }, - "AllocateIdsRequest": { - "id": "AllocateIdsRequest", - "description": "The request for Datastore.AllocateIds.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "keys": { - "description": "Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.", - "type": "array", - "items": { - "$ref": "Key" - } - } - } - }, - "AllocateIdsResponse": { - "id": "AllocateIdsResponse", - "description": "The response for Datastore.AllocateIds.", - "type": "object", - "properties": { - "keys": { - "description": "The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.", - "type": "array", - "items": { - "$ref": "Key" - } - } - } - }, - "ReserveIdsRequest": { - "id": "ReserveIdsRequest", - "description": "The request for Datastore.ReserveIds.", - "type": "object", - "properties": { - "databaseId": { - "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", - "type": "string" - }, - "keys": { - "description": "Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.", - "type": "array", - "items": { - "$ref": "Key" - } - } - } - }, - "ReserveIdsResponse": { - "id": "ReserveIdsResponse", - "description": "The response for Datastore.ReserveIds.", - "type": "object", - "properties": {} - }, - "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", - "description": "Metadata for ExportEntities operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" - }, - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, - "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, - "entityFilter": { - "description": "Description of which entities are being exported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" - }, - "outputUrlPrefix": { - "description": "Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1beta1CommonMetadata": { - "id": "GoogleDatastoreAdminV1beta1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations.", - "type": "object", - "properties": { - "startTime": { - "description": "The time that work began on the operation.", - "type": "string", - "format": "google-datetime" - }, - "endTime": { - "description": "The time the operation ended, either successfully or otherwise.", - "type": "string", - "format": "google-datetime" - }, - "operationType": { - "description": "The type of the operation. Can be used as a filter in ListOperationsRequest.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "ExportEntities.", - "ImportEntities." - ], - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "EXPORT_ENTITIES", - "IMPORT_ENTITIES" - ] - }, - "labels": { - "description": "The client-assigned labels which were provided when the operation was created. May also include additional labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "state": { - "description": "The current state of the Operation.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Request is being prepared for processing.", - "Request is actively being processed.", - "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", - "Request has been processed and is in its finalization stage.", - "Request has completed successfully.", - "Request has finished being processed, but encountered an error.", - "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." - ], - "enum": [ - "STATE_UNSPECIFIED", - "INITIALIZING", - "PROCESSING", - "CANCELLING", - "FINALIZING", - "SUCCESSFUL", - "FAILED", - "CANCELLED" - ] - } - } - }, - "GoogleDatastoreAdminV1beta1Progress": { - "id": "GoogleDatastoreAdminV1beta1Progress", - "description": "Measures the progress of a particular metric.", - "type": "object", - "properties": { - "workCompleted": { - "description": "The amount of work that has been completed. Note that this may be greater than work_estimated.", - "type": "string", - "format": "int64" - }, - "workEstimated": { - "description": "An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleDatastoreAdminV1beta1EntityFilter": { - "id": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']", - "type": "object", - "properties": { - "kinds": { - "description": "If empty, then this represents all kinds.", - "type": "array", - "items": { - "type": "string" - } - }, - "namespaceIds": { - "description": "An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse", - "description": "The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", - "type": "object", - "properties": { - "outputUrl": { - "description": "Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { - "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", - "description": "Metadata for ImportEntities operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" - }, - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, - "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, - "entityFilter": { - "description": "Description of which entities are being imported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" - }, - "inputUrl": { - "description": "The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1ExportEntitiesMetadata": { - "id": "GoogleDatastoreAdminV1ExportEntitiesMetadata", - "description": "Metadata for ExportEntities operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1CommonMetadata" - }, - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1Progress" - }, - "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1Progress" - }, - "entityFilter": { - "description": "Description of which entities are being exported.", - "$ref": "GoogleDatastoreAdminV1EntityFilter" - }, - "outputUrlPrefix": { - "description": "Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1CommonMetadata": { - "id": "GoogleDatastoreAdminV1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations.", - "type": "object", - "properties": { - "startTime": { - "description": "The time that work began on the operation.", - "type": "string", - "format": "google-datetime" - }, - "endTime": { - "description": "The time the operation ended, either successfully or otherwise.", - "type": "string", - "format": "google-datetime" - }, - "operationType": { - "description": "The type of the operation. Can be used as a filter in ListOperationsRequest.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "ExportEntities.", - "ImportEntities.", - "CreateIndex.", - "DeleteIndex." - ], - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "EXPORT_ENTITIES", - "IMPORT_ENTITIES", - "CREATE_INDEX", - "DELETE_INDEX" - ] - }, - "labels": { - "description": "The client-assigned labels which were provided when the operation was created. May also include additional labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "state": { - "description": "The current state of the Operation.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Request is being prepared for processing.", - "Request is actively being processed.", - "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", - "Request has been processed and is in its finalization stage.", - "Request has completed successfully.", - "Request has finished being processed, but encountered an error.", - "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." - ], - "enum": [ - "STATE_UNSPECIFIED", - "INITIALIZING", - "PROCESSING", - "CANCELLING", - "FINALIZING", - "SUCCESSFUL", - "FAILED", - "CANCELLED" - ] - } - } - }, - "GoogleDatastoreAdminV1Progress": { - "id": "GoogleDatastoreAdminV1Progress", - "description": "Measures the progress of a particular metric.", - "type": "object", - "properties": { - "workCompleted": { - "description": "The amount of work that has been completed. Note that this may be greater than work_estimated.", - "type": "string", - "format": "int64" - }, - "workEstimated": { - "description": "An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.", - "type": "string", - "format": "int64" - } - } - }, - "GoogleDatastoreAdminV1ExportEntitiesResponse": { - "id": "GoogleDatastoreAdminV1ExportEntitiesResponse", - "description": "The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.", - "type": "object", - "properties": { - "outputUrl": { - "description": "Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1ImportEntitiesMetadata": { - "id": "GoogleDatastoreAdminV1ImportEntitiesMetadata", - "description": "Metadata for ImportEntities operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1CommonMetadata" - }, - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1Progress" - }, - "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1Progress" - }, - "entityFilter": { - "description": "Description of which entities are being imported.", - "$ref": "GoogleDatastoreAdminV1EntityFilter" - }, - "inputUrl": { - "description": "The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1IndexOperationMetadata": { - "id": "GoogleDatastoreAdminV1IndexOperationMetadata", - "description": "Metadata for Index operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1CommonMetadata" - }, - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1Progress" - }, - "indexId": { - "description": "The index resource ID that this operation is acting on.", - "type": "string" - } - } - }, - "GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata": { - "id": "GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata", - "description": "Metadata for Datastore to Firestore migration operations. The DatastoreFirestoreMigration operation is not started by the end-user via an explicit \"creation\" method. This is an intentional deviation from the LRO design pattern. This singleton resource can be accessed at: \"projects/{project_id}/operations/datastore-firestore-migration\"", - "type": "object", - "properties": { - "migrationState": { - "description": "The current state of migration from Cloud Datastore to Cloud Firestore in Datastore mode.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "The migration is running.", - "The migration is paused.", - "The migration is complete." - ], - "enum": [ - "MIGRATION_STATE_UNSPECIFIED", - "RUNNING", - "PAUSED", - "COMPLETE" - ] - }, - "migrationStep": { - "description": "The current step of migration from Cloud Datastore to Cloud Firestore in Datastore mode.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Pre-migration: the database is prepared for migration.", - "Start of migration.", - "Writes are applied synchronously to at least one replica.", - "Data is copied to Cloud Firestore and then verified to match the data in Cloud Datastore.", - "Eventually-consistent reads are redirected to Cloud Firestore.", - "Strongly-consistent reads are redirected to Cloud Firestore.", - "Writes are redirected to Cloud Firestore." - ], - "enum": [ - "MIGRATION_STEP_UNSPECIFIED", - "PREPARE", - "START", - "APPLY_WRITES_SYNCHRONOUSLY", - "COPY_AND_VERIFY", - "REDIRECT_EVENTUALLY_CONSISTENT_READS", - "REDIRECT_STRONGLY_CONSISTENT_READS", - "REDIRECT_WRITES" - ] - } - } - }, - "GoogleDatastoreAdminV1MigrationProgressEvent": { - "id": "GoogleDatastoreAdminV1MigrationProgressEvent", - "description": "An event signifying the start of a new step in a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).", - "type": "object", - "properties": { - "step": { - "description": "The step that is starting. An event with step set to `START` indicates that the migration has been reverted back to the initial pre-migration state.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Pre-migration: the database is prepared for migration.", - "Start of migration.", - "Writes are applied synchronously to at least one replica.", - "Data is copied to Cloud Firestore and then verified to match the data in Cloud Datastore.", - "Eventually-consistent reads are redirected to Cloud Firestore.", - "Strongly-consistent reads are redirected to Cloud Firestore.", - "Writes are redirected to Cloud Firestore." - ], - "enum": [ - "MIGRATION_STEP_UNSPECIFIED", - "PREPARE", - "START", - "APPLY_WRITES_SYNCHRONOUSLY", - "COPY_AND_VERIFY", - "REDIRECT_EVENTUALLY_CONSISTENT_READS", - "REDIRECT_STRONGLY_CONSISTENT_READS", - "REDIRECT_WRITES" - ] - }, - "prepareStepDetails": { - "description": "Details for the `PREPARE` step.", - "$ref": "GoogleDatastoreAdminV1PrepareStepDetails" - }, - "redirectWritesStepDetails": { - "description": "Details for the `REDIRECT_WRITES` step.", - "$ref": "GoogleDatastoreAdminV1RedirectWritesStepDetails" - } - } - }, - "GoogleDatastoreAdminV1PrepareStepDetails": { - "id": "GoogleDatastoreAdminV1PrepareStepDetails", - "description": "Details for the `PREPARE` step.", - "type": "object", - "properties": { - "concurrencyMode": { - "description": "The concurrency mode this database will use when it reaches the `REDIRECT_WRITES` step.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Pessimistic concurrency.", - "Optimistic concurrency.", - "Optimistic concurrency with entity groups." - ], - "enum": [ - "CONCURRENCY_MODE_UNSPECIFIED", - "PESSIMISTIC", - "OPTIMISTIC", - "OPTIMISTIC_WITH_ENTITY_GROUPS" - ] - } - } - }, - "GoogleDatastoreAdminV1RedirectWritesStepDetails": { - "id": "GoogleDatastoreAdminV1RedirectWritesStepDetails", - "description": "Details for the `REDIRECT_WRITES` step.", - "type": "object", - "properties": { - "concurrencyMode": { - "description": "Ths concurrency mode for this database.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Pessimistic concurrency.", - "Optimistic concurrency.", - "Optimistic concurrency with entity groups." - ], - "enum": [ - "CONCURRENCY_MODE_UNSPECIFIED", - "PESSIMISTIC", - "OPTIMISTIC", - "OPTIMISTIC_WITH_ENTITY_GROUPS" - ] - } - } - }, - "GoogleDatastoreAdminV1MigrationStateEvent": { - "id": "GoogleDatastoreAdminV1MigrationStateEvent", - "description": "An event signifying a change in state of a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).", - "type": "object", - "properties": { - "state": { - "description": "The new state of the migration.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "The migration is running.", - "The migration is paused.", - "The migration is complete." - ], - "enum": [ - "MIGRATION_STATE_UNSPECIFIED", - "RUNNING", - "PAUSED", - "COMPLETE" - ] - } - } - } - }, - "baseUrl": "https://datastore.googleapis.com/", - "version": "v1", - "fullyEncodeReservedExpansion": true, - "documentationLink": "https://cloud.google.com/datastore/", - "ownerDomain": "google.com", - "kind": "discovery#restDescription", - "batchPath": "batch", - "rootUrl": "https://datastore.googleapis.com/", - "discoveryVersion": "v1", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." - }, - "https://www.googleapis.com/auth/datastore": { - "description": "View and manage your Google Cloud Datastore data" - } - } - } - }, - "version_module": true, - "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. ", - "name": "datastore", - "revision": "20231103", - "ownerName": "Google", - "protocol": "rest", - "parameters": { - "access_token": { - "type": "string", - "description": "OAuth access token.", - "location": "query" - }, - "alt": { - "type": "string", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], - "location": "query" - }, - "callback": { - "type": "string", - "description": "JSONP", - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", - "location": "query" - }, - "upload_protocol": { - "type": "string", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query" - }, - "uploadType": { - "type": "string", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query" - }, - "$.xgafv": { - "type": "string", - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - } - }, - "resources": { - "projects": { - "methods": { - "export": { - "id": "datastore.projects.export", - "path": "v1/projects/{projectId}:export", - "flatPath": "v1/projects/{projectId}:export", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "GoogleDatastoreAdminV1ExportEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage." - }, - "import": { - "id": "datastore.projects.import", - "path": "v1/projects/{projectId}:import", - "flatPath": "v1/projects/{projectId}:import", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "GoogleDatastoreAdminV1ImportEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore." - }, - "lookup": { - "id": "datastore.projects.lookup", - "path": "v1/projects/{projectId}:lookup", - "flatPath": "v1/projects/{projectId}:lookup", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "LookupRequest" - }, - "response": { - "$ref": "LookupResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Looks up entities by key." - }, - "runQuery": { - "id": "datastore.projects.runQuery", - "path": "v1/projects/{projectId}:runQuery", - "flatPath": "v1/projects/{projectId}:runQuery", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "RunQueryRequest" - }, - "response": { - "$ref": "RunQueryResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Queries for entities." - }, - "runAggregationQuery": { - "id": "datastore.projects.runAggregationQuery", - "path": "v1/projects/{projectId}:runAggregationQuery", - "flatPath": "v1/projects/{projectId}:runAggregationQuery", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "RunAggregationQueryRequest" - }, - "response": { - "$ref": "RunAggregationQueryResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Runs an aggregation query." - }, - "beginTransaction": { - "id": "datastore.projects.beginTransaction", - "path": "v1/projects/{projectId}:beginTransaction", - "flatPath": "v1/projects/{projectId}:beginTransaction", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "BeginTransactionRequest" - }, - "response": { - "$ref": "BeginTransactionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Begins a new transaction." - }, - "commit": { - "id": "datastore.projects.commit", - "path": "v1/projects/{projectId}:commit", - "flatPath": "v1/projects/{projectId}:commit", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "CommitRequest" - }, - "response": { - "$ref": "CommitResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Commits a transaction, optionally creating, deleting or modifying some entities." - }, - "rollback": { - "id": "datastore.projects.rollback", - "path": "v1/projects/{projectId}:rollback", - "flatPath": "v1/projects/{projectId}:rollback", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "RollbackRequest" - }, - "response": { - "$ref": "RollbackResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Rolls back a transaction." - }, - "allocateIds": { - "id": "datastore.projects.allocateIds", - "path": "v1/projects/{projectId}:allocateIds", - "flatPath": "v1/projects/{projectId}:allocateIds", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "AllocateIdsRequest" - }, - "response": { - "$ref": "AllocateIdsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted." - }, - "reserveIds": { - "id": "datastore.projects.reserveIds", - "path": "v1/projects/{projectId}:reserveIds", - "flatPath": "v1/projects/{projectId}:reserveIds", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the project against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "ReserveIdsRequest" - }, - "response": { - "$ref": "ReserveIdsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore." - } - }, - "resources": { - "operations": { - "methods": { - "list": { - "id": "datastore.projects.operations.list", - "path": "v1/{+name}/operations", - "flatPath": "v1/projects/{projectsId}/operations", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation's parent resource.", - "pattern": "^projects/[^/]+$", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." - }, - "get": { - "id": "datastore.projects.operations.get", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the operation resource.", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." - }, - "delete": { - "id": "datastore.projects.operations.delete", - "path": "v1/{+name}", - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." - }, - "cancel": { - "id": "datastore.projects.operations.cancel", - "path": "v1/{+name}:cancel", - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." - } - } - }, - "indexes": { - "methods": { - "create": { - "id": "datastore.projects.indexes.create", - "path": "v1/projects/{projectId}/indexes", - "flatPath": "v1/projects/{projectId}/indexes", - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "request": { - "$ref": "GoogleDatastoreAdminV1Index" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created." - }, - "delete": { - "id": "datastore.projects.indexes.delete", - "path": "v1/projects/{projectId}/indexes/{indexId}", - "flatPath": "v1/projects/{projectId}/indexes/{indexId}", - "httpMethod": "DELETE", - "parameters": { - "projectId": { - "description": "Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - }, - "indexId": { - "description": "The resource ID of the index to delete.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId", - "indexId" - ], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again." - }, - "get": { - "id": "datastore.projects.indexes.get", - "path": "v1/projects/{projectId}/indexes/{indexId}", - "flatPath": "v1/projects/{projectId}/indexes/{indexId}", - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - }, - "indexId": { - "description": "The resource ID of the index to get.", - "location": "path", - "required": true, - "type": "string" - } - }, - "parameterOrder": [ - "projectId", - "indexId" - ], - "response": { - "$ref": "GoogleDatastoreAdminV1Index" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Gets an index." - }, - "list": { - "id": "datastore.projects.indexes.list", - "path": "v1/projects/{projectId}/indexes", - "flatPath": "v1/projects/{projectId}/indexes", - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "Project ID against which to make the request.", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return. If zero, then all results will be returned.", - "location": "query", - "type": "integer", - "format": "int32" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "location": "query", - "type": "string" - } - }, - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "GoogleDatastoreAdminV1ListIndexesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "description": "Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results." - } - } - } - } - } - }, - "id": "datastore:v1", - "basePath": "", - "title": "Cloud Datastore API" -} diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 6c08f3aaea85..f7ae2fbef21e 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -21,14 +21,11 @@ use Google\ApiCore\ArrayTrait; use Google\ApiCore\ClientOptionsTrait; use Google\ApiCore\Serializer; -use Google\Auth\FetchAuthTokenInterface; +use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\ClientTrait; -use Google\Cloud\Core\GrpcTrait; +use Google\Cloud\Core\DetectProjectIdTrait; use Google\Cloud\Core\Int64; use Google\Cloud\Core\RequestHandler; -use Google\Cloud\Datastore\Connection\ConnectionInterface; -use Google\Cloud\Datastore\Connection\Grpc; -use Google\Cloud\Datastore\Connection\Rest; use Google\Cloud\Datastore\Query\AggregationQuery; use Google\Cloud\Datastore\Query\AggregationQueryResult; use Google\Cloud\Datastore\Query\GqlQuery; @@ -36,7 +33,6 @@ use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; use InvalidArgumentException; -use Psr\Cache\CacheItemPoolInterface; use Psr\Http\Message\StreamInterface; /** @@ -93,14 +89,11 @@ */ class DatastoreClient { + use ApiHelperTrait; use ArrayTrait; - // TODO: - // [START] Replace ClientTrait with DetectProjectIdTrait - use ClientTrait; - // [END] Replace ClientTrait with DetectProjectIdTrait use ClientOptionsTrait; use DatastoreTrait; - use GrpcTrait; + use DetectProjectIdTrait; const VERSION = '1.28.0'; @@ -123,12 +116,6 @@ class DatastoreClient */ private Serializer $serializer; - /** - * @deprecated - * @var ConnectionInterface - */ - protected $connection; - /** * @var Operation */ @@ -177,6 +164,9 @@ 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 string $transport The transport type used for requests. May be + * either `grpc` or `rest`. **Defaults to** `grpc` if gRPC support + * is detected on the system. * } * @throws \InvalidArgumentException */ @@ -184,11 +174,6 @@ public function __construct(array $config = []) { $emulatorHost = getenv('DATASTORE_EMULATOR_HOST'); - // TODO: - // [START] remove once upgraded to V2 - $connectionType = $this->getConnectionType($config); - // [END] remove once upgraded to V2 - $config += [ 'namespaceId' => null, 'databaseId' => '', @@ -213,14 +198,6 @@ public function __construct(array $config = []) $this->projectId = $this->detectProjectId($config); - // TODO: - // [START] remove once upgraded to V2 - $config = $this->configureAuthentication($config); - $this->connection = $connectionType === 'grpc' - ? new Grpc($config) - : new Rest($config); - // [END] remove once upgraded to V2 - $this->serializer = new Serializer([], [ 'google.protobuf.Value' => function ($v) { return $this->flattenValue($v); @@ -250,10 +227,8 @@ public function __construct(array $config = []) $this->projectId, true, $config['returnInt64AsObject'], - $connectionType ); $this->operation = new Operation( - $this->connection, $this->requestHandler, $this->serializer, $this->projectId, diff --git a/Datastore/src/EntityMapper.php b/Datastore/src/EntityMapper.php index 34dea73d13c0..e009a0e8deb2 100644 --- a/Datastore/src/EntityMapper.php +++ b/Datastore/src/EntityMapper.php @@ -49,14 +49,6 @@ class EntityMapper */ private $returnInt64AsObject; - /** - * The connection type of the client. Required while mapping - * `INF`, `-INF` and `NAN` to datastore equivalent values. - * - * @var string - */ - private $connectionType; - /** * Create an Entity Mapper * @@ -65,19 +57,15 @@ class EntityMapper * @param bool $returnInt64AsObject If true, 64 bit integers will be * returned as a {@see \Google\Cloud\Core\Int64} object for 32 bit * platform compatibility. - * @param string $connectionType [optional] The connection type of the client. - * Can be `rest` or `grpc`, defaults to `grpc`. */ public function __construct( $projectId, $encode, $returnInt64AsObject, - $connectionType = 'grpc' ) { $this->projectId = $projectId; $this->encode = $encode; $this->returnInt64AsObject = $returnInt64AsObject; - $this->connectionType = $connectionType; } /** @@ -204,22 +192,6 @@ public function convertValue($type, $value, $className = Entity::class) break; case 'doubleValue': - // Flow will enter this logic only when REST transport is used - // because gRPC response values are always parsed correctly. Therefore - // the default $connectionType is set to 'grpc' - if (is_string($value)) { - switch ($value) { - case 'Infinity': - $value = INF; - break; - case '-Infinity': - $value = -INF; - break; - case 'NaN': - $value = NAN; - break; - } - } $result = (float) $value; break; @@ -359,18 +331,6 @@ public function valueObject($value, $exclude = false, $meaning = null) break; case 'double': - // The mappings happen automatically for grpc hence - // this is required only incase of rest as grpc - // doesn't recognises 'Infinity', '-Infinity' and 'NaN'. - if ($this->connectionType == 'rest') { - if ($value == INF) { - $value = 'Infinity'; - } elseif ($value == -INF) { - $value = '-Infinity'; - } elseif (is_nan($value)) { - $value = 'NaN'; - } - } $propertyValue = [ 'doubleValue' => $value ]; diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index b550334ba6fe..b68d92ca7483 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -23,7 +23,6 @@ use Google\Cloud\Core\Timestamp; use Google\Cloud\Core\TimestampTrait; use Google\Cloud\Core\ValidateTrait; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Query\AggregationQuery; use Google\Cloud\Datastore\Query\AggregationQueryResult; use Google\Cloud\Datastore\Query\Query; @@ -70,12 +69,6 @@ class Operation use ValidateTrait; use TimestampTrait; - /** - * @var ConnectionInterface - * @internal - */ - protected $connection; - /** * @var RequestHandler * @internal @@ -112,9 +105,6 @@ class Operation /** * Create an operation * - * @param ConnectionInterface $connection A connection to Google Cloud Platform's Datastore API. - * This object is created by DatastoreClient, - * and should not be instantiated outside of this client. * @param RequestHandler $requestHandler The request handler responsible for sending * requests and serializing responses into relevant classes. * @param Serializer $serializer The serializer instance to encode/decode messages. @@ -124,7 +114,6 @@ class Operation * @param string $databaseId ID of the database to which the entities belong. */ public function __construct( - ConnectionInterface $connection, RequestHandler $requestHandler, Serializer $serializer, $projectId, @@ -132,7 +121,6 @@ public function __construct( EntityMapper $entityMapper, $databaseId = '' ) { - $this->connection = $connection; $this->projectId = $projectId; $this->namespaceId = $namespaceId; $this->databaseId = $databaseId; diff --git a/Datastore/tests/Snippet/DatastoreClientTest.php b/Datastore/tests/Snippet/DatastoreClientTest.php index 8de36503d633..b5769c68e3d1 100644 --- a/Datastore/tests/Snippet/DatastoreClientTest.php +++ b/Datastore/tests/Snippet/DatastoreClientTest.php @@ -25,7 +25,6 @@ use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Core\Timestamp; use Google\Cloud\Datastore\Blob; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Cursor; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\Entity; @@ -52,7 +51,6 @@ class DatastoreClientTest extends SnippetTestCase const PROJECT = 'example-project'; - private $connection; private $operation; private $client; private $key; @@ -60,8 +58,6 @@ class DatastoreClientTest extends SnippetTestCase public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); - $this->client = TestHelpers::stub(DatastoreClient::class, [], ['operation']); $this->key = new Key('my-awesome-project', [ @@ -320,8 +316,8 @@ public function testAllocateId() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'allocateId'); $snippet->addLocal('datastore', $this->client); - $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->allocateIdsRequestHandlerMock(); + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -337,8 +333,8 @@ public function testAllocateIdsBatch() $snippet = $this->snippetFromMethod(DatastoreClient::class, 'allocateIds'); $snippet->addLocal('datastore', $this->client); - $this->allocateIdsConnectionMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->allocateIdsRequestHandlerMock(); + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -361,7 +357,7 @@ public function testTransaction() ['transaction' => 'foo'] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -378,7 +374,7 @@ public function testReadOnlyTransaction() ['transactionOptions' => ['readOnly' => []]], ['transaction' => 'foo'] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); $res = $snippet->invoke('transaction'); @@ -402,7 +398,7 @@ public function testInsert() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -418,9 +414,9 @@ public function testInsertBatch() $this->mockSendRequestForCommit('insert', []); - $this->allocateIdsConnectionMock(); + $this->allocateIdsRequestHandlerMock(); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -443,7 +439,7 @@ public function testUpdate() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -461,7 +457,7 @@ public function testUpdateBatch() $this->mockSendRequestForCommit('update', []); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -479,7 +475,7 @@ public function testUpsert() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -493,7 +489,7 @@ public function testUpsertBatch() $this->mockSendRequestForCommit('upsert', []); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -511,7 +507,7 @@ public function testDelete() ] ]); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -525,7 +521,7 @@ public function testDeleteBatch() $this->mockSendRequestForCommit('delete', []); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -560,7 +556,7 @@ public function testLookup() ] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -616,7 +612,7 @@ public function testLookupBatch() ] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -698,7 +694,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -740,7 +736,7 @@ public function testRunAggregationQuery() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -757,7 +753,7 @@ public function testRunAggregationQuery() // ******** HELPERS - private function allocateIdsConnectionMock() + private function allocateIdsRequestHandlerMock() { $this->requestHandler->sendRequest( V1DatastoreClient::class, diff --git a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php index 4ec352334f09..a2237f9ae91b 100644 --- a/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php +++ b/Datastore/tests/Snippet/DatastoreSessionHandlerTest.php @@ -22,7 +22,6 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\DatastoreSessionHandler; use Google\Cloud\Datastore\V1\Client\DatastoreClient as V1DatastoreClient; @@ -44,7 +43,6 @@ class DatastoreSessionHandlerTest extends SnippetTestCase const TRANSACTION = 'transaction-id'; const PROJECT = 'example-project'; - private $connection; private $client; private $requestHandler; @@ -62,7 +60,6 @@ public static function setUpBeforeClass(): void public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); $this->client = TestHelpers::stub(DatastoreClient::class, [], [ 'operation', ]); @@ -114,7 +111,7 @@ public function testClass() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); $snippet->addLocal('datastore', $this->client); @@ -162,7 +159,7 @@ public function testClassErrorHandler() )->shouldBeCalled()->will(fn () => trigger_error('oops!', E_USER_WARNING)); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); $snippet->addLocal('datastore', $this->client); diff --git a/Datastore/tests/Snippet/EntityTest.php b/Datastore/tests/Snippet/EntityTest.php index f2e084eafaba..6779ce984ad2 100644 --- a/Datastore/tests/Snippet/EntityTest.php +++ b/Datastore/tests/Snippet/EntityTest.php @@ -20,9 +20,9 @@ use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; use Google\Cloud\Core\RequestHandler; +use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityMapper; @@ -38,6 +38,7 @@ class EntityTest extends SnippetTestCase { use ProphecyTrait; use ApiHelperTrait; + use DatastoreOperationRefreshTrait; private $options; private $entity; @@ -97,24 +98,32 @@ public function testClassEntityType() 'operation' ]); - $connection = $this->prophesize(ConnectionInterface::class); - $connection->commit(Argument::any())->shouldBeCalled()->willReturn(['mutationResults' => [['version' => 1]]]); - $connection->lookup(Argument::any())->shouldBeCalled()->willReturn([ - 'found' => [ - [ - 'entity' => [ - 'key' => [ - 'path' => [['kind' => 'Business', 'name' => 'Google']] - ], - 'properties' => [ - 'name' => [ - 'stringValue' => 'Google' + $this->mockSendRequest( + 'commit', + [], + ['mutationResults' => [['version' => 1]]], + 0 + ); + $this->mockSendRequest( + 'lookup', + [], + [ + 'found' => [ + [ + 'entity' => [ + 'key' => [ + 'path' => [['kind' => 'Business', 'name' => 'Google']] ], - 'parent' => [ - 'entityValue' => [ - 'properties' => [ - 'name' => [ - 'stringValue' => 'Alphabet' + 'properties' => [ + 'name' => [ + 'stringValue' => 'Google' + ], + 'parent' => [ + 'entityValue' => [ + 'properties' => [ + 'name' => [ + 'stringValue' => 'Alphabet' + ] ] ] ] @@ -122,11 +131,11 @@ public function testClassEntityType() ] ] ] - ] - ]); + ], + 0 + ); $operation = new Operation( - $connection->reveal(), $this->requestHandler->reveal(), $this->serializer, 'example_project', diff --git a/Datastore/tests/Snippet/FilterTest.php b/Datastore/tests/Snippet/FilterTest.php index 94a875c01ae8..bf4a36723782 100644 --- a/Datastore/tests/Snippet/FilterTest.php +++ b/Datastore/tests/Snippet/FilterTest.php @@ -6,14 +6,10 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\EntityMapper; -use Google\Cloud\Datastore\Operation; use Google\Cloud\Datastore\Query\Filter; use Google\Cloud\Datastore\Query\Query; -use Google\Cloud\Datastore\Query\QueryInterface; -use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; class FilterTest extends SnippetTestCase @@ -22,7 +18,6 @@ class FilterTest extends SnippetTestCase use ProphecyTrait; private const PROJECT = 'alpha-project'; - private $connection; private $datastore; private $operation; private $query; @@ -33,7 +28,6 @@ public function setUp(): void { $entityMapper = new EntityMapper(self::PROJECT, false, false); - $this->connection = $this->prophesize(ConnectionInterface::class); $this->requestHandler = $this->prophesize(RequestHandler::class); $this->datastore = TestHelpers::stub( @@ -49,7 +43,7 @@ public function setUp(): void public function testFilter() { - $this->createConnectionProphecy(); + $this->createRequestHandlerProphecy(); $snippet = $this->snippetFromClass(Filter::class, 0); $snippet->addLocal('datastore', $this->datastore); @@ -66,7 +60,7 @@ public function testFilter() */ public function testOrFilter($compositeFilterType) { - $this->createConnectionProphecy(); + $this->createRequestHandlerProphecy(); $snippet = $this->snippetFromClass(Filter::class, 1); $snippet->addLocal('filterType', $compositeFilterType); @@ -88,10 +82,10 @@ public function getCompositeFilterTypes() ]; } - private function createConnectionProphecy() + private function createRequestHandlerProphecy() { $this->mockSendRequest( - '', + 'runQuery', [], [ 'batch' => [ @@ -113,7 +107,7 @@ private function createConnectionProphecy() 0 ); - $this->refreshOperation($this->datastore, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->datastore, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); } diff --git a/Datastore/tests/Snippet/Query/AggregationQueryTest.php b/Datastore/tests/Snippet/Query/AggregationQueryTest.php index 542cba94df86..8d55e1d51040 100644 --- a/Datastore/tests/Snippet/Query/AggregationQueryTest.php +++ b/Datastore/tests/Snippet/Query/AggregationQueryTest.php @@ -23,7 +23,6 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Operation; @@ -42,7 +41,6 @@ class AggregationQueryTest extends SnippetTestCase use DatastoreOperationRefreshTrait; private $datastore; - private $connection; private $operation; private $requestHandler; private $serializer; @@ -51,7 +49,6 @@ public function setUp(): void { $mapper = new EntityMapper('my-awesome-project', true, false); $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); - $this->connection = $this->prophesize(ConnectionInterface::class); $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ 'google.protobuf.Value' => function ($v) { @@ -71,7 +68,6 @@ public function setUp(): void ]); $this->operation = TestHelpers::stub(Operation::class, [ - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, 'my-awesome-project', diff --git a/Datastore/tests/Snippet/Query/GqlQueryTest.php b/Datastore/tests/Snippet/Query/GqlQueryTest.php index 4461bd368067..2dfbc5b783ef 100644 --- a/Datastore/tests/Snippet/Query/GqlQueryTest.php +++ b/Datastore/tests/Snippet/Query/GqlQueryTest.php @@ -24,7 +24,6 @@ use Google\Cloud\Core\Testing\Snippet\Parser\Snippet; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\EntityIterator; use Google\Cloud\Datastore\EntityMapper; @@ -43,7 +42,6 @@ class GqlQueryTest extends SnippetTestCase use DatastoreOperationRefreshTrait; private $datastore; - private $connection; private $operation; private $requestHandler; private $serializer; @@ -51,7 +49,6 @@ class GqlQueryTest extends SnippetTestCase public function setUp(): void { $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); - $this->connection = $this->prophesize(ConnectionInterface::class); $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ 'google.protobuf.Value' => function ($v) { @@ -70,7 +67,6 @@ public function setUp(): void } ]); $this->operation = TestHelpers::stub(Operation::class, [ - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, 'my-awesome-project', diff --git a/Datastore/tests/Snippet/Query/QueryTest.php b/Datastore/tests/Snippet/Query/QueryTest.php index 5ac648b42020..430bb07b9fac 100644 --- a/Datastore/tests/Snippet/Query/QueryTest.php +++ b/Datastore/tests/Snippet/Query/QueryTest.php @@ -23,7 +23,6 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\EntityIterator; use Google\Cloud\Datastore\EntityMapper; @@ -44,7 +43,6 @@ class QueryTest extends SnippetTestCase use DatastoreOperationRefreshTrait; private $datastore; - private $connection; private $operation; private $query; private $requestHandler; @@ -55,7 +53,6 @@ public function setUp(): void $mapper = new EntityMapper('my-awesome-project', true, false); $this->datastore = TestHelpers::stub(DatastoreClient::class, [], ['operation']); - $this->connection = $this->prophesize(ConnectionInterface::class); $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ 'google.protobuf.Value' => function ($v) { @@ -74,7 +71,6 @@ public function setUp(): void } ]); $this->operation = TestHelpers::stub(Operation::class, [ - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, 'my-awesome-project', diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index b349525675e3..4d71de24aeda 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -23,15 +23,12 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; -use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Key; use Google\Cloud\Datastore\Operation; use Google\Cloud\Datastore\Query\QueryInterface; use Google\Cloud\Datastore\ReadOnlyTransaction; -use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; /** @@ -46,7 +43,6 @@ class ReadOnlyTransactionTest extends SnippetTestCase const PROJECT = 'my-awesome-project'; const TRANSACTION = 'transaction-id'; - private $connection; private $transaction; private $client; private $key; @@ -55,8 +51,6 @@ class ReadOnlyTransactionTest extends SnippetTestCase public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); - $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ @@ -77,7 +71,6 @@ public function setUp(): void ]); $operation = new Operation( - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, self::PROJECT, @@ -111,7 +104,7 @@ public function testClass() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -141,7 +134,7 @@ public function testClassRollback() $snippet = $this->snippetFromClass(ReadOnlyTransaction::class, 1); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -182,7 +175,7 @@ public function testLookup() ] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -233,7 +226,7 @@ public function testLookupBatch() ] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -279,7 +272,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -294,7 +287,7 @@ public function testRollback() $this->mockSendRequest('rollback', [], [], 0); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index 95cdeb9eca5b..542f1c8962ad 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -23,7 +23,6 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\Snippet\SnippetTestCase; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Key; @@ -47,7 +46,6 @@ class TransactionTest extends SnippetTestCase const PROJECT = 'my-awesome-project'; const TRANSACTION = 'transaction-id'; - private $connection; private $operation; private $transaction; private $client; @@ -57,8 +55,6 @@ class TransactionTest extends SnippetTestCase public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); - $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ @@ -79,7 +75,6 @@ public function setUp(): void ]); $operation = new Operation( - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, self::PROJECT, @@ -113,7 +108,7 @@ public function testClass() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -137,7 +132,7 @@ public function testInsert() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -156,9 +151,9 @@ public function testInsertBatch() ] ]); - $this->allocateIdsConnectionMock(); + $this->allocateIdsRequestHandlerMock(); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -180,7 +175,7 @@ public function testUpdate() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -217,7 +212,7 @@ public function testUpsert() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -251,7 +246,7 @@ public function testDelete() ] ]); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -298,7 +293,7 @@ public function testLookup() ] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -349,7 +344,7 @@ public function testLookupBatch() ] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -395,7 +390,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -431,7 +426,7 @@ public function testRunAggregationQuery() 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -446,7 +441,7 @@ public function testCommit() $this->mockSendRequest('commit', [], [], 0); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -460,7 +455,7 @@ public function testRollback() $this->mockSendRequest('rollback', [], [], 0); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -469,7 +464,7 @@ public function testRollback() // ******** HELPERS - private function allocateIdsConnectionMock() + private function allocateIdsRequestHandlerMock() { $this->requestHandler->sendRequest( V1DatastoreClient::class, diff --git a/Datastore/tests/Unit/Connection/GrpcTest.php b/Datastore/tests/Unit/Connection/GrpcTest.php deleted file mode 100644 index e0b35cdb50ed..000000000000 --- a/Datastore/tests/Unit/Connection/GrpcTest.php +++ /dev/null @@ -1,556 +0,0 @@ -checkAndSkipGrpcTests(); - - $this->requestWrapper = $this->prophesize(GrpcRequestWrapper::class); - $this->successMessage = 'success'; - $this->serializer = new Serializer; - } - - public function testApiEndpoint() - { - $expected = 'foobar.com'; - - $grpc = new GrpcStub(['apiEndpoint' => $expected]); - - $this->assertEquals($expected, $grpc->config['apiEndpoint']); - } - - public function testAllocateIds() - { - $key = [ - 'partitionId' => [ - 'projectId' => self::PROJECT_ID - ], - 'path' => [ - [ - 'kind' => 'foo' - ] - ] - ]; - - $args = [ - 'projectId' => self::PROJECT_ID, - 'keys' => [$key], - ]; - - $expectedArgs = [ - self::PROJECT_ID, - [$this->serializer->decodeMessage(new Key, $key)], - [] - ]; - - $this->assertRunsServiceCall('allocateIds', $args, $expectedArgs); - } - - public function testBeginTransaction() - { - $args = [ - 'projectId' => self::PROJECT_ID, - 'transactionOptions' => [ - 'readWrite' => [ - 'previousTransaction' => '1234' - ] - ] - ]; - - $expectedArgs = [ - self::PROJECT_ID, - [ - 'transactionOptions' => $this->serializer->decodeMessage( - new TransactionOptions, - $args['transactionOptions'] - ) - ] - ]; - - $this->assertRunsServiceCall('beginTransaction', $args, $expectedArgs); - } - - /** - * @dataProvider modes - */ - public function testCommit($mode) - { - $timestamp = new Timestamp(new \DateTime); - - $mutation = [ - 'insert' => [ - 'key' => [ - 'partitionId' => [ - 'projectId' => self::PROJECT_ID - ], - 'path' => [ - [ - 'kind' => 'foo', - 'id' => 1 - ] - ] - ], - 'properties' => [ - 'prop' => [ - 'stringValue' => 'val' - ], - 'nullVal' => [ - 'nullValue' => null - ], - 'time' => [ - 'timestampValue' => $timestamp->formatAsString() - ], - 'point' => [ - 'geoPointValue' => [ - 'latitude' => 1.0, - 'longitude' => null - ] - ] - ] - ] - ]; - - $args = [ - 'projectId' => self::PROJECT_ID, - 'mode' => $mode, - 'mutations' => [ - $mutation - ] - ]; - - $mutation['insert']['properties']['nullVal']['nullValue'] = NullValue::NULL_VALUE; - $mutation['insert']['properties']['time']['timestampValue'] = $timestamp->formatForApi(); - $mutation['insert']['properties']['point']['geoPointValue'] = [ - 'latitude' => 1.0, - 'longitude' => 0.0 - ]; - - $expectedArgs = [ - self::PROJECT_ID, - constant(Mode::class .'::' . $mode), - [$this->serializer->decodeMessage(new Mutation, $mutation)], - [] - ]; - - $this->assertRunsServiceCall('commit', $args, $expectedArgs); - } - - public function modes() - { - return [ - ['TRANSACTIONAL'], - ['NON_TRANSACTIONAL'] - ]; - } - - /** - * @dataProvider readOptions - */ - public function testLookup($readOptions, $readOptionsProto) - { - $args = [ - 'projectId' => self::PROJECT_ID, - 'keys' => [ - [ - 'partitionId' => [ - 'projectId' => self::PROJECT_ID, - 'namespaceId' => 'foobar' - ], - 'path' => [ - [ - 'kind' => 'person', - 'name' => 'steve' - ] - ] - ] - ], - 'readOptions' => $readOptions - ]; - - $keysList = []; - foreach ($args['keys'] as $key) { - $keysList[] = $this->serializer->decodeMessage(new Key, $key); - } - - $expectedArgs = [ - self::PROJECT_ID, - $keysList, - [ - 'readOptions' => $readOptionsProto - ] - ]; - - $this->assertRunsServiceCall('lookup', $args, $expectedArgs); - } - - public function readOptions() - { - $this->setUp(); - - $readOptionsTransaction = [ - 'transaction' => 1234 - ]; - - $strongConsistency = [ - 'readConsistency' => 'STRONG' - ]; - - $strongConsistencyProto = new ReadOptions([ - 'read_consistency' => ReadConsistency::STRONG - ]); - - $eventualConsistency = [ - 'readConsistency' => 'EVENTUAL' - ]; - - $eventualConsistencyProto = new ReadOptions([ - 'read_consistency' => ReadConsistency::EVENTUAL - ]); - - return [ - [ - $readOptionsTransaction, - $this->serializer->decodeMessage(new ReadOptions, $readOptionsTransaction) - ], [ - $strongConsistency, - $strongConsistencyProto - ], [ - $eventualConsistency, - $eventualConsistencyProto - ] - ]; - } - - public function testRollback() - { - $args = [ - 'projectId' => self::PROJECT_ID, - 'transaction' => '1234' - ]; - - $expectedArgs = [ - self::PROJECT_ID, - '1234', - [] - ]; - - $this->assertRunsServiceCall('rollback', $args, $expectedArgs); - } - - public function testRunQuery() - { - $timestamp = new Timestamp(new \DateTime); - - $query = [ - 'order' => [ - [ - 'property' => [ - 'name' => 'foo' - ], - 'direction' => 'DESCENDING', - ], [ - 'property' => [ - 'name' => 'bar' - ], - 'direction' => 'ASCENDING' - ] - ], - 'limit' => 500 - ]; - - $gqlQuery = [ - 'queryString' => 'SELECT 1=1', - 'allowLiterals' => false, - 'namedBindings' => [ - 'foo' => [ - 'value' => [ - 'timestampValue' => $timestamp->formatAsString() - ] - ], - 'bar' => [ - 'cursor' => '1234' - ] - ], - 'positionalBindings' => [ - [ - 'value' => [ - 'timestampValue' => $timestamp->formatAsString() - ] - ], [ - 'cursor' => '531252' - ] - ] - ]; - - $args = [ - 'projectId' => self::PROJECT_ID, - 'partitionId' => [ - 'projectId' => self::PROJECT_ID, - 'namespaceId' => 'foobar' - ], - 'readOptions' => [ - 'transaction' => '1234' - ], - 'query' => $query, - 'gqlQuery' => $gqlQuery - ]; - - $gqlQuery['namedBindings']['foo']['value']['timestampValue'] = $timestamp->formatForApi(); - $gqlQuery['positionalBindings'][0]['value']['timestampValue'] = $timestamp->formatForApi(); - - $expectedArgs = [ - self::PROJECT_ID, - $this->serializer->decodeMessage(new PartitionId, $args['partitionId']), - [ - 'readOptions' => $this->serializer->decodeMessage(new ReadOptions, $args['readOptions']), - 'query' => $this->serializer->decodeMessage(new Query, [ - 'order' => [ - [ - 'property' => [ - 'name' => 'foo' - ], - 'direction' => Direction::DESCENDING - ], - [ - 'property' => [ - 'name' => 'bar' - ], - 'direction' => Direction::ASCENDING - ] - ], - 'limit' => [ - 'value' => 500 - ] - ]), - 'gqlQuery' => $this->serializer->decodeMessage(new GqlQuery, $gqlQuery), - ] - ]; - - $this->assertRunsServiceCall('runQuery', $args, $expectedArgs); - } - - /** - * @dataProvider propertyFilters - */ - public function testQueryPropertyFilters($operator) - { - $query = [ - 'filter' => [ - 'propertyFilter' => [ - 'property' => [ - 'name' => 'foo' - ], - 'op' => $operator, - 'value' => [ - 'stringValue' => 'bar' - ] - ] - ] - ]; - - $args = [ - 'projectId' => self::PROJECT_ID, - 'partitionId' => [ - 'projectId' => self::PROJECT_ID, - ], - 'query' => $query - ]; - - $operator = $query['filter']['propertyFilter']['op']; - $constName = PropertyFilterOperator::class .'::'. $operator; - $query['filter']['propertyFilter']['op'] = defined($constName) - ? constant($constName) - : 0; - - $expectedArgs = [ - self::PROJECT_ID, - $this->serializer->decodeMessage(new PartitionId, $args['partitionId']), - [ - 'query' => $this->serializer->decodeMessage(new Query, $query) - ] - ]; - - $this->assertRunsServiceCall('runQuery', $args, $expectedArgs); - } - - public function testQueryCompositeFilter() - { - $query = [ - 'filter' => [ - 'compositeFilter' => [ - 'op' => 'AND', - 'filters' => [ - [ - 'propertyFilter' => [ - 'property' => [ - 'name' => 'foo' - ], - 'op' => 'EQUAL', - 'value' => [ - 'stringValue' => 'bar' - ] - ] - ], [ - 'compositeFilter' => [ - 'op' => 'AND', - 'filters' => [ - [ - 'propertyFilter' => [ - 'property' => [ - 'name' => 'foo' - ], - 'op' => 'EQUAL', - 'value' => [ - 'stringValue' => 'bar' - ] - ] - ] - ] - ] - ] - ] - ] - ] - ]; - - $args = [ - 'projectId' => self::PROJECT_ID, - 'partitionId' => [ - 'projectId' => self::PROJECT_ID, - ], - 'query' => $query - ]; - - $query['filter']['compositeFilter']['op'] = CompositeFilterOperator::PBAND; - $query['filter']['compositeFilter']['filters'][0]['propertyFilter']['op'] = PropertyFilterOperator::EQUAL; - - $query['filter']['compositeFilter']['filters'][1]['compositeFilter']['op'] = CompositeFilterOperator::PBAND; - $query['filter']['compositeFilter']['filters'][1]['compositeFilter']['filters'][0]['propertyFilter']['op'] - = PropertyFilterOperator::EQUAL; - - $expectedArgs = [ - self::PROJECT_ID, - $this->serializer->decodeMessage(new PartitionId, $args['partitionId']), - [ - 'query' => $this->serializer->decodeMessage(new Query, $query) - ] - ]; - - $this->assertRunsServiceCall('runQuery', $args, $expectedArgs); - } - - public function propertyFilters() - { - return [ - ['LESS_THAN'], - ['LESS_THAN_OR_EQUAL'], - ['GREATER_THAN'], - ['GREATER_THAN_OR_EQUAL'], - ['EQUAL'], - ['HAS_ANCESTOR'], - ]; - } - - /** - * @dataProvider invalidFilters - */ - public function testInvalidFilter($filter) - { - $this->expectException(InvalidArgumentException::class); - - return $this->testQueryPropertyFilters($filter); - } - - public function invalidFilters() - { - return [ - ['F00'], - [9999999] - ]; - } - - private function assertRunsServiceCall($method, $args, $expectedArgs, $return = null, $result = '') - { - $this->requestWrapper->send( - Argument::type('callable'), - $expectedArgs, - Argument::type('array') - )->willReturn($return ?: $this->successMessage); - - $grpc = new Grpc(); - $grpc->setRequestWrapper($this->requestWrapper->reveal()); - - $this->assertEquals($result !== '' ? $result : $this->successMessage, $grpc->$method($args)); - } -} - -//@codingStandardsIgnoreStart -class GrpcStub extends Grpc -{ - public $config; - - protected function constructGapic($gapicName, array $config) - { - $this->config = $config; - - return parent::constructGapic($gapicName, $config); - } -} -//@codingStandardsIgnoreEnd diff --git a/Datastore/tests/Unit/Connection/RestTest.php b/Datastore/tests/Unit/Connection/RestTest.php deleted file mode 100644 index de7303ffdb51..000000000000 --- a/Datastore/tests/Unit/Connection/RestTest.php +++ /dev/null @@ -1,161 +0,0 @@ -requestWrapper = $this->prophesize(RequestWrapper::class); - $this->successBody = '{"canI":"kickIt"}'; - } - - public function testApiEndpoint() - { - $endpoint = 'https://foobar.com/'; - $rest = TestHelpers::stub(Rest::class, [ - [ - 'apiEndpoint' => $endpoint - ] - ], ['requestBuilder']); - - $rb = $rest->___getProperty('requestBuilder'); - $r = new \ReflectionObject($rb); - $p = $r->getProperty('baseUri'); - $p->setAccessible(true); - - $this->assertEquals($endpoint, $p->getValue($rb)); - } - - /** - * @dataProvider methodProvider - * @todo revisit this approach - */ - public function testCallBasicMethods($method) - { - $options = []; - $request = new Request('GET', '/somewhere'); - $response = new Response(200, [], $this->successBody); - - $requestBuilder = $this->prophesize(RequestBuilder::class); - $requestBuilder->build( - Argument::type('string'), - Argument::type('string'), - Argument::type('array') - )->willReturn($request); - - $this->requestWrapper->send( - Argument::type(RequestInterface::class), - Argument::type('array') - )->willReturn($response); - - $rest = new Rest(); - $rest->setRequestBuilder($requestBuilder->reveal()); - $rest->setRequestWrapper($this->requestWrapper->reveal()); - - $this->assertEquals(json_decode($this->successBody, true), $rest->$method($options)); - } - - /** - * @dataProvider methodProvider - */ - public function testSendWithRoutingHeaders($method) - { - $optionsWithDatabaseId = ['databaseId' => 'dbId']; - $optionsWithProjectId = ['projectId' => 'prodId']; - - $request = new Request('GET', '/somewhere'); - $requestBuilder = $this->prophesize(RequestBuilder::class); - $requestBuilder->build( - Argument::type('string'), - Argument::type('string'), - Argument::type('array') - )->willReturn($request); - - $rest = new Rest(); - $rest->setRequestBuilder($requestBuilder->reveal()); - - $args = []; - $this->validateMethodHasHeaders($rest, $method, $args, false); - - $args = $optionsWithDatabaseId; - $this->validateMethodHasHeaders($rest, $method, $args, false); - - $args = $optionsWithProjectId; - $this->validateMethodHasHeaders($rest, $method, $args, false); - - $args = $optionsWithProjectId + $optionsWithDatabaseId; - $this->validateMethodHasHeaders($rest, $method, $args, true); - } - - public function methodProvider() - { - return [ - ['allocateIds'], - ['beginTransaction'], - ['commit'], - ['lookup'], - ['rollback'], - ['runQuery'], - ]; - } - - private function validateMethodHasHeaders($rest, $method, $args, $isHeaderExpected) - { - $isCalled = 0; - $this->requestWrapper->send( - Argument::type(RequestInterface::class), - Argument::that(function ($options) use ($isHeaderExpected, $args, &$isCalled) { - $isCalled++; - if ($isHeaderExpected) { - $expectedHeaderValue = sprintf( - 'project_id=%s&database_id=%s', - $args['projectId'], - $args['databaseId'] - ); - return $expectedHeaderValue === - $options['restOptions']['headers']['x-goog-request-params']; - } else { - return !isset($options['restOptions']['headers']['x-goog-request-params']); - } - }) - )->willReturn(new Response(200, [], $this->successBody)); - $rest->setRequestWrapper($this->requestWrapper->reveal()); - $rest->$method($args); - $this->assertEquals(1, $isCalled); - } -} diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index 20457eb5e2d5..2e60bf159165 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -26,9 +26,6 @@ use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Core\Timestamp; use Google\Cloud\Datastore\Blob; -use Google\Cloud\Datastore\Connection\ConnectionInterface; -use Google\Cloud\Datastore\Connection\Grpc; -use Google\Cloud\Datastore\Connection\Rest; use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\GeoPoint; @@ -53,21 +50,18 @@ class DatastoreClientTest extends TestCase { use DatastoreOperationRefreshTrait; - use GrpcTestTrait; use ProphecyTrait; use ApiHelperTrait; const PROJECT = 'example-project'; const TRANSACTION = 'transaction-id'; - private $connection; private $client; private $requestHandler; private $serializer; public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); $this->client = TestHelpers::stub(DatastoreClient::class, [ ['projectId' => self::PROJECT] ], [ @@ -93,30 +87,6 @@ public function setUp(): void ]); } - public function testGrpcConnection() - { - $this->checkAndSkipGrpcTests(); - - $client = TestHelpers::stub(DatastoreClient::class, [[ - 'projectId' => self::PROJECT, - 'transport' => 'grpc', - ]]); - - $this->assertInstanceOf(Grpc::class, $client->___getProperty('connection')); - } - - public function testRestConnection() - { - $this->checkAndSkipGrpcTests(); - - $client = TestHelpers::stub(DatastoreClient::class, [[ - 'projectId' => self::PROJECT, - 'transport' => 'rest', - ]]); - - $this->assertInstanceOf(Rest::class, $client->___getProperty('connection')); - } - public function testKeyIncomplete() { $key = $this->client->key('Person'); @@ -223,7 +193,7 @@ public function testAllocateId($method, $batch = false) 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -258,7 +228,7 @@ public function testTransaction($method, $type, $key) ['transaction' => self::TRANSACTION] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); $res = $this->client->$method(); @@ -287,7 +257,7 @@ public function testTransactionWithOptions($method, $type, $key) 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -320,7 +290,7 @@ public function testEntityMutations($method, $mutation, $key) 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -345,7 +315,7 @@ public function testEntityMutationsBatch($method, $mutation, $key) 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -385,7 +355,7 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -416,7 +386,7 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -450,7 +420,7 @@ public function testSingleMutationConflict() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -472,7 +442,7 @@ public function testDelete() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -495,7 +465,7 @@ public function testDeleteBatch() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -521,7 +491,7 @@ public function testLookup() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -548,7 +518,7 @@ public function testLookupMissing() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -582,7 +552,7 @@ public function testLookupBatch() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -611,7 +581,7 @@ public function testLookupBatchWithReadTime() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -640,7 +610,7 @@ public function testLookupWithReadTime() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -686,7 +656,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -719,7 +689,7 @@ public function testRunAggregationQuery() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -758,7 +728,7 @@ public function testAggregationQueryWithDifferentReturnTypes($response, $expecte 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -798,7 +768,7 @@ public function testRunQueryWithReadTime() 0 ); - $this->refreshOperation($this->client, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -815,18 +785,9 @@ public function aggregationReturnTypesCases() return [ [['integerValue' => 1], 1], [['doubleValue' => 1.1], 1.1], - - // Returned incase of grpc client [['doubleValue' => INF], INF], [['doubleValue' => -INF], -INF], [['doubleValue' => NAN], NAN], - - // Returned incase of rest client - [['doubleValue' => 'Infinity'], INF], - [['doubleValue' => '-Infinity'], -INF], - [['doubleValue' => 'NaN'], NAN], - - [['nullValue' => ''], null], ]; } diff --git a/Datastore/tests/Unit/EntityMapperTest.php b/Datastore/tests/Unit/EntityMapperTest.php index f1937a85af6b..1b36e5c8c405 100644 --- a/Datastore/tests/Unit/EntityMapperTest.php +++ b/Datastore/tests/Unit/EntityMapperTest.php @@ -686,16 +686,6 @@ public function testValueObjectDoubleForGrpcClient($input, $expected) $this->compareResult($expected, $double['doubleValue']); } - /** - * @dataProvider valueObjectDoubleForRestCases - */ - public function testValueObjectDoubleForRestClient($input, $expected) - { - $mapper = new EntityMapper('foo', true, false, 'rest'); - $double = $mapper->valueObject($input); - $this->compareResult($expected, $double['doubleValue']); - } - public function testValueObjectString() { $string = $this->mapper->valueObject('foo'); @@ -922,13 +912,6 @@ public function datastoreToSimpleDoubleValueCases() { return [ [1.1, 1.1], - - // Happens when using rest client - ['Infinity', INF], - ['-Infinity', -INF], - ['NaN', NAN], - - // Happens when using grpc client [INF, INF], [-INF, -INF], [NAN, NAN] @@ -945,16 +928,6 @@ public function valueObjectDoubleCases() ]; } - public function valueObjectDoubleForRestCases() - { - return [ - [INF, 'Infinity'], - [1.1, 1.1], - [-INF, '-Infinity'], - [NAN, 'NaN'] - ]; - } - private function compareResult($expected, $actual) { if (is_float($expected)) { diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 294da7aebcaa..608059d7b73d 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -22,7 +22,6 @@ use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\TestHelpers; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityIterator; use Google\Cloud\Datastore\EntityMapper; @@ -54,13 +53,11 @@ class OperationTest extends TestCase public const DATABASEID = 'database-id'; private $operation; - private $connection; private $requestHandler; private $serializer; public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ 'google.protobuf.Value' => function ($v) { @@ -79,14 +76,13 @@ public function setUp(): void } ]); $this->operation = TestHelpers::stub(Operation::class, [ - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, self::PROJECT, null, new EntityMapper('foo', true, false), self::DATABASEID, - ], ['connection', 'requestHandler', 'namespaceId']); + ], ['requestHandler', 'namespaceId']); } public function testKey() @@ -291,7 +287,7 @@ public function testLookup() 0 ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $res = $this->operation->lookup([$key]); @@ -307,7 +303,7 @@ public function testLookupFound() ['found' => $body,] ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Kind', 'ID'); $res = $this->operation->lookup([$key]); @@ -332,7 +328,7 @@ public function testLookupMissing() ['missing' => $body,] ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Kind', 'ID'); @@ -355,7 +351,7 @@ public function testLookupDeferred() ['deferred' => [$body[0]['entity']['key']]] ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $key = $this->operation->key('Kind', 'ID'); @@ -686,12 +682,6 @@ public function testRunQueryWithoutReadOptions() public function testRunQueryWithDatabaseIdOverride() { - // $this->connection - // ->runQuery( - // Argument::withEntry('databaseId', 'otherDatabaseId') - // ) - // ->shouldBeCalledTimes(1) - // ->willReturn([]); $this->mockSendRequest( 'runQuery', ['databaseId' => 'otherDatabaseId'], @@ -788,7 +778,7 @@ public function testRollback() 0 ); - $this->operation->___setProperty('connection', $this->connection->reveal()); + $this->operation->___setProperty('requestHandler', $this->requestHandler->reveal()); $this->operation->rollback('bar'); } @@ -1101,13 +1091,6 @@ public function testAllocateIdsWithDatabaseIdOverride() public function testLookupWithDatabaseIdOverride() { - // $this->connection - // ->lookup( - // Argument::withEntry('databaseId', 'otherDatabaseId') - // ) - // ->shouldBeCalledTimes(1) - // ->willReturn([]); - $this->mockSendRequest( 'lookup', ['databaseId' => 'otherDatabaseId'], diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index 110583ab6543..a2c404d1dd5a 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -23,7 +23,6 @@ use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Core\Timestamp; -use Google\Cloud\Datastore\Connection\ConnectionInterface; use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\EntityMapper; use Google\Cloud\Datastore\Key; @@ -54,7 +53,6 @@ class TransactionTest extends TestCase const PROJECT = 'example-project'; const TRANSACTION = 'transaction-id'; - private $connection; private $transaction; private $readOnly; private $key; @@ -64,8 +62,6 @@ class TransactionTest extends TestCase public function setUp(): void { - $this->connection = $this->prophesize(ConnectionInterface::class); - $this->requestHandler = $this->prophesize(RequestHandler::class); $this->serializer = new Serializer([], [ @@ -86,7 +82,6 @@ public function setUp(): void ]); $op = new Operation( - $this->connection->reveal(), $this->requestHandler->reveal(), $this->serializer, self::PROJECT, @@ -128,7 +123,7 @@ public function testLookup(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -161,7 +156,7 @@ public function testLookupWithReadTime() ); $transaction = $this->readOnly; - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -188,7 +183,7 @@ public function testLookupMissing(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -223,7 +218,7 @@ public function testLookupBatch(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -253,7 +248,7 @@ public function testLookupBatchWithReadTime(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -284,7 +279,7 @@ public function testRunQuery(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -321,7 +316,7 @@ public function testRunAggregationQuery(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -360,7 +355,7 @@ public function testRunQueryWithReadTime() ); $transaction = $this->readOnly; - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -380,7 +375,7 @@ public function testRollback(callable $transaction) $this->mockSendRequest('rollback', ['transaction' => self::TRANSACTION], [], 0); $transaction = $transaction(); - $this->refreshOperation($transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -403,7 +398,7 @@ public function testEntityMutations($method, $mutation, $key) 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -429,7 +424,7 @@ public function testEntityMutationsBatch($method, $mutation, $key) 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -470,7 +465,7 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -505,7 +500,7 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -538,7 +533,7 @@ public function testDelete() 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -562,7 +557,7 @@ public function testDeleteBatch() 0 ); - $this->refreshOperation($this->transaction, $this->connection->reveal(), $this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); From 0596f277fa6ef38269683c767e9461a0c770ed4c Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 06:58:12 +0000 Subject: [PATCH 14/31] Remove old gapic files and class aliases --- Datastore/src/DatastoreClient.php | 1 - .../src/V1/AggregationQuery/Aggregation.php | 4 ---- .../src/V1/AggregationQuery/Aggregation/Avg.php | 4 ---- .../V1/AggregationQuery/Aggregation/Count.php | 4 ---- .../src/V1/AggregationQuery/Aggregation/Sum.php | 4 ---- .../src/V1/AggregationQuery_Aggregation.php | 16 ---------------- .../V1/AggregationQuery_Aggregation_Count.php | 16 ---------------- Datastore/src/V1/CommitRequest/Mode.php | 4 ---- Datastore/src/V1/CommitRequest_Mode.php | 16 ---------------- Datastore/src/V1/CompositeFilter/Operator.php | 4 ---- Datastore/src/V1/CompositeFilter_Operator.php | 16 ---------------- Datastore/src/V1/EntityResult/ResultType.php | 4 ---- Datastore/src/V1/EntityResult_ResultType.php | 16 ---------------- Datastore/src/V1/Key/PathElement.php | 4 ---- Datastore/src/V1/Key_PathElement.php | 16 ---------------- Datastore/src/V1/PropertyFilter/Operator.php | 4 ---- Datastore/src/V1/PropertyFilter_Operator.php | 16 ---------------- Datastore/src/V1/PropertyOrder/Direction.php | 4 ---- Datastore/src/V1/PropertyOrder_Direction.php | 16 ---------------- .../src/V1/QueryResultBatch/MoreResultsType.php | 4 ---- .../src/V1/QueryResultBatch_MoreResultsType.php | 16 ---------------- Datastore/src/V1/ReadOptions/ReadConsistency.php | 4 ---- Datastore/src/V1/ReadOptions_ReadConsistency.php | 16 ---------------- .../src/V1/TransactionOptions/PBReadOnly.php | 5 ----- .../src/V1/TransactionOptions/ReadWrite.php | 4 ---- Datastore/src/V1/TransactionOptions_ReadOnly.php | 16 ---------------- .../src/V1/TransactionOptions_ReadWrite.php | 16 ---------------- 27 files changed, 250 deletions(-) delete mode 100644 Datastore/src/V1/AggregationQuery_Aggregation.php delete mode 100644 Datastore/src/V1/AggregationQuery_Aggregation_Count.php delete mode 100644 Datastore/src/V1/CommitRequest_Mode.php delete mode 100644 Datastore/src/V1/CompositeFilter_Operator.php delete mode 100644 Datastore/src/V1/EntityResult_ResultType.php delete mode 100644 Datastore/src/V1/Key_PathElement.php delete mode 100644 Datastore/src/V1/PropertyFilter_Operator.php delete mode 100644 Datastore/src/V1/PropertyOrder_Direction.php delete mode 100644 Datastore/src/V1/QueryResultBatch_MoreResultsType.php delete mode 100644 Datastore/src/V1/ReadOptions_ReadConsistency.php delete mode 100644 Datastore/src/V1/TransactionOptions_ReadOnly.php delete mode 100644 Datastore/src/V1/TransactionOptions_ReadWrite.php diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index f7ae2fbef21e..42d5a8c463d8 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -22,7 +22,6 @@ use Google\ApiCore\ClientOptionsTrait; use Google\ApiCore\Serializer; use Google\Cloud\Core\ApiHelperTrait; -use Google\Cloud\Core\ClientTrait; use Google\Cloud\Core\DetectProjectIdTrait; use Google\Cloud\Core\Int64; use Google\Cloud\Core\RequestHandler; diff --git a/Datastore/src/V1/AggregationQuery/Aggregation.php b/Datastore/src/V1/AggregationQuery/Aggregation.php index fb137d823817..20face739249 100644 --- a/Datastore/src/V1/AggregationQuery/Aggregation.php +++ b/Datastore/src/V1/AggregationQuery/Aggregation.php @@ -284,7 +284,3 @@ public function getOperator() } } - -// Adding a class alias for backwards compatibility with the previous class name. -class_alias(Aggregation::class, \Google\Cloud\Datastore\V1\AggregationQuery_Aggregation::class); - diff --git a/Datastore/src/V1/AggregationQuery/Aggregation/Avg.php b/Datastore/src/V1/AggregationQuery/Aggregation/Avg.php index b5ec942bdb28..7da9ca15899e 100644 --- a/Datastore/src/V1/AggregationQuery/Aggregation/Avg.php +++ b/Datastore/src/V1/AggregationQuery/Aggregation/Avg.php @@ -80,7 +80,3 @@ public function setProperty($var) } } - -// Adding a class alias for backwards compatibility with the previous class name. -class_alias(Avg::class, \Google\Cloud\Datastore\V1\AggregationQuery_Aggregation_Avg::class); - diff --git a/Datastore/src/V1/AggregationQuery/Aggregation/Count.php b/Datastore/src/V1/AggregationQuery/Aggregation/Count.php index b4eefb58afb6..aca2def850d2 100644 --- a/Datastore/src/V1/AggregationQuery/Aggregation/Count.php +++ b/Datastore/src/V1/AggregationQuery/Aggregation/Count.php @@ -175,7 +175,3 @@ public function setUpToValue($var) return $this;} } - -// Adding a class alias for backwards compatibility with the previous class name. -class_alias(Count::class, \Google\Cloud\Datastore\V1\AggregationQuery_Aggregation_Count::class); - diff --git a/Datastore/src/V1/AggregationQuery/Aggregation/Sum.php b/Datastore/src/V1/AggregationQuery/Aggregation/Sum.php index f881817905a6..9d1ff33efe3b 100644 --- a/Datastore/src/V1/AggregationQuery/Aggregation/Sum.php +++ b/Datastore/src/V1/AggregationQuery/Aggregation/Sum.php @@ -89,7 +89,3 @@ public function setProperty($var) } } - -// Adding a class alias for backwards compatibility with the previous class name. -class_alias(Sum::class, \Google\Cloud\Datastore\V1\AggregationQuery_Aggregation_Sum::class); - diff --git a/Datastore/src/V1/AggregationQuery_Aggregation.php b/Datastore/src/V1/AggregationQuery_Aggregation.php deleted file mode 100644 index d37da97cdbc1..000000000000 --- a/Datastore/src/V1/AggregationQuery_Aggregation.php +++ /dev/null @@ -1,16 +0,0 @@ - Date: Thu, 4 Apr 2024 10:25:15 +0000 Subject: [PATCH 15/31] Fix unit test failures --- Core/tests/Unit/ServiceBuilderTest.php | 4 --- Datastore/tests/Unit/DatastoreClientTest.php | 8 +++-- Datastore/tests/Unit/TransactionTest.php | 32 -------------------- 3 files changed, 5 insertions(+), 39 deletions(-) diff --git a/Core/tests/Unit/ServiceBuilderTest.php b/Core/tests/Unit/ServiceBuilderTest.php index 3667628bb299..494d65fb418c 100644 --- a/Core/tests/Unit/ServiceBuilderTest.php +++ b/Core/tests/Unit/ServiceBuilderTest.php @@ -20,7 +20,6 @@ use Google\Cloud\Core\ServiceBuilder; use Google\Cloud\Core\Testing\CheckForClassTrait; use Google\Cloud\Core\Testing\GrpcTestTrait; -use Google\Cloud\Datastore\DatastoreClient; use Google\Cloud\Firestore\FirestoreClient; use Google\Cloud\Language\LanguageClient; use Google\Cloud\Logging\LoggingClient; @@ -161,9 +160,6 @@ public function serviceProvider() [ 'bigQuery', BigQueryClient::class - ], [ - 'datastore', - DatastoreClient::class ], [ 'firestore', FirestoreClient::class, diff --git a/Datastore/tests/Unit/DatastoreClientTest.php b/Datastore/tests/Unit/DatastoreClientTest.php index 2e60bf159165..d7bf1072074c 100644 --- a/Datastore/tests/Unit/DatastoreClientTest.php +++ b/Datastore/tests/Unit/DatastoreClientTest.php @@ -23,6 +23,7 @@ use Google\Cloud\Core\RequestHandler; use Google\Cloud\Core\Testing\DatastoreOperationRefreshTrait; use Google\Cloud\Core\Testing\GrpcTestTrait; +use Google\Cloud\Core\Testing\Snippet\Fixtures; use Google\Cloud\Core\Testing\TestHelpers; use Google\Cloud\Core\Timestamp; use Google\Cloud\Datastore\Blob; @@ -30,7 +31,6 @@ use Google\Cloud\Datastore\Entity; use Google\Cloud\Datastore\GeoPoint; use Google\Cloud\Datastore\Key; -use Google\Cloud\Datastore\Query\Aggregation; use Google\Cloud\Datastore\Query\AggregationQuery; use Google\Cloud\Datastore\Query\AggregationQueryResult; use Google\Cloud\Datastore\Query\GqlQuery; @@ -40,7 +40,6 @@ use Google\Cloud\Datastore\Transaction; use Google\Cloud\Datastore\V1\CommitRequest\Mode; use PHPUnit\Framework\TestCase; -use Prophecy\Argument; use Prophecy\PhpUnit\ProphecyTrait; /** @@ -63,7 +62,10 @@ class DatastoreClientTest extends TestCase public function setUp(): void { $this->client = TestHelpers::stub(DatastoreClient::class, [ - ['projectId' => self::PROJECT] + [ + 'projectId' => self::PROJECT, + 'credentials' => Fixtures::KEYFILE_STUB_FIXTURE() + ] ], [ 'operation' ]); diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index a2c404d1dd5a..efbc0881dec4 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -132,38 +132,6 @@ public function testLookup(callable $transaction) $this->assertEquals($this->key->keyObject(), $res->key()->keyObject()); } - public function testLookupWithReadTime() - { - $time = new Timestamp(new \DateTime()); - - $this->mockSendRequest( - 'lookup', - [ - 'readOptions' => [ - 'readTime' => $time, - 'transaction' => self::TRANSACTION, - ], - 'keys' => [$this->key->keyObject()], - ], - [ - 'found' => [ - [ - 'entity' => $this->entityArray($this->key) - ] - ] - ], - 0 - ); - - $transaction = $this->readOnly; - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ - 'projectId' => self::PROJECT - ]); - - $res = $transaction->lookup($this->key, ['readTime' => $time]); - $this->assertInstanceOf(Entity::class, $res); - } - /** * @dataProvider transactionProvider */ From e6fa30a368503b12df258329f956c80779db15c4 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 10:33:52 +0000 Subject: [PATCH 16/31] Fix PHP style checks --- Datastore/src/Operation.php | 18 ++++++++---- .../tests/Snippet/ReadOnlyTransactionTest.php | 12 ++++---- Datastore/tests/Snippet/TransactionTest.php | 24 ++++++++-------- Datastore/tests/Unit/OperationTest.php | 6 ++-- Datastore/tests/Unit/TransactionTest.php | 28 +++++++++---------- 5 files changed, 48 insertions(+), 40 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index b68d92ca7483..506346b9f9c8 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -459,7 +459,13 @@ public function lookup(array $keys, array $options = []) $serviceKeys[] = $key->keyObject(); }); - list($data, $optionalArgs) = $this->splitOptionalArgs($options, ['transaction', 'className', 'sort', 'readTime', 'readConsistency']); + list($data, $optionalArgs) = $this->splitOptionalArgs($options, [ + 'transaction', + 'className', + 'sort', + 'readTime', + 'readConsistency' + ]); $data += $this->readOptions($options) + [ 'projectId' => $this->projectId, 'databaseId' => $this->databaseId, @@ -748,7 +754,7 @@ public function commit(array $mutations, array $options = []) $data = $mutation[$mutationType]; if (isset($data['properties'])) { foreach ($data['properties'] as &$property) { - list ($type, $val) = $this->toGrpcValue($property); + list($type, $val) = $this->toGrpcValue($property); $property[$type] = $val; } @@ -756,7 +762,7 @@ public function commit(array $mutations, array $options = []) $mutation[$mutationType] = $data; - $mutation = $this->serializer->decodeMessage(new Mutation, $mutation); + $mutation = $this->serializer->decodeMessage(new Mutation(), $mutation); } $options += [ @@ -1104,7 +1110,7 @@ private function parseQuery(array $query) } $parsedQuery = $this->serializer->decodeMessage( - new V1Query, + new V1Query(), $query ); return $parsedQuery; @@ -1139,7 +1145,7 @@ private function parseGqlQuery(array $gqlQuery) } $parsedGqlQuery = $this->serializer->decodeMessage( - new GqlQuery, + new GqlQuery(), $gqlQuery ); @@ -1198,7 +1204,7 @@ private function prepareQueryBinding(array $binding) { $value = $binding['value']; - list ($type, $val) = $this->toGrpcValue($value); + list($type, $val) = $this->toGrpcValue($value); $binding['value'][$type] = $val; diff --git a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php index 4d71de24aeda..c97a60255ab8 100644 --- a/Datastore/tests/Snippet/ReadOnlyTransactionTest.php +++ b/Datastore/tests/Snippet/ReadOnlyTransactionTest.php @@ -104,7 +104,7 @@ public function testClass() 0 ); - $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -134,7 +134,7 @@ public function testClassRollback() $snippet = $this->snippetFromClass(ReadOnlyTransaction::class, 1); - $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -175,7 +175,7 @@ public function testLookup() ] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -226,7 +226,7 @@ public function testLookupBatch() ] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -272,7 +272,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -287,7 +287,7 @@ public function testRollback() $this->mockSendRequest('rollback', [], [], 0); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Snippet/TransactionTest.php b/Datastore/tests/Snippet/TransactionTest.php index 542f1c8962ad..5ecc4fbec75b 100644 --- a/Datastore/tests/Snippet/TransactionTest.php +++ b/Datastore/tests/Snippet/TransactionTest.php @@ -108,7 +108,7 @@ public function testClass() 0 ); - $this->refreshOperation($this->client,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->client, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -132,7 +132,7 @@ public function testInsert() ] ]); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -153,7 +153,7 @@ public function testInsertBatch() $this->allocateIdsRequestHandlerMock(); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -175,7 +175,7 @@ public function testUpdate() ] ]); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -212,7 +212,7 @@ public function testUpsert() ] ]); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -246,7 +246,7 @@ public function testDelete() ] ]); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -293,7 +293,7 @@ public function testLookup() ] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -344,7 +344,7 @@ public function testLookupBatch() ] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -390,7 +390,7 @@ public function testRunQuery() 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -426,7 +426,7 @@ public function testRunAggregationQuery() 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -441,7 +441,7 @@ public function testCommit() $this->mockSendRequest('commit', [], [], 0); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -455,7 +455,7 @@ public function testRollback() $this->mockSendRequest('rollback', [], [], 0); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); diff --git a/Datastore/tests/Unit/OperationTest.php b/Datastore/tests/Unit/OperationTest.php index 608059d7b73d..42fa70e9e4f0 100644 --- a/Datastore/tests/Unit/OperationTest.php +++ b/Datastore/tests/Unit/OperationTest.php @@ -666,7 +666,9 @@ public function testRunQueryWithoutReadOptions() $this->requestHandler->sendRequest( DatastoreClient::class, 'runQuery', - Argument::that(function ($req) {return !$req->hasReadOptions();}), + Argument::that(function ($req) { + return !$req->hasReadOptions(); + }), Argument::cetera() )->willReturn([])->shouldBeCalled(); @@ -862,7 +864,7 @@ public function testMutateWithKey() $this->requestHandler->sendRequest( DatastoreClient::class, 'commit', - Argument::that(function ($arg) use ($otherThis){ + Argument::that(function ($arg) use ($otherThis) { $data = $otherThis->serializer->encodeMessage($arg); $x = isset($data['mutations'][0]['delete']['path']); return isset($data['mutations'][0]['delete']['path']); diff --git a/Datastore/tests/Unit/TransactionTest.php b/Datastore/tests/Unit/TransactionTest.php index efbc0881dec4..de21427076db 100644 --- a/Datastore/tests/Unit/TransactionTest.php +++ b/Datastore/tests/Unit/TransactionTest.php @@ -123,7 +123,7 @@ public function testLookup(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -151,7 +151,7 @@ public function testLookupMissing(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -186,7 +186,7 @@ public function testLookupBatch(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -216,7 +216,7 @@ public function testLookupBatchWithReadTime(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -247,7 +247,7 @@ public function testRunQuery(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -284,7 +284,7 @@ public function testRunAggregationQuery(callable $transaction) ); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -323,7 +323,7 @@ public function testRunQueryWithReadTime() ); $transaction = $this->readOnly; - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -343,7 +343,7 @@ public function testRollback(callable $transaction) $this->mockSendRequest('rollback', ['transaction' => self::TRANSACTION], [], 0); $transaction = $transaction(); - $this->refreshOperation($transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -366,7 +366,7 @@ public function testEntityMutations($method, $mutation, $key) 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -392,7 +392,7 @@ public function testEntityMutationsBatch($method, $mutation, $key) 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -433,7 +433,7 @@ public function testMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -468,7 +468,7 @@ public function testBatchMutationsWithPartialKey($method, $mutation, $key, $id) ['keys' => [$keyWithId->keyObject()]] ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -501,7 +501,7 @@ public function testDelete() 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); @@ -525,7 +525,7 @@ public function testDeleteBatch() 0 ); - $this->refreshOperation($this->transaction,$this->requestHandler->reveal(), [ + $this->refreshOperation($this->transaction, $this->requestHandler->reveal(), [ 'projectId' => self::PROJECT ]); From 2d01ea6b3eed91bbe0b42ea7331bd29e3b98a6e0 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 10:39:22 +0000 Subject: [PATCH 17/31] Fix aggregation query snippet test --- Datastore/tests/Snippet/Query/AggregationQueryTest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Datastore/tests/Snippet/Query/AggregationQueryTest.php b/Datastore/tests/Snippet/Query/AggregationQueryTest.php index 8d55e1d51040..9b4bf0c46d93 100644 --- a/Datastore/tests/Snippet/Query/AggregationQueryTest.php +++ b/Datastore/tests/Snippet/Query/AggregationQueryTest.php @@ -73,7 +73,7 @@ public function setUp(): void 'my-awesome-project', '', $mapper - ]); + ], ['requestHandler']); } public function testClass() From e098d66e7b0c0e0d4d940da4bb6594f72b9057b5 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:46:13 +0000 Subject: [PATCH 18/31] Add MIGRATION.md --- Datastore/MIGRATION.md | 83 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 Datastore/MIGRATION.md diff --git a/Datastore/MIGRATION.md b/Datastore/MIGRATION.md new file mode 100644 index 000000000000..c9c355ee1941 --- /dev/null +++ b/Datastore/MIGRATION.md @@ -0,0 +1,83 @@ +# Migrating Google Datastore from V1 to V2 + +## How to upgrade + +Update your `google/cloud-datastore` dependency to `^2.0`: + +``` +{ + "require": { + "google/cloud-datastore": "^2.0" + } +} +``` + +## Changes + +### Client Options changes + +The following client options are removed/replaced with other options present in +[`ClientOptions`][ClientOptions]. This was done to ensure client options are consistent across all +Google Cloud clients. + +- `authCache` -> Moved to `credentialsConfig.authCache` +- `authCacheOptions` -> Moved to `credentialsConfig.authCacheOptions` +- `credentialsFetcher` -> Moved to `credentials` +- `keyFile` -> Moved to `credentials` +- `keyFilePath` -> Moved to `credentials` +- `requestTimeout` -> Removed from client options and moved to a call option `timeoutMillis` +- `scopes` -> Moved to `credentialsConfig.scopes` +- `defaultScopes` -> Moved to `credentialsConfig.defaultScopes` +- `quotaProject` -> Moved to `credentialsConfig.quotaProject` +- `httpHandler` -> Moved to `transportConfig.rest.httpHandler` +- `authHttpHandler` -> Moved to `credentialsConfig.authHttpHandler` +- `asyncHttpHandler` -> Removed in favour of a single httpHandler option. +- `restOptions` -> Moved to `transportConfig.rest` +- `grpcOptions` -> Moved to `transportConfig.grpc` +- `accessToken` -> Removed +- `shouldSignRequest` -> Removed +- `preferNumericProjectId` -> Removed + +### Retry Options changes + +The retry options have been moved to use [`RetrySettings`][RetrySettings] in Client Options and in +call options. + +- `retries` -> Renamed to `retrySettings.maxRetries` +- `restRetryFunction` -> Renamed to `retrySettings.retryFunction` +- `grpcRetryFunction` -> Renamed to `retrySettings.retryFunction` +- `delayFunc`/`calcDelayFunction` -> Removed in favor of the properties + `retrySettings.initialRetryDelayMillis`, `retrySettings.retryDelayMultiplier` and + `retrySettings.maxRetryDelayMillis`. + +[RetrySettings]: https://googleapis.github.io/gax-php/v1.26.1/Google/ApiCore/RetrySettings.html + +[ClientOptions]: https://googleapis.github.io/gax-php/v1.26.1/Google/ApiCore/Options/ClientOptions.html + +### Connection classes are not used anymore. + +This is a major change with this major version but one that we hope won't break most users. When one +created a `DatastoreClient`, behind the scenes a connection adapter was initialized based on your +transport preferences and then forwarded to operation class internally. This connection adapter was used +to deliver requests internally: + +```php +// This initialized a connection object and passed it internally to Operation class. +$client = new DatastoreClient(['transport' => 'rest']); +// This used the connection object internally to deliver the lookup request. +$client->lookup($key); +``` + +As you can see the connection object was handled internally. If you used the library in this way, +you will not need to make any changes. However, if you created the connection classes directly +and passed it to the Operation class, this will break in Datastore `v2`: + +```php +// Not intended +$connObj = new Rest([]); +$operation = new Operation( + $connObj, + // other operation options +); +$operation->lookup($keys); +``` From 2196aa21a0bb61dcfff0beda37c6ee7023952dec Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:46:28 +0000 Subject: [PATCH 19/31] Update documentation for DatastoreClient --- Datastore/src/DatastoreClient.php | 60 ++++++++++++++++++------------- 1 file changed, 35 insertions(+), 25 deletions(-) diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 42d5a8c463d8..806680c229df 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -135,37 +135,47 @@ class DatastoreClient * place of the service's default endpoint. * @type string $projectId The project ID from the Google Developer's * Console. - * @type CacheItemPoolInterface $authCache A cache for storing access - * tokens. **Defaults to** a simple in memory implementation. - * @type array $authCacheOptions Cache configuration options. - * @type callable $authHttpHandler A handler used to deliver Psr7 - * requests specifically for authentication. - * @type FetchAuthTokenInterface $credentialsFetcher A credentials - * fetcher instance. - * @type callable $httpHandler A handler used to deliver Psr7 requests. - * Only valid for requests sent over REST. - * @type array $keyFile The contents of the service account credentials - * .json file retrieved from the Google Developer's Console. - * Ex: `json_decode(file_get_contents($path), true)`. - * @type string $keyFilePath The full path to your service account - * credentials .json file retrieved from the Google Developers - * Console. - * @type float $requestTimeout Seconds to wait before timing out the - * request. **Defaults to** `0` with REST and `60` with gRPC. - * @type int $retries Number of retries for a failed request. **Defaults - * to** `3`. - * @type array $scopes Scopes to be used for the request. - * @type string $quotaProject Specifies a user project to bill for - * access charges associated with the request. + * @type array $credentialsConfig Options used to configure credentials, including + * auth token caching, http handler, for the client. For a full list of + * supporting configuration options, see + * {@see \Google\ApiCore\CredentialsWrapper::build()} . + * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials + * The credentials to be used by the client to authorize API calls. This option + * accepts either a path to a credentials file, or a decoded credentials file as a + * PHP array. + * *Advanced usage*: In addition, this option can also accept a pre-constructed + * {@see \Google\Auth\FetchAuthTokenInterface} object or + * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these + * objects are provided, any settings in $credentialsConfig will be ignored. + * @type array $transportConfig + * Configuration options that will be used to construct the transport. Options for + * each supported transport type should be passed in a key for that transport. For + * example: + * $transportConfig = [ + * 'grpc' => [...], + * 'rest' => [...], + * ]; + * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and + * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the + * supported options. + * @type string|TransportInterface $transport + * The transport used for executing network requests. May be either the string + * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. + * *Advanced usage*: Additionally, it is possible to pass in an already + * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note + * that when this object is provided, any settings in $transportConfig, and any + * $apiEndpoint setting, will be ignored. + * @type string|array $clientConfig + * Client method configuration, including retry settings. This option can be either + * a path to a JSON file, or a PHP array containing the decoded JSON data. By + * default this settings points to the default client config file, which is + * provided in the resources folder. * @type string $namespaceId Partitions data under a namespace. Useful for * [Multitenant Projects](https://cloud.google.com/datastore/docs/concepts/multitenancy). * @type string $databaseId ID of the database to which the entities belong. * @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 string $transport The transport type used for requests. May be - * either `grpc` or `rest`. **Defaults to** `grpc` if gRPC support - * is detected on the system. * } * @throws \InvalidArgumentException */ From bf2c50b7b85c663beec4861ef21ccb8c72b04538 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:49:10 +0000 Subject: [PATCH 20/31] Increase minimum core version to 1.55 --- Datastore/composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Datastore/composer.json b/Datastore/composer.json index fcc0640abdf8..05c85030d06b 100644 --- a/Datastore/composer.json +++ b/Datastore/composer.json @@ -5,7 +5,7 @@ "minimum-stability": "stable", "require": { "php": "^8.0", - "google/cloud-core": "^1.52.7", + "google/cloud-core": "^1.55", "google/gax": "^1.30" }, "require-dev": { From d6e2823a396a9190d0048e62b118d3e423d05180 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:54:29 +0000 Subject: [PATCH 21/31] Mark `Operation` as internal --- Datastore/src/Operation.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 506346b9f9c8..57c03d71b89c 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -61,6 +61,8 @@ * Examples are omitted for brevity. Detailed usage examples can be found in * {@see \Google\Cloud\Datastore\DatastoreClient} and * {@see \Google\Cloud\Datastore\Transaction}. + * + * @internal */ class Operation { From af549dd3c91459bc890864fa84db5d049df18837 Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Thu, 4 Apr 2024 15:40:02 +0000 Subject: [PATCH 22/31] Increase minimum core version to 1.57 (to be version) --- Datastore/composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Datastore/composer.json b/Datastore/composer.json index 05c85030d06b..6603ac235a77 100644 --- a/Datastore/composer.json +++ b/Datastore/composer.json @@ -5,7 +5,7 @@ "minimum-stability": "stable", "require": { "php": "^8.0", - "google/cloud-core": "^1.55", + "google/cloud-core": "^1.57", "google/gax": "^1.30" }, "require-dev": { From 170d59035493432a177f4c5c3ef0daa6adf1aa3a Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Fri, 5 Apr 2024 09:48:55 +0000 Subject: [PATCH 23/31] Fix emulator tests --- .../tests/System/AggregationQueryTest.php | 6 +++--- .../tests/System/DatastoreMultipleDbTest.php | 18 +++++++++--------- .../System/DatastoreMultipleDbTestCase.php | 11 +++++++---- Datastore/tests/System/DatastoreTestCase.php | 13 ++++++++----- Datastore/tests/System/FilterTest.php | 6 +++--- .../tests/System/QueryResultPaginationTest.php | 4 ++-- Datastore/tests/System/RunQueryTest.php | 18 +++++++++--------- 7 files changed, 41 insertions(+), 35 deletions(-) diff --git a/Datastore/tests/System/AggregationQueryTest.php b/Datastore/tests/System/AggregationQueryTest.php index 283a8e3c3c35..5bcbd9230a77 100644 --- a/Datastore/tests/System/AggregationQueryTest.php +++ b/Datastore/tests/System/AggregationQueryTest.php @@ -46,10 +46,10 @@ public static function setUpBeforeClass(): void { parent::setUpBeforeClass(); self::$kind = uniqid('testKind'); - $keys = self::$restClient->keys(self::$kind, ['number' => count(self::$data)]); - $keys = self::$restClient->allocateIds($keys); + $keys = self::$grpcClient->keys(self::$kind, ['number' => count(self::$data)]); + $keys = self::$grpcClient->allocateIds($keys); foreach ($keys as $count => $key) { - self::$restClient->insert(self::$restClient->entity($key, self::$data[$count])); + self::$grpcClient->insert(self::$grpcClient->entity($key, self::$data[$count])); } // on rare occasions the queries below are returning no results when diff --git a/Datastore/tests/System/DatastoreMultipleDbTest.php b/Datastore/tests/System/DatastoreMultipleDbTest.php index 43c0ce5b64a5..01d2beeeb6ec 100644 --- a/Datastore/tests/System/DatastoreMultipleDbTest.php +++ b/Datastore/tests/System/DatastoreMultipleDbTest.php @@ -51,18 +51,18 @@ class DatastoreMultipleDbTest extends DatastoreMultipleDbTestCase public static function setUpBeforeClass(): void { parent::setUpMultiDbBeforeClass(); - self::$ancestor = self::$restMultiDbClient->key(self::$kind, 'V_A'); - $key1 = self::$restMultiDbClient->key(self::$kind, 'B_S'); + self::$ancestor = self::$grpcMultiDbClient->key(self::$kind, 'V_A'); + $key1 = self::$grpcMultiDbClient->key(self::$kind, 'B_S'); $key1->ancestorKey(self::$ancestor); - $key2 = self::$restMultiDbClient->key(self::$kind, 'D_S'); + $key2 = self::$grpcMultiDbClient->key(self::$kind, 'D_S'); $key2->ancestorKey(self::$ancestor); - $key3 = self::$restMultiDbClient->key(self::$kind, 'S_D'); + $key3 = self::$grpcMultiDbClient->key(self::$kind, 'S_D'); - self::$restMultiDbClient->insertBatch([ - self::$restMultiDbClient->entity(self::$ancestor, self::$data[0]), - self::$restMultiDbClient->entity($key1, self::$data[1]), - self::$restMultiDbClient->entity($key2, self::$data[2]), - self::$restMultiDbClient->entity($key3, self::$data[3]), + self::$grpcMultiDbClient->insertBatch([ + self::$grpcMultiDbClient->entity(self::$ancestor, self::$data[0]), + self::$grpcMultiDbClient->entity($key1, self::$data[1]), + self::$grpcMultiDbClient->entity($key2, self::$data[2]), + self::$grpcMultiDbClient->entity($key3, self::$data[3]), ]); // on rare occasions the queries below are returning no results when diff --git a/Datastore/tests/System/DatastoreMultipleDbTestCase.php b/Datastore/tests/System/DatastoreMultipleDbTestCase.php index 79b425befc94..50ad1d217b13 100644 --- a/Datastore/tests/System/DatastoreMultipleDbTestCase.php +++ b/Datastore/tests/System/DatastoreMultipleDbTestCase.php @@ -83,10 +83,13 @@ public function multiDbClientProvider() self::$multipleDbValidationResult = true; } - return [ - 'multiDbRestClient' => [self::$restMultiDbClient], - 'multiDbGrpcClient' => [self::$grpcMultiDbClient], - ]; + $clients = ['multiDbGrpcClient' => [self::$grpcMultiDbClient]]; + // Emulators don't work well in ReGapic mode + if (!getenv("DATASTORE_EMULATOR_HOST")) { + $clients['multiDbRestClient'] = [self::$restClient]; + } + + return $clients; } public function clientProvider() diff --git a/Datastore/tests/System/DatastoreTestCase.php b/Datastore/tests/System/DatastoreTestCase.php index cce2b0410a55..e6ddb9bf4390 100644 --- a/Datastore/tests/System/DatastoreTestCase.php +++ b/Datastore/tests/System/DatastoreTestCase.php @@ -70,7 +70,7 @@ public static function tearDownFixtures() } $backoff = new ExponentialBackoff(8); - $transaction = self::$restClient->transaction(); + $transaction = self::$grpcClient->transaction(); self::$localDeletionQueue->process(function ($items) use ($backoff, $transaction) { $backoff->execute(function () use ($items, $transaction) { @@ -82,11 +82,14 @@ public static function tearDownFixtures() public function defaultDbClientProvider() { self::setUpBeforeClass(); + $clients = ['grpcClient' => [self::$grpcClient]]; - return [ - 'restClient' => [self::$restClient], - 'grpcClient' => [self::$grpcClient] - ]; + // Emulators don't work well in ReGapic mode + if (!getenv("DATASTORE_EMULATOR_HOST")) { + $clients['restClient'] = [self::$restClient]; + } + + return $clients; } public static function skipEmulatorTests() diff --git a/Datastore/tests/System/FilterTest.php b/Datastore/tests/System/FilterTest.php index dd971aab50ee..f0ef9e560c14 100644 --- a/Datastore/tests/System/FilterTest.php +++ b/Datastore/tests/System/FilterTest.php @@ -33,10 +33,10 @@ public static function setUpBeforeClass(): void $data = self::getInitialData(); $entities = []; foreach ($data as $element) { - $key = self::$restClient->key(self::$kind, $element['Name']); - $entities[] = self::$restClient->entity($key, $element); + $key = self::$grpcClient->key(self::$kind, $element['Name']); + $entities[] = self::$grpcClient->entity($key, $element); } - self::$restClient->insertBatch($entities); + self::$grpcClient->insertBatch($entities); // on rare occasions the queries below are returning no results when // triggered immediately after an insert operation. the sleep here diff --git a/Datastore/tests/System/QueryResultPaginationTest.php b/Datastore/tests/System/QueryResultPaginationTest.php index 067154d70a42..2fa23d883a86 100644 --- a/Datastore/tests/System/QueryResultPaginationTest.php +++ b/Datastore/tests/System/QueryResultPaginationTest.php @@ -40,7 +40,7 @@ public static function setUpBeforeClass(): void $ancestorKind = uniqid(self::TESTING_PREFIX); - $client = self::$restClient; + $client = self::$grpcClient; self::$parentKey = $client->key($ancestorKind, uniqid('pagination-')); self::$testKind = uniqid('test-kind-'); @@ -71,7 +71,7 @@ public static function tearDownAfterClass(): void { self::setUpBeforeClass(); - $client = self::$restClient; + $client = self::$grpcClient; $q = $client->query() ->hasAncestor(self::$parentKey) ->kind(self::$testKind); diff --git a/Datastore/tests/System/RunQueryTest.php b/Datastore/tests/System/RunQueryTest.php index 868f7b520957..3a45997b0623 100644 --- a/Datastore/tests/System/RunQueryTest.php +++ b/Datastore/tests/System/RunQueryTest.php @@ -55,18 +55,18 @@ class RunQueryTest extends DatastoreMultipleDbTestCase public static function setUpBeforeClass(): void { parent::setUpBeforeClass(); - self::$ancestor = self::$restClient->key(self::$kind, 'Grandpa Frank'); - $key1 = self::$restClient->key(self::$kind, 'Frank'); + self::$ancestor = self::$grpcClient->key(self::$kind, 'Grandpa Frank'); + $key1 = self::$grpcClient->key(self::$kind, 'Frank'); $key1->ancestorKey(self::$ancestor); - $key2 = self::$restClient->key(self::$kind, 'Dave'); + $key2 = self::$grpcClient->key(self::$kind, 'Dave'); $key2->ancestorKey(self::$ancestor); - $key3 = self::$restClient->key(self::$kind, 'Greg'); + $key3 = self::$grpcClient->key(self::$kind, 'Greg'); - self::$restClient->insertBatch([ - self::$restClient->entity(self::$ancestor, self::$data[0]), - self::$restClient->entity($key1, self::$data[1]), - self::$restClient->entity($key2, self::$data[2]), - self::$restClient->entity($key3, self::$data[3]) + self::$grpcClient->insertBatch([ + self::$grpcClient->entity(self::$ancestor, self::$data[0]), + self::$grpcClient->entity($key1, self::$data[1]), + self::$grpcClient->entity($key2, self::$data[2]), + self::$grpcClient->entity($key3, self::$data[3]) ]); // on rare occasions the queries below are returning no results when From 8e43aab8c8fef1cac6de986bdc607e6b9364d25e Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Fri, 5 Apr 2024 11:39:29 +0000 Subject: [PATCH 24/31] Self iteration --- Core/src/GrpcTrait.php | 1 - .../DatastoreOperationRefreshTrait.php | 62 ++++++++----------- Datastore/src/DatastoreClient.php | 6 -- Datastore/src/Operation.php | 3 +- 4 files changed, 27 insertions(+), 45 deletions(-) diff --git a/Core/src/GrpcTrait.php b/Core/src/GrpcTrait.php index 86d8ef159e15..bab9d6d325d2 100644 --- a/Core/src/GrpcTrait.php +++ b/Core/src/GrpcTrait.php @@ -18,7 +18,6 @@ namespace Google\Cloud\Core; use Google\Auth\GetUniverseDomainInterface; -use Google\ApiCore\ArrayTrait; use Google\ApiCore\CredentialsWrapper; use Google\Cloud\Core\Exception\NotFoundException; use Google\Cloud\Core\Exception\ServiceException; diff --git a/Core/src/Testing/DatastoreOperationRefreshTrait.php b/Core/src/Testing/DatastoreOperationRefreshTrait.php index b94b9bf8a75a..29cd8a478703 100644 --- a/Core/src/Testing/DatastoreOperationRefreshTrait.php +++ b/Core/src/Testing/DatastoreOperationRefreshTrait.php @@ -60,22 +60,7 @@ public function refreshOperation($stub, RequestHandler $requestHandler, array $o $options['returnInt64AsObject'] ); - $serializer = new Serializer([], [ - 'google.protobuf.Value' => function ($v) { - return $this->flattenValue($v); - }, - 'google.protobuf.Timestamp' => function ($v) { - return $this->formatTimestampFromApi($v); - } - ], [], [ - 'google.protobuf.Timestamp' => function ($v) { - if (is_string($v)) { - $dt = new \DateTime($v); - return ['seconds' => $dt->format('U')]; - } - return $v; - } - ]); + $serializer = $this->getSerializer(); $stub->___setProperty('operation', new Operation( $requestHandler, @@ -105,26 +90,7 @@ public function refreshOperation($stub, RequestHandler $requestHandler, array $o */ private function mockSendRequest($methodName, $params, $returnValue, $shouldBeCalledTimes = null) { - if (isset($this->serializer)) { - $serializer = $this->serializer; - } else { - $serializer = new Serializer([], [ - 'google.protobuf.Value' => function ($v) { - return $this->flattenValue($v); - }, - 'google.protobuf.Timestamp' => function ($v) { - return $this->formatTimestampFromApi($v); - } - ], [], [ - 'google.protobuf.Timestamp' => function ($v) { - if (is_string($v)) { - $dt = new \DateTime($v); - return ['seconds' => $dt->format('U')]; - } - return $v; - } - ]); - } + $serializer = $this->getSerializer(); $prophecy = $this->requestHandler->sendRequest( DatastoreClient::class, @@ -153,4 +119,28 @@ private function mockSendRequest($methodName, $params, $returnValue, $shouldBeCa $prophecy->willReturn($returnValue); } + + private function getSerializer() + { + if (isset($this->serializer)) { + return $this->serializer; + } + + return new Serializer([], [ + 'google.protobuf.Value' => function ($v) { + return $this->flattenValue($v); + }, + 'google.protobuf.Timestamp' => function ($v) { + return $this->formatTimestampFromApi($v); + } + ], [], [ + 'google.protobuf.Timestamp' => function ($v) { + if (is_string($v)) { + $dt = new \DateTime($v); + return ['seconds' => $dt->format('U')]; + } + return $v; + } + ]); + } } diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 806680c229df..0a2946feeba6 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -191,12 +191,6 @@ public function __construct(array $config = []) 'projectIdRequired' => true, 'hasEmulator' => (bool) $emulatorHost, 'emulatorHost' => $emulatorHost, - 'transportConfig' => [ - 'grpc' => [ - // increase default limit to 4MB to prevent metadata exhausted errors - 'stubOpts' => ['grpc.max_metadata_size' => 4 * 1024 * 1024,] - ], - ], ]; $config = $this->buildClientOptions($config); $config['credentials'] = $this->createCredentialsWrapper( diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 57c03d71b89c..b6e7bd11c3e0 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -475,7 +475,6 @@ public function lookup(array $keys, array $options = []) ]; $request = $this->serializer->decodeMessage(new LookupRequest(), $data); - $x = $this->serializer->encodeMessage($request); $res = $this->requestHandler->sendRequest( DatastoreClient::class, @@ -774,7 +773,7 @@ public function commit(array $mutations, array $options = []) ]; if (is_null($options['transaction'])) { - // Remove 'transaction' if `null` to avoid serialization error + // Remove 'transaction' if set to `null` to avoid serialization error unset($options['transaction']); } list($data, $optionalArgs) = $this->splitOptionalArgs($options, ['allowOverwrite', 'baseVersion']); From fad4022373828816a8fcee9aedfa2969734fd02b Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Mon, 6 May 2024 14:09:03 +0000 Subject: [PATCH 25/31] Iteration 1 --- Datastore/src/DatastoreClient.php | 10 +++++++--- Datastore/src/Operation.php | 13 +------------ 2 files changed, 8 insertions(+), 15 deletions(-) diff --git a/Datastore/src/DatastoreClient.php b/Datastore/src/DatastoreClient.php index 5f7eadd047ab..aa13e7139c46 100644 --- a/Datastore/src/DatastoreClient.php +++ b/Datastore/src/DatastoreClient.php @@ -98,6 +98,10 @@ class DatastoreClient const FULL_CONTROL_SCOPE = 'https://www.googleapis.com/auth/datastore'; + /** + * Keeping this consistent with veneer libraries where + * multiple clients are present. + */ private const GAPIC_KEYS = [ V1DatastoreClient::class ]; @@ -108,7 +112,7 @@ class DatastoreClient * The request handler responsible for sending requests and * serializing responses into relevant classes. */ - protected $requestHandler; + private $requestHandler; /** * @var Serializer @@ -609,7 +613,7 @@ public function transaction(array $options = []) { $transaction = $this->operation->beginTransaction([ // if empty, force request to encode as {} rather than []. - 'readWrite' => $this->pluck('transactionOptions', $options, false) ?: (object) [] + 'readWrite' => $this->pluck('transactionOptions', $options, false) ?: [] ], $options); return new Transaction( @@ -648,7 +652,7 @@ public function readOnlyTransaction(array $options = []) { $transaction = $this->operation->beginTransaction([ // if empty, force request to encode as {} rather than []. - 'readOnly' => $this->pluck('transactionOptions', $options, false) ?: (object) [] + 'readOnly' => $this->pluck('transactionOptions', $options, false) ?: [] ], $options); return new ReadOnlyTransaction( diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index b6e7bd11c3e0..88a7f0cc7215 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -77,7 +77,7 @@ class Operation * The request handler responsible for sending requests and * serializing responses into relevant classes. */ - protected RequestHandler $requestHandler; + private RequestHandler $requestHandler; /** * @var Serializer @@ -317,12 +317,6 @@ public function beginTransaction($transactionOptions, array $options = []) ); } - array_walk($transactionOptions, function (&$item) { - if ($item instanceof \stdClass) { - $item = []; - } - }); - list($data, $optionalArgs) = $this->splitOptionalArgs($options); $data += [ @@ -599,11 +593,6 @@ public function runQuery(QueryInterface $query, array $options = []) 'readConsistency', 'transaction' ]); - $data = $this->convertDataToProtos($data, [ - 'partitionId' => PartitionId::class, - 'readOptions' => ReadOptions::class, - 'explainOptions' => ExplainOptions::class - ]); if (isset($data['query'])) { $data['query'] = $this->parseQuery($data['query']); } From d45178ce944b00bc75228f04d8f62cd647ce29ee Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 06:39:02 +0000 Subject: [PATCH 26/31] fix(Spanner):Properly remove redundant keys from request options --- Datastore/src/Operation.php | 42 ++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 88a7f0cc7215..a5a1feb82923 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -455,19 +455,18 @@ public function lookup(array $keys, array $options = []) $serviceKeys[] = $key->keyObject(); }); - list($data, $optionalArgs) = $this->splitOptionalArgs($options, [ - 'transaction', - 'className', - 'sort', - 'readTime', - 'readConsistency' - ]); + list($data, $optionalArgs) = $this->splitOptionalArgs($options); $data += $this->readOptions($options) + [ 'projectId' => $this->projectId, 'databaseId' => $this->databaseId, 'keys' => $this->keysList($serviceKeys), ]; + $this->pluckArray( + ['transaction', 'className', 'sort', 'readTime', 'readConsistency'], + $data + ); + $request = $this->serializer->decodeMessage(new LookupRequest(), $data); $res = $this->requestHandler->sendRequest( @@ -586,13 +585,13 @@ public function runQuery(QueryInterface $query, array $options = []) $runQueryObj->queryKey() => $requestQueryArr, ] + $this->readOptions($options) + $options; - list($data, $optionalArgs) = $this->splitOptionalArgs($req, [ - 'className', - 'namespaceId', - 'readTime', - 'readConsistency', - 'transaction' - ]); + list($data, $optionalArgs) = $this->splitOptionalArgs($req); + + $this->pluckArray( + ['className', 'namespaceId', 'readTime', 'readConsistency', 'transaction'], + $data + ); + if (isset($data['query'])) { $data['query'] = $this->parseQuery($data['query']); } @@ -680,12 +679,12 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option ), ] + $requestQueryArr + $this->readOptions($options) + $options; - list($data, $optionalArgs) = $this->splitOptionalArgs($req, [ - 'namespaceId', - 'readTime', - 'readConsistency', - 'transaction' - ]); + $this->pluckArray( + ['namespaceId', 'readTime', 'readConsistency', 'transaction'], + $req + ); + + list($data, $optionalArgs) = $this->splitOptionalArgs($req); if (isset($data['aggregationQuery'])) { if (isset($data['aggregationQuery']['nestedQuery'])) { @@ -765,7 +764,8 @@ public function commit(array $mutations, array $options = []) // Remove 'transaction' if set to `null` to avoid serialization error unset($options['transaction']); } - list($data, $optionalArgs) = $this->splitOptionalArgs($options, ['allowOverwrite', 'baseVersion']); + list($data, $optionalArgs) = $this->splitOptionalArgs($options); + $this->pluckArray(['allowOverwrite', 'baseVersion'], $data); $request = $this->serializer->decodeMessage(new CommitRequest(), $data); $res = $this->requestHandler->sendRequest( DatastoreClient::class, From 14fc795e4a003566298232a2771ff01af89572bc Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 06:42:26 +0000 Subject: [PATCH 27/31] pr iteration --- Datastore/src/Operation.php | 1 - 1 file changed, 1 deletion(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 88a7f0cc7215..5f2a3919ac19 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -325,7 +325,6 @@ public function beginTransaction($transactionOptions, array $options = []) 'transactionOptions' => $transactionOptions, ]; - $data = $this->convertDataToProtos($data, ['transactionOptions' => TransactionOptions::class]); $request = $this->serializer->decodeMessage(new BeginTransactionRequest(), $data); $res = $this->requestHandler->sendRequest( From b9f0661ca8ca663b3c4720855fb59644357a180d Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 08:59:49 +0000 Subject: [PATCH 28/31] Add comments --- Datastore/src/Operation.php | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index a5a1feb82923..8eba08fc5341 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -462,6 +462,7 @@ public function lookup(array $keys, array $options = []) 'keys' => $this->keysList($serviceKeys), ]; + // Remove redundant keys for request. $this->pluckArray( ['transaction', 'className', 'sort', 'readTime', 'readConsistency'], $data @@ -587,6 +588,7 @@ public function runQuery(QueryInterface $query, array $options = []) list($data, $optionalArgs) = $this->splitOptionalArgs($req); + // Remove redundant keys for request. $this->pluckArray( ['className', 'namespaceId', 'readTime', 'readConsistency', 'transaction'], $data @@ -679,13 +681,14 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option ), ] + $requestQueryArr + $this->readOptions($options) + $options; + list($data, $optionalArgs) = $this->splitOptionalArgs($req); + + // Remove redundant keys for request. $this->pluckArray( ['namespaceId', 'readTime', 'readConsistency', 'transaction'], - $req + $data ); - list($data, $optionalArgs) = $this->splitOptionalArgs($req); - if (isset($data['aggregationQuery'])) { if (isset($data['aggregationQuery']['nestedQuery'])) { $data['aggregationQuery']['nestedQuery'] = $this->parseQuery( @@ -765,7 +768,10 @@ public function commit(array $mutations, array $options = []) unset($options['transaction']); } list($data, $optionalArgs) = $this->splitOptionalArgs($options); + + // Remove redundant keys for request. $this->pluckArray(['allowOverwrite', 'baseVersion'], $data); + $request = $this->serializer->decodeMessage(new CommitRequest(), $data); $res = $this->requestHandler->sendRequest( DatastoreClient::class, From 81655e1dc29c51a22e63ba77edfc687189050e7b Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 09:13:19 +0000 Subject: [PATCH 29/31] chore(Datastore): Update Composer version to use the upcoming latest. --- Datastore/composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Datastore/composer.json b/Datastore/composer.json index 6603ac235a77..11e376579283 100644 --- a/Datastore/composer.json +++ b/Datastore/composer.json @@ -5,7 +5,7 @@ "minimum-stability": "stable", "require": { "php": "^8.0", - "google/cloud-core": "^1.57", + "google/cloud-core": "^1.59", "google/gax": "^1.30" }, "require-dev": { From 4c29341a671141efd3727bad5579abfedbc1ad0f Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 10:03:21 +0000 Subject: [PATCH 30/31] chore(Datastore): Enhance readability of RunQuery and RunAggregationQuery APIs --- Datastore/src/Operation.php | 115 +++++++++++++++++++----------------- 1 file changed, 60 insertions(+), 55 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 8eba08fc5341..05282ff3802c 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -567,26 +567,9 @@ public function runQuery(QueryInterface $query, array $options = []) } $runQueryObj = clone $query; $runQueryFn = function (array $args = []) use (&$runQueryObj, $options, &$remainingLimit) { - $args += [ - 'query' => [], - ]; + $parsedArgs = $this->parseRunQueryArguments($args, $runQueryObj, $options, $remainingLimit); - // The iterator provides the startCursor for subsequent pages as an argument. - $requestQueryArr = $args['query'] + $runQueryObj->queryObject(); - if (isset($remainingLimit)) { - $requestQueryArr['limit'] = $remainingLimit; - } - $req = [ - 'projectId' => $this->projectId, - 'partitionId' => $this->partitionId( - $this->projectId, - $options['namespaceId'], - $options['databaseId'] - ), - $runQueryObj->queryKey() => $requestQueryArr, - ] + $this->readOptions($options) + $options; - - list($data, $optionalArgs) = $this->splitOptionalArgs($req); + list($data, $optionalArgs) = $this->splitOptionalArgs($parsedArgs); // Remove redundant keys for request. $this->pluckArray( @@ -594,12 +577,6 @@ public function runQuery(QueryInterface $query, array $options = []) $data ); - if (isset($data['query'])) { - $data['query'] = $this->parseQuery($data['query']); - } - if (isset($data['gqlQuery'])) { - $data['gqlQuery'] = $this->parseGqlQuery($data['gqlQuery']); - } $request = $this->serializer->decodeMessage(new RunQueryRequest(), $data); $res = $this->requestHandler->sendRequest( DatastoreClient::class, @@ -668,20 +645,9 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option 'databaseId' => $this->databaseId, ]; - $args = [ - 'query' => [], - ]; - $requestQueryArr = $args['query'] + $runQueryObj->queryObject(); - $req = [ - 'projectId' => $this->projectId, - 'partitionId' => $this->partitionId( - $this->projectId, - $options['namespaceId'], - $options['databaseId'] - ), - ] + $requestQueryArr + $this->readOptions($options) + $options; + $parsedArgs = $this->parseRunAggregationQueryArgs($runQueryObj, $options); - list($data, $optionalArgs) = $this->splitOptionalArgs($req); + list($data, $optionalArgs) = $this->splitOptionalArgs($parsedArgs); // Remove redundant keys for request. $this->pluckArray( @@ -689,23 +655,6 @@ public function runAggregationQuery(AggregationQuery $runQueryObj, array $option $data ); - if (isset($data['aggregationQuery'])) { - if (isset($data['aggregationQuery']['nestedQuery'])) { - $data['aggregationQuery']['nestedQuery'] = $this->parseQuery( - $data['aggregationQuery']['nestedQuery'] - ); - } - - $data['aggregationQuery'] = $this->serializer->decodeMessage( - new V1AggregationQuery(), - $data['aggregationQuery'] - ); - } - - if (isset($data['gqlQuery'])) { - $data['gqlQuery'] = $this->parseGqlQuery($data['gqlQuery']); - } - $request = $this->serializer->decodeMessage(new RunAggregationQueryRequest(), $data); $res = $this->requestHandler->sendRequest( DatastoreClient::class, @@ -1231,4 +1180,60 @@ private function toGrpcValue(array $property) return [$type, $val]; } + + private function parseRunQueryArguments($args, &$runQueryObj, $options, &$remainingLimit) + { + $args += ['query' => []]; + + // The iterator provides the startCursor for subsequent pages as an argument. + $requestQueryArr = $args['query'] + $runQueryObj->queryObject(); + if (isset($remainingLimit)) { + $requestQueryArr['limit'] = $remainingLimit; + } + $result = [ + 'projectId' => $this->projectId, + 'partitionId' => $this->partitionId( + $this->projectId, + $options['namespaceId'], + $options['databaseId'] + ), + $runQueryObj->queryKey() => $requestQueryArr, + ] + $this->readOptions($options) + $options; + + if (isset($result['query'])) { + $result['query'] = $this->parseQuery($result['query']); + } + if (isset($result['gqlQuery'])) { + $result['gqlQuery'] = $this->parseGqlQuery($result['gqlQuery']); + } + + return $result; + } + + private function parseRunAggregationQueryArgs($runQueryObj, $options) + { + $requestQueryArr = $runQueryObj->queryObject(); + $result = [ + 'projectId' => $this->projectId, + 'partitionId' => $this->partitionId( + $this->projectId, + $options['namespaceId'], + $options['databaseId'] + ), + ] + $requestQueryArr + $this->readOptions($options) + $options; + + if (isset($result['aggregationQuery'])) { + if (isset($result['aggregationQuery']['nestedQuery'])) { + $result['aggregationQuery']['nestedQuery'] = $this->parseQuery( + $result['aggregationQuery']['nestedQuery'] + ); + } + } + + if (isset($result['gqlQuery'])) { + $result['gqlQuery'] = $this->parseGqlQuery($result['gqlQuery']); + } + + return $result; + } } From ab08e92b9a499b5bc9ee5f1cc58c5c26244d251b Mon Sep 17 00:00:00 2001 From: yash30201 <54198301+yash30201@users.noreply.github.com> Date: Tue, 7 May 2024 10:26:26 +0000 Subject: [PATCH 31/31] Enhance Commit API readability --- Datastore/src/Operation.php | 57 +++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 25 deletions(-) diff --git a/Datastore/src/Operation.php b/Datastore/src/Operation.php index 872e834a6cee..070a6829b5a7 100644 --- a/Datastore/src/Operation.php +++ b/Datastore/src/Operation.php @@ -689,32 +689,8 @@ public function commit(array $mutations, array $options = []) 'databaseId' => $this->databaseId, ]; - foreach ($mutations as &$mutation) { - $mutationType = array_keys($mutation)[0]; - $data = $mutation[$mutationType]; - if (isset($data['properties'])) { - foreach ($data['properties'] as &$property) { - list($type, $val) = $this->toGrpcValue($property); - - $property[$type] = $val; - } - } + $options = $this->parseCommitOptions($mutations, $options); - $mutation[$mutationType] = $data; - - $mutation = $this->serializer->decodeMessage(new Mutation(), $mutation); - } - - $options += [ - 'mode' => ($options['transaction']) ? Mode::TRANSACTIONAL : Mode::NON_TRANSACTIONAL, - 'mutations' => $mutations, - 'projectId' => $this->projectId, - ]; - - if (is_null($options['transaction'])) { - // Remove 'transaction' if set to `null` to avoid serialization error - unset($options['transaction']); - } list($data, $optionalArgs) = $this->splitOptionalArgs($options); // Remove redundant keys for request. @@ -1235,4 +1211,35 @@ private function parseRunAggregationQueryArgs($runQueryObj, $options) return $result; } + + private function parseCommitOptions($mutations, $options) { + foreach ($mutations as &$mutation) { + $mutationType = array_keys($mutation)[0]; + $data = $mutation[$mutationType]; + if (isset($data['properties'])) { + foreach ($data['properties'] as &$property) { + list($type, $val) = $this->toGrpcValue($property); + + $property[$type] = $val; + } + } + + $mutation[$mutationType] = $data; + + $mutation = $this->serializer->decodeMessage(new Mutation(), $mutation); + } + + $options += [ + 'mode' => ($options['transaction']) ? Mode::TRANSACTIONAL : Mode::NON_TRANSACTIONAL, + 'mutations' => $mutations, + 'projectId' => $this->projectId, + ]; + + if (is_null($options['transaction'])) { + // Remove 'transaction' if set to `null` to avoid serialization error + unset($options['transaction']); + } + + return $options; + } }