Option to always "use_list" and not make relay Connections (#257)

* Option to always use_list and not make relay Connections

* Update src/strawberry_sqlalchemy_mapper/mapper.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* RELEASE.md

* moved always_use_list optinal param to last param. Defaults to False, instead of None. Updated README.

* new unit test for always_use_list

* Refactor always_use_list parameter to be non-optional and update related tests for mixed relationships

* Refactor test_always_use_list_with_mixed_relationships to use clearer class names for Employee and Department

* fix tests

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: Ckk3 <[email protected]>

Author: 3 people

README.md

@@ -192,6 +192,25 @@ class ApiB(ApiA):
     # "extra_field" will be overridden and will be a float now instead of the String type declared in ModelB:
     extra_field: float = strawberry.field(name="extraField")
 ```
+
+### Relay connections
+
+By default, StrawberrySQLAlchemyMapper() will create [Relay connections](https://relay.dev/graphql/connections.htm) for relationships to lists. If instead you want these relationships to present as plain lists, you have two options:
+
+1. Declare `__use_list__` in your models, for example:
+
+```python
+@strawberry_sqlalchemy_mapper.type(models.Department)
+class Department:
+    __use_list__ = ["employees"]
+```
+
+2. Alternatively, you can disable relay style connections for all models via the `always_use_list` constructor parameter:
+
+```python
+strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper(always_use_list=True)
+```
+
 ## Limitations
 
 ### Supported Types

RELEASE.md

@@ -0,0 +1,6 @@
+Release type: minor
+
+Added a new optional constructor parameter to always use lists instead of relay Connections for relationships. Defaults to False, maintaining current functionality. If set to True, all relationships will be handled as lists.
+
+Example:
+mapper = StrawberrySQLAlchemyMapper(always_use_list=True)

src/strawberry_sqlalchemy_mapper/mapper.py

@@ -204,6 +204,10 @@ class StrawberrySQLAlchemyMapper(Generic[BaseModelType]):
     #: for a given (polymorphic base) model
     model_to_interface_name: Callable[[Type[BaseModelType]], str]
 
+    #: If set to true, don't create connections for list type
+    #: relationships
+    always_use_list: bool
+
     #: Default mapping from sqlalchemy types to strawberry types
     _default_sqlalchemy_type_to_strawberry_type_map: Dict[
         Type[TypeEngine], Union[Type[Any], SkipTypeSentinelT]
@@ -251,12 +255,14 @@ def __init__(
         extra_sqlalchemy_type_to_strawberry_type_map: Optional[
             Mapping[Type[TypeEngine], Type[Any]]
         ] = None,
+        always_use_list: bool = False,
     ) -> None:
         if model_to_type_name is None:
             model_to_type_name = self._default_model_to_type_name
         self.model_to_type_name = model_to_type_name
         if model_to_interface_name is None:
             model_to_interface_name = self._default_model_to_interface_name
+        self.always_use_list = always_use_list
         self.model_to_interface_name = model_to_interface_name
         self.sqlalchemy_type_to_strawberry_type_map = (
             self._default_sqlalchemy_type_to_strawberry_type_map.copy()
@@ -401,7 +407,7 @@ def _convert_relationship_to_strawberry_type(
             self._related_type_models.add(relationship_model)
         if relationship.uselist:
             # Use list if excluding relay pagination
-            if use_list:
+            if use_list or self.always_use_list:
                 return List[ForwardRef(type_name)]  # type: ignore
 
             return self._connection_type_for(type_name)
@@ -669,7 +675,7 @@ def connection_resolver_for(
         passed from the GraphQL query to the database query.
         """
         relationship_resolver = self.relationship_resolver_for(relationship)
-        if relationship.uselist and not use_list:
+        if relationship.uselist and not use_list and not self.always_use_list:
             return self.make_connection_wrapper_resolver(
                 relationship_resolver,
                 relationship,

tests/conftest.py

@@ -118,3 +118,8 @@ def base():
 @pytest.fixture
 def mapper():
     return StrawberrySQLAlchemyMapper()
+
+
+@pytest.fixture
+def mapper_always_use_list():
+    return StrawberrySQLAlchemyMapper(always_use_list=True)

tests/test_mapper.py

@@ -276,6 +276,68 @@ class Department:
     assert isinstance(name.type, StrawberryList) is True
 
 
+def test_always_use_list(employee_and_department_tables, mapper_always_use_list):
+    Employee, Department = employee_and_department_tables
+
+    @mapper_always_use_list.type(Employee)
+    class Employee:
+        pass
+
+    @mapper_always_use_list.type(Department)
+    class Department:
+        pass
+
+    mapper_always_use_list.finalize()
+    additional_types = list(mapper_always_use_list.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((field for field in department_type_fields if field.name == "employees"), None)
+    assert name is not None
+    assert isinstance(name.type, StrawberryOptional) is False
+    assert isinstance(name.type, StrawberryList) is True
+
+
+def test_always_use_list_with_mixed_relationships(
+    employee_and_department_tables, mapper_always_use_list
+):
+    Employee, Department = employee_and_department_tables
+
+    @mapper_always_use_list.type(Employee)
+    class Employee:
+        pass
+
+    @mapper_always_use_list.type(Department)
+    class Department:
+        pass
+
+    mapper_always_use_list.finalize()
+    additional_types = list(mapper_always_use_list.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"
+
+    department_type_fields = mapped_department_type.__strawberry_definition__.fields
+    employees_field = next((f for f in department_type_fields if f.name == "employees"), None)
+    assert employees_field is not None
+    # List relationship should be StrawberryList with always_use_list=True
+    assert isinstance(employees_field.type, StrawberryList)
+
+    employee_type_fields = mapped_employee_type.__strawberry_definition__.fields
+    department_field = next((f for f in employee_type_fields if f.name == "department"), None)
+    assert department_field is not None
+    # Single relationship should remain as Optional, not converted to a list
+    assert not isinstance(department_field.type, StrawberryList)
+    assert isinstance(department_field.type, StrawberryOptional)
+
+
 def test_type_relationships(employee_and_department_tables, mapper):
     Employee, _ = employee_and_department_tables