sqlload 0.42.0

SQL data loading tooling.
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
//! Checking a job before any request, and running it: one endpoint, or a fan-out over keys.

use std::collections::BTreeMap;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;

use serde_json::{Map, Value};
use tokio::sync::Mutex;
use tokio::sync::mpsc::{Receiver, Sender, channel};
use tokio::task::JoinSet;

use crate::http_source::_helpers::cells::cells_problem;
use crate::http_source::_helpers::endpoint::{endpoint, interval, shared_limiter};
use crate::http_source::_helpers::oauth::token_url;
use crate::http_source::_helpers::pages::{paginate, set_at};
use crate::http_source::_helpers::selector::{selected_rows, selector};
use crate::http_source::_helpers::urls::{filled_path, placeholders, redacted};
use crate::python_sources::errors::ReadError;
use crate::row_batches::main::projection::projection;
use crate::row_batches::main::projection_problem::projection_problem;
use crate::row_batches::models::{Projection, ProjectionRules};
use std::time::Duration;

use crate::http::main::install_tls_provider::install_tls_provider;
use crate::http_source::constants::{
    BODY_DROPPING_REDIRECTS, JOB_THREADS, MAX_REDIRECTS, PAGES_AHEAD,
};
use crate::http_source::models::{
    Auth, Calls, FanKey, FanOut, FieldSpec, HttpJob, HttpPage, KeyFeed, Location, Method, Over,
    Paginator, Request, Selector, Sink, StatusAction,
};

/// Every problem the job's definition has, found before any request, including projected rows that break the table's `rules`.
pub(crate) fn job_problems(job: &HttpJob, rules: ProjectionRules<'_>) -> Vec<String> {
    let rows = match job {
        HttpJob::Paginate(request) => request,
        HttpJob::FanOut(fan_out) => &fan_out.request,
    };
    let mut problems = match request_projection(rows) {
        Ok(Some(projection)) => projection_problem(&projection, rules).into_iter().collect(),
        Ok(None) => Vec::new(),
        Err(problem) => vec![problem],
    };
    problems.extend(match job {
        HttpJob::Paginate(request) => {
            let mut problems = request_problems(request);
            problems.extend(field_problem(request));
            problems.extend(placeholders(&request.path).first().map(|name| {
                format!(
                    "paginate path {} has the placeholder {{{name}}}; use fan_out to fill it",
                    request.path
                )
            }));
            problems
        }
        HttpJob::FanOut(fan_out) => fan_out_problems(fan_out),
    });
    problems.extend(rows.key.as_ref().map(|key| {
        format!("key={key:?} names the keys a job gives as a fan_out's over; this job loads rows")
    }));
    problems
}

/// The projection `request`'s `fields` and `keep_record` describe, if any.
pub(crate) fn request_projection(request: &Request) -> Result<Option<Projection>, String> {
    let fields = request.fields.as_deref().map(field_triples);
    projection(fields.as_deref(), request.keep_record.as_deref())
}

/// Each field as (column, path, required).
fn field_triples(fields: &[FieldSpec]) -> Vec<(String, String, bool)> {
    fields
        .iter()
        .map(|field| (field.name.clone(), field.path.clone(), field.required))
        .collect()
}

/// Why the rows' `select` names a key field, which only fan_out's over reads, if it does.
fn field_problem(request: &Request) -> Option<String> {
    let field = match selector(request.select.as_deref()) {
        Ok(selected) => selected.field?,
        Err(_) => return None,
    };
    Some(format!(
        "select {:?} names a key field ({field}); that form is for fan_out's over, so select the rows instead",
        request.select.clone().unwrap_or_default()
    ))
}

