add list_serializer_class for NodeContributorsCreateSerializer; minor optimization

Author: antkryt

api/base/serializers.py

@@ -1456,6 +1456,11 @@ class JSONAPISerializer(BaseAPISerializer):
     @classmethod
     def many_init(cls, *args, **kwargs):
         kwargs['child'] = cls(*args, **kwargs)
+        # Use DRF list_serializer_class if it exists, otherwise use default JSONAPIListSerializer
+        meta = getattr(cls, 'Meta', None)
+        list_cls = getattr(meta, 'list_serializer_class', None)
+        if list_cls:
+            return list_cls(*args, **kwargs)
         return JSONAPIListSerializer(*args, **kwargs)
 
     def invalid_embeds(self, fields, embeds):

api/nodes/serializers.py

@@ -1,4 +1,4 @@
-from django.db import connection
+from django.db import connection, transaction
 from packaging.version import Version
 
 from api.base.exceptions import (
@@ -7,7 +7,7 @@
 )
 from api.base.serializers import (
     VersionedDateTimeField, HideIfRegistration, IDField,
-    JSONAPISerializer, LinksField,
+    JSONAPISerializer, JSONAPIListSerializer, LinksField,
     NodeFileHyperLinkField, RelationshipField,
     ShowIfVersion, TargetTypeField, TypeField,
     WaterbutlerLink, BaseAPISerializer,
@@ -38,7 +38,7 @@
     Comment, DraftRegistration, ExternalAccount,
     RegistrationSchema, AbstractNode, PrivateLink, Preprint,
     RegistrationProvider, NodeLicense, DraftNode,
-    Registration, Node,
+    Registration, Node, OSFUser,
 )
 from website.project import new_private_link
 from website.project.model import NodeUpdateError
@@ -1219,6 +1219,113 @@ def get_unregistered_contributor(self, obj):
             return unclaimed_records.get('name', None)
 
 
+class NodeContributorsBulkCreateListSerializer(JSONAPIListSerializer):
+
+    def create(self, validated_data):
+        request = self.context['request']
+        node = self.context['resource']
+        auth = Auth(request.user)
+
+        with transaction.atomic():
+            results = []
+            registered_items = []
+            unregistered_items = []
+
+            for item in validated_data:
+                if item.get('_id') and not item.get('user', {}).get('email'):
+                    registered_items.append(item)
+                else:
+                    unregistered_items.append(item)
+
+            def _perm(item):
+                return osf_permissions.get_contributor_proposed_permissions(item)
+
+            if registered_items:
+                # Load users once and build a mapping to reuse
+                user_map = {}
+                for item in registered_items:
+                    user_id = item.get('_id')
+                    if user_id and user_id not in user_map:
+                        user = OSFUser.load(user_id)
+                        if not user:
+                            raise exceptions.NotFound(detail=f"User {user_id} not found")
+                        user_map[user_id] = user
+
+                contrib_dicts = []
+                for item in registered_items:
+                    user = user_map[item.get('_id')]
+                    contrib_dicts.append({
+                        'user': user,
+                        'permissions': _perm(item),
+                        'visible': item.get('bibliographic'),
+                    })
+                contribs = node.add_contributors(contrib_dicts, auth=auth, log=True, save=True)
+                results.extend(contribs)
+
+                child_to_items = {}
+                for item in registered_items:
+                    child_nodes = item.get('child_nodes')
+                    if child_nodes:
+                        for child_id in child_nodes:
+                            child_to_items.setdefault(child_id, []).append(item)
+
+                for child_id, items in child_to_items.items():
+                    child = AbstractNode.load(child_id)
+                    if not child:
+                        continue
+                    child_contribs = []
+                    for item in items:
+                        child_contribs.append({
+                            'user': user_map[item.get('_id')],
+                            'permissions': _perm(item),
+                            'visible': item.get('bibliographic'),
+                        })
+                    child.add_contributors(child_contribs, auth=auth, log=True, save=True)
+
+            for item in unregistered_items:
+                id = item.get('_id')
+                email = item.get('user', {}).get('email', None)
+                full_name = item.get('full_name')
+                bibliographic = item.get('bibliographic')
+                index = item.get('_order') if '_order' in item else None
+                send_email = request.GET.get('send_email') or self.context['default_email']
+                permissions = _perm(item)
+
+                try:
+                    contributor_obj = node.add_contributor_registered_or_not(
+                        auth=auth,
+                        user_id=id,
+                        email=email,
+                        full_name=full_name,
+                        send_email=send_email,
+                        permissions=permissions,
+                        bibliographic=bibliographic,
+                        index=index,
+                        save=True,
+                    )
+                    results.append(contributor_obj)
+                    child_nodes = item.get('child_nodes')
+                    if child_nodes:
+                        for child in AbstractNode.objects.filter(guids___id__in=child_nodes):
+                            child.add_contributor_registered_or_not(
+                                auth=auth,
+                                user_id=id,
+                                email=email,
+                                full_name=full_name,
+                                send_email=send_email,
+                                permissions=permissions,
+                                bibliographic=bibliographic,
+                                index=index,
+                                save=True,
+                            )
+                except ValidationError as e:
+                    raise exceptions.ValidationError(detail=e.messages[0])
+                except ValueError as e:
+                    raise exceptions.NotFound(detail=e.args[0])
+
+            return results
+
+
 class NodeContributorsCreateSerializer(NodeContributorsSerializer):
     """
     Overrides NodeContributorsSerializer to add email, full_name, send_email, and non-required index and users field.
@@ -1239,8 +1346,8 @@ class NodeContributorsCreateSerializer(NodeContributorsSerializer):
 
     email_preferences = ['default', 'false']
 
-    def get_proposed_permissions(self, validated_data):
-        return validated_data.get('permission') or osf_permissions.DEFAULT_CONTRIBUTOR_PERMISSIONS
+    class Meta(NodeContributorsSerializer.Meta):
+        list_serializer_class = NodeContributorsBulkCreateListSerializer
 
     def validate_data(self, node, user_id=None, full_name=None, email=None, index=None, child_nodes=None):
         if not user_id and not full_name:
@@ -1264,7 +1371,7 @@ def create(self, validated_data):
         bibliographic = validated_data.get('bibliographic')
         send_email = self.context['request'].GET.get('send_email') or self.context['default_email']
         child_nodes = validated_data.get('child_nodes')
-        permissions = self.get_proposed_permissions(validated_data)
+        permissions = osf_permissions.get_contributor_proposed_permissions(validated_data)
 
         self.validate_data(node, user_id=id, full_name=full_name, email=email, index=index, child_nodes=child_nodes)
 

osf/models/mixins.py

@@ -1432,7 +1432,7 @@ def add_contributor(self, contributor, permissions=None, visible=True,
             # Add default contributor permissions
             permissions = permissions or self.DEFAULT_CONTRIBUTOR_PERMISSIONS
 
-            self.add_permission(contrib_to_add, permissions, save=True)
+            self.add_permission(contrib_to_add, permissions, save=False)
             if make_curator:
                 contributor_obj.is_curator = True
             contributor_obj.save()
@@ -1482,11 +1482,13 @@ def add_contributors(self, contributors, auth=None, log=True, save=False):
         :param log: Add log to self
         :param save: Save after adding contributor
         """
