graphql-core 3.3.0b2__tar.gz → 3.3.0rc0__tar.gz

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.3.0b2
+current_version = 3.3.0rc0
 commit = False
 tag = False
 

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphql-core
-Version: 3.3.0b2
+Version: 3.3.0rc0
 Summary: GraphQL-core is a Python port of GraphQL.js, the JavaScript reference implementation for GraphQL.
 Keywords: graphql
 Author: Christoph Zwerschke
@@ -42,8 +42,8 @@ with GraphQL.js.
 The current stable version 3.2.11 of GraphQL-core is up-to-date with GraphQL.js
 version 16.14.1 and supports Python versions 3.7 to 3.14.
 
-You can also try out the latest beta version 3.3.0b2 of GraphQL-core,
-which is up-to-date with GraphQL.js version 17.0.0b2.
+You can also try out the latest release candidate 3.3.0rc0 of GraphQL-core,
+which is up-to-date with GraphQL.js version 17.0.0rc0.
 This new minor version of GraphQL-core also supports Python versions 3.10 to 3.14.
 
 Note that for various reasons, GraphQL-core does not use SemVer like GraphQL.js.

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/README.md

@@ -18,8 +18,8 @@ with GraphQL.js.
 The current stable version 3.2.11 of GraphQL-core is up-to-date with GraphQL.js
 version 16.14.1 and supports Python versions 3.7 to 3.14.
 
-You can also try out the latest beta version 3.3.0b2 of GraphQL-core,
-which is up-to-date with GraphQL.js version 17.0.0b2.
+You can also try out the latest release candidate 3.3.0rc0 of GraphQL-core,
+which is up-to-date with GraphQL.js version 17.0.0rc0.
 This new minor version of GraphQL-core also supports Python versions 3.10 to 3.14.
 
 Note that for various reasons, GraphQL-core does not use SemVer like GraphQL.js.

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/docs/conf.py

@@ -52,7 +52,7 @@ author = "Christoph Zwerschke"
 # The short X.Y version.
 # version = '3.3'
 # The full version, including alpha/beta/rc tags.
-version = release = "3.3.0b2"
+version = release = "3.3.0rc0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "graphql-core"
-version = "3.3.0b2"
+version = "3.3.0rc0"
 description = "GraphQL-core is a Python port of GraphQL.js, the JavaScript reference implementation for GraphQL."
 readme = "README.md"
 requires-python = ">=3.10"

graphql_core-3.3.0rc0/src/graphql/validation/rules/defer_stream_directive_on_root_field.py