fn request_problems(request: &Request) -> Vec<String> {
    let mut problems: Vec<String> = Vec::new();
    problems.extend(selector(request.select.as_deref()).err());
    problems.extend(paginator_problem(&request.paginator));
    problems.extend(body_problems(request));
    problems.extend(request.cells.as_ref().and_then(cells_problem));
    problems.extend(match &request.client.auth {
        Auth::Oauth2ClientCredentials(spec)
        | Auth::Oauth2RefreshToken(spec)
        | Auth::Oauth2Password(spec) => token_url(spec).err(),
        Auth::None | Auth::Bearer | Auth::ApiKey { .. } | Auth::Basic => None,
    });
    problems.extend(
        request
            .client
            .headers
            .iter()
            .filter_map(|(name, value)| header_problem(name, value)),
    );
    problems.extend(
        request
            .client
            .rate_limit
            .as_deref()
            .and_then(|rate| interval(rate).err()),
    );
    problems.extend(
        request
            .on_status
            .keys()
            .filter_map(|status| match status.parse::<u16>() {
                Ok(100..=599) => None,
                _ => Some(format!("on_status {status} is not an HTTP status")),
            }),
    );
    problems
}

/// Why the paginator cannot work, if it cannot: a pointer that is not a plain path, or an offset limit of 0.
fn paginator_problem(paginator: &Paginator) -> Option<String> {
    match paginator {
        Paginator::NextLink { pointer } | Paginator::Cursor { pointer, .. } => {
            match selector(Some(pointer)) {
                Ok(parsed) if parsed.field.is_none() && !parsed.rows.is_empty() => None,
                Ok(_) | Err(_) => Some(format!(
                    "paginator pointer {pointer:?} is not a path such as \"$.next\" or \"$.meta.next_cursor\""
                )),
            }
        }
        Paginator::Offset { limit: 0, .. } => Some("sl.offset limit must be at least 1".to_owned()),
        Paginator::Offset { .. }
        | Paginator::Single
        | Paginator::LinkHeader
        | Paginator::PageNumber { .. } => None,
    }
}

/// Why the job's body settings cannot work: a body or body paging on a `GET`, a body path that is not a plain path, or body paging into a body that is not an object.
fn body_problems(request: &Request) -> Vec<String> {
    let (paths, location) = match &request.paginator {
        Paginator::Offset {
            param,
            limit_param,
            location,
            ..
        } => (vec![param, limit_param], *location),
        Paginator::PageNumber {
            param, location, ..
        }
        | Paginator::Cursor {
            param, location, ..
        } => (vec![param], *location),
        Paginator::Single | Paginator::NextLink { .. } | Paginator::LinkHeader => {
            (Vec::new(), Location::Query)
        }
    };
    let mut problems: Vec<String> = Vec::new();
    if request.method == Method::Get && request.json_body.is_some() {
        problems.push("json_body is sent only with method=\"POST\"".to_owned());
    }
    if location == Location::Query {
        return problems;
    }
    if request.method == Method::Get {
        problems.push("a paginator with location=\"body\" needs method=\"POST\"".to_owned());
    }
    if request
        .json_body
        .as_ref()
        .is_some_and(|body| !body.is_object())
    {
        problems.push(
            "a paginator with location=\"body\" sets fields in json_body, so json_body must be an object".to_owned(),
        );
    }
    problems.extend(paths.iter().filter_map(|path| match selector(Some(path)) {
        Ok(parsed) if parsed.field.is_none() && named_fields(&parsed.rows) => None,
        Ok(_) | Err(_) => Some(format!(
            "body path {path:?} is not a path such as \"$.page.cursor\""
        )),
    }));
    if problems.is_empty() {
        let mut body = request
            .json_body
            .clone()
            .unwrap_or_else(|| Value::Object(Map::new()));
        problems.extend(
            paths
                .iter()
                .filter_map(|path| set_at(&mut body, path, Value::Null).err()),
        );
    }
    problems
}

/// Whether `segments` are one or more field names, with no list index such as `[0]`.
fn named_fields(segments: &[String]) -> bool {
    !segments.is_empty() && !segments.iter().any(|segment| segment.starts_with('['))
}

/// Why a header cannot be sent, if it cannot.
fn header_problem(name: &str, value: &str) -> Option<String> {
    match (
        reqwest::header::HeaderName::from_bytes(name.as_bytes()),
        reqwest::header::HeaderValue::from_str(value),
    ) {
        (Ok(_), Ok(_)) => None,
        (Err(_), _) | (_, Err(_)) => Some(format!(
            "header {name:?} is not a valid HTTP header name and value"
        )),
    }
}

