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
|
import asyncio
import json
import sys
import warnings
from typing import List
import pytest
from graphql import ExecutionResult
from parse import search
from gql import Client, gql
from gql.client import AsyncClientSession
from gql.transport.exceptions import TransportConnectionFailed, TransportServerError
from .conftest import MS, PyPy, WebSocketServerHelper
# Marking all tests in this file with the websockets marker
pytestmark = pytest.mark.websockets
countdown_server_answer = (
'{{"type":"data","id":"{query_id}","payload":{{"data":{{"number":{number}}}}}}}'
)
WITH_KEEPALIVE = False
# List which can used to store received messages by the server
logged_messages: List[str] = []
async def server_countdown(ws):
import websockets
logged_messages.clear()
global WITH_KEEPALIVE
try:
await WebSocketServerHelper.send_connection_ack(ws)
if WITH_KEEPALIVE:
await WebSocketServerHelper.send_keepalive(ws)
result = await ws.recv()
logged_messages.append(result)
json_result = json.loads(result)
assert json_result["type"] == "start"
payload = json_result["payload"]
query = payload["query"]
query_id = json_result["id"]
count_found = search("count: {:d}", query)
count = count_found[0]
print(f"Countdown started from: {count}")
async def counting_coro():
for number in range(count, -1, -1):
await ws.send(
countdown_server_answer.format(query_id=query_id, number=number)
)
await asyncio.sleep(2 * MS)
counting_task = asyncio.ensure_future(counting_coro())
async def stopping_coro():
nonlocal counting_task
while True:
try:
result = await ws.recv()
logged_messages.append(result)
except websockets.exceptions.ConnectionClosed:
break
json_result = json.loads(result)
if json_result["type"] == "stop" and json_result["id"] == str(query_id):
print("Cancelling counting task now")
counting_task.cancel()
async def keepalive_coro():
while True:
await asyncio.sleep(5 * MS)
try:
await WebSocketServerHelper.send_keepalive(ws)
except websockets.exceptions.ConnectionClosed:
break
stopping_task = asyncio.ensure_future(stopping_coro())
keepalive_task = asyncio.ensure_future(keepalive_coro())
try:
await counting_task
except asyncio.CancelledError:
print("Now counting task is cancelled")
stopping_task.cancel()
try:
await stopping_task
except asyncio.CancelledError:
print("Now stopping task is cancelled")
if WITH_KEEPALIVE:
keepalive_task.cancel()
try:
await keepalive_task
except asyncio.CancelledError:
print("Now keepalive task is cancelled")
await WebSocketServerHelper.send_complete(ws, query_id)
await WebSocketServerHelper.wait_connection_terminate(ws)
except websockets.exceptions.ConnectionClosedOK:
pass
finally:
await ws.wait_closed()
countdown_subscription_str = """
subscription {{
countdown (count: {count}) {{
number
}}
}}
"""
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription(client_and_server, subscription_str):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_get_execution_result(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
async for result in session.subscribe(subscription, get_execution_result=True):
assert isinstance(result, ExecutionResult)
assert result.data is not None
number = result.data["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_break(client_and_server, subscription_str):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
generator = session.subscribe(subscription)
async for result in generator:
number = result["number"]
print(f"Number received: {number}")
assert number == count
if count <= 5:
break
count -= 1
assert count == 5
# Using aclose here to make it stop cleanly on pypy
await generator.aclose()
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_task_cancel(client_and_server, subscription_str):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
task_cancelled = False
async def task_coro():
nonlocal count
nonlocal task_cancelled
try:
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
except asyncio.CancelledError:
print("Inside task cancelled")
task_cancelled = True
task = asyncio.ensure_future(task_coro())
async def cancel_task_coro():
nonlocal task
await asyncio.sleep(11 * MS)
task.cancel()
cancel_task = asyncio.ensure_future(cancel_task_coro())
await asyncio.gather(task, cancel_task)
assert count > 0
assert task_cancelled is True
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_close_transport(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
async def task_coro():
nonlocal count
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
task = asyncio.ensure_future(task_coro())
async def close_transport_task_coro():
nonlocal task
await asyncio.sleep(11 * MS)
await session.transport.close()
close_transport_task = asyncio.ensure_future(close_transport_task_coro())
await asyncio.gather(task, close_transport_task)
assert count > 0
async def server_countdown_close_connection_in_middle(ws):
await WebSocketServerHelper.send_connection_ack(ws)
result = await ws.recv()
json_result = json.loads(result)
assert json_result["type"] == "start"
payload = json_result["payload"]
query = payload["query"]
query_id = json_result["id"]
count_found = search("count: {:d}", query)
count = count_found[0]
stopping_before = count // 2
print(f"Countdown started from: {count}, stopping server before {stopping_before}")
for number in range(count, stopping_before, -1):
await ws.send(countdown_server_answer.format(query_id=query_id, number=number))
await asyncio.sleep(2 * MS)
print("Closing server while subscription is still running now")
await ws.close()
await ws.wait_closed()
print("Server is now closed")
@pytest.mark.asyncio
@pytest.mark.parametrize(
"server", [server_countdown_close_connection_in_middle], indirect=True
)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_server_connection_closed(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
with pytest.raises(TransportConnectionFailed):
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_slow_consumer(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
async for result in session.subscribe(subscription):
await asyncio.sleep(10 * MS)
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_with_operation_name(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
subscription.operation_name = "CountdownSubscription"
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
# Check that the query contains the operationName
assert '"operationName": "CountdownSubscription"' in logged_messages[0]
WITH_KEEPALIVE = True
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_with_keepalive(
client_and_server, subscription_str
):
session, server = client_and_server
count = 10
subscription = gql(subscription_str.format(count=count))
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_with_keepalive_with_timeout_ok(
server, subscription_str
):
from gql.transport.websockets import WebsocketsTransport
path = "/graphql"
url = f"ws://{server.hostname}:{server.port}{path}"
keep_alive_timeout = 20 * MS
if PyPy:
keep_alive_timeout = 200 * MS
transport = WebsocketsTransport(url=url, keep_alive_timeout=keep_alive_timeout)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
async with client as session:
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_with_keepalive_with_timeout_nok(
server, subscription_str
):
from gql.transport.websockets import WebsocketsTransport
path = "/graphql"
url = f"ws://{server.hostname}:{server.port}{path}"
transport = WebsocketsTransport(url=url, keep_alive_timeout=(1 * MS))
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
async with client as session:
with pytest.raises(TransportServerError) as exc_info:
async for result in session.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert "No keep-alive message has been received" in str(exc_info.value)
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
def test_websocket_subscription_sync(server, subscription_str):
from gql.transport.websockets import WebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = WebsocketsTransport(url=url)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
for result in client.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
def test_websocket_subscription_sync_user_exception(server, subscription_str):
from gql.transport.websockets import WebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = WebsocketsTransport(url=url)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
with pytest.raises(Exception) as exc_info:
for result in client.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
if count == 5:
raise Exception("This is an user exception")
assert count == 5
assert "This is an user exception" in str(exc_info.value)
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
def test_websocket_subscription_sync_break(server, subscription_str):
from gql.transport.websockets import WebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = WebsocketsTransport(url=url)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
for result in client.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
if count == 5:
break
assert count == 5
@pytest.mark.skipif(sys.platform.startswith("win"), reason="test failing on windows")
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
def test_websocket_subscription_sync_graceful_shutdown(server, subscription_str):
"""Note: this test will simulate a control-C happening while a sync subscription
is in progress. To do that we will throw a KeyboardInterrupt exception inside
the subscription async generator.
The code should then do a clean close:
- send stop messages for each active query
- send a connection_terminate message
Then the KeyboardInterrupt will be reraise (to warn potential user code)
This test does not work on Windows but the behaviour with Windows is correct.
"""
from gql.transport.websockets import WebsocketsTransport
url = f"ws://{server.hostname}:{server.port}/graphql"
print(f"url = {url}")
transport = WebsocketsTransport(url=url)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
interrupt_task = None
with pytest.raises(KeyboardInterrupt):
for result in client.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
if count == 5:
# Simulate a KeyboardInterrupt in the generator
with warnings.catch_warnings():
warnings.filterwarnings(
"ignore", message="There is no current event loop"
)
assert isinstance(client.session, AsyncClientSession)
interrupt_task = asyncio.ensure_future(
client.session._generator.athrow(KeyboardInterrupt)
)
count -= 1
assert count == 4
# Catch interrupt_task exception to remove warning
assert interrupt_task is not None
interrupt_task.exception()
# Check that the server received a connection_terminate message last
assert logged_messages.pop() == '{"type": "connection_terminate"}'
@pytest.mark.asyncio
@pytest.mark.parametrize("server", [server_countdown], indirect=True)
@pytest.mark.parametrize("subscription_str", [countdown_subscription_str])
async def test_websocket_subscription_running_in_thread(
server, subscription_str, run_sync_test
):
from gql.transport.websockets import WebsocketsTransport
def test_code():
path = "/graphql"
url = f"ws://{server.hostname}:{server.port}{path}"
transport = WebsocketsTransport(url=url)
client = Client(transport=transport)
count = 10
subscription = gql(subscription_str.format(count=count))
for result in client.subscribe(subscription):
number = result["number"]
print(f"Number received: {number}")
assert number == count
count -= 1
assert count == -1
await run_sync_test(server, test_code)
|