@@ -0,0 +1,123 @@
+"""Defer stream directive on root field rule"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, cast
+
+from ...error import GraphQLError
+from ...language import (
+    FieldNode,
+    FragmentDefinitionNode,
+    FragmentSpreadNode,
+    InlineFragmentNode,
+    OperationType,
+)
+from ...type import GraphQLDeferDirective, GraphQLStreamDirective
+from . import ValidationRule
+
+if TYPE_CHECKING:
+    from ...language import (
+        DirectiveNode,
+        OperationDefinitionNode,
+        SelectionSetNode,
+    )
+    from ...type import GraphQLObjectType
+
+__all__ = ["DeferStreamDirectiveOnRootField"]
+
+
+def get_directive(
+    node: FieldNode | FragmentSpreadNode | InlineFragmentNode, name: str
+) -> DirectiveNode | None:
+    for directive in node.directives or ():
+        if directive.name.value == name:
+            return directive
+    return None
+
+
+class DeferStreamDirectiveOnRootField(ValidationRule):
+    """Defer and stream directives are used on valid root field
+
+    A GraphQL document is only valid if defer directives are not used on root
+    mutation or subscription types.
+    """
+
+    def enter_operation_definition(
+        self, node: OperationDefinitionNode, *_args: Any
+    ) -> None:
+        operation = node.operation
+        if operation not in (OperationType.SUBSCRIPTION, OperationType.MUTATION):
+            return
+        schema = self.context.schema
+        root_type = schema.get_root_type(operation)
+        if root_type:
+            document = self.context.document
+            fragments = {
+                definition.name.value: definition
+                for definition in document.definitions
+                if isinstance(definition, FragmentDefinitionNode)
+            }
+            self.forbid_defer_stream(
+                operation, root_type, fragments, node.selection_set, set()
+            )
+
+    def forbid_defer_stream(
+        self,
+        operation_type: OperationType,
+        root_type: GraphQLObjectType,
+        fragments: dict[str, FragmentDefinitionNode],
+        selection_set: SelectionSetNode,
+        visited_fragments: set[str],
+    ) -> None:
+        for selection in selection_set.selections:
+            if isinstance(selection, FieldNode):
+                stream = get_directive(selection, GraphQLStreamDirective.name)
+                if stream:
+                    self.report_error(
+                        GraphQLError(
+                            "Stream directive cannot be used on root"
+                            f" {operation_type.value} type '{root_type.name}'.",
+                            stream,
+                        )
+                    )
+            elif isinstance(selection, FragmentSpreadNode):
+                fragment_name = selection.name.value
+                if fragment_name in visited_fragments:
+                    continue
+                fragment = fragments.get(fragment_name)
+                if fragment:
+                    defer = get_directive(selection, GraphQLDeferDirective.name)
+                    if defer:
+                        self.report_error(
+                            GraphQLError(
+                                "Defer directive cannot be used on root"
+                                f" {operation_type.value} type '{root_type.name}'.",
+                                defer,
+                            )
+                        )
+                    self.forbid_defer_stream(
+                        operation_type,
+                        root_type,
+                        fragments,
+                        fragment.selection_set,
+                        visited_fragments,
+                    )
+                visited_fragments.add(fragment_name)
+            else:  # the only remaining selection kind is an inline fragment
+                inline_fragment = cast("InlineFragmentNode", selection)
+                defer = get_directive(inline_fragment, GraphQLDeferDirective.name)
+                if defer:
+                    self.report_error(
+                        GraphQLError(
+                            "Defer directive cannot be used on root"
+                            f" {operation_type.value} type '{root_type.name}'.",
+                            defer,
+                        )
+                    )
+                self.forbid_defer_stream(
+                    operation_type,
+                    root_type,
+                    fragments,
+                    inline_fragment.selection_set,
+                    visited_fragments,
+                )

graphql_core-3.3.0rc0/src/graphql/validation/rules/defer_stream_directive_on_valid_operations_rule.py

@@ -0,0 +1,162 @@
+"""Defer stream directive on valid operations rule"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ...error import GraphQLError
+from ...language import (
+    ArgumentNode,
+    BooleanValueNode,
+    DirectiveNode,
+    FragmentDefinitionNode,
+    FragmentSpreadNode,
+    OperationDefinitionNode,
+    OperationType,
+    SelectionSetNode,
+    VariableNode,
+)
+from ...type import (
+    GraphQLDeferDirective,
+    GraphQLIncludeDirective,
+    GraphQLSkipDirective,
+    GraphQLStreamDirective,
+)
+from . import ASTValidationRule
+
+__all__ = ["DeferStreamDirectiveOnValidOperationsRule"]
+
+
+def get_directive(node: Any, name: str) -> DirectiveNode | None:
+    for directive in node.directives or ():
+        if directive.name.value == name:
+            return directive
+    return None
+
+
+def get_if_argument(node: DirectiveNode) -> ArgumentNode | None:
+    for argument in node.arguments or ():
+        if argument.name.value == "if":
+            return argument
+    return None
+
+
+def if_argument_can_be_false(node: DirectiveNode) -> bool:
+    # @defer(if: false) / @stream(if: false)
+    # @defer(if: $shouldDefer) / @stream(if: $shouldStream)
+    if_argument = get_if_argument(node)
+    if not if_argument:
+        return False
+    if isinstance(if_argument.value, BooleanValueNode):
+        if if_argument.value.value:
+            return False
+    elif not isinstance(if_argument.value, VariableNode):
+        return False
+    return True
+
+
+def can_be_skipped_via_skip_directive(node: DirectiveNode) -> bool:
+    # @skip(if: true)
+    # @skip(if: $shouldSkip)
+    if_argument = get_if_argument(node)
+    if not if_argument:
+        # Missing `if` is reported by ProvidedRequiredArgumentsRule. For this rule,
+        # treat malformed @skip as potentially skipped to avoid duplicate errors.
+        return True
+    # If argument is a static boolean, it is always skipped if true,
+    # never skipped if false; otherwise it can be skipped via a variable.
+    if isinstance(if_argument.value, BooleanValueNode):
+        return if_argument.value.value
+    return True
+
+
+def can_be_skipped_via_include_directive(node: DirectiveNode) -> bool:
+    # @include(if: false)
+    # @include(if: $shouldInclude)
+    if_argument = get_if_argument(node)
+    if not if_argument:
+        # Missing `if` is reported by ProvidedRequiredArgumentsRule. For this rule,
+        # treat malformed @include as not skippable.
+        return False
+    # If argument is a static boolean, it is always skipped if false,
+    # never skipped if true; otherwise it can be skipped via a variable.
+    if isinstance(if_argument.value, BooleanValueNode):
+        return not if_argument.value.value
+    return True
+
+
+class DeferStreamDirectiveOnValidOperationsRule(ASTValidationRule):
+    """Defer and stream directives are used on valid operations
+
+    A GraphQL document is only valid if defer and stream directives are not used
+    on root mutation or subscription types.
+    """
+
+    def enter_operation_definition(
+        self, operation: OperationDefinitionNode, *_args: Any
+    ) -> None:
+        if operation.operation != OperationType.SUBSCRIPTION:
+            return
+        fragments: dict[str, FragmentDefinitionNode] = {}
+        for definition in self.context.document.definitions:
+            if isinstance(definition, FragmentDefinitionNode):
+                fragments[definition.name.value] = definition
+        self.forbid_unconditional_defer_stream(
+            fragments, operation.selection_set, [], set()
+        )
+
+    def forbid_unconditional_defer_stream(
+        self,
+        fragments: dict[str, FragmentDefinitionNode],
+        selection_set: SelectionSetNode,
+        parent_nodes: list[FragmentSpreadNode],
+        visited_fragments: set[str],
+    ) -> None:
+        for selection in selection_set.selections:
+            skip = get_directive(selection, GraphQLSkipDirective.name)
+            if skip and can_be_skipped_via_skip_directive(skip):
+                continue
+            include = get_directive(selection, GraphQLIncludeDirective.name)
+            if include and can_be_skipped_via_include_directive(include):
+                continue
+            for directive in selection.directives or ():
+                name = directive.name.value
+                if name == GraphQLDeferDirective.name:
+                    if if_argument_can_be_false(directive):
+                        continue
+                    msg = (
+                        "Defer directive not supported on subscription operations."
+                        " Disable `@defer` by setting the `if` argument to `false`."
+                    )
+                elif name == GraphQLStreamDirective.name:
+                    if if_argument_can_be_false(directive):
+                        continue
+                    msg = (
+                        "Stream directive not supported on subscription operations."
+                        " Disable `@stream` by setting the `if` argument to `false`."
+                    )
+                else:
+                    continue
+                self.report_error(GraphQLError(msg, [directive, *parent_nodes]))
+            if isinstance(selection, FragmentSpreadNode):
+                fragment_name = selection.name.value
+                if fragment_name in visited_fragments:
+                    continue
+                visited_fragments.add(fragment_name)
+                fragment = fragments.get(fragment_name)
+                if fragment:
+                    self.forbid_unconditional_defer_stream(
+                        fragments,
+                        fragment.selection_set,
+                        [selection, *parent_nodes],
+                        visited_fragments,
+                    )
+            else:
+                child_selection_set = getattr(selection, "selection_set", None)
+                if child_selection_set:
+                    self.forbid_unconditional_defer_stream(
+                        fragments,
+                        child_selection_set,
+                        parent_nodes,
+                        visited_fragments,
+                    )

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/src/graphql/version.py

