zero-client 0.3.1

A native Rust client for Zero.
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
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
//! Tracks the queries the client wants from the server, tells the server
//! about changes in batches, and reports which ones the server has sent
//! (`packages/zero-client/src/client/query-manager.ts`).

use super::inspector::{Metrics, QueryClientMetrics};
use super::log::Log;
use super::replica_store::{KvDiff, KvDiffOp, KvMap};
use super::{ConnectionError, Scheduler, Timer};
use crate::ast::Ast;
use crate::decode::JsonCodable;
use crate::hash::query::hash_of_name_and_args;
use crate::json::{self, Object, Value, number};
use crate::keys::{DESIRED_QUERIES_PREFIX, GOT_QUERIES_PREFIX};
use crate::map::OrderedMap;
use crate::protocol::{
    ChangeDesiredQueriesBody, ErroredQuery, UpQueriesPatch, UpQueriesPatchOp, UpQueriesPut,
};
use crate::ttl::Ttl;
use std::cell::{Cell, RefCell};
use std::collections::{HashMap, HashSet};
use std::rc::{Rc, Weak};

/// Client query updates are timed for only the first of every
/// `UPDATE_SAMPLE_RATE` pushes to each source connection (see
/// `MeasurePush`), so each `query-update-client` time is recorded with this
/// weight (`UPDATE_SAMPLE_RATE` in `query-manager.ts`).
pub(crate) const UPDATE_SAMPLE_RATE: u64 = 32;

/// The metrics the client records (`ClientMetricMap` in
/// `packages/zql/src/query/metrics-delegate.ts`).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum ClientMetric {
    /// `query-materialization-client`: building and hydrating a view.
    MaterializationClient,
    /// `query-materialization-end-to-end`: from materializing a query
    /// until the server has sent its rows.
    MaterializationEndToEnd,
    /// `query-update-client`: a push through a query's pipeline.
    UpdateClient,
}

/// Where a query context reports its metrics, and the clock it times them
/// on (`MetricsDelegate`).
pub(crate) trait MetricsDelegate {
    fn monotonic_now(&self) -> f64;
    fn add_metric(&self, metric: ClientMetric, value: f64, query_id: &str, ast: Option<&Ast>);
}

/// What a query's got callback hears: whether the server has confirmed the
/// query's rows on this connection (`Yes`), on an earlier one (`Cached`),
/// or not (`No`).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Got {
    No,
    Cached,
    Yes,
}

pub(crate) type GotCallback = Rc<dyn Fn(Got, Option<ErroredQuery>)>;

struct Entry {
    /// The query's AST, for the inspector.
    ast: Ast,
    name: String,
    args: Vec<Value>,
    count: usize,
    got_callbacks: Vec<(u64, GotCallback)>,
    ttl: f64,
}

type EntryRef = Rc<RefCell<Entry>>;

#[derive(Default)]
struct State {
    queries: OrderedMap<EntryRef>,
    recent_queries: OrderedMap<()>,
    got_queries: HashSet<String>,
    got_queries_authoritative: bool,
    cached_queries: HashSet<String>,
    awaiting_persisted_got_diff: bool,
    pending_query_changes: UpQueriesPatch,
    pending_removals: Vec<Box<dyn FnOnce()>>,
    batch_timer: Option<Box<dyn Timer>>,
    closed_error: Option<ConnectionError>,
}

pub(crate) struct QueryManager {
    me: Weak<QueryManager>,
    client_id: String,
    send: Box<dyn Fn(ChangeDesiredQueriesBody)>,
    /// The number of mutations waiting for the server.
    pending_mutations: Box<dyn Fn() -> usize>,
    scheduler: Rc<dyn Scheduler>,
    query_change_throttle_ms: f64,
    recent_queries_max_size: usize,
    state: RefCell<State>,
    next_callback_id: Cell<u64>,
    log: Log,
    slow_materialize_threshold_ms: f64,
    /// Every query's metrics together.
    metrics: RefCell<Metrics>,
    query_metrics: RefCell<HashMap<String, QueryClientMetrics>>,
    /// The ASTs and metrics of the queries evicted since the inspector was
    /// first asked for: `None` until then (the inspector's
    /// `setQueryEvictedCallback`).
    evicted: RefCell<Option<HashMap<String, (Ast, QueryClientMetrics)>>>,
}

