feat: Transaction and request tagging support (#206)

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v8.1.0 (2024-04-16)
+
+Added
+- Request and Transaction tagging support (#206)
+
 # v8.0.0 (2024-04-11)
 
 Added

README.md

@@ -200,6 +200,19 @@ $queryBuilder
 > This creates a new session in the background which is not shared with the current session pool.
 > This means, queries running with data boost will not be associated with transactions that may be taking place.
 
+### Request Tags and Transaction Tags
+
+Spanner allows you to attach tags to your queries and transactions that can be [used for troubleshooting](https://cloud.google.com/spanner/docs/introspection/troubleshooting-with-tags).
+
+You can set request tags and transaction tags as below.
+
+```php
+$requestPath = request()->path();
+$tag = 'url=' . $requestPath;
+$connection->setRequestTag($tag);
+$connection->setTransactionTag($tag);
+```
+
 ### Data Types
 
 Some data types of Google Cloud Spanner does not have corresponding built-in type of PHP.

phpstan.neon

@@ -44,3 +44,6 @@ parameters:
         - message: "#^Expression on left side of \\?\\? is not nullable\\.$#"
           count: 1
           path: src/Connection.php
+        - message: "#^Cannot access offset 'requestTag' on mixed\\.$#"
+          count: 1
+          path: src/Connection.php

src/Concerns/ManagesTagging.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright 2019 Colopl Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Colopl\Spanner\Concerns;
+
+trait ManagesTagging
+{
+    /**
+     * @var string|null
+     */
+    protected ?string $requestTag = null;
+
+    /**
+     * @var string|null
+     */
+    protected ?string $transactionTag = null;
+
+    /**
+     * @param string|null $tag
+     * @return $this
+     */
+    public function setRequestTag(?string $tag): static
+    {
+        $this->requestTag = $tag;
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getRequestTag(): ?string
+    {
+        return $this->requestTag;
+    }
+
+    /**
+     * @param string|null $tag
+     * @return $this
+     */
+    public function setTransactionTag(?string $tag): static
+    {
+        $this->transactionTag = $tag;
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getTransactionTag(): ?string
+    {
+        return $this->transactionTag;
+    }
+}

src/Concerns/ManagesTransactions.php

@@ -59,7 +59,14 @@ public function transaction(Closure $callback, $attempts = -1)
             return parent::transaction($callback, $attempts);
         }
 
-        return $this->withSessionNotFoundHandling(function () use ($callback, $attempts) {
+        $options = ['maxRetries' => $attempts - 1];
+
+        $tag = $this->getTransactionTag();
+        if ($tag !== null) {
+            $options['tag'] = $tag;
+        }
+
+        return $this->withSessionNotFoundHandling(function () use ($callback, $options) {
             $return = $this->getSpannerDatabase()->runTransaction(function (Transaction $tx) use ($callback) {
                 try {
                     $this->currentTransaction = $tx;
@@ -81,7 +88,7 @@ public function transaction(Closure $callback, $attempts = -1)
                     $this->rollBack();
                     throw $e;
                 }
-            }, ['maxRetries' => $attempts - 1]);
+            }, $options);
 
             $this->fireConnectionEvent('committed');
 

src/Connection.php

@@ -52,6 +52,7 @@ class Connection extends BaseConnection
         Concerns\ManagesMutations,
         Concerns\ManagesPartitionedDml,
         Concerns\ManagesSessionPool,
+        Concerns\ManagesTagging,
         Concerns\ManagesTransactions,
         Concerns\MarksAsNotSupported;
 
@@ -571,9 +572,16 @@ protected function executeQuery(string $query, array $bindings, array $options):
             return $this->executePartitionedQuery($query, $options);
         }
 
-        return $this->getDatabaseContext()
-            ->execute($query, $options)
-            ->rows();
+        $tag = $this->getRequestTag();
+        if ($tag !== null) {
+            $options['requestOptions'] ??= [];
+            $options['requestOptions']['requestTag'] = $tag;
+        }
+
+        if ($transaction = $this->getCurrentTransaction()) {
+            return $transaction->execute($query, $options)->rows();
+        }
+        return $this->getSpannerDatabase()->execute($query, $options)->rows();
     }
 
     /**

tests/Concerns/ManagesTagsTest.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright 2019 Colopl Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Colopl\Spanner\Tests\Concerns;
+
+use Colopl\Spanner\Connection;
+use Colopl\Spanner\Tests\TestCase;
+
+class ManagesTagsTest extends TestCase
+{
+    public function test_set_and_get_requestTag(): void
+    {
+        $conn = $this->getConnection();
+        assert($conn instanceof Connection);
+        $conn->setRequestTag('url=/api/users');
+        $this->assertSame('url=/api/users', $conn->getRequestTag());
+        $conn->setRequestTag(null);
+        $this->assertNull($conn->getRequestTag());
+    }
+
+    public function test_set_and_get_transactionTag(): void
+    {
+        $conn = $this->getDefaultConnection();
+        assert($conn instanceof Connection);
+        $conn->setTransactionTag('url=/api/users/update');
+        $this->assertSame('url=/api/users/update', $conn->getTransactionTag());
+        $conn->setTransactionTag(null);
+        $this->assertNull($conn->getTransactionTag());
+    }
+}