feat: upsert search attributes (#248)

* Upsert search attributes * Search attributes improvements * Linter * Fix tests bootstrap Co-authored-by: Sergey Zhuk <[email protected]>
temporalio · Oct 3, 2022 · 61a9559 · 61a9559
1 parent 269211c
commit 61a9559
Show file tree

Hide file tree

Showing 9 changed files with 154 additions and 1 deletion.
diff --git a/src/Internal/Transport/Request/UpsertSearchAttributes.php b/src/Internal/Transport/Request/UpsertSearchAttributes.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Temporal\Internal\Transport\Request;
+
+use Temporal\Worker\Transport\Command\Request;
+
+class UpsertSearchAttributes extends Request
+{
+    public const NAME = 'UpsertWorkflowSearchAttributes';
+
+    /**
+     * @param array<string, mixed> $searchAttributes
+     */
+    public function __construct(array $searchAttributes)
+    {
+        parent::__construct(self::NAME, ['searchAttributes' => $searchAttributes]);
+    }
+}
diff --git a/src/Internal/Workflow/ScopeContext.php b/src/Internal/Workflow/ScopeContext.php
@@ -22,6 +22,7 @@
 use Temporal\Workflow\CancellationScopeInterface;
 use Temporal\Workflow\ScopedContextInterface;
 use Temporal\Workflow\WorkflowContextInterface;
+use Temporal\Internal\Transport\Request\UpsertSearchAttributes;
 
 class ScopeContext extends WorkflowContext implements ScopedContextInterface
 {
@@ -163,4 +164,14 @@ public function timer($interval): PromiseInterface
 
         return $result;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function upsertSearchAttributes(array $searchAttributes): void
+    {
+        $this->request(
+            new UpsertSearchAttributes($searchAttributes)
+        );
+    }
 }
diff --git a/src/Internal/Workflow/WorkflowContext.php b/src/Internal/Workflow/WorkflowContext.php
@@ -45,6 +45,7 @@
 use Temporal\Workflow\WorkflowContextInterface;
 use Temporal\Workflow\WorkflowExecution;
 use Temporal\Workflow\WorkflowInfo;
+use Temporal\Internal\Transport\Request\UpsertSearchAttributes;
 
 use function React\Promise\reject;
 use function React\Promise\resolve;
@@ -418,6 +419,16 @@ public function getStackTrace(): string
         return StackRenderer::renderTrace($this->trace);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function upsertSearchAttributes(array $searchAttributes): void
+    {
+        $this->services->client->request(
+            new UpsertSearchAttributes($searchAttributes)
+        );
+    }
+
     /**
      * {@inheritDoc}
      */

diff --git a/src/Workflow.php b/src/Workflow.php
@@ -928,4 +928,16 @@ public static function getStackTrace(): string
 
         return $context->getStackTrace();
     }
+
+    /**
+     * Upsert search attributes
+     *
+     * @param array<string, mixed> $searchAttributes
+     */
+    public static function upsertSearchAttributes(array $searchAttributes): void
+    {
+        /** @var ScopedContextInterface $context */
+        $context = self::getCurrentContext();
+        $context->upsertSearchAttributes($searchAttributes);
+    }
 }
diff --git a/src/Workflow/WorkflowContextInterface.php b/src/Workflow/WorkflowContextInterface.php
@@ -274,4 +274,9 @@ public function awaitWithTimeout($interval, ...$conditions): PromiseInterface;
      * @return string
      */
     public function getStackTrace(): string;
+
+    /**
+     * @param array<string, mixed> $searchAttributes
+     */
+    public function upsertSearchAttributes(array $searchAttributes): void;
 }
diff --git a/tests/Fixtures/src/Workflow/UpsertSearchAttributesWorkflow.php b/tests/Fixtures/src/Workflow/UpsertSearchAttributesWorkflow.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * This file is part of Temporal package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Temporal\Tests\Workflow;
+
+use Temporal\Activity\ActivityOptions;
+use Temporal\Tests\Activity\SampleActivityInterface;
+use Temporal\Workflow;
+use Temporal\Workflow\WorkflowMethod;
+
+#[Workflow\WorkflowInterface]
+class UpsertSearchAttributesWorkflow
+{
+    #[WorkflowMethod]
+    public function handler()
+    {
+        Workflow::upsertSearchAttributes(
+            [
+                'attr1' => 'attr1-value',
+                'attr2' => true,
+            ]
+        );
+
+        return 'done';
+    }
+}
diff --git a/tests/Functional/Client/UpsertSearchAttributesWorkflowTestCase.php b/tests/Functional/Client/UpsertSearchAttributesWorkflowTestCase.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Temporal\Tests\Functional\Client;
+
+/**
+ * @group client
+ * @group functional
+ */
+class UpsertSearchAttributesWorkflowTestCase extends ClientTestCase
+{
+    public function testUpsertSearchAttributes()
+    {
+        $client = $this->createClient();
+        $workflow = $client->newUntypedWorkflowStub('UpsertSearchAttributesWorkflow');
+
+        $e = $client->start($workflow);
+
+        $this->assertNotEmpty($e->getExecution()->getID());
+        $this->assertNotEmpty($e->getExecution()->getRunID());
+
+        $this->assertSame('done', $workflow->getResult());
+    }
+}
diff --git a/tests/SearchAttributeTestInvoker.php b/tests/SearchAttributeTestInvoker.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Temporal\Tests;
+
+use Temporal\Api\Operatorservice\V1\OperatorServiceClient;
+use Grpc\ChannelCredentials;
+use Temporal\Api\Operatorservice\V1\AddSearchAttributesRequest;
+
+final class SearchAttributeTestInvoker
+{
+    public function __invoke(): void
+    {
+        $operation = new OperatorServiceClient(
+            getenv('TEMPORAL_ADDRESS') ?: '127.0.0.1:7233',
+            ['credentials' => ChannelCredentials::createInsecure()]
+        );
+        $result = $operation->AddSearchAttributes(
+            new AddSearchAttributesRequest(
+                [
+                    'search_attributes' => [
+                        'attr1' => 2, // Keyword
+                        'attr2' => 5, // Bool
+                    ]
+                ]
+            )
+        );
+
+        $result->getMetadata();
+    }
+}
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -3,12 +3,15 @@
 declare(strict_types=1);
 
 use Temporal\Testing\Environment;
+use Temporal\Tests\SearchAttributeTestInvoker;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 if (getenv('RUN_TEMPORAL_TEST_SERVER') !== false) {
     $environment = Environment::create();
-    $environment->start('./rr serve -c .rr.silent.yaml -w tests');
+    $environment->startTemporalTestServer();
+    (new SearchAttributeTestInvoker)();
+    $environment->startRoadRunner('./rr serve -c .rr.silent.yaml -w tests');
     register_shutdown_function(fn() => $environment->stop());
 }