allow for directives to be added to the types (#204)

* feat: allow for directives to be added to the types

* Add pre-commit updates that work with python 3.8

* add tests and run black

* add release.md

* fix?

* added a Release.md with any \n

* add release minor

---------

Co-authored-by: Cameron Sechrist <[email protected]>
Co-authored-by: Ckk3 <[email protected]>

Author: 3 people

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.4.2
+    rev: 24.4.0
     hooks:
       - id: black
         exclude: ^tests/\w+/snapshots/
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.5
+    rev: v0.11.7
     hooks:
       - id: ruff
         exclude: ^tests/\w+/snapshots/
@@ -24,7 +24,7 @@ repos:
         files: '^docs/.*\.mdx?$'
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-merge-conflict
@@ -33,7 +33,7 @@ repos:
       - id: check-toml
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
         args: [--skip-errors]

RELEASE.md

@@ -0,0 +1,10 @@
+Release type: minor
+
+**Added support for GraphQL directives** in the SQLAlchemy type mapper, enabling better integration with GraphQL federation.
+
+**Example usage:**
+```python
+@mapper.type(Employee, directives=["@deprecated(reason: 'Use newEmployee instead')"])
+class Employee:
+    pass
+```

src/strawberry_sqlalchemy_mapper/mapper.py

@@ -25,6 +25,7 @@
     NewType,
     Optional,
     Protocol,
+    Sequence,
     Set,
     Type,
     TypeVar,
@@ -150,11 +151,13 @@ 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,7 +390,7 @@ def _convert_relationship_to_strawberry_type(
         if relationship.uselist:
             # Use list if excluding relay pagination
             if use_list:
-                return List[ForwardRef(type_name)] # type: ignore
+                return List[ForwardRef(type_name)]  # type: ignore
 
             return self._connection_type_for(type_name)
         else:
@@ -638,6 +641,7 @@ def type(
         model: Type[BaseModelType],
         make_interface=False,
         use_federation=False,
+        directives: Union[Sequence[object], None] = (),
     ) -> Callable[[Type[object]], Any]:
         """
         Decorate a type with this to register it as a strawberry type
@@ -832,10 +836,12 @@ def convert(type_: Any) -> Any:
                 mapped_type = strawberry.interface(type_)
                 self.mapped_interfaces[type_.__name__] = mapped_type
             elif use_federation:
-                mapped_type = strawberry.federation.type(type_)
+                mapped_type = strawberry.federation.type(
+                    type_, directives=directives if directives else ()
+                )
                 self.mapped_types[type_.__name__] = mapped_type
             else:
-                mapped_type = strawberry.type(type_)
+                mapped_type = strawberry.type(type_, directives=directives)
                 self.mapped_types[type_.__name__] = mapped_type
 
             setattr(

tests/test_mapper.py

@@ -326,7 +326,8 @@ class Department:
     @strawberry.type
     class Query:
         @strawberry.field
-        def departments(self) -> Department: ...
+        def departments(self) -> Department:
+            ...
 
     mapper.finalize()
     schema = strawberry.Schema(query=Query)
@@ -379,3 +380,83 @@ def departments(self) -> Department: ...
     }
     '''
     assert str(schema) == textwrap.dedent(expected).strip()
+
+
+@pytest.mark.parametrize(
+    "directives",
+    [
+        (["@deprecated(reason: 'Use newEmployee instead')"]),
+        (
+            [
+                "@deprecated(reason: 'Use newEmployee instead')",
+                "@customDirective(value: 'example')",
+            ]
+        ),
+    ],
+)
+def test_type_with_directives(mapper, employee_table, directives):
+    Employee = employee_table
+
+    @mapper.type(Employee, directives=directives)
+    class Employee:
+        pass
+
+    mapper.finalize()
+    additional_types = list(mapper.mapped_types.values())
+    assert len(additional_types) == 1
+    mapped_employee_type = additional_types[0]
+    assert mapped_employee_type.__name__ == "Employee"
+    assert len(mapped_employee_type.__strawberry_definition__.fields) == 2
+    assert mapped_employee_type.__strawberry_definition__.directives == directives
+
+
+@pytest.mark.parametrize(
+    "directives",
+    [
+        (["@deprecated(reason: 'Use newEmployee instead')"]),
+        (
+            [
+                "@deprecated(reason: 'Use newEmployee instead')",
+                "@customDirective(value: 'example')",
+            ]
+        ),
+    ],
+)
+def test_type_with_directives_and_federation(mapper, employee_table, directives):
+    Employee = employee_table
+
+    @mapper.type(Employee, directives=directives, use_federation=True)
+    class Employee:
+        pass
+
+    mapper.finalize()
+    additional_types = list(mapper.mapped_types.values())
+    assert len(additional_types) == 1
+    mapped_employee_type = additional_types[0]
+    assert mapped_employee_type.__name__ == "Employee"
+    assert len(mapped_employee_type.__strawberry_definition__.fields) == 2
+    assert mapped_employee_type.__strawberry_definition__.directives == directives
+
+
+@pytest.mark.parametrize(
+    "use_federation_value, expected_directives",
+    [(True, []), (False, ())],
+)
+def test_type_with_default_directives(
+    mapper, employee_table, use_federation_value, expected_directives
+):
+    Employee = employee_table
+
+    @mapper.type(Employee, use_federation=use_federation_value)
+    class Employee:
+        pass
+
+    mapper.finalize()
+    additional_types = list(mapper.mapped_types.values())
+    assert len(additional_types) == 1
+    mapped_employee_type = additional_types[0]
+    assert mapped_employee_type.__name__ == "Employee"
+    assert len(mapped_employee_type.__strawberry_definition__.fields) == 2
+    assert (
+        mapped_employee_type.__strawberry_definition__.directives == expected_directives
+    )