Merge pull request #80 from cloudblue/f/LITE-23784

LITE-23784 Added support for non Django-model replicas by RawReplicaMixin

Author: maxipavlovic

dj_cqrs/metas.py

@@ -1,4 +1,4 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 
 from dj_cqrs.constants import ALL_BASIC_FIELDS
 from dj_cqrs.registries import MasterRegistry, ReplicaRegistry
@@ -10,7 +10,6 @@
 
 class MasterMeta(base.ModelBase):
     def __new__(mcs, name, bases, attrs, **kwargs):
-
         model_cls = super(MasterMeta, mcs).__new__(mcs, name, bases, attrs, **kwargs)
 
         if name != 'MasterMixin':
@@ -84,21 +83,26 @@ def __new__(mcs, *args):
         model_cls = super(ReplicaMeta, mcs).__new__(mcs, *args)
 
         if args[0] != 'ReplicaMixin':
-            _MetaUtils.check_cqrs_id(model_cls)
-            ReplicaMeta._check_cqrs_mapping(model_cls)
-            ReplicaRegistry.register_model(model_cls)
+            mcs.register(model_cls)
 
         return model_cls
 
+    @staticmethod
+    def register(model_cls):
+        _MetaUtils.check_cqrs_id(model_cls)
+        ReplicaMeta._check_cqrs_mapping(model_cls)
+        ReplicaRegistry.register_model(model_cls)
+
     @staticmethod
     def _check_cqrs_mapping(model_cls):
         """ Check that model has correct CQRS mapping configuration.
 
         :param dj_cqrs.mixins.ReplicaMixin model_cls: CQRS Replica Model.
         :raises: AssertionError
         """
-        if model_cls.CQRS_MAPPING is not None:
-            cqrs_field_names = list(model_cls.CQRS_MAPPING.values())
+        cqrs_mapping = getattr(model_cls, 'CQRS_MAPPING', None)
+        if cqrs_mapping is not None:
+            cqrs_field_names = list(cqrs_mapping.values())
             _MetaUtils.check_cqrs_field_setting(model_cls, cqrs_field_names, 'CQRS_MAPPING')
 
 

dj_cqrs/mixins.py

@@ -336,7 +336,21 @@ class Meta:
         abstract = True
 
 
-class ReplicaMixin(Model, metaclass=ReplicaMeta):
+class RawReplicaMixin:
+    CQRS_ID = None
+    CQRS_NO_DB_OPERATIONS = True
+    CQRS_META = False
+
+    @classmethod
+    def cqrs_save(cls, master_data, **kwargs):
+        raise NotImplementedError
+
+    @classmethod
+    def cqrs_delete(cls, master_data, **kwargs):
+        raise NotImplementedError
+
+
+class ReplicaMixin(RawReplicaMixin, Model, metaclass=ReplicaMeta):
     """
     Mixin for the replica CQRS model, that will receive data updates from master. Models, using
     this mixin should be readonly, but this is not enforced (f.e. for admin).
@@ -360,7 +374,6 @@ class ReplicaMixin(Model, metaclass=ReplicaMeta):
     """Set it to True to receive meta data for this model."""
 
     objects = Manager()
-
     cqrs = ReplicaManager()
     """Manager that adds needed CQRS queryset methods."""
 
@@ -383,7 +396,7 @@ def cqrs_save(cls, master_data, previous_data=None, sync=False, meta=None):
         :rtype: django.db.models.Model
         """
         if cls.CQRS_NO_DB_OPERATIONS:
-            raise NotImplementedError
+            return super().cqrs_save(master_data, previous_data=previous_data, sync=sync, meta=meta)
 
         return cls.cqrs.save_instance(master_data, previous_data, sync, meta)
 
@@ -428,7 +441,7 @@ def cqrs_delete(cls, master_data, meta=None):
         :rtype: bool
         """
         if cls.CQRS_NO_DB_OPERATIONS:
-            raise NotImplementedError
+            return super().cqrs_delete(master_data, meta=meta)
 
         return cls.cqrs.delete_instance(master_data)
 

tests/dj_replica/models.py

@@ -1,6 +1,7 @@
-#  Copyright © 2021 Ingram Micro Inc. All rights reserved.
+#  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 
-from dj_cqrs.mixins import ReplicaMixin
+from dj_cqrs.metas import ReplicaMeta
+from dj_cqrs.mixins import RawReplicaMixin, ReplicaMixin
 
 from django.db import models
 
@@ -166,3 +167,19 @@ def cqrs_delete(cls, master_data, meta=None):
         super().cqrs_delete(master_data, meta)
 
         return meta
+
+
+for cqrs_id in ('document1', 'document2'):
+    class DocCls(RawReplicaMixin):
+        CQRS_ID = cqrs_id
+        CQRS_META = True
+
+        @classmethod
+        def cqrs_save(cls, master_data, **kwargs):
+            return cls.CQRS_ID, master_data, kwargs
+
+        @classmethod
+        def cqrs_delete(cls, master_data, **kwargs):
+            return cls.CQRS_ID, master_data, kwargs
+
+    ReplicaMeta.register(DocCls)

tests/test_replica/test_mixin.py

@@ -3,6 +3,7 @@
 from dj_cqrs.constants import SignalType
 from dj_cqrs.dataclasses import TransportPayload
 from dj_cqrs.metas import ReplicaMeta
+from dj_cqrs.mixins import RawReplicaMixin
 
 from django.conf import settings
 from django.db.models import CharField, IntegerField, QuerySet
@@ -608,3 +609,51 @@ def test_support_for_meta_delete():
 
     assert meta == {1: 2, 2: {}}
     assert not models.CQRSMetaModel.objects.exists()
+
+
+def test_raw_replica_mixin():
+    assert RawReplicaMixin.CQRS_ID is None
+    assert RawReplicaMixin.CQRS_NO_DB_OPERATIONS is True
+    assert RawReplicaMixin.CQRS_META is False
+
+    with pytest.raises(NotImplementedError):
+        RawReplicaMixin.cqrs_save(None)
+
+    with pytest.raises(NotImplementedError):
+        RawReplicaMixin.cqrs_delete(None)
+
+
+@pytest.mark.parametrize('cqrs_id', ('document1', 'document2'))
+def test_support_for_non_models_save(cqrs_id):
+    data = {
+        'slug': 'test',
+        'cqrs_revision': 0,
+        'cqrs_updated': now(),
+    }
+    meta = {'Hello': 'world'}
+
+    _cqrs_id, _data, kwargs = TransportStub.consume(
+        TransportPayload(SignalType.SAVE, cqrs_id, data, 'test', meta=meta),
+    )
+
+    assert _cqrs_id == cqrs_id
+    assert _data == data
+    assert kwargs == {'previous_data': None, 'meta': meta}
+
+
+@pytest.mark.parametrize('cqrs_id', ('document1', 'document2'))
+def test_support_for_non_models_delete(cqrs_id):
+    data = {
+        'slug': 'test',
+        'cqrs_revision': 1,
+        'cqrs_updated': now(),
+    }
+    meta = {'other': 1}
+
+    _cqrs_id, _data, kwargs = TransportStub.consume(
+        TransportPayload(SignalType.DELETE, cqrs_id, data, 'test', meta=meta),
+    )
+
+    assert _cqrs_id == cqrs_id
+    assert _data == data
+    assert kwargs == {'meta': meta}