strawberry-graphql 0.220.0.dev1709543239__tar.gz → 0.221.0.dev1710955937__tar.gz

{strawberry_graphql-0.220.0.dev1709543239 → strawberry_graphql-0.221.0.dev1710955937}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strawberry-graphql
-Version: 0.220.0.dev1709543239
+Version: 0.221.0.dev1710955937
 Summary: A library for creating GraphQL APIs
 Home-page: https://strawberry.rocks/
 License: MIT

{strawberry_graphql-0.220.0.dev1709543239 → strawberry_graphql-0.221.0.dev1710955937}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "strawberry-graphql"
 packages = [ { include = "strawberry" } ]
-version = "0.220.0.dev.1709543239"
+version = "0.221.0.dev.1710955937"
 description = "A library for creating GraphQL APIs"
 authors = ["Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "MIT"

{strawberry_graphql-0.220.0.dev1709543239 → strawberry_graphql-0.221.0.dev1710955937}/strawberry/channels/testing.py

@@ -69,6 +69,7 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
         path: str,
         headers: Optional[List[Tuple[bytes, bytes]]] = None,
         protocol: str = GRAPHQL_TRANSPORT_WS_PROTOCOL,
+        connection_params: dict = {},
         **kwargs: Any,
     ):
         """
@@ -81,6 +82,7 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
         self.protocol = protocol
         subprotocols = kwargs.get("subprotocols", [])
         subprotocols.append(protocol)
+        self.connection_params = connection_params
         super().__init__(application, path, headers, subprotocols=subprotocols)
 
     async def __aenter__(self) -> Self:
@@ -99,7 +101,9 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
         res = await self.connect()
         if self.protocol == GRAPHQL_TRANSPORT_WS_PROTOCOL:
             assert res == (True, GRAPHQL_TRANSPORT_WS_PROTOCOL)
-            await self.send_json_to(ConnectionInitMessage().as_dict())
+            await self.send_json_to(
+                ConnectionInitMessage(payload=self.connection_params).as_dict()
+            )
             response = await self.receive_json_from()
             assert response == ConnectionAckMessage().as_dict()
         else:

strawberry_graphql-0.221.0.dev1710955937/strawberry/schema/execute.py

@@ -0,0 +1,263 @@
+from __future__ import annotations
+
+from asyncio import ensure_future
+from inspect import isawaitable
+from typing import (
+    TYPE_CHECKING,
+    Awaitable,
+    Callable,
+    Iterable,
+    List,
+    Optional,
+    Sequence,
+    Tuple,
+    Type,
+    TypedDict,
+    Union,
+    cast,
+)
+
+from graphql import GraphQLError, parse
+from graphql import execute as original_execute
+from graphql.validation import validate
+
+from strawberry.exceptions import MissingQueryError
+from strawberry.extensions.runner import SchemaExtensionsRunner
+from strawberry.types import ExecutionResult
+
+from .exceptions import InvalidOperationTypeError
+
+if TYPE_CHECKING:
+    from typing_extensions import NotRequired, Unpack
+
+    from graphql import ExecutionContext as GraphQLExecutionContext
+    from graphql import ExecutionResult as GraphQLExecutionResult
+    from graphql import GraphQLSchema
+    from graphql.language import DocumentNode
+    from graphql.validation import ASTValidationRule
+
+    from strawberry.extensions import SchemaExtension
+    from strawberry.types import ExecutionContext
+    from strawberry.types.graphql import OperationType
+
+
+# duplicated because of https://github.com/mkdocstrings/griffe-typingdoc/issues/7
+class ParseOptions(TypedDict):
+    max_tokens: NotRequired[int]
+
+
+def parse_document(query: str, **kwargs: Unpack[ParseOptions]) -> DocumentNode:
+    return parse(query, **kwargs)
+
+
+def validate_document(
+    schema: GraphQLSchema,
+    document: DocumentNode,
+    validation_rules: Tuple[Type[ASTValidationRule], ...],
+) -> List[GraphQLError]:
+    return validate(
+        schema,
+        document,
+        validation_rules,
+    )
+
+
+def _run_validation(execution_context: ExecutionContext) -> None:
+    # Check if there are any validation rules or if validation has
+    # already been run by an extension
+    if len(execution_context.validation_rules) > 0 and execution_context.errors is None:
+        assert execution_context.graphql_document
+        execution_context.errors = validate_document(
+            execution_context.schema._schema,
+            execution_context.graphql_document,
+            execution_context.validation_rules,
+        )
+
+
+async def execute(
+    schema: GraphQLSchema,
+    *,
+    allowed_operation_types: Iterable[OperationType],
+    extensions: Sequence[Union[Type[SchemaExtension], SchemaExtension]],
+    execution_context: ExecutionContext,
+    execution_context_class: Optional[Type[GraphQLExecutionContext]] = None,
+    process_errors: Callable[[List[GraphQLError], Optional[ExecutionContext]], None],
+) -> ExecutionResult:
+    extensions_runner = SchemaExtensionsRunner(
+        execution_context=execution_context,
+        extensions=list(extensions),
+    )
+
+    async with extensions_runner.operation():
+        # Note: In graphql-core the schema would be validated here but in
+        # Strawberry we are validating it at initialisation time instead
+        if not execution_context.query:
+            raise MissingQueryError()
+
+        async with extensions_runner.parsing():
+            try:
+                if not execution_context.graphql_document:
+                    execution_context.graphql_document = parse_document(
+                        execution_context.query, **execution_context.parse_options
+                    )
+
+            except GraphQLError as error:
+                execution_context.errors = [error]
+                process_errors([error], execution_context)
+                return ExecutionResult(
+                    data=None,
+                    errors=[error],
+                    extensions=await extensions_runner.get_extensions_results(),
+                )
+
+            except Exception as error:  # pragma: no cover
+                error = GraphQLError(str(error), original_error=error)
+
+                execution_context.errors = [error]
+                process_errors([error], execution_context)
+
+                return ExecutionResult(
+                    data=None,
+                    errors=[error],
+                    extensions=await extensions_runner.get_extensions_results(),
+                )
+
+        if execution_context.operation_type not in allowed_operation_types:
+            raise InvalidOperationTypeError(execution_context.operation_type)
+
+        async with extensions_runner.validation():
+            _run_validation(execution_context)
+            if execution_context.errors:
+                process_errors(execution_context.errors, execution_context)
+                return ExecutionResult(data=None, errors=execution_context.errors)
+
+        async with extensions_runner.executing():
+            if not execution_context.result:
+                result = original_execute(
+                    schema,
+                    execution_context.graphql_document,
+                    root_value=execution_context.root_value,
+                    middleware=extensions_runner.as_middleware_manager(),
+                    variable_values=execution_context.variables,
+                    operation_name=execution_context.operation_name,
+                    context_value=execution_context.context,
+                    execution_context_class=execution_context_class,
+                )
+
+                if isawaitable(result):
+                    result = await cast(Awaitable["GraphQLExecutionResult"], result)
+
+                result = cast("GraphQLExecutionResult", result)
+                execution_context.result = result
+                # Also set errors on the execution_context so that it's easier
+                # to access in extensions
+                if result.errors:
+                    execution_context.errors = result.errors
+
+                    # Run the `Schema.process_errors` function here before
+                    # extensions have a chance to modify them (see the MaskErrors
+                    # extension). That way we can log the original errors but
+                    # only return a sanitised version to the client.
+                    process_errors(result.errors, execution_context)
+
+    return ExecutionResult(
+        data=execution_context.result.data,
+        errors=execution_context.result.errors,
+        extensions=await extensions_runner.get_extensions_results(),
+    )
+
+
+def execute_sync(
+    schema: GraphQLSchema,
+    *,
+    allowed_operation_types: Iterable[OperationType],
+    extensions: Sequence[Union[Type[SchemaExtension], SchemaExtension]],
+    execution_context: ExecutionContext,
+    execution_context_class: Optional[Type[GraphQLExecutionContext]] = None,
+    process_errors: Callable[[List[GraphQLError], Optional[ExecutionContext]], None],
+) -> ExecutionResult:
+    extensions_runner = SchemaExtensionsRunner(
+        execution_context=execution_context,
+        extensions=list(extensions),
+    )
+
+    with extensions_runner.operation():
+        # Note: In graphql-core the schema would be validated here but in
+        # Strawberry we are validating it at initialisation time instead
+        if not execution_context.query:
+            raise MissingQueryError()
+
+        with extensions_runner.parsing():
+            try:
+                if not execution_context.graphql_document:
+                    execution_context.graphql_document = parse_document(
+                        execution_context.query, **execution_context.parse_options
+                    )
+
+            except GraphQLError as error:
+                execution_context.errors = [error]
+                process_errors([error], execution_context)
+                return ExecutionResult(
+                    data=None,
+                    errors=[error],
+                    extensions=extensions_runner.get_extensions_results_sync(),
+                )
+
+            except Exception as error:  # pragma: no cover
+                error = GraphQLError(str(error), original_error=error)
+
+                execution_context.errors = [error]
+                process_errors([error], execution_context)
+                return ExecutionResult(
+                    data=None,
+                    errors=[error],
+                    extensions=extensions_runner.get_extensions_results_sync(),
+                )
+
+        if execution_context.operation_type not in allowed_operation_types:
+            raise InvalidOperationTypeError(execution_context.operation_type)
+
+        with extensions_runner.validation():
+            _run_validation(execution_context)
+            if execution_context.errors:
+                process_errors(execution_context.errors, execution_context)
+                return ExecutionResult(data=None, errors=execution_context.errors)
+
+        with extensions_runner.executing():
+            if not execution_context.result:
+                result = original_execute(
+                    schema,
+                    execution_context.graphql_document,
+                    root_value=execution_context.root_value,
+                    middleware=extensions_runner.as_middleware_manager(),
+                    variable_values=execution_context.variables,
+                    operation_name=execution_context.operation_name,
+                    context_value=execution_context.context,
+                    execution_context_class=execution_context_class,
+                )
+
+                if isawaitable(result):
+                    result = cast(Awaitable["GraphQLExecutionResult"], result)
+                    ensure_future(result).cancel()
+                    raise RuntimeError(
+                        "GraphQL execution failed to complete synchronously."
+                    )
+
+                result = cast("GraphQLExecutionResult", result)
+                execution_context.result = result
+                # Also set errors on the execution_context so that it's easier
+                # to access in extensions
+                if result.errors:
+                    execution_context.errors = result.errors
+
+                    # Run the `Schema.process_errors` function here before
+                    # extensions have a chance to modify them (see the MaskErrors
+                    # extension). That way we can log the original errors but
+                    # only return a sanitised version to the client.
+                    process_errors(result.errors, execution_context)
+
+    return ExecutionResult(
+        data=execution_context.result.data,
+        errors=execution_context.result.errors,
+        extensions=extensions_runner.get_extensions_results_sync(),
+    )

{strawberry_graphql-0.220.0.dev1709543239 → strawberry_graphql-0.221.0.dev1710955937}/strawberry/schema_codegen/__init__.py

@@ -2,6 +2,9 @@ from __future__ import annotations
 
 import dataclasses
 import keyword
+from collections import defaultdict
+from typing import TYPE_CHECKING, Tuple
+from typing_extensions import Protocol
 
 import libcst as cst
 from graphql import (
@@ -19,6 +22,7 @@ from graphql import (
     OperationType,
     ScalarTypeDefinitionNode,
     SchemaDefinitionNode,
+    SchemaExtensionNode,
     StringValueNode,
     TypeNode,
     UnionTypeDefinitionNode,
@@ -27,6 +31,14 @@ from graphql import (
 
 from strawberry.utils.str_converters import to_snake_case
 
+if TYPE_CHECKING:
+    from graphql.language.ast import ConstDirectiveNode
+
+
+class HasDirectives(Protocol):
+    directives: Tuple[ConstDirectiveNode]
+
+
 _SCALAR_MAP = {
     "Int": cst.Name("int"),
     "Float": cst.Name("float"),
@@ -48,6 +60,19 @@ _SCALAR_MAP = {
 }
 
 
+def _is_federation_link_directive(directive: ConstDirectiveNode) -> bool:
+    if directive.name.value != "link":
+        return False
+
+    for argument in directive.arguments:
+        if argument.name.value == "url":
+            return argument.value.value.startswith(
+                "https://specs.apollo.dev/federation"
+            )
+
+    return False
+
+
 def _get_field_type(
     field_type: TypeNode, was_non_nullable: bool = False
 ) -> cst.BaseExpression:
@@ -85,7 +110,10 @@ def _get_field_type(
     )
 
 
-def _get_argument(name: str, value: str) -> cst.Arg:
+def _sanitize_argument(value: str | bool) -> cst.SimpleString | cst.Name:
+    if isinstance(value, bool):
+        return cst.Name(value=str(value))
+
     if "\n" in value:
         argument_value = cst.SimpleString(f'"""\n{value}\n"""')
     elif '"' in value:
@@ -93,6 +121,12 @@ def _get_argument(name: str, value: str) -> cst.Arg:
     else:
         argument_value = cst.SimpleString(f'"{value}"')
 
+    return argument_value
+
+
+def _get_argument(name: str, value: str | bool) -> cst.Arg:
+    argument_value = _sanitize_argument(value)
+
     return cst.Arg(
         value=argument_value,
         keyword=cst.Name(name),
@@ -100,7 +134,25 @@ def _get_argument(name: str, value: str) -> cst.Arg:
     )
 
 
-def _get_field_value(description: str | None, alias: str | None) -> cst.Call | None:
+def _get_argument_list(name: str, values: list[str]) -> cst.Arg:
+    value = cst.List(
+        elements=[cst.Element(value=_sanitize_argument(value)) for value in values],
+    )
+
+    return cst.Arg(
+        value=value,
+        keyword=cst.Name(name),
+        equal=cst.AssignEqual(cst.SimpleWhitespace(""), cst.SimpleWhitespace("")),
+    )
+
+
+def _get_field_value(
+    field: FieldDefinitionNode | InputValueDefinitionNode,
+    alias: str | None,
+    is_apollo_federation: bool,
+) -> cst.Call | None:
+    description = field.description.value if field.description else None
+
     args = list(
         filter(
             None,
@@ -111,6 +163,24 @@ def _get_field_value(description: str | None, alias: str | None) -> cst.Call | N
         )
     )
 
+    directives = _get_directives(field)
+
+    apollo_federation_args = _get_federation_arguments(directives)
+
+    if is_apollo_federation and apollo_federation_args:
+        args.extend(apollo_federation_args)
+
+        return cst.Call(
+            func=cst.Attribute(
+                value=cst.Attribute(
+                    value=cst.Name("strawberry"),
+                    attr=cst.Name("federation"),
+                ),
+                attr=cst.Name("field"),
+            ),
+            args=args,
+        )
+
     if args:
         return cst.Call(
             func=cst.Attribute(
@@ -125,6 +195,7 @@ def _get_field_value(description: str | None, alias: str | None) -> cst.Call | N
 
 def _get_field(
     field: FieldDefinitionNode | InputValueDefinitionNode,
+    is_apollo_federation: bool,
 ) -> cst.SimpleStatementLine:
     name = to_snake_case(field.name.value)
     alias: str | None = None
@@ -141,19 +212,67 @@ def _get_field(
                     _get_field_type(field.type),
                 ),
                 value=_get_field_value(
-                    description=field.description.value if field.description else None,
-                    alias=alias if alias != name else None,
+                    field, alias=alias, is_apollo_federation=is_apollo_federation
                 ),
             )
         ]
     )
 
 
+def _get_directives(definition: HasDirectives) -> dict[str, list[dict[str, str]]]:
+    directives = defaultdict(list)
+
+    for directive in definition.directives:
+        directive_name = directive.name.value
+
+        directives[directive_name].append(
+            {
+                argument.name.value: argument.value.value
+                for argument in directive.arguments
+            }
+        )
+
+    return directives
+
+
+def _get_federation_arguments(
+    directives: dict[str, list[dict[str, str]]],
+) -> list[cst.Arg]:
+    def append_arg_from_directive(
+        directive: str, argument_name: str, keyword_name: str | None = None
+    ):
+        keyword_name = keyword_name or directive
+
+        if directive in directives:
+            arguments.append(
+                _get_argument_list(
+                    keyword_name,
+                    [item[argument_name] for item in directives[directive]],
+                )
+            )
+
+    arguments: list[cst.Arg] = []
+
+    append_arg_from_directive("key", "fields", "keys")
+    append_arg_from_directive("requires", "fields")
+    append_arg_from_directive("provides", "fields")
+    append_arg_from_directive("tag", "name", "tags")
+
+    boolean_keys = ("shareable", "inaccessible", "external", "override")
+
+    arguments.extend(
+        _get_argument(key, True) for key in boolean_keys if directives.get(key, False)
+    )
+
+    return arguments
+
+
 def _get_strawberry_decorator(
     definition: ObjectTypeDefinitionNode
     | ObjectTypeExtensionNode
     | InterfaceTypeDefinitionNode
     | InputObjectTypeDefinitionNode,
+    is_apollo_federation: bool,
 ) -> cst.Decorator:
     type_ = {
         ObjectTypeDefinitionNode: "type",
@@ -168,15 +287,36 @@ def _get_strawberry_decorator(
         else None
     )
 
+    directives = _get_directives(definition)
+
     decorator: cst.BaseExpression = cst.Attribute(
         value=cst.Name("strawberry"),
         attr=cst.Name(type_),
     )
 
+    arguments: list[cst.Arg] = []
+
     if description is not None:
+        arguments.append(_get_argument("description", description.value))
+
+    federation_arguments = _get_federation_arguments(directives)
+
+    # and has any directive that is a federation directive
+    if is_apollo_federation and federation_arguments:
+        decorator = cst.Attribute(
+            value=cst.Attribute(
+                value=cst.Name("strawberry"),
+                attr=cst.Name("federation"),
+            ),
+            attr=cst.Name(type_),
+        )
+
+        arguments.extend(federation_arguments)
+
+    if arguments:
         decorator = cst.Call(
             func=decorator,
-            args=[_get_argument("description", description.value)],
+            args=arguments,
         )
 
     return cst.Decorator(
@@ -189,8 +329,9 @@ def _get_class_definition(
     | ObjectTypeExtensionNode
     | InterfaceTypeDefinitionNode
     | InputObjectTypeDefinitionNode,
+    is_apollo_federation: bool,
 ) -> cst.ClassDef:
-    decorator = _get_strawberry_decorator(definition)
+    decorator = _get_strawberry_decorator(definition, is_apollo_federation)
 
     bases = (
         [cst.Arg(cst.Name(interface.name.value)) for interface in definition.interfaces]
@@ -204,7 +345,11 @@ def _get_class_definition(
     return cst.ClassDef(
         name=cst.Name(definition.name.value),
         bases=bases,
-        body=cst.IndentedBlock(body=[_get_field(field) for field in definition.fields]),
+        body=cst.IndentedBlock(
+            body=[
+                _get_field(field, is_apollo_federation) for field in definition.fields
+            ]
+        ),
         decorators=[decorator],
     )
 
@@ -243,6 +388,7 @@ def _get_schema_definition(
     root_query_name: str | None,
     root_mutation_name: str | None,
     root_subscription_name: str | None,
+    is_apollo_federation: bool,
 ) -> cst.SimpleStatementLine | None:
     if not any([root_query_name, root_mutation_name, root_subscription_name]):
         return None
@@ -265,17 +411,40 @@ def _get_schema_definition(
     if root_subscription_name:
         args.append(_get_arg("subscription", root_subscription_name))
 
+    schema_call = cst.Call(
+        func=cst.Attribute(
+            value=cst.Name("strawberry"),
+            attr=cst.Name("Schema"),
+        ),
+        args=args,
+    )
+
+    if is_apollo_federation:
+        args.append(
+            cst.Arg(
+                keyword=cst.Name("enable_federation_2"),
+                value=cst.Name("True"),
+                equal=cst.AssignEqual(
+                    cst.SimpleWhitespace(""), cst.SimpleWhitespace("")
+                ),
+            )
+        )
+        schema_call = cst.Call(
+            func=cst.Attribute(
+                value=cst.Attribute(
+                    value=cst.Name(value="strawberry"),
+                    attr=cst.Name(value="federation"),
+                ),
+                attr=cst.Name(value="Schema"),
+            ),
+            args=args,
+        )
+
     return cst.SimpleStatementLine(
         body=[
             cst.Assign(
                 targets=[cst.AssignTarget(cst.Name("schema"))],
-                value=cst.Call(
-                    func=cst.Attribute(
-                        value=cst.Name("strawberry"),
-                        attr=cst.Name("Schema"),
-                    ),
-                    args=args,
-                ),
+                value=schema_call,
             )
         ]
     )
@@ -430,6 +599,12 @@ def codegen(schema: str) -> str:
 
     object_types: dict[str, cst.ClassDef] = {}
 
+    # when we encounter a extend schema @link ..., we check if is an apollo federation schema
+    # and we use this variable to keep track of it, but at the moment the assumption is that
+    # the schema extension is always done at the top, this might not be the case all the
+    # time
+    is_apollo_federation = False
+
     for definition in document.definitions:
         if isinstance(
             definition,
@@ -440,7 +615,7 @@ def codegen(schema: str) -> str:
                 ObjectTypeExtensionNode,
             ),
         ):
-            class_definition = _get_class_definition(definition)
+            class_definition = _get_class_definition(definition, is_apollo_federation)
 
             object_types[definition.name.value] = class_definition
 
@@ -478,6 +653,11 @@ def codegen(schema: str) -> str:
                 definitions.append(cst.EmptyLine())
                 definitions.append(scalar_definition)
                 definitions.append(cst.EmptyLine())
+        elif isinstance(definition, SchemaExtensionNode):
+            is_apollo_federation = any(
+                _is_federation_link_directive(directive)
+                for directive in definition.directives
+            )
         else:
             raise NotImplementedError(f"Unknown definition {definition}")
 
@@ -496,6 +676,7 @@ def codegen(schema: str) -> str:
         root_query_name=root_query_name,
         root_mutation_name=root_mutation_name,
         root_subscription_name=root_subscription_name,
+        is_apollo_federation=is_apollo_federation,
     )
 
     if schema_definition: