Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/base/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,21 @@ def absolute_reverse(view_name, query_kwargs=None, args=None, kwargs=None):
return url


def get_object_or_error(model_or_qs, query_or_pk=None, request=None, display_name=None, check_deleted=True):
def get_object_or_error(model_or_qs, query_or_pk=None, request=None, display_name=None, check_deleted=True, allow_select_for_update=True):
OSFUser = apps.get_model('osf', 'OSFUser')
if not request:
# for backwards compat with existing get_object_or_error usages
raise TypeError('request is a required argument')

obj = query = None
model_cls = model_or_qs
select_for_update = check_select_for_update(request)
select_for_update = allow_select_for_update and check_select_for_update(request)

if isinstance(model_or_qs, QuerySet):
# they passed a queryset
model_cls = model_or_qs.model
try:
obj = model_or_qs.select_for_update().get() if select_for_update else model_or_qs.get()
obj = model_or_qs.select_for_update(of=('self',)).get() if select_for_update else model_or_qs.get()
except model_cls.DoesNotExist:
raise NotFound

Expand Down
1 change: 1 addition & 0 deletions api/collection_submissions/permissions.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ def has_permission(self, request, view):
),
request=request,
display_name='collection submission',
allow_select_for_update=False,
)
return self.has_object_permission(request, view, obj)

Expand Down
1 change: 1 addition & 0 deletions api/draft_nodes/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ def get_node(self, check_object_permissions=True):
Q(guids___id=self.kwargs['node_id']),
request=self.request,
display_name='node',
allow_select_for_update=False,
)

if check_object_permissions:
Expand Down
1 change: 1 addition & 0 deletions api/institutions/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ def get_institution(self):
self.kwargs[self.institution_lookup_url_kwarg],
self.request,
display_name='institution',
allow_select_for_update=False,
)
return inst

Expand Down
2 changes: 1 addition & 1 deletion api/nodes/filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def build_query_from_field(self, field_name, operation):
if operation['op'] == 'eq':
if operation['value']:
# filter[parent]=<nid>
parent = utils.get_object_or_error(AbstractNode, operation['value'], self.request, display_name='parent')
parent = utils.get_object_or_error(AbstractNode, operation['value'], self.request, display_name='parent', allow_select_for_update=False)
node_ids = NodeRelation.objects.filter(parent=parent, is_node_link=False).values_list('child_id', flat=True)
return Q(id__in=node_ids)
elif operation['op'] == 'ne':
Expand Down
2 changes: 1 addition & 1 deletion api/nodes/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -1576,7 +1576,7 @@ def create(self, validated_data):
class RegistrationSchemaRelationshipField(RelationshipField):

def to_internal_value(self, registration_schema_id):
schema = get_object_or_error(RegistrationSchema, registration_schema_id, self.context['request'])
schema = get_object_or_error(RegistrationSchema, registration_schema_id, self.context['request'], allow_select_for_update=False)
latest_version = RegistrationSchema.objects.get_latest_version(schema.name).schema_version
if latest_version != schema.schema_version or not schema.active:
raise exceptions.ValidationError('Registration supplement must be an active schema.')
Expand Down
20 changes: 15 additions & 5 deletions api/providers/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ def get_provider(self):
self.kwargs['provider_id'],
self.request,
display_name=self.provider_class.__name__,
allow_select_for_update=False,
)

if self.kwargs.get('node_id'):
Expand Down Expand Up @@ -287,7 +288,7 @@ class BaseProviderSubjects(SubjectList):

def get_default_queryset(self):
parent = self.request.query_params.get('filter[parent]', None)
provider = get_object_or_error(self.provider_class, self.kwargs['provider_id'], self.request, display_name=self.provider_class.__name__)
provider = get_object_or_error(self.provider_class, self.kwargs['provider_id'], self.request, display_name=self.provider_class.__name__, allow_select_for_update=False)
if parent:
if parent == 'null':
return optimize_subject_query(provider.top_level_subjects)
Expand Down Expand Up @@ -398,6 +399,7 @@ def get_default_queryset(self):
self.kwargs['provider_id'],
self.request,
display_name=self.provider_class.__name__,
allow_select_for_update=False,
)

