8000 Introduce mutex to ensure ordering consistency by mkgs · Pull Request #218 · django-ordered-model/django-ordered-model · GitHub
[go: up one dir, main page]

Skip to content

Introduce mutex to ensure ordering consistency #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,6 @@ dmypy.json

# Cython debug symbols
cython_debug/

/dist
/django_ordered_model.egg-info
20 changes: 20 additions & 0 deletions ordered_model/migrations/0001_initial.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Generated by Django 3.0.6 on 2020-05-09 22:15

from django.db import migrations, models


class Migration(migrations.Migration):

initial = True

dependencies = [
]

operations = [
migrations.CreateModel(
name='OrderedMutex',
fields=[
('key', models.PositiveIntegerField(editable=False, primary_key=True, serialize=False)),
],
),
]
Empty file.
67 changes: 64 additions & 3 deletions ordered_model/models.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from functools import partial, reduce
from operator import xor

from django.db import models
from django.db import models, transaction
from django.db.models import Max, Min, F
from django.db.models.constants import LOOKUP_SEP
from django.utils.module_loading import import_string
Expand Down Expand Up @@ -140,18 +141,31 @@ class OrderedModelBase(models.Model):
- use the same field name in ``Meta.ordering``
[optional]
- set ``order_with_respect_to`` to limit order to a subset
- specify ``order_class_path`` in case of polymorphic classes
- specify ``order_class_path`` in case of polymorpic classes
- set ``use_order_mutex`` to True to get mutex lock before modifying order
"""

objects = OrderedModelManager()

order_field_name = None
order_with_respect_to = None
order_class_path = None
use_order_mutex = False

class Meta:
abstract = True

def _get_mutex(self):
hashes = [hash(self._meta.db_table)]
if self.order_with_respect_to:
order_with_respect_to = [self.order_with_respect_to] if isinstance(self.order_with_respect_to, str) \
else self.order_with_respect_to
hashes.extend([hash(get_lookup_value(self, attr)) for attr in order_with_respect_to])
return OrderedMutex.objects.select_for_update().get_or_create(key=reduce(xor, hashes) & 0x7FFFFFFF)[0]

def _get_order_with_respect_to_filter_kwargs(self):
return self._meta.default_manager._get_order_with_respect_to_filter_kwargs(self)

def _validate_ordering_reference(self, ref):
if self.order_with_respect_to is not None:
self_kwargs = self._meta.default_manager._get_order_with_respect_to_filter_kwargs(
Expand All @@ -176,7 +190,7 @@ def get_ordering_queryset(self, qs=None):
qs = model._meta.default_manager.all()
else:
qs = self._meta.default_manager.all()
return qs.filter_by_order_with_respect_to(self)
return qs.filter_by_order_with_respect_to(self).order_by(self.order_field_name)

def previous(self):
"""
Expand All @@ -190,26 +204,45 @@ def next(self):
"""
return self.get_ordering_queryset().above_instance(self).first()

@transaction.atomic()
def save(self, *args, **kwargs):
order_field_name = self.order_field_name
if getattr(self, order_field_name) is None:

if self.use_order_mutex:
mutex = self._get_mutex()

order = self.get_ordering_queryset().get_next_order()
setattr(self, order_field_name, order)
super().save(*args, **kwargs)

@transaction.atomic()
def delete(self, *args, extra_update=None, **kwargs):
qs = self.get_ordering_queryset()
extra_update = {} if extra_update is None else extra_update

if self.use_order_mutex:
mutex = self._get_mutex()
order_field_name = self.order_field_name
self.refresh_from_db(fields=[order_field_name])

qs.above_instance(self).decrease_order(**extra_update)
super().delete(*args, **kwargs)

@transaction.atomic()
def swap(self, replacement):
"""
Swap the position of this object with a replacement object.
"""
self._validate_ordering_reference(replacement)

order_field_name = self.order_field_name

if self.use_order_mutex:
mutex = self._get_mutex()
self.refresh_from_db(fields=[order_field_name])
replacement.refresh_from_db(fields=[order_field_name])

order, replacement_order = (
getattr(self, order_field_name),
getattr(replacement, order_field_name),
Expand All @@ -235,6 +268,7 @@ def down(self):
if _next:
self.swap(_next)

@transaction.atomic()
def to(self, order, extra_update=None):
"""
Move object to a certain position, updating all affected objects to move accordingly up or down.
Expand All @@ -247,6 +281,11 @@ def to(self, order, extra_update=None):
)

order_field_name = self.order_field_name

if self.use_order_mutex:
mutex = self._get_mutex()
self.refresh_from_db(fields=[order_field_name])

if order is None or getattr(self, order_field_name) == order:
# object is already at desired position
return
Expand All @@ -263,12 +302,19 @@ def to(self, order, extra_update=None):
setattr(self, order_field_name, order)
self.save()

@transaction.atomic()
def above(self, ref, extra_update=None):
"""
Move this object above the referenced object.
"""
self._validate_ordering_reference(ref)
order_field_name = self.order_field_name

if self.use_order_mutex:
mutex = self._get_mutex()
self.refresh_from_db(fields=[order_field_name])
ref.refresh_from_db(fields=[order_field_name])

if getattr(self, order_field_name) == getattr(ref, order_field_name):
return
if getattr(self, order_field_name) > getattr(ref, order_field_name):
Expand All @@ -277,12 +323,19 @@ def above(self, ref, extra_update=None):
o = self.get_ordering_queryset().below_instance(ref).get_max_order() or 0
self.to(o, extra_update=extra_update)

@transaction.atomic()
def below(self, ref, extra_update=None):
"""
Move this object below the referenced object.
"""
self._validate_ordering_reference(ref)
order_field_name = self.order_field_name

if self.use_order_mutex:
mutex = self._get_mutex()
self.refresh_from_db(fields=[order_field_name])
ref.refresh_from_db(fields=[order_field_name])

if getattr(self, order_field_name) == getattr(ref, order_field_name):
return
if getattr(self, order_field_name) > getattr(ref, order_field_name):
Expand Down Expand Up @@ -318,3 +371,11 @@ class OrderedModel(OrderedModelBase):
class Meta:
abstract = True
ordering = ("order",)


class OrderedMutex(models.Model):
"""
Mutex model that ensures ordering integrity
"""

key = models.PositiveIntegerField(editable=False, primary_key=True)
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Django
Django
0