nbreq 0.3.1

Runtime-independent cancellable HTTP client
Documentation
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
use std::sync::atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering};

use crate::atomic::{try_update_u64, try_update_usize};

use crate::Completion;

/// Current or historical pressure on the Engine's bounded resources.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
#[non_exhaustive]
pub struct ResourceMetrics {
    reserved_buffered_body_bytes: usize,
    inflight_requests: usize,
    queued_commands: usize,
    queued_callbacks: usize,
    reserved_stream_queue_bytes: usize,
    inflight_resolutions: usize,
    standalone_tcp_connections: usize,
    reserved_tcp_queue_bytes: usize,
    active_connections: usize,
    idle_connections: usize,
    connection_waiters: usize,
}

impl ResourceMetrics {
    /// Returns buffered HTTP capacity retained or reserved, including spare capacity and staging.
    /// This can remain nonzero after requests complete while callers retain response bodies.
    pub fn reserved_buffered_body_bytes(&self) -> usize {
        self.reserved_buffered_body_bytes
    }

    /// Returns requests that are accepted but not fully released.
    ///
    /// A terminal callback remains inflight until its callback job returns.
    pub fn inflight_requests(&self) -> usize {
        self.inflight_requests
    }

    /// Returns commands currently waiting for the Engine owner.
    pub fn queued_commands(&self) -> usize {
        self.queued_commands
    }

    /// Returns terminal callback jobs waiting for a callback worker or manual dispatch.
    pub fn queued_callbacks(&self) -> usize {
        self.queued_callbacks
    }

    /// Returns bytes reserved against the Engine-wide streaming queue budget.
    pub fn reserved_stream_queue_bytes(&self) -> usize {
        self.reserved_stream_queue_bytes
    }

    /// Returns DNS capacity borrowed by public Resolver operations (when compiled) and hostname
    /// TCP connects that are still in their DNS phase.
    pub fn inflight_resolutions(&self) -> usize {
        self.inflight_resolutions
    }

    /// Returns accepted standalone TCP connects and live connections.
    ///
    /// This occupancy gauge is independent of the finite `tcp_connects_*` attempt counters.
    pub fn standalone_tcp_connections(&self) -> usize {
        self.standalone_tcp_connections
    }

    /// Returns bytes reserved against standalone TCP send and unread-receive queues.
    pub fn reserved_tcp_queue_bytes(&self) -> usize {
        self.reserved_tcp_queue_bytes
    }

    /// Returns native connection-capacity slots, including DNS, connecting, leased, and idle.
    pub fn active_connections(&self) -> usize {
        self.active_connections
    }

    /// Returns native idle connections, or zero when connection metrics are unavailable.
    pub fn idle_connections(&self) -> usize {
        self.idle_connections
    }

    /// Returns native connection-capacity waiters, or zero when connection metrics are unavailable.
    pub fn connection_waiters(&self) -> usize {
        self.connection_waiters
    }
}

/// A payload-free, approximate snapshot of one Engine's lifetime activity and pressure.
///
/// Counters saturate rather than wrap and cannot be reset. Each field is loaded independently, so
/// a snapshot taken while work is progressing may be cross-field inconsistent.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
#[non_exhaustive]
pub struct EngineMetrics {
    connection_metrics_available: bool,
    requests_accepted: u64,
    requests_completed: u64,
    requests_failed: u64,
    requests_cancelled: u64,
    connections_opened: u64,
    connections_reused: u64,
    connections_closed: u64,
    idle_connections_evicted: u64,
    resolutions_accepted: u64,
    resolutions_completed: u64,
    resolutions_failed: u64,
    resolutions_cancelled: u64,
    tcp_connects_accepted: u64,
    tcp_connects_completed: u64,
    tcp_connects_failed: u64,
    tcp_connects_cancelled: u64,
    current: ResourceMetrics,
    high_water: ResourceMetrics,
}