fn fan_out_problems(fan_out: &FanOut) -> Vec<String> {
    let mut problems = request_problems(&fan_out.request);
    problems.extend(field_problem(&fan_out.request));
    problems.extend(level_problems(fan_out));
    problems
}

/// The problems of a fan-out level apart from its own request's, and of every level above it, whether it loads rows or feeds keys to the level below.
fn level_problems(fan_out: &FanOut) -> Vec<String> {
    let path = &fan_out.request.path;
    let wanted = placeholders(path);
    let mut problems: Vec<String> = Vec::new();
    problems.extend(
        (fan_out.concurrency == 0).then(|| "fan_out concurrency must be at least 1".to_owned()),
    );
    let (picker, kind) = match &fan_out.over {
        Over::Values { .. } if wanted.is_empty() => {
            problems.push(format!(
                "fan-out path {path} has no placeholder, so every key would request the same URL; add one such as {{id}}"
            ));
            return problems;
        }
        Over::Values { values } => {
            problems.extend(
                values
                    .iter()
                    .find_map(|value| key_problem(path, &wanted, value)),
            );
            return problems;
        }
        Over::Paginate(over) => {
            problems.extend(request_problems(over));
            problems.extend(picker_problem(over));
            problems.extend(placeholders(&over.path).first().map(|name| {
                format!("fan_out over path {} has the placeholder {{{name}}}; over must be a plain paginate", over.path)
            }));
            (&**over, "a paginate")
        }
        Over::FanOut(inner) => {
            problems.extend(request_problems(&inner.request));
            problems.extend(level_problems(inner));
            problems.extend(picker_problem(&inner.request));
            (&inner.request, "a fan_out")
        }
    };
    let Some(name) = key_name(picker) else {
        problems.push(format!(
            "fan_out over {kind} needs a select naming each key's field, such as \"$.items[*].id\", not {:?}",
            picker.select.clone().unwrap_or_else(|| "$".to_owned())
        ));
        return problems;
    };
    let above = match &fan_out.over {
        Over::FanOut(inner) => provided_keys(&inner.over, &placeholders(&inner.request.path)),
        Over::Values { .. } | Over::Paginate(_) => Vec::new(),
    };
    problems.extend(above.contains(&name).then(|| {
        format!(
            "fan_out over picks {name}, which a level above already gives; name it apart with key="
        )
    }));
    let given: Vec<String> = above.into_iter().chain([name]).collect();
    problems.extend(
        wanted
            .iter()
            .filter(|name| !given.contains(name))
            .map(|name| {
                format!(
                    "fan-out path {path} needs {{{name}}}, but over gives only {}",
                    given.join(", ")
                )
            }),
    );
    problems
}

/// Why `picker`, which feeds keys to the level below, cannot have `fields` or `keep_record`, if it has them.
fn picker_problem(picker: &Request) -> Option<String> {
    match (picker.fields.is_some() || picker.keep_record.is_some(), picker.cells.is_some()) {
        (true, _) => Some("fan_out's over picks keys with its select; fields and keep_record are for the fan-out's own rows".to_owned()),
        (false, true) => Some("fan_out's over picks keys with its select; cells are for the fan-out's own rows".to_owned()),
        (false, false) => None,
    }
}

/// The name the keys `picker` selects fill: its `key`, else the selected field; `None` when its select names no field.
fn key_name(picker: &Request) -> Option<String> {
    let field = match selector(picker.select.as_deref()) {
        Ok(selected) => selected.field,
        Err(_) => None,
    }?;
    Some(picker.key.clone().unwrap_or(field))
}

/// Whether every object of `objects` has the field `name`.
fn in_every(objects: &[&Map<String, Value>], name: &str) -> bool {
    objects.iter().all(|object| object.contains_key(name))
}

/// The placeholder names every key `over` sends fills, for a level whose path has the placeholders `wanted`.
fn provided_keys(over: &Over, wanted: &[String]) -> Vec<String> {
    match over {
        Over::Values { values } => {
            let objects: Vec<&Map<String, Value>> =
                values.iter().filter_map(Value::as_object).collect();
            match objects.split_first() {
                Some((first, rest)) if objects.len() == values.len() => first
                    .keys()
                    .filter(|name| in_every(rest, name))
                    .cloned()
                    .collect(),
                Some(_) | None => wanted.to_vec(),
            }
        }
        Over::Paginate(over) => key_name(over).into_iter().collect(),
        Over::FanOut(inner) => provided_keys(&inner.over, &placeholders(&inner.request.path))
            .into_iter()
            .chain(key_name(&inner.request))
            .collect(),
    }
}