impl MetricsDelegate for QueryManager {
    fn monotonic_now(&self) -> f64 {
        self.scheduler.monotonic_now()
    }

    fn add_metric(&self, metric: ClientMetric, value: f64, query_id: &str, ast: Option<&Ast>) {
        QueryManager::add_metric(self, metric, value, query_id, ast)
    }
}

impl QueryManager {
    pub(crate) fn new(
        client_id: String,
        scheduler: Rc<dyn Scheduler>,
        query_change_throttle_ms: f64,
        send: Box<dyn Fn(ChangeDesiredQueriesBody)>,
        pending_mutations: Box<dyn Fn() -> usize>,
        log: Log,
        slow_materialize_threshold_ms: f64,
    ) -> Rc<Self> {
        Rc::new_cyclic(|me| QueryManager {
            me: me.clone(),
            client_id,
            send,
            pending_mutations,
            scheduler,
            query_change_throttle_ms,
            recent_queries_max_size: 0,
            state: RefCell::new(State {
                awaiting_persisted_got_diff: true,
                ..State::default()
            }),
            next_callback_id: Cell::new(0),
            log,
            slow_materialize_threshold_ms,
            metrics: RefCell::default(),
            query_metrics: RefCell::default(),
            evicted: RefCell::new(None),
        })
    }

    /// Every query's client metrics together (`metrics`).
    pub(crate) fn metrics(&self) -> Metrics {
        self.metrics.borrow().clone()
    }

    /// The client metrics of query `id`, if it has any, evicted or not
    /// (`getQueryMetrics`).
    pub(crate) fn query_metrics(&self, id: &str) -> Option<QueryClientMetrics> {
        if let Some(m) = self.query_metrics.borrow().get(id) {
            return Some(m.clone());
        }
        let evicted = self.evicted.borrow();
        evicted.as_ref()?.get(id).map(|(_, m)| m.clone())
    }

    /// The AST of query `id`, evicted or not (`getAST`).
    pub(crate) fn query_ast(&self, id: &str) -> Option<Ast> {
        if let Some(e) = self.state.borrow().queries.get(id) {
            return Some(e.borrow().ast.clone());
        }
        let evicted = self.evicted.borrow();
        evicted.as_ref()?.get(id).map(|(a, _)| a.clone())
    }

    /// Keeps the ASTs and metrics of the queries evicted from now on, as
    /// JS does once its inspector exists.
    pub(crate) fn keep_evicted(&self) {
        self.evicted.borrow_mut().get_or_insert_with(HashMap::new);
    }

    /// `addMetric`: records a metric of query `query_id`, client-wide and
    /// for the query, and logs each end-to-end materialization, as a
    /// warning past `slow_materialize_threshold_ms`.
    pub(crate) fn add_metric(
        &self,
        metric: ClientMetric,
        value: f64,
        query_id: &str,
        ast: Option<&Ast>,
    ) {
        let weight = if metric == ClientMetric::UpdateClient {
            UPDATE_SAMPLE_RATE as f64
        } else {
            1.0
        };
        {
            let mut m = self.metrics.borrow_mut();
            let digest = match metric {
                ClientMetric::MaterializationClient => &mut m.query_materialization_client,
                ClientMetric::MaterializationEndToEnd => &mut m.query_materialization_end_to_end,
                ClientMetric::UpdateClient => &mut m.query_update_client,
            };
            digest.add(value, weight);
        }
        if metric == ClientMetric::MaterializationEndToEnd {
            let message = |m: &str| {
                let ast = ast.map_or("undefined".to_owned(), |a| json::stringify(&a.to_json()));
                format!("{m} {query_id} {ast} {}", number::format(value))
            };
            if value > self.slow_materialize_threshold_ms {
                self.log
                    .warn(|| message("Slow query materialization (including server/network)"));
            } else {
                self.log
                    .debug(|| message("Materialized query (including server/network)"));
            }
        }
        let mut per_query = self.query_metrics.borrow_mut();
        let existing = match per_query.get_mut(query_id) {
            Some(e) => e,
            None => per_query.entry(query_id.to_owned()).or_default(),
        };
        match metric {
            ClientMetric::UpdateClient => existing.query_update_client.add(value, weight),
            // Recorded once per query: the last value wins.
            ClientMetric::MaterializationClient => {
                existing.query_materialization_client = Some(value)
            }
            ClientMetric::MaterializationEndToEnd => {
                existing.query_materialization_end_to_end = Some(value)
            }
        }
    }

