Repository navigation
Commit d943237
authored
fix: long partitions behind a NAT idle timeout never return (#359)
## What
Partition requests that take longer than a few minutes now return their
response when the client is behind a NAT or load balancer that drops
idle connections. The SDK's own HTTP clients now send TCP keepalive
probes while they wait. That covers the default sync and async clients
and the split-PDF client.
```
hi_res partition, response headers after ~5 min, client behind a NAT gateway with a 4 min idle timeout
Before: request sent → no packets for 4 min → NAT drops the flow → response never arrives → ReadTimeout at the full read timeout (900 s)
After: request sent → keepalive probe every 30 s after 60 s idle → flow stays open → 200
```
It is on by default (60 s idle, 30 s interval, 5 probes). It can be
tuned or turned off with `UNSTRUCTURED_CLIENT_TCP_KEEPALIVE`,
`UNSTRUCTURED_CLIENT_TCP_KEEPALIVE_IDLE`,
`UNSTRUCTURED_CLIENT_TCP_KEEPALIVE_INTERVAL` and
`UNSTRUCTURED_CLIENT_TCP_KEEPALIVE_COUNT`. The split-PDF `plan_created`
and `batch_async_start` logs show the setting in use.
## Why
Long-running partition requests can exceed a NAT gateway’s idle timeout,
causing responses to be lost while the client waits for its read
timeout. This change enables TCP keepalive to keep those connections
active.
Neither httpx nor the SDK turns on keepalive, and the OS keepalive
settings only apply to sockets that ask for it. That makes the SDK,
which opens these sockets, the place to fix it.
Unchanged:
- Clients passed in by the caller (`client=` / `async_client=`) are not
modified.
- Proxy routing from `HTTP(S)_PROXY` / `NO_PROXY` works as before.
Connections made through a proxy do not get keepalive, because httpcore
drops socket options for proxied connections.
- If a future httpx release moves the helper used to rebuild proxy
routing, the SDK falls back to building its clients exactly as it did
before this change.
## Validation
- Unit tests (416 passed, on top of 0.46.4), pylint and mypy pass.
- Tests check that real sockets carry `SO_KEEPALIVE` and every idle,
interval and count setting. They also cover the bounds on the
environment values, proxy routing and parity of TLS, limits and
timeouts.
- Docker reproduction with a NAT router that silently drops idle flows
after 20 s, and a server that answers after 45 s:
- with keepalive: `200` at 45 s;
- without keepalive: `ReadTimeout` at 90 s.
- Released as 0.46.5: CHANGELOG entry and `_version.py` bump (0.46.4 is
already published).1 parent 24fadc4 commit d943237
8 files changed
Lines changed: 396 additions & 29 deletions
File tree
- _test_unstructured_client/unit
- src/unstructured_client
- _hooks/custom
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
1 | 6 | | |
2 | 7 | | |
3 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| 9 | + | |
9 | 10 | | |
10 | 11 | | |
11 | 12 | | |
| |||
60 | 61 | | |
61 | 62 | | |
62 | 63 | | |
63 | | - | |
64 | | - | |
65 | | - | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
66 | 67 | | |
67 | 68 | | |
68 | 69 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
498 | 498 | | |
499 | 499 | | |
500 | 500 | | |
501 | | - | |
| 501 | + | |
502 | 502 | | |
503 | | - | |
| 503 | + | |
504 | 504 | | |
505 | | - | |
| 505 | + | |
506 | 506 | | |
507 | 507 | | |
508 | | - | |
509 | | - | |
| 508 | + | |
| 509 | + | |
510 | 510 | | |
511 | 511 | | |
512 | 512 | | |
| |||
622 | 622 | | |
623 | 623 | | |
624 | 624 | | |
625 | | - | |
| 625 | + | |
626 | 626 | | |
627 | 627 | | |
628 | | - | |
629 | | - | |
630 | | - | |
631 | | - | |
| 628 | + | |
632 | 629 | | |
633 | 630 | | |
634 | 631 | | |
635 | 632 | | |
636 | 633 | | |
| 634 | + | |
637 | 635 | | |
638 | 636 | | |
639 | 637 | | |
640 | 638 | | |
641 | | - | |
642 | | - | |
| 639 | + | |
643 | 640 | | |
644 | 641 | | |
645 | 642 | | |
| |||
648 | 645 | | |
649 | 646 | | |
650 | 647 | | |
651 | | - | |
| 648 | + | |
652 | 649 | | |
653 | | - | |
| 650 | + | |
| 651 | + | |
| 652 | + | |
654 | 653 | | |
655 | 654 | | |
656 | 655 | | |
657 | 656 | | |
658 | 657 | | |
659 | | - | |
660 | | - | |
| 658 | + | |
| 659 | + | |
| 660 | + | |
| 661 | + | |
| 662 | + | |
661 | 663 | | |
662 | 664 | | |
663 | 665 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 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 | + | |
0 commit comments