if provider.licenses_acceptable.count():
Expand Down Expand Up @@ -549,7 +551,7 @@ def get_queryset(self):

def perform_create(self, serializer):
user = self.request.user
provider = get_object_or_error(RegistrationProvider, self.kwargs['provider_id'], self.request, display_name='RegistrationProvider')
provider = get_object_or_error(RegistrationProvider, self.kwargs['provider_id'], self.request, display_name='RegistrationProvider', allow_select_for_update=False)
if provider and provider.primary_collection:
return serializer.save(creator=user, collection=provider.primary_collection)
raise ValidationError(f'Provider {provider.name} has no primary collection to submit to.')
Expand Down Expand Up @@ -597,8 +599,14 @@ class ModeratorMixin(ProviderMixin):
provider_class = PreprintProvider
model_class = OSFUser

def get_provider(self):
return get_object_or_error(self.provider_type, self.kwargs['provider_id'], self.request, display_name='PreprintProvider')
def get_provider(self, allow_select_for_update=False):
return get_object_or_error(
self.provider_type,
self.kwargs['provider_id'],
self.request,
display_name='PreprintProvider',
allow_select_for_update=allow_select_for_update,
)

def get_serializer_context(self, *args, **kwargs):
ctx = super().get_serializer_context(*args, **kwargs)
Expand Down Expand Up @@ -654,6 +662,8 @@ def get_object(self):
except AttributeError:
# Group doesn't exist -- users not moderator
raise NotFound
if perm_group == ADMIN:
self.get_provider(allow_select_for_update=True)
setattr(user, 'permission_group', perm_group)
return user

Expand Down Expand Up @@ -884,7 +894,7 @@ def get_hash(self, file_obj):

def put(self, request, *args, **kwargs):
provider_id = kwargs['provider_id']
provider = get_object_or_error(RegistrationProvider, provider_id, request)
provider = get_object_or_error(RegistrationProvider, provider_id, request, allow_select_for_update=False)
if not provider.allow_bulk_uploads:
return JsonResponse(
{'errors': [{'type': 'bulkUploadNotAllowed'}]},
Expand Down
1 change: 1 addition & 0 deletions api/schema_responses/permissions.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ def has_permission(self, request, view):
Registration,
query_or_pk=request_json['data']['relationships']['registration']['data']['id'],
request=request,
allow_select_for_update=False,
)

return self.has_object_permission(request, view, obj)
Expand Down
1 change: 1 addition & 0 deletions api/users/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,7 @@ def create(self, validated_data: Dict[str, Any]) -> UserMessage:
institution_id,
request,
'institution',
allow_select_for_update=False,
)

if not sender.is_institutional_admin_at(institution):
Expand Down
42 changes: 42 additions & 0 deletions api_tests/base/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@
from importlib import import_module
from django.conf import settings as django_conf_settings

from django.db import connection, transaction
from django.test.utils import CaptureQueriesContext
from rest_framework import fields

from api.base import utils as api_utils
from osf.models import AbstractNode
from osf.models.base import coerce_guid, Guid, GuidMixin, OptionalGuidMixin, VersionedGuidMixin, InvalidGuid
from osf_tests.factories import ProjectFactory, PreprintFactory
from tests.test_websitefiles import TestFile
Expand Down Expand Up @@ -50,6 +53,45 @@ def test_is_deprecated_larger_versions(self):
assert is_deprecated is True


@pytest.mark.django_db
@mock.patch('osf.utils.requests.settings.SELECT_FOR_UPDATE_ENABLED', True)
class TestGetObjectOrErrorSelectForUpdate:

@pytest.fixture()
def node(self):
return ProjectFactory()

@staticmethod
def lock_queries(ctx):
for_update_sql = connection.ops.for_update_sql()
return [query for query in ctx.captured_queries if for_update_sql in query['sql']]

def test_locks_row_on_mutating_request_by_default(self, node):
with transaction.atomic(), CaptureQueriesContext(connection) as ctx:
obj = api_utils.get_object_or_error(AbstractNode, node._id, mock.Mock(method='POST'))

assert obj == node
assert self.lock_queries(ctx)