    /// Every mutation the server had to confirm is confirmed: the removals
    /// held back meanwhile happen now.
    pub(crate) fn on_all_mutations_applied(&self) {
        let removals = std::mem::take(&mut self.state.borrow_mut().pending_removals);
        for r in removals {
            r();
        }
    }

    /// The watch of `g/`. The first call is the got set already in the
    /// store.
    pub(crate) fn process_got_queries(&self, diff: &KvDiff) {
        let mut fire: Vec<(String, Got)> = Vec::new();
        {
            let mut s = self.state.borrow_mut();
            let persisted = std::mem::replace(&mut s.awaiting_persisted_got_diff, false);
            for op in diff {
                let hash = op.key()[GOT_QUERIES_PREFIX.len()..].to_owned();
                match op {
                    KvDiffOp::Add { .. } => {
                        s.got_queries.insert(hash.clone());
                        if s.got_queries_authoritative {
                            fire.push((hash, Got::Yes));
                        } else if persisted {
                            s.cached_queries.insert(hash.clone());
                            fire.push((hash, Got::Cached));
                        }
                    }
                    KvDiffOp::Del { .. } => {
                        s.got_queries.remove(&hash);
                        s.cached_queries.remove(&hash);
                        fire.push((hash, Got::No));
                    }
                    KvDiffOp::Change { .. } => {}
                }
            }
        }
        for (hash, got) in fire {
            self.fire_got_callbacks(&hash, got, None);
        }
    }

    fn fire_got_callbacks(&self, hash: &str, got: Got, error: Option<ErroredQuery>) {
        let callbacks: Vec<GotCallback> = {
            let s = self.state.borrow();
            let Some(entry) = s.queries.get(hash) else {
                return;
            };
            entry
                .borrow()
                .got_callbacks
                .iter()
                .map(|(_, c)| c.clone())
                .collect()
        };
        for c in callbacks {
            c(got, error.clone());
        }
    }

    /// Trusts the got set once the first poke after a connect is applied.
    pub(crate) fn mark_got_queries_authoritative(&self) {
        let hashes: Vec<String> = {
            let mut s = self.state.borrow_mut();
            if s.got_queries_authoritative {
                return;
            }
            s.got_queries_authoritative = true;
            s.cached_queries.clear();
            s.awaiting_persisted_got_diff = false;
            s.queries
                .keys()
                .filter(|h| s.got_queries.contains(*h))
                .cloned()
                .collect()
        };
        for h in hashes {
            self.fire_got_callbacks(&h, Got::Yes, None);
        }
    }

    /// On disconnect: the next connection must confirm the got set again.
    pub(crate) fn clear_got_queries_authoritative(&self) {
        let mut s = self.state.borrow_mut();
        if !s.got_queries_authoritative {
            return;
        }
        s.got_queries_authoritative = false;
        let got: Vec<String> = s.got_queries.iter().cloned().collect();
        s.cached_queries.extend(got);
    }

    /// The changes to send so the server's desired queries for this client
    /// (`d/<clientID>/` in the store) become ours, less what `last_patch`
    /// already sent.
    pub(crate) fn queries_patch(
        &self,
        main: &KvMap,
        last_patch: Option<&OrderedMap<UpQueriesPatchOp>>,
    ) -> OrderedMap<UpQueriesPatchOp> {
        let prefix = format!("{DESIRED_QUERIES_PREFIX}{}/", self.client_id);
        let mut existing: Vec<String> = Vec::new();
        let mut existing_set: HashSet<String> = HashSet::new();
        for (key, _) in main.scan(&prefix) {
            let hash = key[prefix.len()..].to_owned();
            if existing_set.insert(hash.clone()) {
                existing.push(hash);
            }
        }
        let s = self.state.borrow();
        let mut patch: OrderedMap<UpQueriesPatchOp> = OrderedMap::new();
        for hash in existing {
            if !s.queries.contains_key(&hash) {
                patch.insert(hash.clone(), UpQueriesPatchOp::Del { hash });
            }
        }
        for (hash, entry) in s.queries.iter() {
            if !existing_set.contains(hash) {
                let ttl = entry.borrow().ttl;
                patch.insert(hash.clone(), put(hash, &entry.borrow(), ttl));
            }
        }
        if let Some(last) = last_patch {
            for (hash, op) in last.iter() {
                if matches!(op, UpQueriesPatchOp::Put(_)) && !patch.contains_key(hash) {
                    patch.insert(hash.clone(), UpQueriesPatchOp::Del { hash: hash.clone() });
                }
            }
            let same: Vec<String> = patch
                .iter()
                .filter(|(hash, op)| last.get(hash).is_some_and(|l| same_op(l, op)))
                .map(|(h, _)| h.clone())
                .collect();
            for h in same {
                patch.remove(&h);
            }
        }
        patch
    }

