style: Add debug to API call responses

Author: Alan Christie

workflow/workflow_engine.py

@@ -85,7 +85,7 @@ def _handle_workflow_message(self, msg: WorkflowMessage) -> None:
         step (or steps) to launch (run) first."""
         assert msg
 
-        _LOGGER.debug("WorkflowMessage:\n%s", str(msg))
+        _LOGGER.info("WorkflowMessage:\n%s", str(msg))
         assert msg.action in ["START", "STOP"]
 
         r_wfid = msg.running_workflow
@@ -106,14 +106,17 @@ def _handle_workflow_start_message(self, r_wfid: str) -> None:
         response, _ = self._wapi_adapter.get_running_workflow(
             running_workflow_id=r_wfid
         )
+        _LOGGER.debug(
+            "API.get_running_workflow(%s) returned: -\n%s", r_wfid, str(response)
+        )
         assert "running_workflow" in response
         running_workflow = response["running_workflow"]
         assert "user_id" in running_workflow
         launching_user_name: str = running_workflow["user_id"]
-        _LOGGER.debug("RunningWorkflow: %s", running_workflow)
         # Now get the workflow definition (to get all the steps)
         wfid = running_workflow["workflow"]["id"]
         response, _ = self._wapi_adapter.get_workflow(workflow_id=wfid)
+        _LOGGER.debug("API.get_workflow(%s) returned: -\n%s", wfid, str(response))
         assert "workflow" in response
         workflow = response["workflow"]
 
@@ -125,6 +128,12 @@ def _handle_workflow_start_message(self, r_wfid: str) -> None:
             running_workflow_id=r_wfid,
             step=first_step_name,
         )
+        _LOGGER.debug(
+            "API.create_running_workflow_step(%s, %s) returned: -\n%s",
+            r_wfid,
+            first_step_name,
+            str(response),
+        )
         assert "id" in response
         r_wfsid = response["id"]
 
@@ -136,6 +145,15 @@ def _handle_workflow_start_message(self, r_wfid: str) -> None:
 
         project_id = running_workflow["project_id"]
         variables = running_workflow["variables"]
+
+        _LOGGER.info(
+            "RunningWorkflow: %s (name=%s project=%s, variables=%s)",
+            r_wfid,
+            running_workflow["name"],
+            project_id,
+            variables,
+        )
+
         lp: LaunchParameters = LaunchParameters(
             project_id=project_id,
             application_id=DM_JOB_APPLICATION_ID,
@@ -171,7 +189,7 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
         assert msg
 
         # The PodMessage has a 'instance', 'has_exit_code', and 'exit_code' values.
-        _LOGGER.debug("PodMessage:\n%s", str(msg))
+        _LOGGER.info("PodMessage:\n%s", str(msg))
 
         # ALL THIS CODE ADDED SIMPLY TO DEMONSTRATE THE USE OF THE API ADAPTER
         # AND THE INSTANCE LAUNCHER FOR THE SIMPLEST OF WORKFLOWS: -
@@ -188,10 +206,16 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
         instance_id: str = msg.instance
         exit_code: int = msg.exit_code
         response, _ = self._wapi_adapter.get_instance(instance_id=instance_id)
+        _LOGGER.debug(
+            "API.get_instance(%s) returned: -\n%s", instance_id, str(response)
+        )
         r_wfsid: str = response["running_workflow_step"]
         response, _ = self._wapi_adapter.get_running_workflow_step(
             running_workflow_step_id=r_wfsid
         )
+        _LOGGER.debug(
+            "API.get_running_workflow_step(%s) returned: -\n%s", r_wfsid, str(response)
+        )
         step_name: str = response["running_workflow_step"]["step"]
 
         # Get the step's running workflow record.
@@ -200,6 +224,9 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
         response, _ = self._wapi_adapter.get_running_workflow(
             running_workflow_id=r_wfid
         )
+        _LOGGER.debug(
+            "API.get_running_workflow(%s) returned: -\n%s", r_wfid, str(response)
+        )
 
         if exit_code:
             # The job was launched but it failed.
@@ -219,6 +246,7 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
         wfid = running_workflow["workflow"]["id"]
         assert wfid
         response, _ = self._wapi_adapter.get_workflow(workflow_id=wfid)
+        _LOGGER.debug("API.get_workflow(%s) returned: -\n%s", wfid, str(response))
         workflow = response["workflow"]
 
         # Given the step for the instance just finished (successfully),
@@ -242,6 +270,12 @@ def _handle_pod_message(self, msg: PodMessage) -> None:
                         running_workflow_id=r_wfid,
                         step=next_step_name,
                     )
+                    _LOGGER.debug(
+                        "API.create_running_workflow_step(%s, %s) returned: -\n%s",
+                        r_wfid,
+                        next_step_name,
+                        str(response),
+                    )
                     assert "id" in response
                     r_wfsid = response["id"]
                     project_id = running_workflow["project_id"]