Add Workflow::upsertTypedSearchAttributes() helper

temporalio · Dec 30, 2024 · 0b021da · 0b021da
1 parent f5e6323
commit 0b021da
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/src/Internal/Transport/Request/UpsertTypedSearchAttributes.php b/src/Internal/Transport/Request/UpsertTypedSearchAttributes.php
@@ -13,7 +13,7 @@ class UpsertTypedSearchAttributes extends Request
     public const NAME = 'UpsertWorkflowTypedSearchAttributes';
 
     /**
-     * @param list<SearchAttributeUpdate> $searchAttributes
+     * @param array<array-key, SearchAttributeUpdate> $searchAttributes
      */
     public function __construct(
         private readonly array $searchAttributes,
@@ -22,7 +22,7 @@ public function __construct(
     }
 
     /**
-     * @return list<SearchAttributeUpdate>
+     * @return array<array-key, SearchAttributeUpdate>
      */
     public function getSearchAttributes(): array
     {

diff --git a/src/Internal/Workflow/ScopeContext.php b/src/Internal/Workflow/ScopeContext.php
@@ -113,9 +113,7 @@ public function upsertSearchAttributes(array $searchAttributes): void
 
     public function upsertTypedSearchAttributes(SearchAttributeUpdate ...$updates): void
     {
-        $this->request(
-            new UpsertTypedSearchAttributes($updates),
-        );
+        $this->request(new UpsertTypedSearchAttributes($updates));
     }
 
     #[\Override]

diff --git a/src/Workflow.php b/src/Workflow.php
@@ -16,6 +16,7 @@
 use Temporal\Activity\ActivityOptions;
 use Temporal\Activity\ActivityOptionsInterface;
 use Temporal\Client\WorkflowStubInterface;
+use Temporal\Common\SearchAttributes\SearchAttributeUpdate;
 use Temporal\DataConverter\Type;
 use Temporal\DataConverter\ValuesInterface;
 use Temporal\Exception\OutOfContextException;
@@ -911,6 +912,21 @@ public static function upsertSearchAttributes(array $searchAttributes): void
         self::getCurrentContext()->upsertSearchAttributes($searchAttributes);
     }
 
+    /**
+     * Upsert typed Search Attributes
+     *
+     * ```php
+     *  Workflow::upsertTypedSearchAttributes(
+     *      SearchAttributeKey::forKeyword('CustomKeyword')->valueSet('CustomValue'),
+     *      SearchAttributeKey::forInt('MyCounter')->valueSet(42),
+     *  );
+     * ```
+     */
+    public static function upsertTypedSearchAttributes(SearchAttributeUpdate ...$updates): void
+    {
+        self::getCurrentContext()->upsertTypedSearchAttributes(...$updates);
+    }
+
     /**
      * Generate a UUID.
      *