impl EngineMetrics {
    pub(crate) fn with_body_budget(mut self, used: usize, peak: usize) -> Self {
        self.current.reserved_buffered_body_bytes = used;
        self.high_water.reserved_buffered_body_bytes = peak;
        self
    }
    /// Reports whether this Engine owns and measures physical connection/pool lifecycles.
    ///
    /// When false, connection counters and connection-specific gauges remain zero because the
    /// selected backend does not expose trustworthy physical connection events. Request and queue
    /// metrics remain available.
    pub fn connection_metrics_available(&self) -> bool {
        self.connection_metrics_available
    }

    /// Returns the number of requests accepted during this Engine's lifetime.
    pub fn requests_accepted(&self) -> u64 {
        self.requests_accepted
    }

    /// Returns accepted requests whose canonical terminal outcome was a response.
    pub fn requests_completed(&self) -> u64 {
        self.requests_completed
    }

    /// Returns accepted requests whose canonical terminal outcome was failure.
    pub fn requests_failed(&self) -> u64 {
        self.requests_failed
    }

    /// Returns accepted requests whose canonical terminal outcome was cancellation.
    pub fn requests_cancelled(&self) -> u64 {
        self.requests_cancelled
    }

    /// Returns native connection-capacity lifecycles begun.
    ///
    /// A lifecycle starts when DNS/connect capacity is reserved, before a socket necessarily
    /// reaches the connected state, and ends when that reservation is released.
    pub fn connections_opened(&self) -> u64 {
        self.connections_opened
    }

    /// Returns native connection-pool reuses, or zero when connection metrics are unavailable.
    pub fn connections_reused(&self) -> u64 {
        self.connections_reused
    }

    /// Returns native connection-capacity lifecycles released.
    pub fn connections_closed(&self) -> u64 {
        self.connections_closed
    }

    /// Returns native idle evictions, or zero when connection metrics are unavailable.
    pub fn idle_connections_evicted(&self) -> u64 {
        self.idle_connections_evicted
    }

    /// Returns public resolutions accepted during this Engine's lifetime.
    pub fn resolutions_accepted(&self) -> u64 {
        self.resolutions_accepted
    }

    /// Returns accepted public resolutions whose terminal outcome was a DNS exchange.
    pub fn resolutions_completed(&self) -> u64 {
        self.resolutions_completed
    }

    /// Returns accepted public resolutions whose terminal outcome was failure.
    pub fn resolutions_failed(&self) -> u64 {
        self.resolutions_failed
    }

    /// Returns accepted public resolutions whose terminal outcome was cancellation.
    pub fn resolutions_cancelled(&self) -> u64 {
        self.resolutions_cancelled
    }

    /// Returns accepted standalone TCP connect operations during this Engine's lifetime.
    ///
    /// These counters track finite connect attempts. Live occupancy and in-flight connects are
    /// [`ResourceMetrics::standalone_tcp_connections`].
    pub fn tcp_connects_accepted(&self) -> u64 {
        self.tcp_connects_accepted
    }

    /// Returns accepted standalone TCP connects whose terminal outcome was a live connection.
    pub fn tcp_connects_completed(&self) -> u64 {
        self.tcp_connects_completed
    }

    /// Returns accepted standalone TCP connects whose terminal outcome was failure.
    pub fn tcp_connects_failed(&self) -> u64 {
        self.tcp_connects_failed
    }

    /// Returns accepted standalone TCP connects whose terminal outcome was cancellation.
    pub fn tcp_connects_cancelled(&self) -> u64 {
        self.tcp_connects_cancelled
    }

    /// Returns the current bounded-resource snapshot.
    pub fn current(&self) -> ResourceMetrics {
        self.current
    }

    /// Returns lifetime high-water marks for bounded resources.
    pub fn high_water(&self) -> ResourceMetrics {
        self.high_water
    }
}

