Optional Pagination

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.4.2
     hooks:
       - id: black
         exclude: ^tests/\w+/snapshots/
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.289
+    rev: v0.4.5
     hooks:
       - id: ruff
         exclude: ^tests/\w+/snapshots/
@@ -18,13 +18,13 @@ repos:
         exclude: (CHANGELOG|TWEET).md
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.3
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         files: '^docs/.*\.mdx?$'
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: check-merge-conflict

RELEASE.md

@@ -0,0 +1,4 @@
+Release type: minor
+
+Add an optional function to exclude relationships from relay pagination and use traditional strawberry lists.
+Default behavior preserves original behavior for backwords compatibilty.

src/strawberry_sqlalchemy_mapper/mapper.py

@@ -150,13 +150,11 @@ class StrawberrySQLAlchemyType(Generic[BaseModelType]):
 
     @overload
     @classmethod
-    def from_type(cls, type_: type, *, strict: Literal[True]) -> Self:
-        ...
+    def from_type(cls, type_: type, *, strict: Literal[True]) -> Self: ...
 
     @overload
     @classmethod
-    def from_type(cls, type_: type, *, strict: bool = False) -> Optional[Self]:
-        ...
+    def from_type(cls, type_: type, *, strict: bool = False) -> Optional[Self]: ...
 
     @classmethod
     def from_type(
@@ -387,6 +385,10 @@ def _convert_relationship_to_strawberry_type(
         else:
             self._related_type_models.add(relationship_model)
         if relationship.uselist:
+            # Use list if excluding relay pagination
+            if getattr(relationship, "__exclude_relay__", False):
+                return List[ForwardRef(type_name)]
+
             return self._connection_type_for(type_name)
         else:
             if self._get_relationship_is_optional(relationship):
@@ -531,7 +533,9 @@ def connection_resolver_for(
         returns a Connection instead of an array of objects.
         """
         relationship_resolver = self.relationship_resolver_for(relationship)
-        if relationship.uselist:
+        if relationship.uselist and not getattr(
+            relationship, "__exclude_relay__", False
+        ):
             return self.make_connection_wrapper_resolver(
                 relationship_resolver,
                 self.model_to_type_or_interface_name(relationship.entity.entity),  # type: ignore[arg-type]

src/strawberry_sqlalchemy_mapper/relay.py

@@ -27,7 +27,7 @@
 if TYPE_CHECKING:
     from typing_extensions import Literal, Self
 
-    from sqlalchemy.orm import Query, Session
+    from sqlalchemy.orm import Query, RelationshipProperty, Session
     from strawberry.types.info import Info
     from strawberry.utils.await_maybe import AwaitableOrValue
 
@@ -146,6 +146,20 @@ async def resolve_async(nodes=nodes):
         return resolve_nodes(session)
 
 
+def exclude_relay(
+    relationship: RelationshipProperty,
+) -> RelationshipProperty:
+    """
+    Wrap a relationship to use traditional GraphQL lists,
+    which return all related items in a single list,
+    instead of relay pagination, which provides a cursor-based approach.
+    """
+
+    relationship.__exclude_relay__ = True
+
+    return relationship
+
+
 @overload
 def resolve_model_nodes(
     source: Union[
@@ -158,8 +172,7 @@ def resolve_model_nodes(
     info: Optional[Info] = None,
     node_ids: Iterable[Union[str, relay.GlobalID]],
     required: Literal[True],
-) -> AwaitableOrValue[Iterable[_T]]:
-    ...
+) -> AwaitableOrValue[Iterable[_T]]: ...
 
 
 @overload
@@ -174,8 +187,7 @@ def resolve_model_nodes(
     info: Optional[Info] = None,
     node_ids: None = None,
     required: Literal[True],
-) -> AwaitableOrValue[Iterable[_T]]:
-    ...
+) -> AwaitableOrValue[Iterable[_T]]: ...
 
 
 @overload
@@ -190,8 +202,7 @@ def resolve_model_nodes(
     info: Optional[Info] = None,
     node_ids: Iterable[Union[str, relay.GlobalID]],
     required: Literal[False],
-) -> AwaitableOrValue[Iterable[Optional[_T]]]:
-    ...
+) -> AwaitableOrValue[Iterable[Optional[_T]]]: ...
 
 
 @overload
@@ -206,8 +217,7 @@ def resolve_model_nodes(
     info: Optional[Info] = None,
     node_ids: None = None,
     required: Literal[False],
-) -> AwaitableOrValue[Optional[Iterable[_T]]]:
-    ...
+) -> AwaitableOrValue[Optional[Iterable[_T]]]: ...
 
 
 @overload
@@ -229,8 +239,7 @@ def resolve_model_nodes(
         Iterable[Optional[_T]],
         Optional[Query[_T]],
     ]
-]:
-    ...
+]: ...
 
 
 def resolve_model_nodes(
@@ -307,8 +316,7 @@ def resolve_model_node(
     session: Session,
     info: Optional[Info] = ...,
     required: Literal[False] = ...,
-) -> AwaitableOrValue[Optional[_T]]:
-    ...
+) -> AwaitableOrValue[Optional[_T]]: ...
 
 
 @overload
@@ -323,8 +331,7 @@ def resolve_model_node(
     session: Session,
     info: Optional[Info] = ...,
     required: Literal[True],
-) -> AwaitableOrValue[_T]:
-    ...
+) -> AwaitableOrValue[_T]: ...
 
 
 def resolve_model_node(

tests/test_mapper.py

@@ -10,6 +10,7 @@
 from strawberry.scalars import JSON as StrawberryJSON
 from strawberry.type import StrawberryOptional
 from strawberry_sqlalchemy_mapper import StrawberrySQLAlchemyMapper
+from strawberry_sqlalchemy_mapper.relay import exclude_relay
 
 
 @pytest.fixture
@@ -263,6 +264,32 @@ class Lawyer:
     assert {"Employee", "Lawyer"} == {t.__name__ for t in additional_types}
 
 
+def test_exclude_relay(employee_and_department_tables, mapper):
+    Employee, Department = employee_and_department_tables
+    Department.employees = exclude_relay(Department.employees)
+
+    @mapper.type(Employee)
+    class Employee:
+        pass
+
+    @mapper.type(Department)
+    class Department:
+        pass
+
+    mapper.finalize()
+    additional_types = list(mapper.mapped_types.values())
+    assert len(additional_types) == 2
+    mapped_employee_type = additional_types[0]
+    assert mapped_employee_type.__name__ == "Employee"
+    mapped_department_type = additional_types[1]
+    assert mapped_department_type.__name__ == "Department"
+    assert len(mapped_department_type.__strawberry_definition__._fields) == 3
+    department_type_fields = mapped_department_type.__strawberry_definition__._fields
+    name = next(iter(filter(lambda f: f.name == "employees", department_type_fields)))
+    assert type(name.type) != StrawberryOptional
+    assert type(name.type) == List[mapped_employee_type]
+
+
 def test_type_relationships(employee_and_department_tables, mapper):
     Employee, _ = employee_and_department_tables
 
@@ -297,8 +324,7 @@ class Department:
     @strawberry.type
     class Query:
         @strawberry.field
-        def departments(self) -> Department:
-            ...
+        def departments(self) -> Department: ...
 
     mapper.finalize()
     schema = strawberry.Schema(query=Query)