/// Why the listed key `value` cannot fill the placeholders `wanted` of `path`, if it cannot.
fn key_problem(path: &str, wanted: &[String], value: &Value) -> Option<String> {
    let missing = |key: &Map<String, Value>| {
        wanted
            .iter()
            .find(|name| !key.contains_key(name.as_str()))
            .cloned()
    };
    match value {
        Value::Object(key) => missing(key).map(|name| {
            format!("fan-out path {path} needs {{{name}}}, which the key {value} lacks")
        }),
        _ if wanted.len() == 1 => None,
        _ => Some(format!(
            "fan-out path {path} has {} placeholders, so over needs objects naming each, not {value}",
            wanted.len()
        )),
    }
}

/// Run `job` on a runtime of its own, handing each page to `deliver` in arrival order; `deliver` returning `false` cancels the requests in flight.
pub(crate) fn drive_job(
    job: HttpJob,
    connections: &Map<String, Value>,
    mut deliver: impl FnMut(HttpPage) -> bool,
) -> Result<(), ReadError> {
    let runtime = tokio::runtime::Builder::new_multi_thread()
        .worker_threads(JOB_THREADS)
        .enable_all()
        .build()
        .map_err(|error| format!("cannot start the sl.http runtime: {error}"))?;
    let (sender, mut receiver) = channel(PAGES_AHEAD);
    let task = runtime.spawn(run_job(job, connections.clone(), sender));
    while let Some(page) = receiver.blocking_recv() {
        if !deliver(page) {
            task.abort();
            break;
        }
    }
    drop(receiver);
    match runtime.block_on(task) {
        Ok(result) => result,
        Err(error) if error.is_cancelled() => Ok(()),
        Err(error) => Err(format!("the sl.http job stopped: {error}").into()),
    }
}

/// Run `job`, sending every page to `pages`.
async fn run_job(
    job: HttpJob,
    connections: Map<String, Value>,
    pages: Sender<HttpPage>,
) -> Result<(), ReadError> {
    let posts = match &job {
        HttpJob::Paginate(request) => request.method == Method::Post,
        HttpJob::FanOut(fan_out) => fan_out_posts(fan_out),
    };
    let http = job_client(posts)?;
    match job {
        HttpJob::Paginate(request) => {
            let calls = request_calls(&request, &connections, &http)?;
            paginate(&calls, &request, &request.path, &pages).await
        }
        HttpJob::FanOut(fan_out) => {
            run_fan_out(*fan_out, &connections, &http, Sink::Pages(pages)).await
        }
    }
}

/// Whether any level of `fan_out` sends a `POST`.
fn fan_out_posts(fan_out: &FanOut) -> bool {
    fan_out.request.method == Method::Post
        || match &fan_out.over {
            Over::Values { .. } => false,
            Over::Paginate(over) => over.method == Method::Post,
            Over::FanOut(inner) => fan_out_posts(inner),
        }
}

/// A pooled client that follows redirects only within the first request's origin, so connection headers and credentials never reach another host; when the job `posts`, it also stops at 301, 302 and 303, which would resend the request as a `GET` without its body.
fn job_client(posts: bool) -> Result<reqwest::Client, String> {
    install_tls_provider();
    reqwest::Client::builder()
        .redirect(reqwest::redirect::Policy::custom(move |attempt| {
            match posts && BODY_DROPPING_REDIRECTS.contains(&attempt.status().as_u16()) {
                true => attempt.stop(),
                false => same_origin_redirect(attempt),
            }
        }))
        .pool_idle_timeout(Duration::from_secs(90))
        .connect_timeout(Duration::from_secs(15))
        .timeout(Duration::from_secs(300))
        .user_agent(concat!("sqlload/", env!("CARGO_PKG_VERSION")))
        .build()
        .map_err(|error| format!("cannot start the HTTP client: {error}"))
}