@@ -8,9 +8,9 @@ from typing import NamedTuple
 __all__ = ["version", "version_info", "version_info_js", "version_js"]
 
 
-version = "3.3.0b2"
+version = "3.3.0rc0"
 
-version_js = "17.0.0b2"
+version_js = "17.0.0rc0"
 
 
 _re_version = re.compile(r"(\d+)\.(\d+)\.(\d+)(\D*)(\d*)")

{graphql_core-3.3.0b2 → graphql_core-3.3.0rc0}/tests/validation/test_defer_stream_directive_on_root_field.py

@@ -12,19 +12,26 @@ schema = build_schema(
       sender: String
     }
 
-    type SubscriptionRoot {
+    interface Root {
+      rootField: Message
+    }
+
+    type SubscriptionRoot implements Root {
       subscriptionField: Message
       subscriptionListField: [Message]
+      rootField: Message
     }
 
-    type MutationRoot {
+    type MutationRoot implements Root {
       mutationField: Message
       mutationListField: [Message]
+      rootField: Message
     }
 
-    type QueryRoot {
+    type QueryRoot implements Root {
       message: Message
       messages: [Message]
+      rootField: Message
     }
 
     schema {
@@ -75,6 +82,13 @@ def describe_defer_stream_on_root_field():
             """
             mutation {
               ...rootFragment @defer
+              ...otherFragment
+            }
+            fragment otherFragment on MutationRoot {
+              ...rootFragment
+              mutationListField {
+                body
+              }
             }
             fragment rootFragment on MutationRoot {
               mutationField {
@@ -91,6 +105,29 @@ def describe_defer_stream_on_root_field():
             ],
         )
 
+    def defer_fragment_spread_on_root_mutation_field_interface():
+        assert_errors(
+            """
+            mutation {
+              ...rootFragment
+            }
+            fragment rootFragment on Root {
+              ... @defer {
+                rootField {
+                  body
+                }
+              }
+            }
+            """,
+            [
+                {
+                    "message": "Defer directive cannot be used on root"
+                    " mutation type 'MutationRoot'.",
+                    "locations": [(6, 19)],
+                },
+            ],
+        )
+
     def defer_inline_fragment_spread_on_root_mutation_field():
         assert_errors(
             """
@@ -124,6 +161,29 @@ def describe_defer_stream_on_root_field():
             """
         )
 
+    def defer_fragment_spread_on_root_subscription_field_interface():
+        assert_errors(
+            """
+            subscription {
+              ...rootFragment
+            }
+            fragment rootFragment on Root {
+              ... @defer {
+                rootField {
+                  body
+                }
+              }
+            }
+            """,
+            [
+                {
+                    "message": "Defer directive cannot be used on root"
+                    " subscription type 'SubscriptionRoot'.",
+                    "locations": [(6, 19)],
+                },
+            ],
+        )
+
     def defer_fragment_spread_on_root_subscription_field():
         assert_errors(
             """
@@ -281,3 +341,57 @@ def describe_defer_stream_on_root_field():
                 },
             ],
         )
+
+    def other_directive_on_root_mutation_field():
+        assert_valid(
+            """
+            mutation {
+              mutationField @foo {
+                body
+              }
+            }
+            """
+        )
+
+    def defer_fragment_spread_on_undefined_fragment():
+        assert_valid(
+            """
+            mutation {
+              ...undefinedFragment @defer
+            }
+            """
+        )
+
+    def inline_fragment_without_defer_on_root_mutation_field():
+        assert_valid(
+            """
+            mutation {
+              ... {
+                mutationField {
+                  body
+                }
+              }
+            }
+            """
+        )
+
+    def defer_on_mutation_without_mutation_root_type():
+        query_only_schema = build_schema(
+            """
+            type Query {
+              message: String
+            }
+            """
+        )
+        assert_validation_errors(
+            DeferStreamDirectiveOnRootField,
+            """
+            mutation {
+              ... @defer {
+                message
+              }
+            }
+            """,
+            [],
+            schema=query_only_schema,
+        )