#[derive(Default)]
pub(crate) struct Metrics {
    connection_metrics_available: AtomicBool,
    requests_accepted: AtomicU64,
    requests_completed: AtomicU64,
    requests_failed: AtomicU64,
    requests_cancelled: AtomicU64,
    connections_opened: AtomicU64,
    connections_reused: AtomicU64,
    connections_closed: AtomicU64,
    idle_connections_evicted: AtomicU64,
    resolutions_accepted: AtomicU64,
    resolutions_completed: AtomicU64,
    resolutions_failed: AtomicU64,
    resolutions_cancelled: AtomicU64,
    tcp_connects_accepted: AtomicU64,
    tcp_connects_completed: AtomicU64,
    tcp_connects_failed: AtomicU64,
    tcp_connects_cancelled: AtomicU64,
    queued_commands: AtomicUsize,
    queued_callbacks: AtomicUsize,
    active_connections: AtomicUsize,
    idle_connections: AtomicUsize,
    connection_waiters: AtomicUsize,
    high_inflight_requests: AtomicUsize,
    high_queued_commands: AtomicUsize,
    high_queued_callbacks: AtomicUsize,
    high_reserved_stream_queue_bytes: AtomicUsize,
    #[allow(dead_code)]
    // Gauge is sourced from Shared; the atomic is reserved for future snapshots.
    inflight_resolutions: AtomicUsize,
    standalone_tcp_connections: AtomicUsize,
    reserved_tcp_queue_bytes: AtomicUsize,
    high_inflight_resolutions: AtomicUsize,
    high_standalone_tcp_connections: AtomicUsize,
    high_reserved_tcp_queue_bytes: AtomicUsize,
    high_active_connections: AtomicUsize,
    high_idle_connections: AtomicUsize,
    high_connection_waiters: AtomicUsize,
}

impl Metrics {
    pub(crate) fn enable_connection_metrics(&self) {
        self.connection_metrics_available
            .store(true, Ordering::Release);
    }

    pub(crate) fn request_accepted(&self, inflight: usize, stream_bytes: usize) {
        saturating_increment(&self.requests_accepted);
        update_max(&self.high_inflight_requests, inflight);
        update_max(&self.high_reserved_stream_queue_bytes, stream_bytes);
    }

    pub(crate) fn request_terminal(&self, completion: &Completion) {
        match completion {
            Completion::Completed(_) => saturating_increment(&self.requests_completed),
            Completion::Failed(_) => saturating_increment(&self.requests_failed),
            Completion::Cancelled => saturating_increment(&self.requests_cancelled),
        }
    }

    #[cfg(feature = "resolver")]
    pub(crate) fn resolution_accepted(&self, inflight: usize) {
        saturating_increment(&self.resolutions_accepted);
        update_max(&self.high_inflight_resolutions, inflight);
    }

    pub(crate) fn resolution_borrowed(&self, inflight: usize) {
        update_max(&self.high_inflight_resolutions, inflight);
    }

    #[cfg(feature = "resolver")]
    pub(crate) fn resolution_terminal(&self, completion: &crate::ResolveCompletion) {
        match completion {
            crate::ResolveCompletion::Completed(_) => {
                saturating_increment(&self.resolutions_completed)
            }
            crate::ResolveCompletion::Failed(_) => saturating_increment(&self.resolutions_failed),
            crate::ResolveCompletion::Cancelled => {
                saturating_increment(&self.resolutions_cancelled)
            }
        }
    }

    pub(crate) fn tcp_connect_accepted(&self, connections: usize, reserved_bytes: usize) {
        saturating_increment(&self.tcp_connects_accepted);
        self.standalone_tcp_connections
            .store(connections, Ordering::Release);
        self.reserved_tcp_queue_bytes
            .store(reserved_bytes, Ordering::Release);
        update_max(&self.high_standalone_tcp_connections, connections);
        update_max(&self.high_reserved_tcp_queue_bytes, reserved_bytes);
    }

    pub(crate) fn tcp_connect_terminal(&self, completion: &crate::TcpConnectCompletion) {
        match completion {
            crate::TcpConnectCompletion::Completed(_) => {
                saturating_increment(&self.tcp_connects_completed)
            }
            crate::TcpConnectCompletion::Failed(_) => {
                saturating_increment(&self.tcp_connects_failed)
            }
            crate::TcpConnectCompletion::Cancelled => {
                saturating_increment(&self.tcp_connects_cancelled)
            }
        }
    }

