ISSUE #176

* Refactor `run` method.

Author: Sergio García Prado

packages/core/minos-microservice-saga/minos/saga/executions/runners.py

@@ -114,47 +114,39 @@ async def run(
             but with ``Errored`` status.
         :param return_execution: If ``True`` the ``SagaExecution`` instance is returned. Otherwise, only the
             identifier (``UUID``) is returned.
+        # :param timeout: TODO
         :param kwargs: Additional named arguments.
         :return: This method does not return anything.
         """
         if isinstance(definition, SagaDecoratorWrapper):
             definition = definition.meta.definition
 
-        if response is not None:
-            return await self._load_and_run(
-                response=response,
-                autocommit=autocommit,
-                pause_on_disk=pause_on_disk,
-                raise_on_error=raise_on_error,
-                return_execution=return_execution,
-                **kwargs,
-            )
-
-        return await self._run_new(
-            definition=definition,
-            context=context,
-            user=user,
+        if response is None:
+            execution = await self._create(definition, context, user)
+        else:
+            execution = await self._load(response)
+
+        return await self._run(
+            execution,
+            response=response,
             autocommit=autocommit,
             pause_on_disk=pause_on_disk,
             raise_on_error=raise_on_error,
             return_execution=return_execution,
             **kwargs,
         )
 
-    async def _run_new(
-        self, definition: Saga, context: Optional[SagaContext] = None, user: Optional[UUID] = None, **kwargs
-    ) -> Union[UUID, SagaExecution]:
+    @staticmethod
+    async def _create(definition: Saga, context: Optional[SagaContext], user: Optional[UUID]) -> SagaExecution:
         if REQUEST_USER_CONTEXT_VAR.get() is not None:
             if user is not None:
                 warnings.warn("The `user` Argument will be ignored in favor of the `user` ContextVar", RuntimeWarning)
             user = REQUEST_USER_CONTEXT_VAR.get()
 
-        execution = SagaExecution.from_definition(definition, context=context, user=user)
-        return await self._run(execution, **kwargs)
+        return SagaExecution.from_definition(definition, context=context, user=user)
 
-    async def _load_and_run(self, response: SagaResponse, **kwargs) -> Union[UUID, SagaExecution]:
-        execution = await self.storage.load(response.uuid)
-        return await self._run(execution, response=response, **kwargs)
+    async def _load(self, response: SagaResponse) -> Union[UUID, SagaExecution]:
+        return await self.storage.load(response.uuid)
 
     async def _run(
         self,
@@ -197,9 +189,11 @@ def _update_request_headers(execution: SagaExecution) -> None:
         headers["related_services"] = ",".join(related_services)
 
     @staticmethod
-    async def _run_with_pause_on_disk(execution: SagaExecution, autocommit: bool = True, **kwargs) -> None:
+    async def _run_with_pause_on_disk(
+        execution: SagaExecution, response: Optional[SagaResponse] = None, autocommit: bool = True, **kwargs
+    ) -> None:
         try:
-            await execution.execute(autocommit=False, **kwargs)
+            await execution.execute(autocommit=False, response=response, **kwargs)
             if autocommit:
                 await execution.commit(**kwargs)
         except SagaPausedExecutionStepException:

packages/core/minos-microservice-saga/tests/test_saga/test_executions/test_runners.py

@@ -91,24 +91,30 @@ async def test_context_runner(self):
 
     async def test_run(self):
         expected = SagaExecution.from_definition(ADD_ORDER)
-        mock = AsyncMock(return_value=expected)
-        self.runner._run_new = mock
+        create_mock = AsyncMock()
+        run_mock = AsyncMock(return_value=expected)
+        self.runner._create = create_mock
+        self.runner._run = run_mock
 
         observed = await self.runner.run(ADD_ORDER)
         self.assertEqual(expected, observed)
 
     async def test_run_from_wrapper(self):
         expected = SagaExecution.from_definition(DeleteOrderSaga)
-        mock = AsyncMock(return_value=expected)
-        self.runner._run_new = mock
+        create_mock = AsyncMock()
+        run_mock = AsyncMock(return_value=expected)
+        self.runner._create = create_mock
+        self.runner._run = run_mock
 
         observed = await self.runner.run(DeleteOrderSaga)
         self.assertEqual(expected, observed)
 
     async def test_load_and_run(self):
         expected = SagaExecution.from_definition(ADD_ORDER)
-        mock = AsyncMock(return_value=expected)
-        self.runner._load_and_run = mock
+        load_mock = AsyncMock()
+        run_mock = AsyncMock(return_value=expected)
+        self.runner._load = load_mock
+        self.runner._run = run_mock
 
         observed = await self.runner.run(response=SagaResponse(uuid=expected.uuid))
         self.assertEqual(expected, observed)