fn same_origin_redirect(attempt: reqwest::redirect::Attempt<'_>) -> reqwest::redirect::Action {
    let crossed = attempt
        .previous()
        .first()
        .is_some_and(|first| first.origin() != attempt.url().origin());
    match crossed || attempt.previous().len() > MAX_REDIRECTS {
        true => attempt.stop(),
        false => attempt.follow(),
    }
}

/// What requests of `request` need: its connection's endpoint, the shared limiter and its statuses.
fn request_calls(
    request: &Request,
    connections: &Map<String, Value>,
    http: &reqwest::Client,
) -> Result<Calls, String> {
    let client = &request.client;
    let limiter = client
        .rate_limit
        .as_deref()
        .map(|rate| shared_limiter(&client.connection, rate))
        .transpose()?;
    let on_status = request
        .on_status
        .iter()
        .map(|(status, action)| {
            let code = status
                .parse::<u16>()
                .map_err(|_| format!("on_status {status} is not an HTTP status"))?;
            Ok((code, *action))
        })
        .collect::<Result<BTreeMap<u16, StatusAction>, String>>()?;
    Ok(Calls {
        http: http.clone(),
        endpoint: endpoint(client, connections)?,
        limiter,
        retries: client.retries,
        on_status,
    })
}

/// Page through the fan-out's path for each key, up to `concurrency` at once, while the keys still arrive, sending the pages to `sink`. In a job of more than one fan-out level, errors start with the trail of requests that led to the failing one.
fn run_fan_out<'a>(
    fan_out: FanOut,
    connections: &'a Map<String, Value>,
    http: &'a reqwest::Client,
    sink: Sink,
) -> LevelRun<'a> {
    Box::pin(async move {
        let calls = request_calls(&fan_out.request, connections, http)?;
        let (key_sender, key_receiver) = channel::<FanKey>(fan_out.concurrency * 2);
        let keys = Arc::new(Mutex::new(key_receiver));
        let mut tasks: JoinSet<Result<(), ReadError>> = JoinSet::new();
        let nested = matches!(sink, Sink::Keys(_)) || matches!(fan_out.over, Over::FanOut(_));
        let feed = match fan_out.over.clone() {
            Over::Values { values } => KeyFeed::Values(values),
            Over::Paginate(over) => {
                KeyFeed::Pages(Box::new((request_calls(&over, connections, http)?, *over)))
            }
            Over::FanOut(inner) => {
                KeyFeed::FanOut(Box::new((*inner, connections.clone(), http.clone())))
            }
        };
        let wanted = placeholders(&fan_out.request.path);
        tasks.spawn(feed_keys(feed, wanted, key_sender, nested));
        let request = Arc::new(fan_out.request);
        for _ in 0..fan_out.concurrency {
            let (calls, request, keys, sink) =
                (calls.clone(), request.clone(), keys.clone(), sink.clone());
            tasks.spawn(async move {
                loop {
                    let key = keys.lock().await.recv().await;
                    let Some(key) = key else { return Ok(()) };
                    fan_out_key(&calls, &request, &key, &sink)
                        .await
                        .map_err(|error| ReadError {
                            message: match nested {
                                true => format!(
                                    "{}{}",
                                    redacted(&key.trail, &calls.endpoint.current_secrets()),
                                    error.message
                                ),
                                false => error.message,
                            },
                            retryable: error.retryable,
                        })?;
                }
            });
        }
        while let Some(finished) = tasks.join_next().await {
            finished.map_err(|error| format!("a fan-out request stopped: {error}"))??;
        }
        Ok(())
    })
}

/// A fan-out level's run, boxed so a level can run the level above it.
type LevelRun<'a> = Pin<Box<dyn Future<Output = Result<(), ReadError>> + Send + 'a>>;