    pub(crate) fn tcp_connect_completed(&self) {
        saturating_increment(&self.tcp_connects_completed);
    }
    pub(crate) fn tcp_connect_failed(&self) {
        saturating_increment(&self.tcp_connects_failed);
    }
    pub(crate) fn tcp_connect_cancelled(&self) {
        saturating_increment(&self.tcp_connects_cancelled);
    }

    pub(crate) fn set_tcp_resources(&self, connections: usize, reserved_bytes: usize) {
        self.standalone_tcp_connections
            .store(connections, Ordering::Release);
        self.reserved_tcp_queue_bytes
            .store(reserved_bytes, Ordering::Release);
    }

    pub(crate) fn stream_terminal(&self, outcome: crate::stream::StreamOutcome) {
        match outcome {
            crate::stream::StreamOutcome::Completed => {
                saturating_increment(&self.requests_completed)
            }
            crate::stream::StreamOutcome::Failed => saturating_increment(&self.requests_failed),
            crate::stream::StreamOutcome::Cancelled => {
                saturating_increment(&self.requests_cancelled)
            }
        }
    }

    pub(crate) fn command_queued(&self) {
        increment_gauge(&self.queued_commands, &self.high_queued_commands);
    }

    pub(crate) fn commands_drained(&self, count: usize) {
        subtract_gauge(&self.queued_commands, count);
    }

    pub(crate) fn callback_queued(&self) {
        increment_gauge(&self.queued_callbacks, &self.high_queued_callbacks);
    }

    pub(crate) fn callback_dequeued(&self) {
        subtract_gauge(&self.queued_callbacks, 1);
    }

    #[cfg(feature = "native")]
    pub(crate) fn connection_opened(&self, active: usize) {
        saturating_increment(&self.connections_opened);
        self.set_active_connections(active);
    }

    #[cfg(feature = "native")]
    pub(crate) fn connection_reused(&self) {
        saturating_increment(&self.connections_reused);
    }

    #[cfg(feature = "native")]
    pub(crate) fn connection_closed(&self, active: usize) {
        saturating_increment(&self.connections_closed);
        self.set_active_connections(active);
    }

    #[cfg(feature = "native")]
    pub(crate) fn idle_evicted(&self) {
        saturating_increment(&self.idle_connections_evicted);
    }

    #[cfg(feature = "native")]
    pub(crate) fn set_active_connections(&self, value: usize) {
        self.active_connections.store(value, Ordering::Release);
        update_max(&self.high_active_connections, value);
    }

    #[cfg(feature = "native")]
    pub(crate) fn set_idle_connections(&self, value: usize) {
        self.idle_connections.store(value, Ordering::Release);
        update_max(&self.high_idle_connections, value);
    }

    #[cfg(feature = "native")]
    pub(crate) fn set_connection_waiters(&self, value: usize) {
        self.connection_waiters.store(value, Ordering::Release);
        update_max(&self.high_connection_waiters, value);
    }