+        users = []
         for contrib in contributors:
             self.add_contributor(
                 contributor=contrib['user'], permissions=contrib['permissions'],
                 visible=contrib['visible'], auth=auth, log=False, save=False,
             )
+            users.append(contrib['user'])
         if log and contributors:
             params = self.log_params
             params['contributors'] = [
@@ -1502,8 +1504,10 @@ def add_contributors(self, contributors, auth=None, log=True, save=False):
         if save:
             self.save()
 
+        return self.contributor_set.filter(user__in=users)
+
     def add_unregistered_contributor(self, fullname, email, auth, send_email=None,
-                                     visible=True, permissions=None, save=False, existing_user=None):
+                                     visible=True, permissions=None, save=True, existing_user=None):
         """Add a non-registered contributor to the project.
 
         :param str fullname: The full name of the person.
@@ -1554,12 +1558,13 @@ def add_unregistered_contributor(self, fullname, email, auth, send_email=None,
             visible=visible, send_email=send_email, log=True, save=False
         )
         self._add_related_source_tags(contributor)
-        self.save()
+        if save:
+            self.save()
         return contributor
 
     def add_contributor_registered_or_not(self, auth, user_id=None,
                                           full_name=None, email=None, send_email=None,
-                                          permissions=None, bibliographic=True, index=None, save=False):
+                                          permissions=None, bibliographic=True, index=None, save=True):
         OSFUser = apps.get_model('osf.OSFUser')
         send_email = send_email or self.contributor_email_template
 
@@ -1573,7 +1578,7 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
 
             if contributor.is_registered:
                 contributor = self.add_contributor(contributor=contributor, auth=auth, visible=bibliographic,
-                                                   permissions=permissions, send_email=send_email, save=True)
+                                                   permissions=permissions, send_email=send_email, save=save)
             else:
                 if not full_name:
                     raise ValueError(
@@ -1583,7 +1588,7 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
                 contributor = self.add_unregistered_contributor(
                     fullname=full_name, email=contributor.username, auth=auth,
                     send_email=send_email, permissions=permissions,
-                    visible=bibliographic, existing_user=contributor, save=True
+                    visible=bibliographic, existing_user=contributor, save=save
                 )
 
         else:
@@ -1592,20 +1597,26 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
                 raise ValidationValueError(f'{contributor.fullname} is already a contributor.')
 
             if contributor and contributor.is_registered:
-                self.add_contributor(contributor=contributor, auth=auth, visible=bibliographic,
-                                     send_email=send_email, permissions=permissions, save=True)
+                self.add_contributor(
+                    contributor=contributor,
+                    auth=auth,
+                    visible=bibliographic,
+                    send_email=send_email,
+                    permissions=permissions,
+                    save=save,
+                )
             else:
                 contributor = self.add_unregistered_contributor(
                     fullname=full_name, email=email, auth=auth,
                     send_email=send_email, permissions=permissions,
-                    visible=bibliographic, save=True
+                    visible=bibliographic, save=save
                 )
 
         auth.user.email_last_sent = timezone.now()
         auth.user.save()
 
         if index is not None:
-            self.move_contributor(contributor=contributor, index=index, auth=auth, save=True)
+            self.move_contributor(contributor=contributor, index=index, auth=auth, save=save)
 
         contributor_obj = self.contributor_set.get(user=contributor)
         return contributor_obj

osf/utils/permissions.py

@@ -72,3 +72,7 @@ def check_private_key_for_anonymized_link(private_key):
     except PrivateLink.DoesNotExist:
         return False
     return link.anonymous
+
+
+def get_contributor_proposed_permissions(validated_data):
+    return validated_data.get('permission') or DEFAULT_CONTRIBUTOR_PERMISSIONS