/// Every page of `request` for `key`: out as rows, or picked into keys for the level below, each keeping `key`'s fields.
async fn fan_out_key(
    calls: &Calls,
    request: &Request,
    key: &FanKey,
    sink: &Sink,
) -> Result<(), ReadError> {
    let path = filled_path(&request.path, &key.fields)?;
    match sink {
        Sink::Pages(pages) => paginate(calls, request, &path, pages).await,
        Sink::Keys(keys) => {
            let picker = key_picker(request)?;
            let (page_sender, page_receiver) = channel::<HttpPage>(PAGES_AHEAD);
            let shown = path.clone();
            let pager = async move { paginate(calls, request, &path, &page_sender).await };
            let secrets = calls.endpoint.current_secrets();
            let forward = forward_keys(page_receiver, &picker, (key, &shown, Some(&secrets)), keys);
            let (paged, forwarded) = tokio::join!(pager, forward);
            paged.and(forwarded)
        }
    }
}

/// What a key-picking job selects: the rows, the field of each to read, and the name it fills.
fn key_picker(request: &Request) -> Result<(Selector, String, String), String> {
    let selected = selector(request.select.as_deref())?;
    let field = selected.field.clone().unwrap_or_default();
    let name = request.key.clone().unwrap_or_else(|| field.clone());
    Ok((selected, field, name))
}

/// Send each key: a value fills the path's one placeholder, an object fills them by name, and a paginate's or fan-out's selected field is named after itself or its `key`.
async fn feed_keys(
    feed: KeyFeed,
    wanted: Vec<String>,
    keys: Sender<FanKey>,
    nested: bool,
) -> Result<(), ReadError> {
    let single = |value: Value| -> FanKey {
        let fields = match value {
            Value::Object(key) => key,
            other => wanted
                .first()
                .map(|name| (name.clone(), other))
                .into_iter()
                .collect(),
        };
        FanKey {
            fields,
            trail: String::new(),
        }
    };
    match feed {
        KeyFeed::Values(values) => {
            for value in values {
                if keys.send(single(value)).await.is_err() {
                    return Ok(());
                }
            }
            Ok(())
        }
        KeyFeed::Pages(pages) => {
            let (calls, over) = *pages;
            let picker = key_picker(&over)?;
            let path = over.path.clone();
            let secrets = nested.then(|| calls.endpoint.current_secrets());
            let (page_sender, page_receiver) = channel::<HttpPage>(PAGES_AHEAD);
            let pager = async move { paginate(&calls, &over, &over.path, &page_sender).await };
            let root = FanKey::default();
            let forward = forward_keys(
                page_receiver,
                &picker,
                (&root, &path, secrets.as_deref()),
                &keys,
            );
            let (paged, forwarded) = tokio::join!(pager, forward);
            paged.and(forwarded)
        }
        KeyFeed::FanOut(level) => {
            let (inner, connections, http) = *level;
            run_fan_out(inner, &connections, &http, Sink::Keys(keys)).await
        }
    }
}

/// Each page's picked field values as keys named by `picker`, each with `parent`'s fields and, when `secrets` is given, its trail extended by the request at `path` that gave it, with `secrets` (that request's) redacted.
async fn forward_keys(
    mut pages: Receiver<HttpPage>,
    (selected, field, name): &(Selector, String, String),
    (parent, path, secrets): (&FanKey, &str, Option<&[String]>),
    keys: &Sender<FanKey>,
) -> Result<(), ReadError> {
    while let Some(page) = pages.recv().await {
        let document: Value = serde_json::from_slice(&page.bytes)
            .map_err(|error| format!("the fan-out's over response is not JSON: {error}"))?;
        for row in selected_rows(&document, selected) {
            let Some(value) = row.get(field).filter(|value| !value.is_null()) else {
                continue;
            };
            let mut fields = parent.fields.clone();
            fields.insert(name.clone(), value.clone());
            let trail = secrets.map_or_else(String::new, |secrets| {
                trail_step(&parent.trail, (path, name, value), secrets)
            });
            if keys.send(FanKey { fields, trail }).await.is_err() {
                return Ok(());
            }
        }
    }
    Ok(())
}

/// `trail` followed by the request at `path` and the key `name` = `value` it gave, with `secrets` redacted from the step.
fn trail_step(
    trail: &str,
    (path, name, value): (&str, &str, &Value),
    secrets: &[String],
) -> String {
    let shown = match value {
        Value::String(text) => text.clone(),
        other => other.to_string(),
    };
    format!(
        "{trail}{}",
        redacted(&format!("{path} {name}={shown} → "), secrets)
    )
}