    pub(crate) fn handle_transform_errors(&self, errors: &[ErroredQuery]) {
        for error in errors {
            let id = match error {
                ErroredQuery::App { id, .. } | ErroredQuery::Parse { id, .. } => id,
            };
            self.fire_got_callbacks(id, Got::No, Some(error.clone()));
        }
    }

    pub(crate) fn handle_closed(&self, reason: &ConnectionError) {
        let entries: Vec<(String, String)> = {
            let mut s = self.state.borrow_mut();
            if s.closed_error.is_some() {
                return;
            }
            s.closed_error = Some(reason.clone());
            s.queries
                .iter()
                .map(|(h, e)| (h.clone(), e.borrow().name.clone()))
                .collect()
        };
        for (hash, name) in entries {
            let error = closed_error(&hash, Some(&name), reason);
            self.fire_got_callbacks(&hash, Got::No, Some(error));
        }
    }

    /// Registers a named query. Returns the function that unregisters it.
    pub(crate) fn add_custom(
        &self,
        ast: &Ast,
        name: &str,
        args: &[Value],
        ttl: &Ttl,
        got_callback: Option<GotCallback>,
    ) -> Box<dyn Fn()> {
        let hash = hash_of_name_and_args(name, args);
        let ttl = ttl.clamped();
        let callback_id = got_callback.as_ref().map(|_| {
            let id = self.next_callback_id.get() + 1;
            self.next_callback_id.set(id);
            id
        });
        let (entry, got) = {
            let mut s = self.state.borrow_mut();
            s.recent_queries.remove(&hash);
            let existing = s.queries.get(&hash).cloned();
            let entry = match existing {
                Some(entry) => {
                    entry.borrow_mut().count += 1;
                    drop(s);
                    self.update_entry(&entry, &hash, ttl);
                    s = self.state.borrow_mut();
                    if let (Some(cb), Some(id)) = (&got_callback, callback_id) {
                        entry.borrow_mut().got_callbacks.push((id, cb.clone()));
                    }
                    entry
                }
                None => {
                    let entry = Rc::new(RefCell::new(Entry {
                        ast: ast.clone(),
                        name: name.to_owned(),
                        args: args.to_vec(),
                        count: 1,
                        got_callbacks: match (&got_callback, callback_id) {
                            (Some(cb), Some(id)) => vec![(id, cb.clone())],
                            _ => Vec::new(),
                        },
                        ttl,
                    }));
                    s.queries.insert(hash.clone(), entry.clone());
                    let op = put(&hash, &entry.borrow(), ttl);
                    drop(s);
                    self.queue_query_change(op);
                    s = self.state.borrow_mut();
                    entry
                }
            };
            let got = if s.got_queries_authoritative {
                if s.got_queries.contains(&hash) {
                    Got::Yes
                } else {
                    Got::No
                }
            } else if s.cached_queries.contains(&hash) {
                Got::Cached
            } else {
                Got::No
            };
            (entry, got)
        };
        if let Some(cb) = &got_callback {
            cb(got, None);
        }
        let removed = Cell::new(false);
        let me = self.me.clone();
        Box::new(move || {
            let Some(qm) = me.upgrade() else { return };
            if removed.replace(true) {
                return;
            }
            // Queries can't be removed while mutations are pending: a
            // rebase could need data they keep in scope.
            if (qm.pending_mutations)() > 0 {
                let me = me.clone();
                let entry = entry.clone();
                let hash = hash.clone();
                qm.state
                    .borrow_mut()
                    .pending_removals
                    .push(Box::new(move || {
                        if let Some(qm) = me.upgrade() {
                            qm.remove(&entry, &hash, callback_id);
                        }
                    }));
                return;
            }
            qm.remove(&entry, &hash, callback_id);
        })
    }

