reworked views and serializers to pass and take into account the "validation timestamp" to the model + refactored models to have a content validation method + adapted tests
import json, uuid, datetime, time
from django.db import transaction
from django.contrib.auth import get_user_model
from django.conf import settings
from renkanmanager.models import Renkan, Workspace, Revision
from rest_framework import serializers
RENKAN_USER_DISPLAY_FIELD = getattr(settings, "RENKAN_USER_DISPLAY_FIELD", get_user_model().USERNAME_FIELD)
class RenkanSerializer(serializers.Serializer):
id = serializers.ReadOnlyField(source="renkan_guid")
current_revision_id = serializers.SlugRelatedField(source="current_revision", slug_field="revision_guid", read_only=True)
workspace_id = serializers.SlugRelatedField(source="workspace", slug_field="workspace_guid", queryset=Workspace.objects, required=False)
source_revision_id = serializers.SlugRelatedField(source="source_revision", slug_field="revision_guid", queryset=Revision.objects, required=False)
revision_count = serializers.ReadOnlyField()
created_by = serializers.SlugRelatedField(source="creator", slug_field=RENKAN_USER_DISPLAY_FIELD, read_only=True)
last_updated_by = serializers.SerializerMethodField("get_current_revision_last_updator")
title = serializers.CharField(required=False)
content = serializers.JSONField(required=False)
creation_date = serializers.ReadOnlyField()
modification_date = serializers.SerializerMethodField("get_current_revision_modification_date")
create_new_revision = serializers.BooleanField(write_only=True, required=False) # only used for updating
validation_timestamp = serializers.CharField(write_only=True, required=False) # only used for updating is a content json is not provided
# ADD ERROR HANDLING
def get_current_revision_last_updator(self, renkan):
return getattr(renkan.current_revision.last_updated_by, RENKAN_USER_DISPLAY_FIELD)
def get_current_revision_modification_date(self, renkan):
return renkan.current_revision.modification_date
@transaction.atomic
def create(self, validated_data):
"""
Method to create a new Renkan (and its first revision)
"""
creator = validated_data.get('creator')
workspace_obj = validated_data.get('workspace', None)
source_revision_obj = validated_data.get('source_revision', None)
try:
return Renkan.objects.create_renkan(
creator=creator,
title=validated_data.get('title', ''),
content=validated_data.get('content', ''),
workspace=workspace_obj,
source_revision=source_revision_obj
)
except ValidationError as ve:
raise serializers.ValidationError(ve.args[0])
@transaction.atomic
def update(self, renkan, validated_data):
"""
Method to update a Renkan object. Creates a new revision if needed
"""
updator = validated_data.get('updator')
create_new_revision = validated_data.get("create_new_revision", False)
title = validated_data.get('title', renkan.current_revision.title)
content = validated_data.get('content', '')
if not content:
content = renkan.current_revision.content
if not 'validation_timestamp' in validated_data:
raise serializers.ValidationError("No validation timestamp and no content json to extract it from")
validation_timestamp = validated_data.get('validation_timestamp')
else:
validation_timestamp = json.loads(content).get("updated", "")
if title != json.loads(content).get("title", ""):
content_dict = json.loads(content)
content_dict["title"] = title
content = json.dumps(content_dict)
try:
renkan.save_renkan(updator=updator, timestamp=validation_timestamp, title=title, content=content, create_new_revision=create_new_revision)
except ValidationError as ve:
raise serializers.ValidationError(ve.args[0])
return renkan
def validate_workspace_id(self, value):
if self.instance is not None:
raise serializers.ValidationError("You cannot update workspace_guid")
return value
def validate_source_revision_id(self, value):
if self.instance is not None:
raise serializers.ValidationError("You cannot update source_revision_guid")
return value
def validate_content(self, value):
try:
json.loads(value)
except ValueError:
raise serializers.ValidationError("Content format is not a JSON-serializable")
loaded_json = json.loads(value)
if (not "nodes" in loaded_json):
raise serializers.ValidationError("Content requires a 'nodes' entry")
if (not "edges" in loaded_json):
raise serializers.ValidationError("Content requires a 'edges' entry")
if (not "views" in loaded_json):
raise serializers.ValidationError("Content requires a 'views' entry")
return value
class RevisionSerializer(serializers.Serializer):
id = serializers.ReadOnlyField(source="revision_guid")
parent_renkan_id = serializers.SlugRelatedField(source="parent_renkan", slug_field='renkan_guid', read_only=True)
workspace_id = serializers.SerializerMethodField("get_related_workspace_guid")
title = serializers.ReadOnlyField()
content = serializers.JSONField(read_only=True)
renkan_created_by = serializers.SerializerMethodField("get_related_renkan_creator")
renkan_creation_date = serializers.SerializerMethodField("get_related_renkan_creation_date")
revision_created_by = serializers.SlugRelatedField(source="creator", slug_field=RENKAN_USER_DISPLAY_FIELD, read_only=True)
revision_last_updated_by = serializers.SlugRelatedField(source="last_updated_by", slug_field=RENKAN_USER_DISPLAY_FIELD, read_only=True)
revision_modification_date = serializers.ReadOnlyField(source="modification_date")
def get_related_workspace_guid(self, revision):
if revision.parent_renkan.workspace:
return revision.parent_renkan.workspace.workspace_guid
else:
return ''
def get_related_renkan_creator(self, revision):
return getattr(revision.parent_renkan.creator, RENKAN_USER_DISPLAY_FIELD)
def get_related_renkan_creation_date(self, revision):
return revision.parent_renkan.creation_date
class WorkspaceSerializer(serializers.Serializer):
id = serializers.ReadOnlyField(source="workspace_guid")
workspace_created_by = serializers.SlugRelatedField(source="creator", slug_field=RENKAN_USER_DISPLAY_FIELD, read_only=True)
creation_date = serializers.ReadOnlyField()
renkan_count = serializers.ReadOnlyField()
title = serializers.CharField()
def create(self, validated_data):
creator = validated_data.get('creator')
title = validated_data.get('title', '')
workspace = Workspace.objects.create(creator=creator, title=title)
workspace.save()
return workspace
def update(self, workspace, validated_data):
workspace.title = validated_data.get('title', '')
workspace.save()
return workspace