ISSUE #198

* Rename `OnSagaStepDecorator` as `SagaOperationDecorator`.

Author: Sergio García Prado

packages/core/minos-microservice-saga/minos/saga/__init__.py

@@ -20,14 +20,14 @@
     LocalSagaStep,
     LocalSagaStepDecoratorMeta,
     LocalSagaStepDecoratorWrapper,
-    OnSagaStepDecorator,
     RemoteSagaStep,
     RemoteSagaStepDecoratorMeta,
     RemoteSagaStepDecoratorWrapper,
     Saga,
     SagaDecoratorMeta,
     SagaDecoratorWrapper,
     SagaOperation,
+    SagaOperationDecorator,
     SagaStep,
     SagaStepDecoratorMeta,
     SagaStepDecoratorWrapper,

packages/core/minos-microservice-saga/minos/saga/definitions/__init__.py

@@ -1,5 +1,6 @@
 from .operations import (
     SagaOperation,
+    SagaOperationDecorator,
 )
 from .saga import (
     Saga,
@@ -19,7 +20,6 @@
     LocalSagaStep,
     LocalSagaStepDecoratorMeta,
     LocalSagaStepDecoratorWrapper,
-    OnSagaStepDecorator,
     RemoteSagaStep,
     RemoteSagaStepDecoratorMeta,
     RemoteSagaStepDecoratorWrapper,

packages/core/minos-microservice-saga/minos/saga/definitions/operations.py

@@ -7,13 +7,17 @@
     Iterable,
 )
 from typing import (
+    TYPE_CHECKING,
     Any,
     Generic,
     Optional,
     TypeVar,
     Union,
 )
 
