1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
|
import asyncio
from typing import Any, Callable, Dict, List
from graphql.execution import (
ExecutionResult,
MapAsyncIterator,
create_source_event_stream,
subscribe,
)
from graphql.language import parse
from graphql.pyutils import SimplePubSub
from graphql.type import (
GraphQLArgument,
GraphQLBoolean,
GraphQLField,
GraphQLInt,
GraphQLList,
GraphQLObjectType,
GraphQLSchema,
GraphQLString,
)
from pytest import mark, raises
try:
anext # type: ignore
except NameError: # pragma: no cover (Python < 3.10)
# noinspection PyShadowingBuiltins
async def anext(iterator):
"""Return the next item from an async iterator."""
return await iterator.__anext__()
Email = Dict # should become a TypedDict once we require Python 3.8
EmailType = GraphQLObjectType(
"Email",
{
"from": GraphQLField(GraphQLString),
"subject": GraphQLField(GraphQLString),
"message": GraphQLField(GraphQLString),
"unread": GraphQLField(GraphQLBoolean),
},
)
InboxType = GraphQLObjectType(
"Inbox",
{
"total": GraphQLField(
GraphQLInt, resolve=lambda inbox, _info: len(inbox["emails"])
),
"unread": GraphQLField(
GraphQLInt,
resolve=lambda inbox, _info: sum(
1 for email in inbox["emails"] if email["unread"]
),
),
"emails": GraphQLField(GraphQLList(EmailType)),
},
)
QueryType = GraphQLObjectType("Query", {"inbox": GraphQLField(InboxType)})
EmailEventType = GraphQLObjectType(
"EmailEvent", {"email": GraphQLField(EmailType), "inbox": GraphQLField(InboxType)}
)
email_schema = GraphQLSchema(
query=QueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"importantEmail": GraphQLField(
EmailEventType,
args={"priority": GraphQLArgument(GraphQLInt)},
)
},
),
)
def create_subscription(pubsub: SimplePubSub):
document = parse(
"""
subscription ($priority: Int = 0) {
importantEmail(priority: $priority) {
email {
from
subject
}
inbox {
unread
total
}
}
}
"""
)
emails: List[Email] = [
{
"from": "joe@graphql.org",
"subject": "Hello",
"message": "Hello World",
"unread": False,
}
]
def transform(new_email):
emails.append(new_email)
return {"importantEmail": {"email": new_email, "inbox": data["inbox"]}}
data: Dict[str, Any] = {
"inbox": {"emails": emails},
"importantEmail": pubsub.get_subscriber(transform),
}
return subscribe(email_schema, document, data)
DummyQueryType = GraphQLObjectType("Query", {"dummy": GraphQLField(GraphQLString)})
# Check all error cases when initializing the subscription.
def describe_subscription_initialization_phase():
@mark.asyncio
async def accepts_positional_arguments():
document = parse(
"""
subscription {
importantEmail
}
"""
)
async def empty_async_iterator(_info):
for value in (): # type: ignore
yield value # pragma: no cover
ai = await subscribe(
email_schema, document, {"importantEmail": empty_async_iterator}
)
with raises(StopAsyncIteration):
await anext(ai)
await ai.aclose() # type: ignore
@mark.asyncio
async def accepts_multiple_subscription_fields_defined_in_schema():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"foo": GraphQLField(GraphQLString),
"bar": GraphQLField(GraphQLString),
},
),
)
async def foo_generator(_info):
yield {"foo": "FooValue"}
subscription = await subscribe(
schema, parse("subscription { foo }"), {"foo": foo_generator}
)
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"foo": "FooValue"}, None)
await subscription.aclose()
@mark.asyncio
async def accepts_type_definition_with_sync_subscribe_function():
async def foo_generator(_obj, _info):
yield {"foo": "FooValue"}
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{"foo": GraphQLField(GraphQLString, subscribe=foo_generator)},
),
)
subscription = await subscribe(schema, parse("subscription { foo }"))
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"foo": "FooValue"}, None)
await subscription.aclose()
@mark.asyncio
async def accepts_type_definition_with_async_subscribe_function():
async def foo_generator(_obj, _info):
await asyncio.sleep(0)
yield {"foo": "FooValue"}
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{"foo": GraphQLField(GraphQLString, subscribe=foo_generator)},
),
)
subscription = await subscribe(schema, parse("subscription { foo }"))
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"foo": "FooValue"}, None)
await subscription.aclose()
@mark.asyncio
async def uses_a_custom_default_subscribe_field_resolver():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription", {"foo": GraphQLField(GraphQLString)}
),
)
class Root:
@staticmethod
async def custom_foo():
yield {"foo": "FooValue"}
subscription = await subscribe(
schema,
document=parse("subscription { foo }"),
root_value=Root(),
subscribe_field_resolver=lambda root, _info: root.custom_foo(),
)
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == (
{"foo": "FooValue"},
None,
)
await subscription.aclose()
@mark.asyncio
async def should_only_resolve_the_first_field_of_invalid_multi_field():
did_resolve = {"foo": False, "bar": False}
async def subscribe_foo(_obj, _info):
did_resolve["foo"] = True
yield {"foo": "FooValue"}
async def subscribe_bar(_obj, _info): # pragma: no cover
did_resolve["bar"] = True
yield {"bar": "BarValue"}
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"foo": GraphQLField(GraphQLString, subscribe=subscribe_foo),
"bar": GraphQLField(GraphQLString, subscribe=subscribe_bar),
},
),
)
subscription = await subscribe(schema, parse("subscription { foo bar }"))
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == (
{"foo": "FooValue", "bar": None},
None,
)
assert did_resolve == {"foo": True, "bar": False}
await subscription.aclose()
@mark.asyncio
async def throws_an_error_if_some_of_required_arguments_are_missing():
document = parse("subscription { foo }")
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription", {"foo": GraphQLField(GraphQLString)}
),
)
with raises(TypeError, match="^Expected None to be a GraphQL schema\\.$"):
await subscribe(None, document) # type: ignore
with raises(TypeError, match="missing .* positional argument: 'schema'"):
await subscribe(document=document) # type: ignore
with raises(TypeError, match="^Must provide document\\.$"):
await subscribe(schema, None) # type: ignore
with raises(TypeError, match="missing .* positional argument: 'document'"):
await subscribe(schema=schema) # type: ignore
@mark.asyncio
async def resolves_to_an_error_if_schema_does_not_support_subscriptions():
schema = GraphQLSchema(query=DummyQueryType)
document = parse("subscription { unknownField }")
result = await subscribe(schema, document)
assert result == (
None,
[
{
"message": "Schema is not configured to execute"
" subscription operation.",
"locations": [(1, 1)],
}
],
)
@mark.asyncio
async def resolves_to_an_error_for_unknown_subscription_field():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription", {"foo": GraphQLField(GraphQLString)}
),
)
document = parse("subscription { unknownField }")
result = await subscribe(schema, document)
assert result == (
None,
[
{
"message": "The subscription field 'unknownField' is not defined.",
"locations": [(1, 16)],
}
],
)
@mark.asyncio
async def should_pass_through_unexpected_errors_thrown_in_subscribe():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription", {"foo": GraphQLField(GraphQLString)}
),
)
with raises(TypeError, match="^Must provide document\\.$"):
await subscribe(schema=schema, document={}) # type: ignore
@mark.asyncio
@mark.filterwarnings("ignore:.* was never awaited:RuntimeWarning")
async def throws_an_error_if_subscribe_does_not_return_an_iterator():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"foo": GraphQLField(
GraphQLString, subscribe=lambda _obj, _info: "test"
)
},
),
)
document = parse("subscription { foo }")
with raises(TypeError) as exc_info:
await subscribe(schema, document)
assert str(exc_info.value) == (
"Subscription field must return AsyncIterable. Received: 'test'."
)
@mark.asyncio
async def resolves_to_an_error_for_subscription_resolver_errors():
async def subscribe_with_fn(subscribe_fn: Callable):
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{"foo": GraphQLField(GraphQLString, subscribe=subscribe_fn)},
),
)
document = parse("subscription { foo }")
result = await subscribe(schema, document)
assert await create_source_event_stream(schema, document) == result
return result
expected_result = (
None,
[
{
"message": "test error",
"locations": [(1, 16)],
"path": ["foo"],
}
],
)
# Returning an error
def return_error(_obj, _info):
return TypeError("test error")
assert await subscribe_with_fn(return_error) == expected_result
# Throwing an error
def throw_error(*_args):
raise TypeError("test error")
assert await subscribe_with_fn(throw_error) == expected_result
# Resolving to an error
async def resolve_error(*_args):
return TypeError("test error")
assert await subscribe_with_fn(resolve_error) == expected_result
# Rejecting with an error
async def reject_error(*_args):
return TypeError("test error")
assert await subscribe_with_fn(reject_error) == expected_result
@mark.asyncio
async def resolves_to_an_error_if_variables_were_wrong_type():
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"foo": GraphQLField(
GraphQLString, {"arg": GraphQLArgument(GraphQLInt)}
)
},
),
)
variable_values = {"arg": "meow"}
document = parse(
"""
subscription ($arg: Int) {
foo(arg: $arg)
}
"""
)
# If we receive variables that cannot be coerced correctly, subscribe() will
# resolve to an ExecutionResult that contains an informative error description.
result = await subscribe(schema, document, variable_values=variable_values)
assert isinstance(result, ExecutionResult)
assert result == (
None,
[
{
"message": "Variable '$arg' got invalid value 'meow';"
" Int cannot represent non-integer value: 'meow'",
"locations": [(2, 27)],
}
],
)
errors = result.errors
assert errors
assert errors[0].original_error
# Once a subscription returns a valid AsyncIterator, it can still yield errors.
def describe_subscription_publish_phase():
@mark.asyncio
async def produces_a_payload_for_multiple_subscribe_in_same_subscription():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
second_subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
payload1 = anext(subscription)
payload2 = anext(second_subscription)
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright",
"message": "Tests are good",
"unread": True,
}
)
is True
)
expected_payload = {
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright"},
"inbox": {"unread": 1, "total": 2},
}
}
assert await payload1 == (expected_payload, None)
assert await payload2 == (expected_payload, None)
@mark.asyncio
async def produces_a_payload_per_subscription_event():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
# Wait for the next subscription payload.
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright",
"message": "Tests are good",
"unread": True,
}
)
is True
)
# The previously waited on payload now has a value.
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright"},
"inbox": {"unread": 1, "total": 2},
}
},
None,
)
# Another new email arrives, before anext(subscription) is called.
assert (
pubsub.emit(
{
"from": "hyo@graphql.org",
"subject": "Tools",
"message": "I <3 making things",
"unread": True,
}
)
is True
)
# The next waited on payload will have a value.
assert await anext(subscription) == (
{
"importantEmail": {
"email": {"from": "hyo@graphql.org", "subject": "Tools"},
"inbox": {"unread": 2, "total": 3},
}
},
None,
)
# The client decides to disconnect.
# noinspection PyUnresolvedReferences
await subscription.aclose()
# Which may result in disconnecting upstream services as well.
assert (
pubsub.emit(
{
"from": "adam@graphql.org",
"subject": "Important",
"message": "Read me please",
"unread": True,
}
)
is False
) # No more listeners.
# Awaiting subscription after closing it results in completed results.
with raises(StopAsyncIteration):
assert await anext(subscription)
@mark.asyncio
async def produces_a_payload_when_there_are_multiple_events():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright",
"message": "Tests are good",
"unread": True,
}
)
is True
)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright"},
"inbox": {"unread": 1, "total": 2},
}
},
None,
)
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright 2",
"message": "Tests are good 2",
"unread": True,
}
)
is True
)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright 2"},
"inbox": {"unread": 2, "total": 3},
}
},
None,
)
@mark.asyncio
async def should_not_trigger_when_subscription_is_already_done():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright",
"message": "Tests are good",
"unread": True,
}
)
is True
)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright"},
"inbox": {"unread": 1, "total": 2},
}
},
None,
)
payload = anext(subscription)
await subscription.aclose()
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright 2",
"message": "Tests are good 2",
"unread": True,
}
)
is False
)
with raises(StopAsyncIteration):
await payload
@mark.asyncio
async def should_not_trigger_when_subscription_is_thrown():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Alright",
"message": "Tests are good",
"unread": True,
}
)
is True
)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Alright"},
"inbox": {"unread": 1, "total": 2},
}
},
None,
)
payload = anext(subscription)
# Throw error
with raises(RuntimeError) as exc_info:
await subscription.athrow(RuntimeError("ouch"))
assert str(exc_info.value) == "ouch"
with raises(StopAsyncIteration):
await payload
@mark.asyncio
async def event_order_is_correct_for_multiple_publishes():
pubsub = SimplePubSub()
subscription = await create_subscription(pubsub)
assert isinstance(subscription, MapAsyncIterator)
payload = anext(subscription)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Message",
"message": "Tests are good",
"unread": True,
}
)
is True
)
# A new email arrives!
assert (
pubsub.emit(
{
"from": "yuzhi@graphql.org",
"subject": "Message 2",
"message": "Tests are good 2",
"unread": True,
}
)
is True
)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Message"},
"inbox": {"unread": 2, "total": 3},
}
},
None,
)
payload = anext(subscription)
assert await payload == (
{
"importantEmail": {
"email": {"from": "yuzhi@graphql.org", "subject": "Message 2"},
"inbox": {"unread": 2, "total": 3},
}
},
None,
)
@mark.asyncio
async def should_handle_error_during_execution_of_source_event():
async def generate_messages(_obj, _info):
yield "Hello"
yield "Goodbye"
yield "Bonjour"
def resolve_message(message, _info):
if message == "Goodbye":
raise RuntimeError("Never leave.")
return message
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"newMessage": GraphQLField(
GraphQLString,
subscribe=generate_messages,
resolve=resolve_message,
)
},
),
)
document = parse("subscription { newMessage }")
subscription = await subscribe(schema, document)
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"newMessage": "Hello"}, None)
# An error in execution is presented as such.
assert await anext(subscription) == (
{"newMessage": None},
[
{
"message": "Never leave.",
"locations": [(1, 16)],
"path": ["newMessage"],
}
],
)
# However that does not close the response event stream.
# Subsequent events are still executed.
assert await anext(subscription) == ({"newMessage": "Bonjour"}, None)
@mark.asyncio
async def should_pass_through_error_thrown_in_source_event_stream():
async def generate_messages(_obj, _info):
yield "Hello"
raise RuntimeError("test error")
def resolve_message(message, _info):
return message
schema = GraphQLSchema(
query=DummyQueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"newMessage": GraphQLField(
GraphQLString,
resolve=resolve_message,
subscribe=generate_messages,
)
},
),
)
document = parse("subscription { newMessage }")
subscription = await subscribe(schema, document)
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"newMessage": "Hello"}, None)
with raises(RuntimeError) as exc_info:
await anext(subscription)
assert str(exc_info.value) == "test error"
with raises(StopAsyncIteration):
await anext(subscription)
@mark.asyncio
async def should_work_with_async_resolve_function():
async def generate_messages(_obj, _info):
yield "Hello"
def resolve_message(message, _info):
return message
schema = GraphQLSchema(
query=QueryType,
subscription=GraphQLObjectType(
"Subscription",
{
"newMessage": GraphQLField(
GraphQLString,
resolve=resolve_message,
subscribe=generate_messages,
)
},
),
)
document = parse("subscription { newMessage }")
subscription = await subscribe(schema, document)
assert isinstance(subscription, MapAsyncIterator)
assert await anext(subscription) == ({"newMessage": "Hello"}, None)
|