IWF-693 return workflow run id when starting a workflow (#92)

* IWF-693 return workflow run id when starting a workflow

---------

Co-authored-by: Nathan Givens <[email protected]>

Author: N-give

iwf/client.py

@@ -55,7 +55,7 @@ def start_workflow(
         timeout_seconds: int,
         input: Any = None,
         options: Optional[WorkflowOptions] = None,
-    ) -> None:
+    ) -> str:
         """
 
         Args:
@@ -65,6 +65,9 @@ def start_workflow(
             input: input of the workflow, aka, the input of the starting state of the workflow
             options: advanced options
 
+        Returns:
+            workflow_run_id: the run id of the started workflow
+
         Raises:
             ClientSideError for non-retryable error
             ServerSideError for server error
@@ -114,7 +117,7 @@ def start_workflow(
             )
             unreg_opts.start_state_options = starting_state_opts
 
-        self._unregistered_client.start_workflow(
+        return self._unregistered_client.start_workflow(
             wf_type, wf_id, starting_state_id, timeout_seconds, input, unreg_opts
         )
 

iwf/tests/test_basic_workflow.py

@@ -85,9 +85,15 @@ def test_basic_workflow(self):
             workflow_already_started_options_1
         )
 
-        client.start_workflow(BasicWorkflow, wf_id, 100, "input", start_options_1)
+        wf_run_id = client.start_workflow(
+            BasicWorkflow, wf_id, 100, "input", start_options_1
+        )
+        assert wf_run_id
 
-        client.start_workflow(BasicWorkflow, wf_id, 100, "input", start_options_1)
+        wf_run_id = client.start_workflow(
+            BasicWorkflow, wf_id, 100, "input", start_options_1
+        )
+        assert wf_run_id
 
         workflow_already_started_options_2 = WorkflowAlreadyStartedOptions(
             ignore_already_started_error=True
@@ -100,7 +106,10 @@ def test_basic_workflow(self):
         )
 
         with self.assertRaises(WorkflowAlreadyStartedError):
-            client.start_workflow(BasicWorkflow, wf_id, 100, "input", start_options_2)
+            wf_run_id = client.start_workflow(
+                BasicWorkflow, wf_id, 100, "input", start_options_2
+            )
+            assert wf_run_id
 
-        res = client.get_simple_workflow_result_with_wait(wf_id, str)
+        res = client.wait_for_workflow_completion(wf_id, str)
         assert res == "done"

iwf/unregistered_client.py

@@ -61,6 +61,7 @@
     WorkflowSetSearchAttributesRequest,
     WorkflowWaitForStateCompletionRequest,
 )
+from iwf.iwf_api.models.workflow_start_response import WorkflowStartResponse
 from iwf.iwf_api.types import Response
 from iwf.reset_workflow_type_and_options import ResetWorkflowTypeAndOptions
 from iwf.stop_workflow_options import StopWorkflowOptions
@@ -193,11 +194,18 @@ def start_workflow(
                     options.wait_for_completion_state_ids
                 )
 
-        response = post_api_v1_workflow_start.sync_detailed(
-            client=self.api_client,
-            json_body=request,
+        workflow_start_response = handler_error_and_return(
+            post_api_v1_workflow_start.sync_detailed(
+                client=self.api_client,
+                json_body=request,
+            )
         )
-        return handler_error_and_return(response)
+        if workflow_start_response is None or not isinstance(
+            workflow_start_response, WorkflowStartResponse
+        ):
+            raise RuntimeError("Failed to parse WorkflowStartResponse")
+
+        return workflow_start_response.workflow_run_id
 
     def get_simple_workflow_result_with_wait(
         self,