    pub(crate) fn update_custom(&self, name: &str, args: &[Value], ttl: &Ttl) {
        let hash = hash_of_name_and_args(name, args);
        let entry = self.state.borrow().queries.get(&hash).cloned();
        if let Some(entry) = entry {
            self.update_entry(&entry, &hash, ttl.clamped());
        }
    }

    fn update_entry(&self, entry: &EntryRef, hash: &str, ttl: f64) {
        let current = entry.borrow().ttl;
        if Ttl::compare(&Ttl::Milliseconds(ttl), &Ttl::Milliseconds(current)) > 0.0 {
            entry.borrow_mut().ttl = ttl;
            let op = put(hash, &entry.borrow(), ttl);
            self.queue_query_change(op);
        }
    }

    fn queue_query_change(&self, op: UpQueriesPatchOp) {
        let mut s = self.state.borrow_mut();
        s.pending_query_changes.push(op);
        if s.batch_timer.is_none() {
            let me = self.me.clone();
            s.batch_timer = Some(self.scheduler.schedule(
                self.query_change_throttle_ms,
                Box::new(move || {
                    if let Some(qm) = me.upgrade() {
                        qm.flush_batch();
                    }
                }),
            ));
        }
    }

    pub(crate) fn flush_batch(&self) {
        let changes = {
            let mut s = self.state.borrow_mut();
            if let Some(t) = s.batch_timer.take() {
                t.cancel();
            }
            if s.pending_query_changes.is_empty() {
                return;
            }
            std::mem::take(&mut s.pending_query_changes)
        };
        (self.send)(ChangeDesiredQueriesBody {
            desired_queries_patch: changes,
            traceparent: None,
        });
    }

    fn remove(&self, entry: &EntryRef, hash: &str, callback_id: Option<u64>) {
        {
            let mut e = entry.borrow_mut();
            if let Some(id) = callback_id {
                e.got_callbacks.retain(|(i, _)| *i != id);
            }
            e.count -= 1;
            if e.count > 0 {
                return;
            }
        }
        let evicted = {
            let mut s = self.state.borrow_mut();
            s.recent_queries.insert(hash.to_owned(), ());
            if s.recent_queries.len() > self.recent_queries_max_size {
                let lru = s.recent_queries.get_index(0).map(|(k, _)| k.clone());
                if let Some(lru) = &lru {
                    let evicted = s.queries.remove(lru);
                    s.recent_queries.remove(lru);
                    let metrics = self.query_metrics.borrow_mut().remove(lru);
                    if let (Some(kept), Some(e)) = (self.evicted.borrow_mut().as_mut(), evicted) {
                        kept.insert(
                            lru.clone(),
                            (e.borrow().ast.clone(), metrics.unwrap_or_default()),
                        );
                    }
                }
                lru
            } else {
                None
            }
        };
        if let Some(lru) = evicted {
            self.queue_query_change(UpQueriesPatchOp::Del { hash: lru });
        }
    }
}

fn put(hash: &str, entry: &Entry, ttl: f64) -> UpQueriesPatchOp {
    UpQueriesPatchOp::Put(Box::new(UpQueriesPut {
        hash: hash.to_owned(),
        ttl: Some(ttl),
        ast: None,
        name: Some(entry.name.clone()),
        args: Some(entry.args.clone()),
    }))
}

fn same_op(a: &UpQueriesPatchOp, b: &UpQueriesPatchOp) -> bool {
    matches!(
        (a, b),
        (UpQueriesPatchOp::Put(_), UpQueriesPatchOp::Put(_))
            | (UpQueriesPatchOp::Del { .. }, UpQueriesPatchOp::Del { .. })
            | (UpQueriesPatchOp::Clear, UpQueriesPatchOp::Clear)
    )
}

/// The error of a query that waited for the server when the client closed
/// (or, in this client, that waits for it once closed).
pub(crate) fn closed_error(id: &str, name: Option<&str>, reason: &ConnectionError) -> ErroredQuery {
    let mut details = Object::new();
    details.insert("kind", Value::from(reason.kind_name()));
    ErroredQuery::App {
        id: id.to_owned(),
        name: name.unwrap_or("legacy").to_owned(),
        message: Some(reason.message().to_owned()),
        details: Some(Value::Object(details)),
    }
}