Skip to content

Commit

Permalink
Not require explicitly set ordering in DjangoConnectionField (#1518)
Browse files Browse the repository at this point in the history
* Revert "feat!: check django model has a default ordering when used in a relay connection (#1495)"

This reverts commit 96c09ac.

* Fix assert no warning for pytest>=8
  • Loading branch information
kiendang authored Apr 18, 2024
1 parent ea45de0 commit 6f21dc7
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 59 deletions.
3 changes: 0 additions & 3 deletions examples/starwars/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ def __str__(self):


class Ship(models.Model):
class Meta:
ordering = ["pk"]

name = models.CharField(max_length=50)
faction = models.ForeignKey(Faction, on_delete=models.CASCADE, related_name="ships")

Expand Down
8 changes: 1 addition & 7 deletions graphene_django/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,19 +101,13 @@ def type(self):
non_null = True
assert issubclass(
_type, DjangoObjectType
), "DjangoConnectionField only accepts DjangoObjectType types as underlying type"
), "DjangoConnectionField only accepts DjangoObjectType types"
assert _type._meta.connection, "The type {} doesn't have a connection".format(
_type.__name__
)
connection_type = _type._meta.connection
if non_null:
return NonNull(connection_type)
# Since Relay Connections require to have a predictible ordering for pagination,
# check on init that the Django model provided has a default ordering declared.
model = connection_type._meta.node._meta.model
assert (
len(getattr(model._meta, "ordering", [])) > 0
), f"Django model {model._meta.app_label}.{model.__name__} has to have a default ordering to be used in a Connection."
return connection_type

@property
Expand Down
3 changes: 0 additions & 3 deletions graphene_django/filter/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@


class Event(models.Model):
class Meta:
ordering = ["pk"]

name = models.CharField(max_length=50)
tags = ArrayField(models.CharField(max_length=50))
tag_ids = ArrayField(models.IntegerField())
Expand Down
12 changes: 0 additions & 12 deletions graphene_django/tests/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,13 @@


class Person(models.Model):
class Meta:
ordering = ["pk"]

name = models.CharField(max_length=30)
parent = models.ForeignKey(
"self", on_delete=models.CASCADE, null=True, blank=True, related_name="children"
)


class Pet(models.Model):
class Meta:
ordering = ["pk"]

name = models.CharField(max_length=30)
age = models.PositiveIntegerField()
owner = models.ForeignKey(
Expand All @@ -37,9 +31,6 @@ class FilmDetails(models.Model):


class Film(models.Model):
class Meta:
ordering = ["pk"]

genre = models.CharField(
max_length=2,
help_text="Genre",
Expand All @@ -55,9 +46,6 @@ def get_queryset(self):


class Reporter(models.Model):
class Meta:
ordering = ["pk"]

first_name = models.CharField(max_length=30)
last_name = models.CharField(max_length=30)
email = models.EmailField()
Expand Down
36 changes: 2 additions & 34 deletions graphene_django/tests/test_fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
import re

import pytest
from django.db.models import Count, Model, Prefetch
from django.db.models import Count, Prefetch

from graphene import List, NonNull, ObjectType, Schema, String
from graphene.relay import Node

from ..fields import DjangoConnectionField, DjangoListField
from ..fields import DjangoListField
from ..types import DjangoObjectType
from .models import (
Article as ArticleModel,
Expand Down Expand Up @@ -717,34 +716,3 @@ def resolve_articles(root, info):
r'SELECT .* FROM "tests_film" INNER JOIN "tests_film_reporters" .* LEFT OUTER JOIN "tests_filmdetails"',
captured.captured_queries[1]["sql"],
)


class TestDjangoConnectionField:
def test_model_ordering_assertion(self):
class Chaos(Model):
class Meta:
app_label = "test"

class ChaosType(DjangoObjectType):
class Meta:
model = Chaos
interfaces = (Node,)

class Query(ObjectType):
chaos = DjangoConnectionField(ChaosType)

with pytest.raises(
TypeError,
match=r"Django model test\.Chaos has to have a default ordering to be used in a Connection\.",
):
Schema(query=Query)

def test_only_django_object_types(self):
class Query(ObjectType):
something = DjangoConnectionField(String)

with pytest.raises(
TypeError,
match="DjangoConnectionField only accepts DjangoObjectType types as underlying type",
):
Schema(query=Query)

0 comments on commit 6f21dc7

Please sign in to comment.