def test_does_not_lock_row_when_select_for_update_not_allowed(self, node):
with transaction.atomic(), CaptureQueriesContext(connection) as ctx:
obj = api_utils.get_object_or_error(
AbstractNode,
node._id,
mock.Mock(method='POST'),
allow_select_for_update=False,
)

assert obj == node
assert not self.lock_queries(ctx)

def test_does_not_lock_row_on_safe_request(self, node):
with transaction.atomic(), CaptureQueriesContext(connection) as ctx:
obj = api_utils.get_object_or_error(AbstractNode, node._id, mock.Mock(method='GET'))

assert obj == node
assert not self.lock_queries(ctx)

@pytest.mark.django_db
class TestFlaskDjangoIntegration:
def test_push_status_message_no_response(self):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
from waffle.testutils import override_flag

from framework.auth.core import Auth
from django.db import connection, transaction
from django.test.utils import CaptureQueriesContext
from django.utils import timezone
from api_tests.nodes.views.test_node_draft_registration_list import AbstractDraftRegistrationTestCase
from api.base.settings.defaults import API_BASE
Expand Down Expand Up @@ -465,6 +467,17 @@ def test_admin_can_create_draft(
assert draft.creator == user
assert draft.has_permission(user, ADMIN) is True

def test_create_draft_does_not_lock_registration_schema(self, app, user, url_draft_registrations, payload):
with transaction.atomic(), CaptureQueriesContext(connection) as ctx, capture_notifications():
res = app.post_json_api(url_draft_registrations, payload, auth=user.auth)

assert res.status_code == 201
for_update_sql = connection.ops.for_update_sql()
assert not any(
for_update_sql in query['sql'] and 'FROM "osf_registrationschema"' in query['sql']
for query in ctx.captured_queries
)

def test_create_no_project_draft_emails_initiator(self, app, user, url_draft_registrations, payload):
with capture_notifications() as notifications:
app.post_json_api(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import pytest
from django.db import connection, transaction
from django.test.utils import CaptureQueriesContext

from api.base.settings.defaults import API_BASE
from osf_tests.factories import (
AuthUserFactory,
CollectionFactory,
RegistrationFactory,
RegistrationProviderFactory,
)
from tests.utils import capture_notifications


@pytest.mark.django_db
class TestRegistrationProviderSubmissionCreate:

@pytest.fixture()
def user(self):
return AuthUserFactory()

@pytest.fixture()
def registration(self, user):
return RegistrationFactory(creator=user)

@pytest.fixture()
def provider(self):
return RegistrationProviderFactory()

@pytest.fixture()
def url(self, provider):
return f'/{API_BASE}providers/registrations/{provider._id}/submissions/'

@pytest.fixture()
def payload(self, registration):
return {
'data': {
'type': 'collection-submissions',
'attributes': {
'guid': registration._id,
},
},
}

@pytest.fixture()
def primary_collection(self, user, provider):
collection = CollectionFactory(creator=user, provider=provider, is_public=True)
provider.primary_collection = collection
provider.save()
return collection

def test_create_submission_in_primary_collection(self, app, user, registration, primary_collection, url, payload):
with capture_notifications():
res = app.post_json_api(url, payload, auth=user.auth)

assert res.status_code == 201
assert primary_collection.collectionsubmission_set.filter(guid___id=registration._id).exists()

def test_cannot_create_submission_without_primary_collection(self, app, user, provider, url, payload):
assert provider.primary_collection is None

res = app.post_json_api(url, payload, auth=user.auth, expect_errors=True)

assert res.status_code == 400
assert 'has no primary collection' in res.json['errors'][0]['detail']

def test_create_submission_does_not_lock_provider(self, app, user, primary_collection, url, payload):
with transaction.atomic(), CaptureQueriesContext(connection) as ctx, capture_notifications():
res = app.post_json_api(url, payload, auth=user.auth)

assert res.status_code == 201
for_update_sql = connection.ops.for_update_sql()
assert not any(
query['sql'].startswith('SELECT') and 'osf_abstractprovider' in query['sql'] and for_update_sql in query['sql']
for query in ctx.captured_queries
)
Loading