    pub(crate) fn snapshot(
        &self,
        inflight: usize,
        stream_bytes: usize,
        resolutions: usize,
    ) -> EngineMetrics {
        EngineMetrics {
            connection_metrics_available: self.connection_metrics_available.load(Ordering::Acquire),
            requests_accepted: self.requests_accepted.load(Ordering::Acquire),
            requests_completed: self.requests_completed.load(Ordering::Acquire),
            requests_failed: self.requests_failed.load(Ordering::Acquire),
            requests_cancelled: self.requests_cancelled.load(Ordering::Acquire),
            connections_opened: self.connections_opened.load(Ordering::Acquire),
            connections_reused: self.connections_reused.load(Ordering::Acquire),
            connections_closed: self.connections_closed.load(Ordering::Acquire),
            idle_connections_evicted: self.idle_connections_evicted.load(Ordering::Acquire),
            resolutions_accepted: self.resolutions_accepted.load(Ordering::Acquire),
            resolutions_completed: self.resolutions_completed.load(Ordering::Acquire),
            resolutions_failed: self.resolutions_failed.load(Ordering::Acquire),
            resolutions_cancelled: self.resolutions_cancelled.load(Ordering::Acquire),
            tcp_connects_accepted: self.tcp_connects_accepted.load(Ordering::Acquire),
            tcp_connects_completed: self.tcp_connects_completed.load(Ordering::Acquire),
            tcp_connects_failed: self.tcp_connects_failed.load(Ordering::Acquire),
            tcp_connects_cancelled: self.tcp_connects_cancelled.load(Ordering::Acquire),
            current: ResourceMetrics {
                reserved_buffered_body_bytes: 0,
                inflight_requests: inflight,
                queued_commands: self.queued_commands.load(Ordering::Acquire),
                queued_callbacks: self.queued_callbacks.load(Ordering::Acquire),
                reserved_stream_queue_bytes: stream_bytes,
                inflight_resolutions: resolutions,
                standalone_tcp_connections: self.standalone_tcp_connections.load(Ordering::Acquire),
                reserved_tcp_queue_bytes: self.reserved_tcp_queue_bytes.load(Ordering::Acquire),
                active_connections: self.active_connections.load(Ordering::Acquire),
                idle_connections: self.idle_connections.load(Ordering::Acquire),
                connection_waiters: self.connection_waiters.load(Ordering::Acquire),
            },
            high_water: ResourceMetrics {
                reserved_buffered_body_bytes: 0,
                inflight_requests: self.high_inflight_requests.load(Ordering::Acquire),
                queued_commands: self.high_queued_commands.load(Ordering::Acquire),
                queued_callbacks: self.high_queued_callbacks.load(Ordering::Acquire),
                reserved_stream_queue_bytes: self
                    .high_reserved_stream_queue_bytes
                    .load(Ordering::Acquire),
                inflight_resolutions: self.high_inflight_resolutions.load(Ordering::Acquire),
                standalone_tcp_connections: self
                    .high_standalone_tcp_connections
                    .load(Ordering::Acquire),
                reserved_tcp_queue_bytes: self
                    .high_reserved_tcp_queue_bytes
                    .load(Ordering::Acquire),
                active_connections: self.high_active_connections.load(Ordering::Acquire),
                idle_connections: self.high_idle_connections.load(Ordering::Acquire),
                connection_waiters: self.high_connection_waiters.load(Ordering::Acquire),
            },
        }
    }
}

fn saturating_increment(counter: &AtomicU64) {
    let _ = try_update_u64(counter, Ordering::AcqRel, Ordering::Acquire, |value| {
        Some(value.saturating_add(1))
    });
}

fn increment_gauge(gauge: &AtomicUsize, high: &AtomicUsize) {
    let previous = try_update_usize(gauge, Ordering::AcqRel, Ordering::Acquire, |value| {
        Some(value.saturating_add(1))
    })
    .unwrap_or_else(|value| value);
    let value = previous.saturating_add(1);
    update_max(high, value);
}

fn subtract_gauge(gauge: &AtomicUsize, amount: usize) {
    let _ = try_update_usize(gauge, Ordering::AcqRel, Ordering::Acquire, |value| {
        Some(value.saturating_sub(amount))
    });
}

fn update_max(high: &AtomicUsize, value: usize) {
    let _ = try_update_usize(high, Ordering::AcqRel, Ordering::Acquire, |current| {
        (value > current).then_some(value)
    });
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn counters_and_gauges_saturate_instead_of_wrapping() {
        let metrics = Metrics::default();
        metrics.requests_accepted.store(u64::MAX, Ordering::Release);
        metrics.queued_commands.store(usize::MAX, Ordering::Release);

        metrics.request_accepted(usize::MAX, usize::MAX);
        metrics.command_queued();

        let snapshot = metrics.snapshot(usize::MAX, usize::MAX, 0);
        assert_eq!(snapshot.requests_accepted(), u64::MAX);
        assert_eq!(snapshot.current().queued_commands(), usize::MAX);
        assert_eq!(snapshot.high_water().queued_commands(), usize::MAX);
        assert_eq!(snapshot.high_water().inflight_requests(), usize::MAX);
        assert_eq!(
            snapshot.high_water().reserved_stream_queue_bytes(),
            usize::MAX
        );
    }
}