incremental: introduce GraphQLWrappedResult to avoid filtering

Replicates graphql/graphql-js@05e7a29

Author: Cito

docs/conf.py

@@ -147,10 +147,11 @@
     "TContext",
     "Enum",
     "traceback",
-    "types.TracebackType",
     "TypeMap",
     "AwaitableOrValue",
     "DeferredFragmentRecord",
+    "DeferredGroupedFieldSetRecord",
+    "DeferredGroupedFieldSetResult",
     "DeferUsage",
     "EnterLeaveVisitor",
     "ExperimentalIncrementalExecutionResults",
@@ -167,15 +168,18 @@
     "GraphQLNullableType",
     "GraphQLOutputType",
     "GraphQLTypeResolver",
+    "GraphQLWrappedResult",
     "GroupedFieldSet",
     "IncrementalDataRecord",
     "IncrementalResult",
-    "InitialResultRecord",
     "Middleware",
     "PendingResult",
     "StreamItemsRecord",
+    "StreamItemsResult",
     "StreamRecord",
     "SubsequentDataRecord",
+    "SubsequentResultRecord",
+    "UndefinedType",
     "asyncio.events.AbstractEventLoop",
     "collections.abc.MutableMapping",
     "collections.abc.MutableSet",
@@ -187,16 +191,23 @@
     "graphql.execution.execute.SubFieldPlan",
     "graphql.execution.execute.StreamUsage",
     "graphql.execution.map_async_iterable.map_async_iterable",
+    "graphql.execution.incremental_publisher.BareDeferredGroupedFieldSetResult",
+    "graphql.execution.incremental_publisher.BareStreamItemsResult",
+    "graphql.execution.incremental_publisher.CancellableStreamRecord",
     "graphql.execution.incremental_publisher.CompletedResult",
     "graphql.execution.incremental_publisher.DeferredFragmentRecord",
     "graphql.execution.incremental_publisher.DeferredGroupedFieldSetRecord",
     "graphql.execution.incremental_publisher.FormattedCompletedResult",
     "graphql.execution.incremental_publisher.FormattedPendingResult",
     "graphql.execution.incremental_publisher.IncrementalPublisher",
-    "graphql.execution.incremental_publisher.InitialResultRecord",
+    "graphql.execution.incremental_publisher.IncrementalPublisherContext",
+    "graphql.execution.incremental_publisher.NonReconcilableStreamItemsResult",
     "graphql.execution.incremental_publisher.PendingResult",
+    "graphql.execution.incremental_publisher.ReconcilableStreamItemsResult",
     "graphql.execution.incremental_publisher.StreamItemsRecord",
     "graphql.execution.incremental_publisher.StreamRecord",
+    "graphql.execution.incremental_publisher.SubsequentResultRecord",
+    "graphql.execution.incremental_publisher.TerminatingStreamItemsResult",
     "graphql.execution.Middleware",
     "graphql.language.lexer.EscapeSequence",
     "graphql.language.visitor.EnterLeaveVisitor",

pyproject.toml

@@ -288,7 +288,10 @@ module = [
 disallow_untyped_defs = false
 
 [tool.pyright]
+# silence pyright since we're using mypy already
+reportArgumentType = false
 reportIncompatibleVariableOverride = false
+reportMissingModuleSource = false
 reportMissingTypeArgument = false
 reportReturnType = false
 reportUnknownArgumentType = false

src/graphql/execution/__init__.py

@@ -5,7 +5,6 @@
 """
 
 from .execute import (
-    ASYNC_DELAY,
     create_source_event_stream,
     execute,
     experimental_execute_incrementally,
@@ -36,7 +35,6 @@
 from .values import get_argument_values, get_directive_values, get_variable_values
 
 __all__ = [
-    "ASYNC_DELAY",
     "ExecutionContext",
     "ExecutionResult",
     "ExperimentalIncrementalExecutionResults",

src/graphql/execution/build_field_plan.py

@@ -21,7 +21,6 @@
     "FieldGroup",
     "FieldPlan",
     "GroupedFieldSet",
-    "NewGroupedFieldSetDetails",
     "build_field_plan",
 ]
 
@@ -46,18 +45,11 @@ def to_nodes(self) -> list[FieldNode]:
     GroupedFieldSet: TypeAlias = dict[str, FieldGroup]
 
 
-class NewGroupedFieldSetDetails(NamedTuple):
-    """Details of a new grouped field set."""
-
-    grouped_field_set: GroupedFieldSet
-    should_initiate_defer: bool
-
-
 class FieldPlan(NamedTuple):
     """A plan for executing fields."""
 
     grouped_field_set: GroupedFieldSet
-    new_grouped_field_set_details_map: RefMap[DeferUsageSet, NewGroupedFieldSetDetails]
+    new_grouped_field_sets: RefMap[DeferUsageSet, GroupedFieldSet]
 
 
 def build_field_plan(
@@ -70,9 +62,7 @@ def build_field_plan(
 
     grouped_field_set: GroupedFieldSet = {}
 
-    new_grouped_field_set_details_map: RefMap[
-        DeferUsageSet, NewGroupedFieldSetDetails
-    ] = RefMap()
+    new_grouped_field_sets: RefMap[DeferUsageSet, GroupedFieldSet] = RefMap()
 
     map_: dict[str, tuple[DeferUsageSet, list[FieldDetails]]] = {}
 
@@ -108,28 +98,19 @@ def build_field_plan(
 
         for (
             new_grouped_field_set_defer_usage_set,
-            new_grouped_field_set_details,
-        ) in new_grouped_field_set_details_map.items():
+            new_grouped_field_set_field_group,
+        ) in new_grouped_field_sets.items():
             if new_grouped_field_set_defer_usage_set == defer_usage_set:
-                new_grouped_field_set = new_grouped_field_set_details.grouped_field_set
+                new_grouped_field_set = new_grouped_field_set_field_group
                 break
         else:
             new_grouped_field_set = {}
-            new_grouped_field_set_details = NewGroupedFieldSetDetails(
-                new_grouped_field_set,
-                any(
-                    defer_usage not in parent_defer_usages
-                    for defer_usage in defer_usage_set
-                ),
-            )
-            new_grouped_field_set_details_map[defer_usage_set] = (
-                new_grouped_field_set_details
-            )
+            new_grouped_field_sets[defer_usage_set] = new_grouped_field_set
 
         field_group = new_grouped_field_set.get(response_key)
         if field_group is None:  # pragma: no cover else
             field_group = FieldGroup([], defer_usage_set)
             new_grouped_field_set[response_key] = field_group
         field_group.fields.extend(field_details_list)
 
-    return FieldPlan(grouped_field_set, new_grouped_field_set_details_map)
+    return FieldPlan(grouped_field_set, new_grouped_field_sets)