Import feature: show the differences of an element when it is updated by an import (and refactor)

package.json

@@ -35,7 +35,8 @@
     "react-select": "^5.7.0",
     "redux": "^4.1.1",
     "redux-logger": "^3.0.6",
-    "redux-thunk": "^2.3.0"
+    "redux-thunk": "^2.3.0",
+    "react-diff-viewer-continued": "^3.3.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.23.4",

pyproject.toml

@@ -62,6 +62,7 @@ dependencies = [
   "pypandoc~=1.11",
   "requests-toolbelt~=1.0",
   "rules~=3.3",
+  "diff-match-patch==v20230430",
 ]
 
 [project.optional-dependencies]

rdmo/conditions/imports.py

@@ -1,42 +1,14 @@
-import logging
-
-from django.contrib.sites.models import Site
-
-from rdmo.core.imports import check_permissions, set_common_fields, set_foreign_field, validate_instance
+from rdmo.core.import_helpers import ElementImportHelper, ExtraFieldHelper
 
 from .models import Condition
 from .validators import ConditionLockedValidator, ConditionUniqueURIValidator
 
-logger = logging.getLogger(__name__)
-
-
-def import_condition(element, save=False, user=None):
-    try:
-        condition = Condition.objects.get(uri=element.get('uri'))
-    except Condition.DoesNotExist:
-        condition = Condition()
-
-    set_common_fields(condition, element)
-
-    set_foreign_field(condition, 'source', element)
-    set_foreign_field(condition, 'target_option', element)
-
-    condition.relation = element.get('relation')
-    condition.target_text = element.get('target_text') or ''
-
-    validate_instance(condition, element, ConditionLockedValidator, ConditionUniqueURIValidator)
-
-    check_permissions(condition, element, user)
-
-    if save and not element.get('errors'):
-        if condition.id:
-            element['updated'] = True
-            logger.info('Condition %s updated.', element.get('uri'))
-        else:
-            element['created'] = True
-            logger.info('Condition created with uri %s.', element.get('uri'))
-
-        condition.save()
-        condition.editors.add(Site.objects.get_current())
-
-    return condition
+import_helper_condition = ElementImportHelper(
+    model=Condition,
+    validators=(ConditionLockedValidator, ConditionUniqueURIValidator),
+    foreign_fields=('source', 'target_option'),
+    extra_fields=(
+        ExtraFieldHelper(field_name='relation', value=''),
+        ExtraFieldHelper(field_name='target_text', value=''),
+    ),
+)

rdmo/core/assets/scss/variables.scss

@@ -25,6 +25,7 @@ $footer-link-color: #999;
 $footer-background-color: #001;
 
 $danger-color: #a94442;
+$warning-color: #8a6d3b;
 $success-color: #5cb85c;
 $modal-border-color: #e5e5e5;
 

rdmo/core/constants.py

@@ -77,3 +77,17 @@
     "tib": {"base": 1024, "power": 4},
     "pib": {"base": 1024, "power": 5},
 }
+
+RDMO_MODELS = {
+  'catalog': 'questions.catalog',
+  'section': 'questions.section',
+  'page': 'questions.page',
+  'questionset': 'questions.questionset',
+  'question': 'questions.question',
+  'attribute': 'domain.attribute',
+  'optionset': 'options.optionset',
+  'option': 'options.option',
+  'condition': 'conditions.condition',
+  'task': 'tasks.task',
+  'view': 'views.view'
+}

rdmo/core/import_helpers.py

@@ -0,0 +1,55 @@
+from dataclasses import dataclass, field
+from inspect import signature
+from typing import Callable, Iterable, Optional, Sequence, Union
+
+from django.db import models
+
+ELEMENT_COMMON_FIELDS = (
+    'uri_prefix',
+    'uri_path',
+    'comment',
+)
+
+@dataclass(frozen=True)
+class ThroughInstanceMapper:
+    field_name: str
+    source_name: str
+    target_name: str
+    through_name: str
+
+
+@dataclass(frozen=True)
+class ExtraFieldHelper:
+    field_name: str
+    value: Union[str, bool, int, None] = None
+    callback: Optional[Callable] = None
+    overwrite_in_element: bool = False
+
+    def get_value(self, **kwargs):
+        if self.value is not None:
+            return self.value
+        elif self.callback is not None:
+            return self.get_value_from_callback(self.callback, kwargs)
+
+    @staticmethod
+    def get_value_from_callback(callback, kwargs):
+        sig = signature(callback)
+        kwargs = {k: val for k, val in kwargs.items() if k in sig.parameters}
+        value = callback(**kwargs)
+        return value
+
+
+@dataclass(frozen=True)
+class ElementImportHelper:
+    model: Optional[models.Model] = field(default=None)
+    model_path: Optional[str] = field(default=None)
+    validators: Iterable[Callable] = field(default_factory=list)
+    common_fields: Sequence[str] = field(default=ELEMENT_COMMON_FIELDS)
+    lang_fields: Sequence[str] = field(default_factory=list)
+    foreign_fields: Sequence[str] = field(default_factory=list)
+    extra_fields: Sequence[ExtraFieldHelper] = field(default_factory=list)
+    m2m_instance_fields: Sequence[str] = field(default_factory=list)
+    m2m_through_instance_fields: Sequence[ThroughInstanceMapper] = field(default_factory=list)
+    reverse_m2m_through_instance_fields: Sequence[ThroughInstanceMapper] = field(default_factory=list)
+    add_current_site_editors: bool = field(default=True)
+    add_current_site_sites: bool = field(default=False)