+if TYPE_CHECKING:
+    from .steps import SagaStepDecoratorMeta
+
 from minos.common import (
     classname,
     import_module,
@@ -26,6 +30,27 @@
 T = TypeVar("T", bound=Callable)
 
 
+class SagaOperationDecorator(Generic[T]):
+    """ "TODO"""
+
+    def __init__(self, attr_name: str = None, step_meta: SagaStepDecoratorMeta = None, *args, **kwargs):
+        if attr_name is None:
+            raise ValueError(f"The 'attr_name' must not be {None!r}.")
+        if step_meta is None:
+            raise ValueError(f"The 'step_meta' must not be {None!r}.")
+
+        self._step_meta = step_meta
+        self._attr_name = attr_name
+
+        self._args = args
+        self._kwargs = kwargs
+
+    def __call__(self, func: T) -> T:
+        operation = SagaOperation(func, *self._args, **self._kwargs)
+        setattr(self._step_meta, self._attr_name, operation)
+        return func
+
+
 class SagaOperation(Generic[T]):
     """Saga Step Operation class."""
 

packages/core/minos-microservice-saga/minos/saga/definitions/steps/__init__.py

@@ -1,5 +1,4 @@
 from .abc import (
-    OnSagaStepDecorator,
     SagaStep,
     SagaStepDecoratorMeta,
     SagaStepDecoratorWrapper,

packages/core/minos-microservice-saga/minos/saga/definitions/steps/abc.py

@@ -14,10 +14,8 @@
 from typing import (
     TYPE_CHECKING,
     Any,
-    Generic,
     Optional,
     Protocol,
-    TypeVar,
     Union,
     runtime_checkable,
 )
@@ -68,23 +66,6 @@ def definition(self) -> SagaStep:
         """TODO"""
 
 
-FN = TypeVar("FN", bound=Callable)
-
-
-class OnSagaStepDecorator(Generic[FN]):
-    """ "TODO"""
-
-    def __init__(self, attr_name: [str] = None, step_meta: Optional[SagaStepDecoratorMeta] = None):
-        if attr_name is None or step_meta is None:
-            raise ValueError("TODO")
-        self.step_meta = step_meta
-        self.attr_name = attr_name
-
-    def __call__(self, func: FN) -> FN:
-        setattr(self.step_meta, self.attr_name, func)
-        return func
-
-
 class SagaStep(ABC):
     """Saga step class."""
 

packages/core/minos-microservice-saga/minos/saga/definitions/steps/local.py

@@ -33,12 +33,12 @@
 )
 from ..operations import (
     SagaOperation,
+    SagaOperationDecorator,
 )
 from ..types import (
     LocalCallback,
 )
 from .abc import (
-    OnSagaStepDecorator,
     SagaStep,
     SagaStepDecoratorMeta,
     SagaStepDecoratorWrapper,
@@ -49,7 +49,7 @@ class LocalSagaStepDecoratorWrapper(SagaStepDecoratorWrapper):
     """TODO"""
 
     meta: LocalSagaStepDecoratorMeta
-    on_failure: type[OnSagaStepDecorator[LocalCallback]]
+    on_failure: type[SagaOperationDecorator[LocalCallback]]
     __call__: LocalCallback
 
 
@@ -72,10 +72,10 @@ def definition(self):
         return self._definition
 
     @cached_property
-    def on_failure(self) -> OnSagaStepDecorator:
+    def on_failure(self) -> SagaOperationDecorator:
         """TODO"""
         # noinspection PyTypeChecker
-        return partial(OnSagaStepDecorator, step_meta=self, attr_name="_on_failure")
+        return partial(SagaOperationDecorator, step_meta=self, attr_name="_on_failure")
 
 
 class LocalSagaStep(SagaStep):

packages/core/minos-microservice-saga/minos/saga/definitions/steps/remote.py

@@ -35,13 +35,13 @@
 )
 from ..operations import (
     SagaOperation,
+    SagaOperationDecorator,
 )
 from ..types import (
     RequestCallBack,
     ResponseCallBack,
 )
 from .abc import (
-    OnSagaStepDecorator,
     SagaStep,
     SagaStepDecoratorMeta,
     SagaStepDecoratorWrapper,
@@ -52,9 +52,9 @@ class RemoteSagaStepDecoratorWrapper(SagaStepDecoratorWrapper):
     """TODO"""
 
     meta: RemoteSagaStepDecoratorMeta
-    on_success: type[OnSagaStepDecorator[ResponseCallBack]]
-    on_error: type[OnSagaStepDecorator[ResponseCallBack]]
-    on_failure: type[OnSagaStepDecorator[RequestCallBack]]
+    on_success: type[SagaOperationDecorator[ResponseCallBack]]
+    on_error: type[SagaOperationDecorator[ResponseCallBack]]
+    on_failure: type[SagaOperationDecorator[RequestCallBack]]
     __call__: RequestCallBack
 
 
@@ -85,22 +85,22 @@ def definition(self):
         return self._definition
 
     @cached_property
-    def on_success(self) -> OnSagaStepDecorator:
+    def on_success(self) -> SagaOperationDecorator:
         """TODO"""
         # noinspection PyTypeChecker
-        return partial(OnSagaStepDecorator, step_meta=self, attr_name="_on_success")
+        return partial(SagaOperationDecorator, step_meta=self, attr_name="_on_success")
 
     @cached_property
-    def on_error(self) -> OnSagaStepDecorator:
+    def on_error(self) -> SagaOperationDecorator:
         """TODO"""
         # noinspection PyTypeChecker
-        return partial(OnSagaStepDecorator, step_meta=self, attr_name="_on_error")
+        return partial(SagaOperationDecorator, step_meta=self, attr_name="_on_error")
 
     @cached_property
-    def on_failure(self) -> OnSagaStepDecorator:
+    def on_failure(self) -> SagaOperationDecorator:
         """TODO"""
         # noinspection PyTypeChecker
-        return partial(OnSagaStepDecorator, step_meta=self, attr_name="_on_failure")
+        return partial(SagaOperationDecorator, step_meta=self, attr_name="_on_failure")
 
 
 class RemoteSagaStep(SagaStep):

packages/core/minos-microservice-saga/tests/test_saga/test_definitions/test_operations.py

@@ -3,12 +3,41 @@
 from minos.saga import (
     SagaContext,
     SagaOperation,
+    SagaOperationDecorator,
 )
 from tests.utils import (
     send_create_ticket,
 )
 
 
+class TestSagaOperationDecorator(unittest.TestCase):
+    def test_constructor(self):
+        class _Meta:
+            """For testing purposes."""
+
+        meta = _Meta()
+        meta.foo = None
+
+        # noinspection PyTypeChecker
+        decorator = SagaOperationDecorator("foo", meta, foobar="foobar")
+
+        # noinspection PyTypeChecker
+        decorator("bar")
+
+        # noinspection PyTypeChecker
+        expected = SagaOperation("bar", SagaContext(foobar="foobar"))
+        self.assertEqual(expected, meta.foo)
+
+    def test_constructor_raises(self):
+        with self.assertRaises(ValueError):
+            # noinspection PyArgumentEqualDefault,PyTypeChecker
+            SagaOperationDecorator(None, object())
+
+        with self.assertRaises(ValueError):
+            # noinspection PyArgumentEqualDefault,PyTypeChecker
+            SagaOperationDecorator(object(), None)
+
+
 class TestSagaOperation(unittest.TestCase):
     def test_callback(self):
         operation = SagaOperation(send_create_ticket)

packages/core/minos-microservice-saga/tests/test_saga/test_definitions/test_steps/test_abc.py

@@ -14,15 +14,32 @@
     LocalSagaStep,
     RemoteSagaStep,
     Saga,
+    SagaContext,
     SagaNotDefinedException,
+    SagaRequest,
     SagaStep,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 from tests.utils import (
     create_payment,
     send_create_ticket,
 )
 
 
+class TestSagaStepDecoratorMeta(unittest.TestCase):
+    def test_constructor(self):
+        # noinspection PyUnusedLocal
+        @RemoteSagaStep()
+        def _fn(context: SagaContext) -> SagaRequest:
+            """For testing purposes"""
+
+        self.assertIsInstance(_fn, SagaStepDecoratorWrapper)
+        meta = _fn.meta
+        self.assertIsInstance(meta, SagaStepDecoratorMeta)
+        self.assertEqual(RemoteSagaStep(_fn), meta.definition)
+
+
 class TestSagaStep(unittest.TestCase):
     def test_from_raw(self):
         with patch("minos.saga.SagaStep._from_raw") as mock: