feat!: Spanner V2

Author: bshaffer

.github/workflows/system-tests-spanner-emulator.yaml

@@ -49,7 +49,7 @@ jobs:
       - name: Install dependencies
         run: |
           # ensure composer uses local Core instead of pulling from packagist
-          composer config repositories.local  --json '{"type":"path", "url": "../Core", "options": {"versions": {"google/cloud-core": "1.100"}}}' -d Spanner
+          # composer config repositories.local  --json '{"type":"path", "url": "../Core", "options": {"versions": {"google/cloud-core": "1.100"}}}' -d Spanner
           composer update --prefer-dist --no-interaction --no-suggest -d Spanner/
 
       - name: Run system tests

Core/src/ApiHelperTrait.php

@@ -261,8 +261,8 @@ private function splitOptionalArgs(array $input, array $extraAllowedKeys = []) :
         $callOptionFields = array_keys((new CallOptions([]))->toArray());
         $keys = array_merge($callOptionFields, $extraAllowedKeys);
 
-        $optionalArgs = $this->pluckArray($keys, $input);
+        $callOptions = $this->pluckArray($keys, $input);
 
-        return [$input, $optionalArgs];
+        return [$input, $callOptions];
     }
 }

Core/src/Iam/Iam.php

@@ -34,7 +34,7 @@
  *
  * use Google\Cloud\Spanner\SpannerClient;
  *
- * $spanner = new SpannerClient();
+ * $spanner = new SpannerClient(['projectId' => 'my-project']);
  * $instance = $spanner->instance('my-new-instance');
  *
  * $iam = $instance->iam();

Core/src/Middleware/ExceptionMiddleware.php

@@ -0,0 +1,86 @@
+<?php
+/*
+ * Copyright 2024 Google LLC
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace Google\Cloud\Core\Middleware;
+
+use Google\ApiCore\ApiException;
+use Google\ApiCore\BidiStream;
+use Google\ApiCore\Call;
+use Google\ApiCore\ClientStream;
+use Google\ApiCore\Middleware\MiddlewareInterface;
+use Google\ApiCore\ServerStream;
+use Google\Cloud\Core\RequestProcessorTrait;
+use GuzzleHttp\Promise\PromiseInterface;
+use Throwable;
+
+/**
+ * Middleware that wraps any Api Exception to a `Google\Cloud\Core\Exception`
+ * exception class. This is primarily to maintain backwards compatibility with
+ * previous Spanner versions.
+ *
+ * @internal
+ */
+class ExceptionMiddleware implements MiddlewareInterface
+{
+    use RequestProcessorTrait;
+
+    /** @var callable */
+    private $nextHandler;
+
+    public function __construct(callable $nextHandler) {
+        $this->nextHandler = $nextHandler;
+    }
+
+    /**
+     * @param Call $call
+     * @param array $options
+     *
+     * @return PromiseInterface|ClientStream|ServerStream|BidiStream
+     */
+    public function __invoke(Call $call, array $options)
+    {
+        $response = ($this->nextHandler)($call, $options);
+        if ($response instanceof PromiseInterface) {
+            return $response->then(null, function ($value) {
+                if ($value instanceof \Google\ApiCore\ApiException) {
+                    throw $this->convertToGoogleException($value);
+                }
+                if ($value instanceof Throwable) {
+                    throw $value;
+                }
+            });
+        }
+        // this can also be a Stream
+        return $response;
+    }
+}
+

Core/src/RequestHandler.php

@@ -45,11 +45,11 @@ class RequestHandler
      */
     private Serializer $serializer;
 
-    private array $clients;
+    private array $clients = [];
 
     /**
      * @param Serializer $serializer
-     * @param array $clientClasses
+     * @param array<string|object> $clientClasses
      * @param array $clientConfig
      */
     public function __construct(
@@ -76,11 +76,14 @@ public function __construct(
             );
         }
         //@codeCoverageIgnoreEnd
-        
+
         // Initialize the client classes and store them in memory
-        $this->clients = [];
-        foreach ($clientClasses as $className) {
-            $this->clients[$className] = new $className($clientConfig);
+        foreach ($clientClasses as $client) {
+            if (is_object($client)) {
+                $this->clients[get_class($client)] = $client;
+            } else {
+                $this->clients[$client] = new $client($clientConfig);
+            }
         }
     }
 

Core/src/ServiceBuilder.php

@@ -249,7 +249,7 @@ public function pubsub(array $config = [])
      *
      * Example:
      * ```
-     * $spanner = $cloud->spanner();
+     * $spanner = $cloud->spanner(['projectId' => 'my-project']);
      * ```
      *
      * @param array $config [optional] {

Core/src/TimeTrait.php

@@ -92,10 +92,10 @@ private function formatTimeAsString(\DateTimeInterface $dateTime, $ns)
      *        $dateTime will be used instead.
      * @return array
      */
-    private function formatTimeAsArray(\DateTimeInterface $dateTime, $ns)
+    private function formatTimeAsArray(\DateTimeInterface $dateTime, $ns = null)
     {
         if ($ns === null) {
-            $ns = $dateTime->format('u');
+            $ns = $this->convertFractionToNanoSeconds($dateTime->format('u'));
         }
         return [
             'seconds' => (int) $dateTime->format('U'),

Core/tests/Snippet/Iam/IamTest.php

@@ -19,6 +19,7 @@
 
 use Google\Cloud\Core\Testing\Snippet\SnippetTestCase;
 use Google\Cloud\Core\Iam\Iam;
+use Google\Cloud\Core\Iam\IamManager;
 use Google\Cloud\Core\Iam\IamConnectionInterface;
 use Google\Cloud\Core\Testing\TestHelpers;
 use Google\Cloud\Spanner\SpannerClient;
@@ -55,7 +56,7 @@ public function testClass()
         ]);
         $res = $snippet->invoke('iam');
 
-        $this->assertInstanceOf(Iam::class, $res->returnVal());
+        $this->assertInstanceOf(IamManager::class, $res->returnVal());
     }
 
     public function testPolicy()

Core/tests/Unit/LongRunning/OperationResponseTraitTest.php

@@ -18,10 +18,10 @@
 namespace Google\Cloud\Core\Tests\Unit\LongRunning;
 
 use Google\ApiCore\OperationResponse;
+use Google\ApiCore\Serializer;
 use Google\Cloud\Core\LongRunning\OperationResponseTrait;
 use Google\Cloud\Core\LongRunning\LongRunningOperation;
 use Google\Cloud\Core\LongRunning\LongRunningConnectionInterface;
-use Google\ApiCore\Serializer;
 use Prophecy\Argument;
 use Google\Cloud\Audit\RequestMetadata;
 use Google\Cloud\Audit\AuthorizationInfo;

Core/tests/Unit/ServiceBuilderTest.php

@@ -24,7 +24,6 @@
 use Google\Cloud\Firestore\FirestoreClient;
 use Google\Cloud\Language\LanguageClient;
 use Google\Cloud\Logging\LoggingClient;
-use Google\Cloud\Spanner\SpannerClient;
 use Google\Cloud\Speech\SpeechClient;
 use Google\Cloud\Storage\StorageClient;
 use Google\Cloud\Core\Tests\Unit\Fixtures;
@@ -175,11 +174,6 @@ public function serviceProvider()
             ], [
                 'language',
                 LanguageClient::class
-            ], [
-                'spanner',
-                SpannerClient::class,
-                [],
-                [$this, 'checkAndSkipGrpcTests']
             ], [
                 'speech',
                 SpeechClient::class,