Add models to persist embed config

[TaiWilkin]

Overview

The embed config is complex and will grow over time as we add features. Rather than serialize to the query string, store the config in the database and link it to the contributor.

• Adds configuration models
• Adds creation, update and fetching of embedded map configurations via API
  • Note that the nested embedded map fields are deleted and recreated on update of the parent EmbedConfig
• Adds embedded map configuration to the data fetched for user profiles

Connects #1299

Demo

Testing Instructions

• Run ./scripts/manage migrate
• Run ./scripts/server and login as a user with an associated contributor
• Navigate to :8081/api/embed-configs/
• POST a new embed config object
  • The new EmbedConfig should be created successfully

     {
	"width": "100",
	"height": "100",
	"color": "pink",
	"font": "serif",
	"show_other_contributor_information": false,
	"embed_fields": [{
		"column_name": "xyz",
		"display_name": "123",
		"visible": true,
		"order": 1
	}]
   }

• Navigate to [your profile](http://localhost:6543/profile/8]
  • Confirm in the network tab that the EmbedConfig is returned with the contributor details
• Navigate to your new EmbedConfig and update some fields, including the embed_fields
  • The configuration should update successfully
• Attempt to create an embed_field with a duplicate order
  • You should receive an error message
• Attempt to create a new EmbedConfig with the same user
  • You should receive an error message

Checklist

• fixup! commits have been squashed
• CI passes after rebase
• CHANGELOG.md updated with summary of features or fixes, following Keep a Changelog guidelines

[jwalgran]

The models look good but I found what look like a few required fixes that we need to make to the API.

[jwalgran]

I tested the permission updates and they look good. There were two lines in the test instructions that failed for me

• Preventing the creation of multiple configs for a single contributor
• Returning the embed config from the profile endpoint

Consider changes similar to these:

diff --git a/src/django/api/serializers.py b/src/django/api/serializers.py
index fd9bab1..a9ee624 100644
--- a/src/django/api/serializers.py
+++ b/src/django/api/serializers.py
@@ -171,11 +171,13 @@ class UserProfileSerializer(ModelSerializer):
     other_contributor_type = SerializerMethodField()
     facility_lists = SerializerMethodField()
     is_verified = SerializerMethodField()
+    embed_config = SerializerMethodField()
 
     class Meta:
         model = User
         fields = ('id', 'name', 'description', 'website', 'contributor_type',
-                  'other_contributor_type', 'facility_lists', 'is_verified')
+                  'other_contributor_type', 'facility_lists', 'is_verified',
+                  'embed_config')
 
     def get_name(self, user):
         try:
@@ -233,6 +235,12 @@ class UserProfileSerializer(ModelSerializer):
         except Contributor.DoesNotExist:
             return False
 
+    def get_embed_config(self, user):
+        try:
+            return EmbedConfigSerializer(user.contributor.embed_config).data
+        except Contributor.DoesNotExist:
+            return None
+
 
 class FacilityListSummarySerializer(ModelSerializer):
     contributor_id = SerializerMethodField()
diff --git a/src/django/api/views.py b/src/django/api/views.py
index 5c60122..e5aac11 100644
--- a/src/django/api/views.py
+++ b/src/django/api/views.py
@@ -3534,6 +3534,8 @@ class EmbedConfigViewSet(mixins.ListModelMixin,
             return Response(status=status.HTTP_401_UNAUTHORIZED)
 
         contributor = self.get_contributor(request)
+        if contributor.embed_config is not None:
+            raise ValidationError('Contributor has an existing embed configuration.')
 
         fields_data = request.data.pop('embed_fields', [])
 

[jwalgran]

This is nice. I don't regularly use pop and may have missed the fact that you can provide a default argument 👍

[TaiWilkin]

Thanks for the feedback! I've updated the profile fetching and the contributor check in d4b0b0c

[jwalgran]

Looks good. Thanks for working through the changes with me.

[TaiWilkin]

Thank you for reviewing!