Merge branch 'main' into failure-conversion-failure

Author: cretz

temporalio/client.py

@@ -2177,9 +2177,6 @@ async def execute_update(
         This will target the workflow with :py:attr:`run_id` if present. To use a
         different run ID, create a new handle with via :py:meth:`Client.get_workflow_handle`.
 
-        .. warning::
-           This API is experimental
-
         Args:
             update: Update function or name on the workflow.
             arg: Single argument to the update.
@@ -2284,9 +2281,6 @@ async def start_update(
         This will target the workflow with :py:attr:`run_id` if present. To use a
         different run ID, create a new handle with via :py:meth:`Client.get_workflow_handle`.
 
-        .. warning::
-           This API is experimental
-
         Args:
             update: Update function or name on the workflow. arg: Single argument to the
                 update.
@@ -2366,9 +2360,6 @@ def get_update_handle(
         Users may prefer the more typesafe :py:meth:`get_update_handle_for`
         which accepts an update definition.
 
-        .. warning::
-           This API is experimental
-
         Args:
             id: Update ID to get a handle to.
             workflow_run_id: Run ID to tie the handle to. If this is not set,
@@ -2398,9 +2389,6 @@ def get_update_handle_for(
 
         This is the same as :py:meth:`get_update_handle` but typed.
 
-        .. warning::
-           This API is experimental
-
         Args:
             update: The update method to use for typing the handle.
             id: Update ID to get a handle to.

temporalio/workflow.py

@@ -778,9 +778,6 @@ def current_update_info() -> Optional[UpdateInfo]:
     This is powered by :py:mod:`contextvars` so it is only valid within the
     update handler and coroutines/tasks it has started.
 
-    .. warning::
-       This API is experimental
-
     Returns:
         Info for the current update handler the code calling this is executing
             within if any.
@@ -1512,6 +1509,13 @@ def _apply_to_class(
                         f"Multiple update methods found for {defn_name} "
                         f"(at least on {name} and {updates[update_defn.name].fn.__name__})"
                     )
+                elif update_defn.validator and not _parameters_identical_up_to_naming(
+                    update_defn.fn, update_defn.validator
+                ):
+                    issues.append(
+                        f"Update validator method {update_defn.validator.__name__} parameters "
+                        f"do not match update method {update_defn.fn.__name__} parameters"
+                    )
                 else:
                     updates[update_defn.name] = update_defn
 

tests/helpers/__init__.py

@@ -4,7 +4,7 @@
 import uuid
 from contextlib import closing
 from datetime import timedelta
-from typing import Awaitable, Callable, Optional, Sequence, Type, TypeVar
+from typing import Any, Awaitable, Callable, Optional, Sequence, Type, TypeVar
 
 from temporalio.api.common.v1 import WorkflowExecution
 from temporalio.api.enums.v1 import IndexedValueType
@@ -14,11 +14,12 @@
 )
 from temporalio.api.update.v1 import UpdateRef
 from temporalio.api.workflowservice.v1 import PollWorkflowExecutionUpdateRequest
-from temporalio.client import BuildIdOpAddNewDefault, Client
+from temporalio.client import BuildIdOpAddNewDefault, Client, WorkflowHandle
 from temporalio.common import SearchAttributeKey
 from temporalio.service import RPCError, RPCStatusCode
 from temporalio.worker import Worker, WorkflowRunner
 from temporalio.worker.workflow_sandbox import SandboxedWorkflowRunner
+from temporalio.workflow import UpdateMethodMultiParam
 
 
 def new_worker(
@@ -128,3 +129,24 @@ async def workflow_update_exists(
         if err.status != RPCStatusCode.NOT_FOUND:
             raise
         return False
+
+
+# TODO: type update return value
+async def admitted_update_task(
+    client: Client,
+    handle: WorkflowHandle,
+    update_method: UpdateMethodMultiParam,
+    id: str,
+    **kwargs,
+) -> asyncio.Task:
+    """
+    Return an asyncio.Task for an update after waiting for it to be admitted.
+    """
+    update_task = asyncio.create_task(
+        handle.execute_update(update_method, id=id, **kwargs)
+    )
+    await assert_eq_eventually(
+        True,
+        lambda: workflow_update_exists(client, handle.id, id),
+    )
+    return update_task

tests/test_workflow.py

@@ -418,3 +418,26 @@ def test_workflow_init_not__init__():
     with pytest.raises(ValueError) as err:
         workflow.init(BadWorkflowInit.not__init__)
     assert "@workflow.init may only be used on the __init__ method" in str(err.value)
+
+
+class BadUpdateValidator:
+    @workflow.update
+    def my_update(self, a: str):
+        pass
+
+    @my_update.validator  # type: ignore
+    def my_validator(self, a: int):
+        pass
+
+    @workflow.run
+    async def run(self):
+        pass
+
+
+def test_workflow_update_validator_not_update():
+    with pytest.raises(ValueError) as err:
+        workflow.defn(BadUpdateValidator)
+    assert (
+        "Update validator method my_validator parameters do not match update method my_update parameters"
+        in str(err.value)
+    )