jshift 0.7.0

Schema-guided typed JSON on raw bytes: path get/mutate, open views, project — without a Value tree.
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
//! Bench array splice + derive mutator (`set_*` / `append_*` / `prepend_*` / `insert_*` /
//! `delete_*`) + `project_each` (list / filter / slice) on a ~50 MiB document vs serde_json.
//!
//! ```bash
//! cargo run --release --example array_insert_bench
//! # ARRAY_BENCH_MIB=50 ARRAY_BENCH_ITERS=12 cargo run --release --example array_insert_bench
//! ```

use std::env;
use std::time::{Duration, Instant};

use jshift::{
    append_to_array, array_len, delete_index, insert_array_element, parse_path, prepend_to_array,
    project_each, project_jmespath, JsonMutatorSchema, ProjectPlan,
};

/// Open view over root metadata — does **not** load the huge `items` array.
#[derive(JsonMutatorSchema)]
struct CatalogMeta {
    status: String,
    tags: Vec<String>,
}

/// Sparse JMES read of the first catalog row (no full items materialization).
#[derive(JsonMutatorSchema)]
struct FirstItem {
    #[json(path = "id", jmes = "items[0].id")]
    id: u64,
    #[json(path = "t", jmes = "items[0].t")]
    t: String,
}

fn med(mut v: Vec<Duration>) -> Duration {
    v.sort();
    v[v.len() / 2]
}

fn time_it(iters: usize, warm: usize, mut f: impl FnMut()) -> Duration {
    for _ in 0..warm {
        f();
    }
    let mut times = Vec::with_capacity(iters);
    for _ in 0..iters {
        let t = Instant::now();
        f();
        times.push(t.elapsed());
    }
    med(times)
}

fn fmt(d: Duration) -> String {
    if d.as_secs_f64() >= 1.0 {
        format!("{:.3} s", d.as_secs_f64())
    } else if d.as_millis() >= 1 {
        format!("{:.2} ms", d.as_secs_f64() * 1000.0)
    } else {
        format!("{:.1} µs", d.as_secs_f64() * 1e6)
    }
}

fn ratio(js: Duration, se: Duration) -> String {
    format!("~{:.1}×", se.as_secs_f64() / js.as_secs_f64().max(1e-12))
}

