.github/ISSUE_TEMPLATE/bug_report.yml

@@ -35,6 +35,7 @@ body:
         If you are not using the latest version, please try to also reproduce the bug
         on the latest version before opening the issue.
       options:
+        - "0.2.10"
         - "0.2.9"
         - "0.2.8"
         - "0.2.7"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "graphene-django-query-optimizer"
-version = "0.2.9"
+version = "0.2.10"
 description = "Automatically optimize SQL queries in Graphene-Django schemas."
 authors = [
     "Matti Lamppu <lamppu.matti.akseli@gmail.com>",

query_optimizer/optimizer.py

@@ -60,7 +60,7 @@ def __init__(self, model: type[Model], info: GQLInfo) -> None:
         self.annotations: dict[str, Expression] = {}
         self.select_related: dict[str, QueryOptimizer] = {}
         self.prefetch_related: dict[str, QueryOptimizer] = {}
-        self._cache_key: Optional[str] = None  # generated during optimization process
+        self._cache_key: Optional[str] = None  # generated during the optimization process
         self.total_count: bool = False
 
     def optimize_queryset(
@@ -167,8 +167,7 @@ def paginate_prefetch_queryset(
             offset=filter_info.get("filters", {}).get("offset"),
             first=filter_info.get("filters", {}).get("first"),
             last=filter_info.get("filters", {}).get("last"),
-            # Just use `RELAY_CONNECTION_MAX_LIMIT` (ignore DjangoConnectionField.max_limit).
-            max_limit=graphene_settings.RELAY_CONNECTION_MAX_LIMIT,
+            max_limit=filter_info.get("max_limit", graphene_settings.RELAY_CONNECTION_MAX_LIMIT),
         )
 
         # If no pagination arguments are given, and `RELAY_CONNECTION_MAX_LIMIT` is `None`,

query_optimizer/typing.py

@@ -123,3 +123,4 @@ class GraphQLFilterInfo(TypedDict, total=False):
     filterset_class: Optional[type[FilterSet]]
     is_connection: bool
     is_node: bool
+    max_limit: Optional[int]

query_optimizer/utils.py

@@ -8,6 +8,7 @@
 from graphene import Connection
 from graphene.relay.node import AbstractNode
 from graphene.utils.str_converters import to_snake_case
+from graphene_django.settings import graphene_settings
 from graphene_django.utils import DJANGO_FILTER_INSTALLED
 from graphql import FieldNode, FragmentSpreadNode, GraphQLField, InlineFragmentNode, get_argument_values
 from graphql.execution.execute import get_field_def
@@ -301,11 +302,18 @@ def _find_filter_info_from_field_node(
 
     new_parent = get_underlying_type(field_def.type)
 
-    # If the field is a relay node field, its `id` field should not be counted as a filter.
     is_node = issubclass(getattr(getattr(field_def.resolve, "func", None), "__self__", type(None)), AbstractNode)
+    is_connection = issubclass(getattr(new_parent, "graphene_type", type(None)), Connection)
+
+    # Find the field-specific limit, or use the default limit.
+    max_limit: Optional[int] = getattr(
+        getattr(parent.graphene_type, name, None),
+        "max_limit",
+        graphene_settings.RELAY_CONNECTION_MAX_LIMIT,
+    )
 
     # If the field is a connection, we need to go deeper to get the actual field
-    if is_connection := issubclass(getattr(new_parent, "graphene_type", type(None)), Connection):
+    if is_connection:
         # Find the actual parent object type.
         field_def = new_parent.fields["edges"]
         new_parent = get_underlying_type(field_def.type)
@@ -327,11 +335,13 @@ def _find_filter_info_from_field_node(
 
     arguments[name] = filter_info = GraphQLFilterInfo(
         name=new_parent.name,
+        # If the field is a relay node field, its `id` field should not be counted as a filter.
         filters={} if is_node else filters,
         children={},
         filterset_class=None,
         is_connection=is_connection,
         is_node=is_node,
+        max_limit=max_limit,
     )
 
     if DJANGO_FILTER_INSTALLED and hasattr(new_parent, "graphene_type"):

tests/conftest.py

@@ -6,6 +6,7 @@
 from graphene_django.utils.testing import graphql_query
 
 from query_optimizer.typing import Callable
+from tests.example.types import BuildingNode
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.project.settings")
 
@@ -45,3 +46,13 @@ def func(*args, **kwargs) -> HttpResponse:
         return graphql_query(*args, **kwargs, client=client)
 
     return func
+
+
+@pytest.fixture()
+def _set_building_node_apartments_max_limit() -> int:
+    limit = BuildingNode.apartments.max_limit
+    try:
+        BuildingNode.apartments.max_limit = 1
+        yield
+    finally:
+        BuildingNode.apartments.max_limit = limit

tests/test_relay.py

@@ -144,6 +144,9 @@ def test_optimizer__relay_node__object_type_has_id_filter__nested_filtering(clie
     assert edges[0]["node"]["streetAddress"] == apartments[0].street_address
 
 
+# Connection
+
+
 def test_optimizer__relay_connection(client_query):
     query = """
         query {
@@ -509,6 +512,9 @@ def test_optimizer__relay_connection__filtering_empty(client_query):
     assert queries == 1, results.log
 
 
+# Nested
+
+
 def test_optimizer__relay_connection__nested(client_query):
     query = """
         query {
@@ -839,3 +845,43 @@ def test_optimizer__relay_connection__nested__filtered_fragment_spread(client_qu
     assert queries == 3, results.log
     # Check that the filter is actually applied
     assert '"example_housingcompany"."name" LIKE' in results.queries[2], results.log
+
+
+@pytest.mark.usefixtures("_set_building_node_apartments_max_limit")
+def test_optimizer__relay_connection__nested__max_limit(client_query):
+    query = """
+        query {
+          pagedBuildings {
+            edges {
+              node {
+                id
+                apartments {
+                  edges {
+                    node {
+                      id
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+    """
+
+    with capture_database_queries() as results:
+        response = client_query(query)
+
+    content = json.loads(response.content)
+    assert "errors" not in content, content["errors"]
+
+    buildings = content["data"]["pagedBuildings"]["edges"]
+
+    print(json.dumps(buildings, indent=2))
+
+    assert all(len(building["node"]["apartments"]["edges"]) == 1 for building in buildings)
+
+    queries = len(results.queries)
+    # 1 query for counting Buildings
+    # 1 query for fetching Buildings
+    # 1 query for fetching nested Apartments
+    assert queries == 3, results.log