# -*- coding: utf-8 -*-
import functools as ft
from typing import Any, Callable, Mapping, Optional, Type, cast
from ..exc import ExecutionError
from ..lang import ast as _ast
from ..schema import ObjectType, Schema
from ..utilities import coerce_variable_values
from .executor import Executor
from .get_operation import get_operation_with_type
from .instrumentation import Instrumentation
from .runtime import SubscriptionRuntime
from .wrappers import GraphQLResult, ResolveInfo
Resolver = Callable[..., Any]
[docs]def subscribe(
schema: Schema,
document: _ast.Document,
*,
operation_name: Optional[str] = None,
variables: Optional[Mapping[str, Any]] = None,
initial_value: Optional[Any] = None,
context_value: Optional[Any] = None,
instrumentation: Optional[Instrumentation] = None,
runtime: SubscriptionRuntime,
executor_cls: Type[Executor] = Executor
) -> Any:
"""
Execute a subscription against a schema and return the appropriate response stream.
Warning:
This assumes the query has been validated beforehand.
Args:
schema: Schema to execute the query against.
document: The query document.
variables: Raw, JSON decoded variables parsed from the request.
operation_name: Operation to execute
If specified, the operation with the given name will be executed.
If not, this executes the single operation without disambiguation.
initial_value: Root resolution value passed to top-level resolver.
context_value: Custom application-specific execution context.
Use this to pass in anything your resolvers require like database
connection, user information, etc.
Limits on the type(s) used here will depend on your own resolver
implementations and the executor class you use. Most thread safe
data-structures should work.
instrumentation: Instrumentation instance.
Use :class:`~py_gql.execution.MultiInstrumentation` to compose
multiple instances together.
runtime: Runtime against which to execute field resolvers (defaults to
`~py_gql.execution.runtime.BlockingRuntime()`).
executor_cls: Executor class to use.
The executor class defines the implementation of the GraphQL
resolution algorithm. This **must** be a subclass of
`py_gql.execution.Executor`.
Returns:
An iterator over subscription results. Exact type dependent on the runtime.
Raises:
RuntimeError: on invalid operation.
"""
instrumentation = instrumentation or Instrumentation()
operation, root_type = get_operation_with_type(
schema, document, operation_name
)
coerced_variables = coerce_variable_values(
schema, operation, variables or {}
)
if operation.operation != "subscription":
raise RuntimeError(
"`subscribe` does not support %s operation, "
"use the `execute` helper." % operation.operation
)
executor = executor_cls(
schema,
document,
coerced_variables,
context_value,
instrumentation=instrumentation,
# Enforce no middlewares for subscriptions.
# TODO: This should work somehow but needs more work.
middlewares=[],
runtime=runtime,
)
if not isinstance(runtime, SubscriptionRuntime):
raise RuntimeError(
"Runtime of type '%s' doesn't support subscriptions."
% type(runtime)
)
_on_event = ft.partial(
execute_subscription_event, executor, root_type, operation
)
instrumentation.on_execution_start()
# MapSourceToResponseEvent
# Needs to be mapped to support async subscription resolvers.
def _on_stream_created(source_stream):
response_stream = runtime.map_stream(source_stream, _on_event)
cast(Instrumentation, instrumentation).on_execution_end()
return response_stream
return runtime.ensure_wrapped(
runtime.map_value(
create_source_event_stream(
executor, root_type, operation, initial_value
),
_on_stream_created,
)
)
def create_source_event_stream(
executor: Executor,
root_type: ObjectType,
operation: _ast.OperationDefinition,
initial_value: Optional[Any] = None,
) -> Any:
fields = executor.collect_fields(
root_type, operation.selection_set.selections
)
if len(fields) != 1:
raise ExecutionError(
"Subscription operation must specify only one field."
)
key, nodes = next(iter(fields.items()))
node = nodes[0]
field_def = executor.field_definition(root_type, node.name.value)
if field_def is None:
raise RuntimeError(
"No field definition found for subscription field %s." % key
)
if field_def.subscription_resolver is None:
raise RuntimeError(
"Subscription field %s should provide a subscription resolver."
% field_def.name
)
info = ResolveInfo(
field_def, [key], root_type, nodes, executor.runtime, executor,
)
coerced_args = executor.argument_values(field_def, node)
return field_def.subscription_resolver(
initial_value, executor.context_value, info, **coerced_args
)
def execute_subscription_event(
executor: Executor,
root_type: ObjectType,
operation: _ast.OperationDefinition,
event: Any,
) -> Any:
# As we carry the executor through the source stream iteration we need to
# clear the errors between events.
# REVIEW: We could split the Executor in 2 parts to maintain the benefit
# of the caches while isolating the errors.
executor.clear_errors()
return executor.runtime.ensure_wrapped(
executor.runtime.map_value(
executor.runtime.unwrap_value(
executor.execute_fields(
root_type,
event,
[],
executor.collect_fields(
root_type, operation.selection_set.selections
),
)
),
lambda data: GraphQLResult(data=data, errors=executor.errors),
)
)