Resolve TMSS-272

Closes TMSS-272 Please see comments in JIRA as well. This was quite a hard feature to implement, as it touched many pieces of code. In the end I think the result is better than what we started with because we now have reusable schemas with lots of validation, and full annotation of the schemas.

SAS/TMSS/src/tmss/tmssapp/serializers/specification.py

@@ -91,7 +91,23 @@ class TagsSerializer(RelationalHyperlinkedModelSerializer):
         fields = '__all__'
 
 
-class GeneratorTemplateSerializer(RelationalHyperlinkedModelSerializer):
+
+
+class AbstractTemplateSerializer(RelationalHyperlinkedModelSerializer):
+    schema = JSONEditorField(schema_source=None)
+
+
+    class Meta:
+        abstract = True
+
+
+class CommonSchemaTemplateSerializer(AbstractTemplateSerializer):
+    class Meta:
+        model = models.CommonSchemaTemplate
+        fields = '__all__'
+
+
+class GeneratorTemplateSerializer(AbstractTemplateSerializer):
     class Meta:
         model = models.GeneratorTemplate
         fields = '__all__'
@@ -104,12 +120,14 @@ class DefaultGeneratorTemplateSerializer(RelationalHyperlinkedModelSerializer):
 
 
 class SchedulingUnitObservingStrategyTemplateSerializer(RelationalHyperlinkedModelSerializer):
+    template = JSONEditorField(schema_source="scheduling_unit_template.schema")
+
     class Meta:
         model = models.SchedulingUnitObservingStrategyTemplate
         fields = '__all__'
 
 
-class SchedulingUnitTemplateSerializer(RelationalHyperlinkedModelSerializer):
+class SchedulingUnitTemplateSerializer(AbstractTemplateSerializer):
     class Meta:
         model = models.SchedulingUnitTemplate
         fields = '__all__'
@@ -121,7 +139,7 @@ class DefaultSchedulingUnitTemplateSerializer(RelationalHyperlinkedModelSerializ
         fields = '__all__'
 
 
-class TaskTemplateSerializer(RelationalHyperlinkedModelSerializer):
+class TaskTemplateSerializer(AbstractTemplateSerializer):
     class Meta:
         model = models.TaskTemplate
         fields = '__all__'
@@ -133,7 +151,7 @@ class DefaultTaskTemplateSerializer(RelationalHyperlinkedModelSerializer):
         fields = '__all__'
 
 
-class TaskRelationSelectionTemplateSerializer(RelationalHyperlinkedModelSerializer):
+class TaskRelationSelectionTemplateSerializer(AbstractTemplateSerializer):
     class Meta:
         model = models.TaskRelationSelectionTemplate
         fields = '__all__'
@@ -248,15 +266,7 @@ class PeriodCategorySerializer(RelationalHyperlinkedModelSerializer):
 
 
 class SchedulingSetSerializer(RelationalHyperlinkedModelSerializer):
-
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['generator_doc'] = JSONEditorField(self.instance.generator_template.schema)
-        except Exception as e:
-            pass
+    generator_doc = JSONEditorField(schema_source="generator_template.schema")
 
     class Meta:
         model = models.SchedulingSet
@@ -265,18 +275,9 @@ class SchedulingSetSerializer(RelationalHyperlinkedModelSerializer):
 
 
 class SchedulingUnitDraftSerializer(RelationalHyperlinkedModelSerializer):
-
+    requirements_doc = JSONEditorField(schema_source="requirements_template.schema")
     duration = FloatDurationField(required=False)
 
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['requirements_doc'] = JSONEditorField(self.instance.requirements_template.schema)
-        except Exception as e:
-            pass
-
     class Meta:
         model = models.SchedulingUnitDraft
         fields = '__all__'
@@ -294,18 +295,9 @@ class SchedulingUnitDraftCopyFromSchedulingSetSerializer(SchedulingUnitDraftSeri
        read_only_fields = ['scheduling_unit_blueprints','task_drafts']
 
 class SchedulingUnitBlueprintSerializer(RelationalHyperlinkedModelSerializer):
-
+    requirements_doc = JSONEditorField(schema_source="requirements_template.schema")
     duration = FloatDurationField(required=False)
 
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['requirements_doc'] = JSONEditorField(self.instance.requirements_template.schema)
-        except Exception as e:
-            pass
-
     class Meta:
         model = models.SchedulingUnitBlueprint
         fields = '__all__'
@@ -324,15 +316,7 @@ class TaskDraftSerializer(RelationalHyperlinkedModelSerializer):
     duration = FloatDurationField(required=False)
     relative_start_time = FloatDurationField(required=False)
     relative_stop_time = FloatDurationField(required=False)
-
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['specifications_doc'] = JSONEditorField(self.instance.specifications_template.schema)
-        except Exception as e:
-            pass
+    specifications_doc = JSONEditorField(schema_source='specifications_template.schema')
 
     class Meta:
         model = models.TaskDraft
@@ -345,15 +329,7 @@ class TaskBlueprintSerializer(RelationalHyperlinkedModelSerializer):
     duration = FloatDurationField(required=False)
     relative_start_time = FloatDurationField(required=False)
     relative_stop_time = FloatDurationField(required=False)
-
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['specifications_doc'] = JSONEditorField(self.instance.specifications_template.schema)
-        except Exception as e:
-            pass
+    specifications_doc = JSONEditorField(schema_source='specifications_template.schema')
 
     class Meta:
         model = models.TaskBlueprint
@@ -362,15 +338,7 @@ class TaskBlueprintSerializer(RelationalHyperlinkedModelSerializer):
 
 
 class TaskRelationDraftSerializer(RelationalHyperlinkedModelSerializer):
-
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['selection_doc'] = JSONEditorField(self.instance.selection_template.schema)
-        except Exception as e:
-            pass
+    selection_doc = JSONEditorField(schema_source='selection_template.schema')
 
     class Meta:
         model = models.TaskRelationDraft
@@ -379,15 +347,7 @@ class TaskRelationDraftSerializer(RelationalHyperlinkedModelSerializer):
 
 
 class TaskRelationBlueprintSerializer(RelationalHyperlinkedModelSerializer):
-
-    # Create a JSON editor form to replace the simple text field based on the schema in the template that this
-    # draft refers to. If that fails, the JSONField remains a standard text input.
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        try:
-            self.fields['selection_doc'] = JSONEditorField(self.instance.selection_template.schema)
-        except Exception as e:
-            pass
+    selection_doc = JSONEditorField(schema_source='selection_template.schema')
 
     class Meta:
         model = models.TaskRelationBlueprint