/// ~target_mib of `{"status":"ok","tags":["seed"],"items":[…]}`.
fn gen_catalog(target_mib: usize) -> Vec<u8> {
    let target = target_mib.saturating_mul(1024 * 1024);
    let mut out = Vec::with_capacity(target + 1024);
    out.extend_from_slice(br#"{"status":"ok","tags":["seed"],"items":["#);
    let mut i = 0u64;
    while out.len() < target {
        if i > 0 {
            out.push(b',');
        }
        out.extend_from_slice(br#"{"id":"#);
        out.extend_from_slice(i.to_string().as_bytes());
        out.extend_from_slice(br#","t":"item-"#);
        out.extend_from_slice(i.to_string().as_bytes());
        // Alternate `n` so filter `items[?n]` keeps ~half the catalog.
        if i % 2 == 0 {
            out.extend_from_slice(br#"-xxxxxxxxxxxxxxxx","n":true}"#);
        } else {
            out.extend_from_slice(br#"-xxxxxxxxxxxxxxxx","n":false}"#);
        }
        i += 1;
    }
    out.extend_from_slice(br#"]}"#);
    out
}

fn main() {
    let mib: usize = env::var("ARRAY_BENCH_MIB")
        .ok()
        .and_then(|s| s.parse().ok())
        .unwrap_or(50);
    let iters: usize = env::var("ARRAY_BENCH_ITERS")
        .ok()
        .and_then(|s| s.parse().ok())
        .unwrap_or(if mib >= 40 { 12 } else { 25 });
    let warm = 2usize;

    eprintln!("generating ~{mib} MiB catalog…");
    let base = gen_catalog(mib);
    let items_path = parse_path("items");
    let n = array_len(&base, &items_path).unwrap();
    let mid = n / 2;
    eprintln!(
        "size={:.2} MiB  items={n}  mid={mid}  iters={iters}\n",
        base.len() as f64 / 1024.0 / 1024.0
    );

    let elem = br#"{"id":999999,"t":"NEW","n":false}"#;

    // ── free-function array splice on huge `items` ───────────────────────
    let j_pre = time_it(iters, warm, || {
        let mut json = base.clone();
        prepend_to_array(&mut json, &items_path, elem).unwrap();
        assert_eq!(array_len(&json, &items_path).unwrap(), n + 1);
    });
    let s_pre = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["items"]
            .as_array_mut()
            .unwrap()
            .insert(0, serde_json::json!({"id":999999,"t":"NEW","n":false}));
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_mid = time_it(iters, warm, || {
        let mut json = base.clone();
        insert_array_element(&mut json, &items_path, mid, elem).unwrap();
        assert_eq!(array_len(&json, &items_path).unwrap(), n + 1);
    });
    let s_mid = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["items"].as_array_mut().unwrap().insert(
            mid,
            serde_json::json!({"id":999999,"t":"NEW","n":false}),
        );
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_end = time_it(iters, warm, || {
        let mut json = base.clone();
        insert_array_element(&mut json, &items_path, n, elem).unwrap();
        assert_eq!(array_len(&json, &items_path).unwrap(), n + 1);
    });
    let s_end = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["items"]
            .as_array_mut()
            .unwrap()
            .push(serde_json::json!({"id":999999,"t":"NEW","n":false}));
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_app = time_it(iters, warm, || {
        let mut json = base.clone();
        append_to_array(&mut json, &items_path, elem).unwrap();
        assert_eq!(array_len(&json, &items_path).unwrap(), n + 1);
    });

    // ── derive mutator on open view (status + tags only; items unread) ───
    let j_set = time_it(iters, warm, || {
        let mut json = base.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.set_status("skipped").unwrap();
        let meta = CatalogMeta::read_from_json(&json).unwrap();
        assert_eq!(meta.status, "skipped");
        assert_eq!(meta.tags, vec!["seed".to_string()]);
    });
    let s_set = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["status"] = serde_json::json!("skipped");
        let out = serde_json::to_vec(&v).unwrap();
        assert!(out.windows(9).any(|w| w == b"\"skipped\""));
    });

    let j_m_app = time_it(iters, warm, || {
        let mut json = base.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.append_tags("new").unwrap();
        let meta = CatalogMeta::read_from_json(&json).unwrap();
        assert_eq!(meta.tags, vec!["seed".to_string(), "new".to_string()]);
    });
    let s_m_app = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["tags"].as_array_mut().unwrap().push(serde_json::json!("new"));
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_m_pre = time_it(iters, warm, || {
        let mut json = base.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.prepend_tags("hot").unwrap();
        let meta = CatalogMeta::read_from_json(&json).unwrap();
        assert_eq!(meta.tags[0], "hot");
    });
    let s_m_pre = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["tags"]
            .as_array_mut()
            .unwrap()
            .insert(0, serde_json::json!("hot"));
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_m_ins = time_it(iters, warm, || {
        let mut json = base.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.insert_tags(1, "mid").unwrap(); // after "seed"
        let meta = CatalogMeta::read_from_json(&json).unwrap();
        assert_eq!(
            meta.tags,
            vec!["seed".to_string(), "mid".to_string()]
        );
    });
    let s_m_ins = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["tags"]
            .as_array_mut()
            .unwrap()
            .insert(1, serde_json::json!("mid"));
        let _ = serde_json::to_vec(&v).unwrap();
    });

    // ── mutator deletes (open view: tags/status; free mid-item delete) ───
    // Seed with two tags so delete_tags_at(0) is non-empty after.
    let base_two_tags = {
        let mut j = base.clone();
        let mut m = CatalogMeta::mutator(&mut j);
        m.append_tags("extra").unwrap();
        drop(m);
        j
    };

    let j_del_status = time_it(iters, warm, || {
        let mut json = base.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.delete_status().unwrap();
        drop(m);
        assert!(CatalogMeta::read_from_json(&json).is_err());
    });
    let s_del_status = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v.as_object_mut().unwrap().remove("status");
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_del_tags_at = time_it(iters, warm, || {
        let mut json = base_two_tags.clone();
        let mut m = CatalogMeta::mutator(&mut json);
        m.delete_tags_at(0).unwrap();
        drop(m);
        let meta = CatalogMeta::read_from_json(&json).unwrap();
        assert_eq!(meta.tags, vec!["extra".to_string()]);
    });
    let s_del_tags_at = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base_two_tags).unwrap();
        v["tags"].as_array_mut().unwrap().remove(0);
        let _ = serde_json::to_vec(&v).unwrap();
    });

    let j_del_mid = time_it(iters, warm, || {
        let mut json = base.clone();
        delete_index(&mut json, &items_path, mid).unwrap();
        assert_eq!(array_len(&json, &items_path).unwrap(), n - 1);
    });
    let s_del_mid = time_it(iters, 1, || {
        let mut v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        v["items"].as_array_mut().unwrap().remove(mid);
        let _ = serde_json::to_vec(&v).unwrap();
    });

    // ── project_each: full list / filter / slice vs serde rebuild ────────
    let plan_each = ProjectPlan::from_jmespath("items[*].{id: id, t: t}").unwrap();
    let plan_filt = ProjectPlan::from_jmespath("items[?n].{id: id, t: t}").unwrap();
    let plan_slice = ProjectPlan::from_jmespath("items[0:1000].{id: id, t: t}").unwrap();

    let j_each = time_it(iters, warm, || {
        let mut count = 0usize;
        let mut bytes = 0usize;
        project_each(&base, &plan_each, |_, card| {
            count += 1;
            bytes = bytes.wrapping_add(card.len());
            Ok(())
        })
        .unwrap();
        assert_eq!(count, n);
        assert!(bytes > 0);
    });
    let s_each = time_it(iters, 1, || {
        let v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        let cards: Vec<serde_json::Value> = v["items"]
            .as_array()
            .unwrap()
            .iter()
            .map(|it| {
                serde_json::json!({
                    "id": it["id"].clone(),
                    "t": it["t"].clone(),
                })
            })
            .collect();
        assert_eq!(cards.len(), n);
        let _ = serde_json::to_vec(&cards).unwrap();
    });

    let j_filt = time_it(iters, warm, || {
        let mut count = 0usize;
        project_each(&base, &plan_filt, |_, card| {
            count += 1;
            assert!(card.starts_with(b"{"));
            Ok(())
        })
        .unwrap();
        // ~half of items have n:true
        assert!(count > n / 3 && count < (2 * n) / 3 + 1);
    });
    let s_filt = time_it(iters, 1, || {
        let v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        let cards: Vec<serde_json::Value> = v["items"]
            .as_array()
            .unwrap()
            .iter()
            .filter(|it| it["n"].as_bool() == Some(true))
            .map(|it| {
                serde_json::json!({
                    "id": it["id"].clone(),
                    "t": it["t"].clone(),
                })
            })
            .collect();
        assert!(cards.len() > n / 3);
        let _ = serde_json::to_vec(&cards).unwrap();
    });

    let j_slice = time_it(iters, warm, || {
        let mut count = 0usize;
        project_each(&base, &plan_slice, |_, card| {
            count += 1;
            assert!(card.starts_with(b"{"));
            Ok(())
        })
        .unwrap();
        assert_eq!(count, 1000.min(n));
    });
    let s_slice = time_it(iters, 1, || {
        let v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        let cards: Vec<serde_json::Value> = v["items"]
            .as_array()
            .unwrap()
            .iter()
            .take(1000)
            .map(|it| {
                serde_json::json!({
                    "id": it["id"].clone(),
                    "t": it["t"].clone(),
                })
            })
            .collect();
        assert_eq!(cards.len(), 1000.min(n));
        let _ = serde_json::to_vec(&cards).unwrap();
    });

    // ── JMES sparse read of items[0] via derive + free project_jmespath ──
    let j_jmes_view = time_it(iters, warm, || {
        let first = FirstItem::read_from_json(&base).unwrap();
        assert_eq!(first.id, 0);
        assert!(first.t.starts_with("item-0"));
    });
    let j_jmes_proj = time_it(iters, warm, || {
        let out = project_jmespath(&base, "items[0].{id: id, t: t}").unwrap();
        assert!(out.windows(6).any(|w| w == b"\"id\":0") || out.contains(&b'0'));
    });
    let s_jmes = time_it(iters, 1, || {
        let v: serde_json::Value = serde_json::from_slice(&base).unwrap();
        let id = v["items"][0]["id"].as_u64().unwrap();
        let t = v["items"][0]["t"].as_str().unwrap().to_string();
        assert_eq!(id, 0);
        assert!(t.starts_with("item-0"));
    });

    println!("=== Array + mutator + project_each + JMES bench (~{mib} MiB, {n} items) ===\n");
    println!("| Workload | jshift | serde parse+edit+to_vec* | **jshift vs serde** |");
    println!("| :--- | ---: | ---: | ---: |");
    println!(
        "| Free **prepend** `items` | {} | {} | {} |",
        fmt(j_pre),
        fmt(s_pre),
        ratio(j_pre, s_pre)
    );
    println!(
        "| Free **insert mid** `items[{mid}]` | {} | {} | {} |",
        fmt(j_mid),
        fmt(s_mid),
        ratio(j_mid, s_mid)
    );
    println!(
        "| Free **insert end** / **append** `items` | {} / {} | {} | {} / {} |",
        fmt(j_end),
        fmt(j_app),
        fmt(s_end),
        ratio(j_end, s_end),
        ratio(j_app, s_end)
    );
    println!(
        "| Free **delete mid** `items[{mid}]` | {} | {} | {} |",
        fmt(j_del_mid),
        fmt(s_del_mid),
        ratio(j_del_mid, s_del_mid)
    );
    println!(
        "| Mutator **`set_status`** (open view) | {} | {} | {} |",
        fmt(j_set),
        fmt(s_set),
        ratio(j_set, s_set)
    );
    println!(
        "| Mutator **`append_tags`** | {} | {} | {} |",
        fmt(j_m_app),
        fmt(s_m_app),
        ratio(j_m_app, s_m_app)
    );
    println!(
        "| Mutator **`prepend_tags`** | {} | {} | {} |",
        fmt(j_m_pre),
        fmt(s_m_pre),
        ratio(j_m_pre, s_m_pre)
    );
    println!(
        "| Mutator **`insert_tags(1, …)`** | {} | {} | {} |",
        fmt(j_m_ins),
        fmt(s_m_ins),
        ratio(j_m_ins, s_m_ins)
    );
    println!(
        "| Mutator **`delete_status`** | {} | {} | {} |",
        fmt(j_del_status),
        fmt(s_del_status),
        ratio(j_del_status, s_del_status)
    );
    println!(
        "| Mutator **`delete_tags_at(0)`** | {} | {} | {} |",
        fmt(j_del_tags_at),
        fmt(s_del_tags_at),
        ratio(j_del_tags_at, s_del_tags_at)
    );
    println!(
        "| **`project_each`** `items[*].{{id,t}}` | {} | {} | {} |",
        fmt(j_each),
        fmt(s_each),
        ratio(j_each, s_each)
    );
    println!(
        "| **`project_each`** `items[?n].{{id,t}}` | {} | {} | {} |",
        fmt(j_filt),
        fmt(s_filt),
        ratio(j_filt, s_filt)
    );
    println!(
        "| **`project_each`** `items[0:1000].{{id,t}}` | {} | {} | {} |",
        fmt(j_slice),
        fmt(s_slice),
        ratio(j_slice, s_slice)
    );
    println!(
        "| Derive **JMES** `items[0].id`/`t` read | {} | {} | {} |",
        fmt(j_jmes_view),
        fmt(s_jmes),
        ratio(j_jmes_view, s_jmes)
    );
    println!(
        "| Free **JMES** `items[0].{{id,t}}` project | {} | {} | {} |",
        fmt(j_jmes_proj),
        fmt(s_jmes),
        ratio(j_jmes_proj, s_jmes)
    );

    eprintln!(
        "\n*Serde column is full-document parse + edit + `to_vec` \
         (JMES rows: parse + index only; `project_each` rows: parse + thin-array rebuild).\n\
         Mutator/JMES views never load `items` into a Rust `Vec`.\n\
         `project_each` holds **one card** at a time; serde rebuilds a full projected array.\n\
         Clone/memmove of ~{mib} MiB still appears in splice/delete-mid free-function rows."
    );
}