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 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
|
# Tests for aiohttp/http_writer.py
import array
import asyncio
import zlib
from typing import Generator, Iterable, Union
from unittest import mock
import pytest
from multidict import CIMultiDict
from aiohttp import ClientConnectionResetError, hdrs, http
from aiohttp.base_protocol import BaseProtocol
from aiohttp.compression_utils import ZLibBackend
from aiohttp.http_writer import _serialize_headers
@pytest.fixture
def enable_writelines() -> Generator[None, None, None]:
with mock.patch("aiohttp.http_writer.SKIP_WRITELINES", False):
yield
@pytest.fixture
def disable_writelines() -> Generator[None, None, None]:
with mock.patch("aiohttp.http_writer.SKIP_WRITELINES", True):
yield
@pytest.fixture
def force_writelines_small_payloads() -> Generator[None, None, None]:
with mock.patch("aiohttp.http_writer.MIN_PAYLOAD_FOR_WRITELINES", 1):
yield
@pytest.fixture
def buf() -> bytearray:
return bytearray()
@pytest.fixture
def transport(buf):
transport = mock.Mock()
def write(chunk):
buf.extend(chunk)
def writelines(chunks: Iterable[bytes]) -> None:
for chunk in chunks:
buf.extend(chunk)
transport.write.side_effect = write
transport.writelines.side_effect = writelines
transport.is_closing.return_value = False
return transport
@pytest.fixture
def protocol(loop, transport):
protocol = mock.Mock(transport=transport)
protocol._drain_helper = mock.AsyncMock()
return protocol
def decompress(data: bytes) -> bytes:
d = ZLibBackend.decompressobj()
return d.decompress(data)
def decode_chunked(chunked: Union[bytes, bytearray]) -> bytes:
i = 0
out = b""
while i < len(chunked):
j = chunked.find(b"\r\n", i)
assert j != -1, "Malformed chunk"
size = int(chunked[i:j], 16)
if size == 0:
break
i = j + 2
out += chunked[i : i + size]
i += size + 2 # skip \r\n after the chunk
return out
def test_payloadwriter_properties(transport, protocol, loop) -> None:
writer = http.StreamWriter(protocol, loop)
assert writer.protocol == protocol
assert writer.transport == transport
async def test_write_headers_buffered_small_payload(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
headers = CIMultiDict({"Content-Length": "11", "Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("GET / HTTP/1.1", headers)
assert len(buf) == 0 # Headers not sent yet
# Write small body - should coalesce with headers
await msg.write(b"Hello World", drain=False)
# Verify content
assert b"GET / HTTP/1.1\r\n" in buf
assert b"Host: example.com\r\n" in buf
assert b"Content-Length: 11\r\n" in buf
assert b"\r\n\r\nHello World" in buf
async def test_write_headers_chunked_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
headers = CIMultiDict({"Transfer-Encoding": "chunked", "Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("POST /upload HTTP/1.1", headers)
assert len(buf) == 0 # Headers not sent yet
# Write first chunk - should coalesce with headers
await msg.write(b"First chunk", drain=False)
# Verify content
assert b"POST /upload HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
# "b" is hex for 11 (length of "First chunk")
assert b"\r\n\r\nb\r\nFirst chunk\r\n" in buf
async def test_write_eof_with_buffered_headers(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
headers = CIMultiDict({"Content-Length": "9", "Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Call write_eof with body - should coalesce
await msg.write_eof(b"Last data")
# Verify content
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"\r\n\r\nLast data" in buf
async def test_set_eof_sends_buffered_headers(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
headers = CIMultiDict({"Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("GET /empty HTTP/1.1", headers)
assert len(buf) == 0
# Call set_eof without body - headers should be sent
msg.set_eof()
# Headers should be sent
assert len(buf) > 0
assert b"GET /empty HTTP/1.1\r\n" in buf
async def test_write_payload_eof(
transport: asyncio.Transport,
protocol: BaseProtocol,
loop: asyncio.AbstractEventLoop,
) -> None:
write = transport.write = mock.Mock()
msg = http.StreamWriter(protocol, loop)
await msg.write(b"data1")
await msg.write(b"data2")
await msg.write_eof()
content = b"".join([c[1][0] for c in list(write.mock_calls)])
assert b"data1data2" == content.split(b"\r\n\r\n", 1)[-1]
async def test_write_payload_chunked(buf, protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof()
assert b"4\r\ndata\r\n0\r\n\r\n" == buf
async def test_write_payload_chunked_multiple(buf, protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
await msg.write(b"data1")
await msg.write(b"data2")
await msg.write_eof()
assert b"5\r\ndata1\r\n5\r\ndata2\r\n0\r\n\r\n" == buf
async def test_write_payload_length(protocol, transport, loop) -> None:
write = transport.write = mock.Mock()
msg = http.StreamWriter(protocol, loop)
msg.length = 2
await msg.write(b"d")
await msg.write(b"ata")
await msg.write_eof()
content = b"".join([c[1][0] for c in list(write.mock_calls)])
assert b"da" == content.split(b"\r\n\r\n", 1)[-1]
@pytest.mark.usefixtures("disable_writelines")
@pytest.mark.internal # Used for performance benchmarking
async def test_write_large_payload_deflate_compression_data_in_eof(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data" * 4096)
assert transport.write.called # type: ignore[attr-defined]
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
transport.write.reset_mock() # type: ignore[attr-defined]
# This payload compresses to 20447 bytes
payload = b"".join(
[bytes((*range(0, i), *range(i, 0, -1))) for i in range(255) for _ in range(64)]
)
await msg.write_eof(payload)
chunks.extend([c[1][0] for c in list(transport.write.mock_calls)]) # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert zlib.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("disable_writelines")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_large_payload_deflate_compression_data_in_eof_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data" * 4096)
# Behavior depends on zlib backend, isal compress() returns b'' initially
# and the entire compressed bytes at flush() for this data
backend_to_write_called = {
"isal.isal_zlib": False,
"zlib": True,
"zlib_ng.zlib_ng": True,
}
assert transport.write.called == backend_to_write_called[ZLibBackend.name] # type: ignore[attr-defined]
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
transport.write.reset_mock() # type: ignore[attr-defined]
# This payload compresses to 20447 bytes
payload = b"".join(
[bytes((*range(0, i), *range(i, 0, -1))) for i in range(255) for _ in range(64)]
)
await msg.write_eof(payload)
chunks.extend([c[1][0] for c in list(transport.write.mock_calls)]) # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert ZLibBackend.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.internal # Used for performance benchmarking
async def test_write_large_payload_deflate_compression_data_in_eof_writelines(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data" * 4096)
assert transport.write.called # type: ignore[attr-defined]
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
transport.write.reset_mock() # type: ignore[attr-defined]
assert not transport.writelines.called # type: ignore[attr-defined]
# This payload compresses to 20447 bytes
payload = b"".join(
[bytes((*range(0, i), *range(i, 0, -1))) for i in range(255) for _ in range(64)]
)
await msg.write_eof(payload)
assert not transport.write.called # type: ignore[attr-defined]
assert transport.writelines.called # type: ignore[attr-defined]
chunks.extend(transport.writelines.mock_calls[0][1][0]) # type: ignore[attr-defined]
content = b"".join(chunks)
assert zlib.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_large_payload_deflate_compression_data_in_eof_writelines_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data" * 4096)
# Behavior depends on zlib backend, isal compress() returns b'' initially
# and the entire compressed bytes at flush() for this data
backend_to_write_called = {
"isal.isal_zlib": False,
"zlib": True,
"zlib_ng.zlib_ng": True,
}
assert transport.write.called == backend_to_write_called[ZLibBackend.name] # type: ignore[attr-defined]
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
transport.write.reset_mock() # type: ignore[attr-defined]
assert not transport.writelines.called # type: ignore[attr-defined]
# This payload compresses to 20447 bytes
payload = b"".join(
[bytes((*range(0, i), *range(i, 0, -1))) for i in range(255) for _ in range(64)]
)
await msg.write_eof(payload)
assert transport.writelines.called != transport.write.called # type: ignore[attr-defined]
if transport.writelines.called: # type: ignore[attr-defined]
chunks.extend(transport.writelines.mock_calls[0][1][0]) # type: ignore[attr-defined]
else: # transport.write.called: # type: ignore[attr-defined]
chunks.extend([c[1][0] for c in list(transport.write.mock_calls)]) # type: ignore[attr-defined]
content = b"".join(chunks)
assert ZLibBackend.decompress(content) == (b"data" * 4096) + payload
async def test_write_payload_chunked_filter(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
await msg.write(b"da")
await msg.write(b"ta")
await msg.write_eof()
content = b"".join([b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)]) # type: ignore[attr-defined]
content += b"".join([c[1][0] for c in list(transport.write.mock_calls)]) # type: ignore[attr-defined]
assert content.endswith(b"2\r\nda\r\n2\r\nta\r\n0\r\n\r\n")
async def test_write_payload_chunked_filter_multiple_chunks(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
await msg.write(b"da")
await msg.write(b"ta")
await msg.write(b"1d")
await msg.write(b"at")
await msg.write(b"a2")
await msg.write_eof()
content = b"".join([b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)]) # type: ignore[attr-defined]
content += b"".join([c[1][0] for c in list(transport.write.mock_calls)]) # type: ignore[attr-defined]
assert content.endswith(
b"2\r\nda\r\n2\r\nta\r\n2\r\n1d\r\n2\r\nat\r\n2\r\na2\r\n0\r\n\r\n"
)
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression(protocol, transport, loop) -> None:
COMPRESSED = b"x\x9cKI,I\x04\x00\x04\x00\x01\x9b"
write = transport.write = mock.Mock()
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data")
await msg.write_eof()
chunks = [c[1][0] for c in list(write.mock_calls)]
assert all(chunks)
content = b"".join(chunks)
assert COMPRESSED == content.split(b"\r\n\r\n", 1)[-1]
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write(b"data")
await msg.write_eof()
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert b"data" == decompress(content)
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression_chunked(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
expected = b"2\r\nx\x9c\r\na\r\nKI,I\x04\x00\x04\x00\x01\x9b\r\n0\r\n\r\n"
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof()
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert content == expected
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_chunked_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof()
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert b"data" == decompress(decode_chunked(content))
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression_chunked_writelines(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
expected = b"2\r\nx\x9c\r\na\r\nKI,I\x04\x00\x04\x00\x01\x9b\r\n0\r\n\r\n"
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof()
chunks = [b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert content == expected
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_chunked_writelines_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof()
chunks = [b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert b"data" == decompress(decode_chunked(content))
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_and_chunked(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"da")
await msg.write(b"ta")
await msg.write_eof()
thing = b"2\r\nx\x9c\r\na\r\nKI,I\x04\x00\x04\x00\x01\x9b\r\n0\r\n\r\n"
assert thing == buf
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_and_chunked_all_zlib(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"da")
await msg.write(b"ta")
await msg.write_eof()
assert b"data" == decompress(decode_chunked(buf))
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression_chunked_data_in_eof(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
expected = b"2\r\nx\x9c\r\nd\r\nKI,IL\xcdK\x01\x00\x0b@\x02\xd2\r\n0\r\n\r\n"
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof(b"end")
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert content == expected
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_chunked_data_in_eof_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof(b"end")
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert b"dataend" == decompress(decode_chunked(content))
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression_chunked_data_in_eof_writelines(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
expected = b"2\r\nx\x9c\r\nd\r\nKI,IL\xcdK\x01\x00\x0b@\x02\xd2\r\n0\r\n\r\n"
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof(b"end")
chunks = [b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert content == expected
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_chunked_data_in_eof_writelines_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
await msg.write_eof(b"end")
chunks = [b"".join(c[1][0]) for c in list(transport.writelines.mock_calls)] # type: ignore[attr-defined]
assert all(chunks)
content = b"".join(chunks)
assert b"dataend" == decompress(decode_chunked(content))
@pytest.mark.internal # Used for performance benchmarking
async def test_write_large_payload_deflate_compression_chunked_data_in_eof(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data" * 4096)
# This payload compresses to 1111 bytes
payload = b"".join([bytes((*range(0, i), *range(i, 0, -1))) for i in range(255)])
await msg.write_eof(payload)
compressed = []
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
chunked_body = b"".join(chunks)
split_body = chunked_body.split(b"\r\n")
while split_body:
if split_body.pop(0):
compressed.append(split_body.pop(0))
content = b"".join(compressed)
assert zlib.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_large_payload_deflate_compression_chunked_data_in_eof_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data" * 4096)
# This payload compresses to 1111 bytes
payload = b"".join([bytes((*range(0, i), *range(i, 0, -1))) for i in range(255)])
await msg.write_eof(payload)
compressed = []
chunks = [c[1][0] for c in list(transport.write.mock_calls)] # type: ignore[attr-defined]
chunked_body = b"".join(chunks)
split_body = chunked_body.split(b"\r\n")
while split_body:
if split_body.pop(0):
compressed.append(split_body.pop(0))
content = b"".join(compressed)
assert ZLibBackend.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.internal # Used for performance benchmarking
async def test_write_large_payload_deflate_compression_chunked_data_in_eof_writelines(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data" * 4096)
# This payload compresses to 1111 bytes
payload = b"".join([bytes((*range(0, i), *range(i, 0, -1))) for i in range(255)])
await msg.write_eof(payload)
assert not transport.write.called # type: ignore[attr-defined]
chunks = []
for write_lines_call in transport.writelines.mock_calls: # type: ignore[attr-defined]
chunked_payload = list(write_lines_call[1][0])[1:]
chunked_payload.pop()
chunks.extend(chunked_payload)
assert all(chunks)
content = b"".join(chunks)
assert zlib.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_large_payload_deflate_compression_chunked_data_in_eof_writelines_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data" * 4096)
# This payload compresses to 1111 bytes
payload = b"".join([bytes((*range(0, i), *range(i, 0, -1))) for i in range(255)])
await msg.write_eof(payload)
assert not transport.write.called # type: ignore[attr-defined]
chunks = []
for write_lines_call in transport.writelines.mock_calls: # type: ignore[attr-defined]
chunked_payload = list(write_lines_call[1][0])[1:]
chunked_payload.pop()
chunks.extend(chunked_payload)
assert all(chunks)
content = b"".join(chunks)
assert ZLibBackend.decompress(content) == (b"data" * 4096) + payload
@pytest.mark.internal # Used for performance benchmarking
async def test_write_payload_deflate_compression_chunked_connection_lost(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
with (
pytest.raises(
ClientConnectionResetError, match="Cannot write to closing transport"
),
mock.patch.object(transport, "is_closing", return_value=True),
):
await msg.write_eof(b"end")
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_write_payload_deflate_compression_chunked_connection_lost_all_zlib(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
await msg.write(b"data")
with (
pytest.raises(
ClientConnectionResetError, match="Cannot write to closing transport"
),
mock.patch.object(transport, "is_closing", return_value=True),
):
await msg.write_eof(b"end")
async def test_write_payload_bytes_memoryview(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
mv = memoryview(b"abcd")
await msg.write(mv)
await msg.write_eof()
thing = b"abcd"
assert thing == buf
async def test_write_payload_short_ints_memoryview(buf, protocol, transport, loop):
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
payload = memoryview(array.array("H", [65, 66, 67]))
await msg.write(payload)
await msg.write_eof()
endians = (
(b"6\r\n\x00A\x00B\x00C\r\n0\r\n\r\n"),
(b"6\r\nA\x00B\x00C\x00\r\n0\r\n\r\n"),
)
assert buf in endians
async def test_write_payload_2d_shape_memoryview(buf, protocol, transport, loop):
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
mv = memoryview(b"ABCDEF")
payload = mv.cast("c", [3, 2])
await msg.write(payload)
await msg.write_eof()
thing = b"6\r\nABCDEF\r\n0\r\n\r\n"
assert thing == buf
async def test_write_payload_slicing_long_memoryview(buf, protocol, transport, loop):
msg = http.StreamWriter(protocol, loop)
msg.length = 4
mv = memoryview(b"ABCDEF")
payload = mv.cast("c", [3, 2])
await msg.write(payload)
await msg.write_eof()
thing = b"ABCD"
assert thing == buf
async def test_write_drain(protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
msg.drain = mock.AsyncMock()
await msg.write(b"1" * (64 * 1024 * 2), drain=False)
assert not msg.drain.called
await msg.write(b"1", drain=True)
assert msg.drain.called
assert msg.buffer_size == 0
async def test_write_calls_callback(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
on_chunk_sent = mock.AsyncMock()
msg = http.StreamWriter(protocol, loop, on_chunk_sent=on_chunk_sent)
chunk = b"1"
await msg.write(chunk)
assert on_chunk_sent.called
assert on_chunk_sent.call_args == mock.call(chunk)
async def test_write_eof_calls_callback(
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
on_chunk_sent = mock.AsyncMock()
msg = http.StreamWriter(protocol, loop, on_chunk_sent=on_chunk_sent)
chunk = b"1"
await msg.write_eof(chunk=chunk)
assert on_chunk_sent.called
assert on_chunk_sent.call_args == mock.call(chunk)
async def test_write_to_closing_transport(protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
await msg.write(b"Before closing")
transport.is_closing.return_value = True
with pytest.raises(ClientConnectionResetError):
await msg.write(b"After closing")
async def test_write_to_closed_transport(protocol, transport, loop) -> None:
"""Test that writing to a closed transport raises ClientConnectionResetError.
The StreamWriter checks to see if protocol.transport is None before
writing to the transport. If it is None, it raises ConnectionResetError.
"""
msg = http.StreamWriter(protocol, loop)
await msg.write(b"Before transport close")
protocol.transport = None
with pytest.raises(
ClientConnectionResetError, match="Cannot write to closing transport"
):
await msg.write(b"After transport closed")
async def test_drain(protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
await msg.drain()
assert protocol._drain_helper.called
async def test_drain_no_transport(protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
msg._protocol.transport = None
await msg.drain()
assert not protocol._drain_helper.called
async def test_write_headers_prevents_injection(protocol, transport, loop) -> None:
msg = http.StreamWriter(protocol, loop)
status_line = "HTTP/1.1 200 OK"
wrong_headers = CIMultiDict({"Set-Cookie: abc=123\r\nContent-Length": "256"})
with pytest.raises(ValueError):
await msg.write_headers(status_line, wrong_headers)
wrong_headers = CIMultiDict({"Content-Length": "256\r\nSet-Cookie: abc=123"})
with pytest.raises(ValueError):
await msg.write_headers(status_line, wrong_headers)
async def test_set_eof_after_write_headers(
protocol: BaseProtocol,
transport: mock.Mock,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
status_line = "HTTP/1.1 200 OK"
good_headers = CIMultiDict({"Set-Cookie": "abc=123"})
# Write headers - should be buffered
await msg.write_headers(status_line, good_headers)
assert not transport.write.called # Headers are buffered
# set_eof should send the buffered headers
msg.set_eof()
assert transport.write.called
# Subsequent write_eof should do nothing
transport.write.reset_mock()
await msg.write_eof()
assert not transport.write.called
async def test_write_headers_does_not_write_immediately(
protocol: BaseProtocol,
transport: mock.Mock,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
status_line = "HTTP/1.1 200 OK"
headers = CIMultiDict({"Content-Type": "text/plain"})
# write_headers should buffer, not write immediately
await msg.write_headers(status_line, headers)
assert not transport.write.called
assert not transport.writelines.called
# Headers should be sent when set_eof is called
msg.set_eof()
assert transport.write.called
async def test_write_headers_with_compression_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
headers = CIMultiDict({"Content-Encoding": "deflate", "Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Write compressed data via write_eof - should coalesce
await msg.write_eof(b"Hello World")
# Verify headers are present
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"Content-Encoding: deflate\r\n" in buf
# Verify compressed data is present
# The data should contain headers + compressed payload
assert len(buf) > 50 # Should have headers + some compressed data
@pytest.mark.parametrize(
"char",
[
"\n",
"\r",
],
)
def test_serialize_headers_raises_on_new_line_or_carriage_return(char: str) -> None:
"""Verify serialize_headers raises on cr or nl in the headers."""
status_line = "HTTP/1.1 200 OK"
headers = CIMultiDict(
{
hdrs.CONTENT_TYPE: f"text/plain{char}",
}
)
with pytest.raises(
ValueError,
match=(
"Newline or carriage return detected in headers. "
"Potential header injection attack."
),
):
_serialize_headers(status_line, headers)
async def test_write_compressed_data_with_headers_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that headers are coalesced with compressed data in write() method."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
headers = CIMultiDict({"Content-Encoding": "deflate", "Host": "example.com"})
# Write headers - should be buffered
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Write compressed data - should coalesce with headers
await msg.write(b"Hello World")
# Headers and compressed data should be written together
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"Content-Encoding: deflate\r\n" in buf
assert len(buf) > 50 # Headers + compressed data
async def test_write_compressed_chunked_with_headers_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test headers coalescing with compressed chunked data."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
headers = CIMultiDict(
{"Content-Encoding": "deflate", "Transfer-Encoding": "chunked"}
)
# Write headers - should be buffered
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Write compressed chunked data - should coalesce
await msg.write(b"Hello World")
# Check headers are present
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
# Should have chunk size marker for compressed data
output = buf.decode("latin-1", errors="ignore")
assert "\r\n" in output # Should have chunk markers
async def test_write_multiple_compressed_chunks_after_headers_sent(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test multiple compressed writes after headers are already sent."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
headers = CIMultiDict({"Content-Encoding": "deflate"})
# Write headers and send them immediately by writing first chunk
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0 # Headers buffered
# Write first chunk - this will send headers + compressed data
await msg.write(b"First chunk of data that should compress")
len_after_first = len(buf)
assert len_after_first > 0 # Headers + first chunk written
# Write second chunk and force flush via EOF
await msg.write(b"Second chunk of data that should also compress well")
await msg.write_eof()
# After EOF, all compressed data should be flushed
final_len = len(buf)
assert final_len > len_after_first
async def test_write_eof_empty_compressed_with_buffered_headers(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test write_eof with no data but compression enabled and buffered headers."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
headers = CIMultiDict({"Content-Encoding": "deflate"})
# Write headers - should be buffered
await msg.write_headers("GET /data HTTP/1.1", headers)
assert len(buf) == 0
# Write EOF with no data - should still coalesce headers with compression flush
await msg.write_eof()
# Headers should be present
assert b"GET /data HTTP/1.1\r\n" in buf
assert b"Content-Encoding: deflate\r\n" in buf
# Should have compression flush data
assert len(buf) > 40
async def test_write_compressed_gzip_with_headers_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test gzip compression with header coalescing."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("gzip")
headers = CIMultiDict({"Content-Encoding": "gzip"})
# Write headers - should be buffered
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Write gzip compressed data via write_eof
await msg.write_eof(b"Test gzip compression")
# Verify coalescing happened
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"Content-Encoding: gzip\r\n" in buf
# Gzip typically produces more overhead than deflate
assert len(buf) > 60
async def test_compression_with_content_length_constraint(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test compression respects content length constraints."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.length = 5 # Set small content length
headers = CIMultiDict({"Content-Length": "5"})
await msg.write_headers("POST /data HTTP/1.1", headers)
# Write some initial data to trigger headers to be sent
await msg.write(b"12345") # This matches our content length of 5
headers_and_first_chunk_len = len(buf)
# Try to write more data than content length allows
await msg.write(b"This is a longer message")
# The second write should not add any data since content length is exhausted
# After writing 5 bytes, length becomes 0, so additional writes are ignored
assert len(buf) == headers_and_first_chunk_len # No additional data written
async def test_write_compressed_zero_length_chunk(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test writing empty chunk with compression."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
await msg.write_headers("POST /data HTTP/1.1", CIMultiDict())
# Force headers to be sent by writing something
await msg.write(b"x") # Write something to trigger header send
buf.clear()
# Write empty chunk - compression may still produce output
await msg.write(b"")
# With compression, even empty input might produce small output
# due to compression state, but it should be minimal
assert len(buf) < 10 # Should be very small if anything
async def test_chunked_compressed_eof_coalescing(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test chunked compressed data with EOF marker coalescing."""
msg = http.StreamWriter(protocol, loop)
msg.enable_compression("deflate")
msg.enable_chunking()
headers = CIMultiDict(
{"Content-Encoding": "deflate", "Transfer-Encoding": "chunked"}
)
# Buffer headers
await msg.write_headers("POST /data HTTP/1.1", headers)
assert len(buf) == 0
# Write compressed chunked data with EOF
await msg.write_eof(b"Final compressed chunk")
# Should have headers
assert b"POST /data HTTP/1.1\r\n" in buf
# Should end with chunked EOF marker
assert buf.endswith(b"0\r\n\r\n")
# Should have chunk size in hex before the compressed data
output = buf
# Verify we have chunk markers - look for \r\n followed by hex digits
# The chunk size should be between the headers and the compressed data
assert b"\r\n\r\n" in output # End of headers
# After headers, we should have a hex chunk size
headers_end = output.find(b"\r\n\r\n") + 4
chunk_data = output[headers_end:]
# Should start with hex digits followed by \r\n
assert (
chunk_data[:10]
.strip()
.decode("ascii", errors="ignore")
.replace("\r\n", "")
.isalnum()
)
async def test_compression_different_strategies(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test compression with different strategies."""
# Test with best speed strategy (default)
msg1 = http.StreamWriter(protocol, loop)
msg1.enable_compression("deflate") # Default strategy
await msg1.write_headers("POST /fast HTTP/1.1", CIMultiDict())
await msg1.write_eof(b"Test data for compression test data for compression")
buf1_len = len(buf)
# Both should produce output
assert buf1_len > 0
# Headers should be present
assert b"POST /fast HTTP/1.1\r\n" in buf
# Since we can't easily test different compression strategies
# (the compressor initialization might not support strategy parameter),
# we just verify that compression works
async def test_chunked_headers_single_write_with_set_eof(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that set_eof combines headers and chunked EOF in single write."""
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
# Write headers - should be buffered
headers = CIMultiDict({"Transfer-Encoding": "chunked", "Host": "example.com"})
await msg.write_headers("GET /test HTTP/1.1", headers)
assert len(buf) == 0 # Headers not sent yet
assert not transport.writelines.called # type: ignore[attr-defined] # No writelines calls yet
# Call set_eof - should send headers + chunked EOF in single write call
msg.set_eof()
# Should have exactly one write call (since payload is small, writelines falls back to write)
assert transport.write.call_count == 1 # type: ignore[attr-defined]
assert transport.writelines.call_count == 0 # type: ignore[attr-defined] # Not called for small payloads
# The write call should have the combined headers and chunked EOF marker
write_data = transport.write.call_args[0][0] # type: ignore[attr-defined]
assert write_data.startswith(b"GET /test HTTP/1.1\r\n")
assert b"Transfer-Encoding: chunked\r\n" in write_data
assert write_data.endswith(b"\r\n\r\n0\r\n\r\n") # Headers end + chunked EOF
# Verify final output
assert b"GET /test HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
assert buf.endswith(b"0\r\n\r\n")
async def test_send_headers_forces_header_write(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that send_headers() forces writing buffered headers."""
msg = http.StreamWriter(protocol, loop)
headers = CIMultiDict({"Content-Length": "10", "Host": "example.com"})
# Write headers (should be buffered)
await msg.write_headers("GET /test HTTP/1.1", headers)
assert len(buf) == 0 # Headers buffered
# Force send headers
msg.send_headers()
# Headers should now be written
assert b"GET /test HTTP/1.1\r\n" in buf
assert b"Content-Length: 10\r\n" in buf
assert b"Host: example.com\r\n" in buf
# Writing body should not resend headers
buf.clear()
await msg.write(b"0123456789")
assert b"GET /test" not in buf # Headers not repeated
assert buf == b"0123456789" # Just the body
async def test_send_headers_idempotent(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that send_headers() is idempotent and safe to call multiple times."""
msg = http.StreamWriter(protocol, loop)
headers = CIMultiDict({"Content-Length": "5", "Host": "example.com"})
# Write headers (should be buffered)
await msg.write_headers("GET /test HTTP/1.1", headers)
assert len(buf) == 0 # Headers buffered
# Force send headers
msg.send_headers()
headers_output = bytes(buf)
# Call send_headers again - should be no-op
msg.send_headers()
assert buf == headers_output # No additional output
# Call send_headers after headers already sent - should be no-op
await msg.write(b"hello")
msg.send_headers()
assert buf[len(headers_output) :] == b"hello" # Only body added
async def test_send_headers_no_buffered_headers(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that send_headers() is safe when no headers are buffered."""
msg = http.StreamWriter(protocol, loop)
# Call send_headers without writing headers first
msg.send_headers() # Should not crash
assert len(buf) == 0 # No output
async def test_write_drain_condition_with_small_buffer(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that drain is not called when buffer_size <= LIMIT."""
msg = http.StreamWriter(protocol, loop)
# Write headers first
await msg.write_headers("GET /test HTTP/1.1", CIMultiDict())
msg.send_headers() # Send headers to start with clean state
# Reset buffer size manually since send_headers doesn't do it
msg.buffer_size = 0
# Reset drain helper mock
protocol._drain_helper.reset_mock() # type: ignore[attr-defined]
# Write small amount of data with drain=True but buffer under limit
small_data = b"x" * 100 # Much less than LIMIT (2**16)
await msg.write(small_data, drain=True)
# Drain should NOT be called because buffer_size <= LIMIT
assert not protocol._drain_helper.called # type: ignore[attr-defined]
assert msg.buffer_size == 100
assert small_data in buf
async def test_write_drain_condition_with_large_buffer(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that drain is called only when drain=True AND buffer_size > LIMIT."""
msg = http.StreamWriter(protocol, loop)
# Write headers first
await msg.write_headers("GET /test HTTP/1.1", CIMultiDict())
msg.send_headers() # Send headers to start with clean state
# Reset buffer size manually since send_headers doesn't do it
msg.buffer_size = 0
# Reset drain helper mock
protocol._drain_helper.reset_mock() # type: ignore[attr-defined]
# Write large amount of data with drain=True
large_data = b"x" * (2**16 + 1) # Just over LIMIT
await msg.write(large_data, drain=True)
# Drain should be called because drain=True AND buffer_size > LIMIT
assert protocol._drain_helper.called # type: ignore[attr-defined]
assert msg.buffer_size == 0 # Buffer reset after drain
assert large_data in buf
async def test_write_no_drain_with_large_buffer(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that drain is not called when drain=False even with large buffer."""
msg = http.StreamWriter(protocol, loop)
# Write headers first
await msg.write_headers("GET /test HTTP/1.1", CIMultiDict())
msg.send_headers() # Send headers to start with clean state
# Reset buffer size manually since send_headers doesn't do it
msg.buffer_size = 0
# Reset drain helper mock
protocol._drain_helper.reset_mock() # type: ignore[attr-defined]
# Write large amount of data with drain=False
large_data = b"x" * (2**16 + 1) # Just over LIMIT
await msg.write(large_data, drain=False)
# Drain should NOT be called because drain=False
assert not protocol._drain_helper.called # type: ignore[attr-defined]
assert msg.buffer_size == (2**16 + 1) # Buffer not reset
assert large_data in buf
async def test_set_eof_idempotent(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test that set_eof() is idempotent and can be called multiple times safely."""
msg = http.StreamWriter(protocol, loop)
# Test 1: Multiple set_eof calls with buffered headers
headers = CIMultiDict({"Content-Length": "0"})
await msg.write_headers("GET /test HTTP/1.1", headers)
# First set_eof should send headers
msg.set_eof()
first_output = buf
assert b"GET /test HTTP/1.1\r\n" in first_output
assert b"Content-Length: 0\r\n" in first_output
# Second set_eof should be no-op
msg.set_eof()
assert bytes(buf) == first_output # No additional output
# Third set_eof should also be no-op
msg.set_eof()
assert bytes(buf) == first_output # Still no additional output
# Test 2: set_eof with chunked encoding
buf.clear()
msg2 = http.StreamWriter(protocol, loop)
msg2.enable_chunking()
headers2 = CIMultiDict({"Transfer-Encoding": "chunked"})
await msg2.write_headers("POST /data HTTP/1.1", headers2)
# First set_eof should send headers + chunked EOF
msg2.set_eof()
chunked_output = buf
assert b"POST /data HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
assert b"0\r\n\r\n" in buf # Chunked EOF marker
# Second set_eof should be no-op
msg2.set_eof()
assert buf == chunked_output # No additional output
# Test 3: set_eof after headers already sent
buf.clear()
msg3 = http.StreamWriter(protocol, loop)
headers3 = CIMultiDict({"Content-Length": "5"})
await msg3.write_headers("PUT /update HTTP/1.1", headers3)
# Send headers by writing some data
await msg3.write(b"hello")
headers_and_body = buf
# set_eof after headers sent should be no-op
msg3.set_eof()
assert buf == headers_and_body # No additional output
# Another set_eof should still be no-op
msg3.set_eof()
assert buf == headers_and_body # Still no additional output
async def test_non_chunked_write_empty_body(
buf: bytearray,
protocol: BaseProtocol,
transport: mock.Mock,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test non-chunked response with empty body."""
msg = http.StreamWriter(protocol, loop)
# Non-chunked response with Content-Length: 0
headers = CIMultiDict({"Content-Length": "0"})
await msg.write_headers("GET /empty HTTP/1.1", headers)
# Write empty body
await msg.write(b"")
# Check the output
assert b"GET /empty HTTP/1.1\r\n" in buf
assert b"Content-Length: 0\r\n" in buf
async def test_chunked_headers_sent_with_empty_chunk_not_eof(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test chunked encoding where headers are sent without data and not EOF."""
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
headers = CIMultiDict({"Transfer-Encoding": "chunked"})
await msg.write_headers("POST /upload HTTP/1.1", headers)
# This should trigger the else case in _send_headers_with_payload
# by having no chunk data and is_eof=False
await msg.write(b"")
# Headers should be sent alone
assert b"POST /upload HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
# Should not have any chunk markers yet
assert b"0\r\n" not in buf
async def test_chunked_set_eof_after_headers_sent(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test chunked encoding where set_eof is called after headers already sent."""
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
headers = CIMultiDict({"Transfer-Encoding": "chunked"})
await msg.write_headers("POST /data HTTP/1.1", headers)
# Send headers by writing some data
await msg.write(b"test data")
buf.clear() # Clear buffer to check only what set_eof writes
# This should trigger writing chunked EOF when headers already sent
msg.set_eof()
# Should only have the chunked EOF marker
assert buf == b"0\r\n\r\n"
@pytest.mark.usefixtures("enable_writelines")
@pytest.mark.usefixtures("force_writelines_small_payloads")
async def test_write_eof_chunked_with_data_using_writelines(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test write_eof with chunked data that uses writelines (line 336)."""
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
headers = CIMultiDict({"Transfer-Encoding": "chunked"})
await msg.write_headers("POST /data HTTP/1.1", headers)
# Send headers first
await msg.write(b"initial")
transport.writelines.reset_mock() # type: ignore[attr-defined]
# This should trigger writelines for final chunk with EOF
await msg.write_eof(b"final chunk data")
# Should have used writelines
assert transport.writelines.called # type: ignore[attr-defined]
# Get the data from writelines call
writelines_data = transport.writelines.call_args[0][0] # type: ignore[attr-defined]
combined = b"".join(writelines_data)
# Should have chunk size, data, and EOF marker
assert b"10\r\n" in combined # hex for 16 (length of "final chunk data")
assert b"final chunk data" in combined
assert b"0\r\n\r\n" in combined
async def test_send_headers_with_payload_chunked_eof_no_data(
buf: bytearray,
protocol: BaseProtocol,
transport: asyncio.Transport,
loop: asyncio.AbstractEventLoop,
) -> None:
"""Test _send_headers_with_payload with chunked, is_eof=True but no chunk data."""
msg = http.StreamWriter(protocol, loop)
msg.enable_chunking()
headers = CIMultiDict({"Transfer-Encoding": "chunked"})
await msg.write_headers("GET /test HTTP/1.1", headers)
# This triggers the elif is_eof branch in _send_headers_with_payload
# by calling write_eof with empty chunk
await msg.write_eof(b"")
# Should have headers and chunked EOF marker together
assert b"GET /test HTTP/1.1\r\n" in buf
assert b"Transfer-Encoding: chunked\r\n" in buf
assert buf.endswith(b"0\r\n\r\n")
|