rustial-renderer-bevy 0.0.1

Bevy Engine renderer for the rustial 2.5D map engine
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
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
//! Debug-route regression parsing and threshold evaluation.
//!
//! This module turns the structured CSV snapshots exported by the Bevy debug HUD
//! into reusable regression metrics. It is intentionally std-only so it can be
//! used from tests, examples, and CI wrappers without constructing a Bevy app.

use std::collections::HashMap;
use std::fmt;
use std::fs;
use std::path::Path;

/// Parsed subset of one row from `rustial_debug_values.csv`.
#[derive(Debug, Clone, PartialEq)]
pub struct DebugRegressionSample {
    /// Monotonic sample index written by the exporter.
    pub sample_index: u64,
    /// Sample FPS captured at the export cadence.
    pub fps: f32,
    /// Number of selected tiles in the frame.
    pub selected_tiles: usize,
    /// Number of engine-visible tiles that already have tile data.
    pub loaded_tiles: usize,
    /// Number of engine-visible tiles that are still pending.
    pub pending_tiles: usize,
    /// Number of visible tiles considered by the tile-selection diagnostics.
    pub visible_tiles: usize,
    /// Number of visible tiles backed by exact imagery.
    pub exact_visible_tiles: usize,
    /// Number of visible tiles backed by fallback imagery.
    pub fallback_visible_tiles: usize,
    /// Number of visible tiles with no imagery currently available.
    pub missing_visible_tiles: usize,
    /// Number of renderable cache entries at the time of the snapshot.
    pub cache_renderable_entries: usize,
    /// Number of queued transport requests.
    pub queued_requests: usize,
    /// Number of requests currently in flight.
    pub in_flight_requests: usize,
    /// Maximum concurrent requests allowed by the source.
    pub max_concurrent_requests: usize,
    /// Cumulative stale-cancel counter at the time of the snapshot.
    pub counter_cancelled_stale_pending: u64,
}

impl DebugRegressionSample {
    fn visible_coverage_ratio(&self) -> f64 {
        if self.visible_tiles == 0 {
            return 0.0;
        }
        (self.exact_visible_tiles + self.fallback_visible_tiles) as f64 / self.visible_tiles as f64
    }

    fn exact_coverage_ratio(&self) -> f64 {
        if self.visible_tiles == 0 {
            return 0.0;
        }
        self.exact_visible_tiles as f64 / self.visible_tiles as f64
    }

    fn is_fallback_only(&self) -> bool {
        self.visible_tiles > 0 && self.exact_visible_tiles == 0 && self.fallback_visible_tiles > 0
    }

    fn is_saturated(&self) -> bool {
        self.max_concurrent_requests > 0 && self.in_flight_requests >= self.max_concurrent_requests
    }
}

/// Aggregated regression metrics computed from a full debug route.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DebugRegressionMetrics {
    /// Number of parsed samples.
    pub total_samples: usize,
    /// First sample whose visible tile set already had tile data.
    pub first_loaded_sample_index: Option<u64>,
    /// First sample with any renderable cache entry.
    pub first_renderable_sample_index: Option<u64>,
    /// First sample where visible coverage reached at least 50%.
    pub first_majority_visible_coverage_sample_index: Option<u64>,
    /// First sample where exact-tile coverage reached at least 50%.
    pub first_majority_exact_coverage_sample_index: Option<u64>,
    /// Longest consecutive streak where coverage stayed fallback-only.
    pub longest_fallback_only_streak: usize,
    /// Longest consecutive streak with any missing visible tiles.
    pub longest_missing_visible_streak: usize,
    /// Longest consecutive streak with the request pool saturated.
    pub longest_saturated_request_streak: usize,
    /// Peak number of missing visible tiles seen in any sample.
    pub max_missing_visible_tiles: usize,
    /// Peak queued-request count seen in any sample.
    pub max_queued_requests: usize,
    /// Lowest FPS seen in the route.
    pub min_fps: f32,
    /// Final cumulative stale-cancel counter.
    pub final_counter_cancelled_stale_pending: u64,
    /// Final visible exact-coverage ratio in the last sample.
    pub final_exact_coverage_ratio: f64,
}

impl DebugRegressionMetrics {
    /// Render the metrics as a compact human-readable report.
    pub fn to_report(&self) -> String {
        let mut lines = Vec::new();
        lines.push(format!("samples: {}", self.total_samples));
        lines.push(format!(
            "first-loaded-sample: {}",
            option_or_na(self.first_loaded_sample_index)
        ));
        lines.push(format!(
            "first-renderable-sample: {}",
            option_or_na(self.first_renderable_sample_index)
        ));
        lines.push(format!(
            "first-majority-visible-coverage-sample: {}",
            option_or_na(self.first_majority_visible_coverage_sample_index)
        ));
        lines.push(format!(
            "first-majority-exact-coverage-sample: {}",
            option_or_na(self.first_majority_exact_coverage_sample_index)
        ));
        lines.push(format!(
            "longest-fallback-only-streak: {}",
            self.longest_fallback_only_streak
        ));
        lines.push(format!(
            "longest-missing-visible-streak: {}",
            self.longest_missing_visible_streak
        ));
        lines.push(format!(
            "longest-saturated-request-streak: {}",
            self.longest_saturated_request_streak
        ));
        lines.push(format!(
            "max-missing-visible-tiles: {}",
            self.max_missing_visible_tiles
        ));
        lines.push(format!("max-queued-requests: {}", self.max_queued_requests));
        lines.push(format!("min-fps: {:.3}", self.min_fps));
        lines.push(format!(
            "final-stale-cancels: {}",
            self.final_counter_cancelled_stale_pending
        ));
        lines.push(format!(
            "final-exact-coverage-ratio: {:.3}",
            self.final_exact_coverage_ratio
        ));
        lines.join("\n")
    }
}

/// Optional threshold set used to turn metrics into pass/fail checks.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct DebugRegressionThresholds {
    /// Maximum acceptable sample index for first loaded coverage.
    pub max_first_loaded_sample_index: Option<u64>,
    /// Maximum acceptable sample index for first renderable coverage.
    pub max_first_renderable_sample_index: Option<u64>,
    /// Maximum acceptable sample index for 50% visible coverage.
    pub max_first_majority_visible_coverage_sample_index: Option<u64>,
    /// Maximum acceptable sample index for 50% exact coverage.
    pub max_first_majority_exact_coverage_sample_index: Option<u64>,
    /// Maximum acceptable fallback-only streak length.
    pub max_longest_fallback_only_streak: Option<usize>,
    /// Maximum acceptable missing-visible streak length.
    pub max_longest_missing_visible_streak: Option<usize>,
    /// Maximum acceptable saturated-request streak length.
    pub max_longest_saturated_request_streak: Option<usize>,
    /// Maximum acceptable peak missing-visible count.
    pub max_missing_visible_tiles: Option<usize>,
    /// Maximum acceptable final stale-cancel counter.
    pub max_final_counter_cancelled_stale_pending: Option<u64>,
    /// Minimum acceptable final exact coverage ratio.
    pub min_final_exact_coverage_ratio: Option<f64>,
}

impl DebugRegressionThresholds {
    /// Returns `true` when no threshold is configured.
    pub fn is_empty(&self) -> bool {
        self.max_first_loaded_sample_index.is_none()
            && self.max_first_renderable_sample_index.is_none()
            && self
                .max_first_majority_visible_coverage_sample_index
                .is_none()
            && self
                .max_first_majority_exact_coverage_sample_index
                .is_none()
            && self.max_longest_fallback_only_streak.is_none()
            && self.max_longest_missing_visible_streak.is_none()
            && self.max_longest_saturated_request_streak.is_none()
            && self.max_missing_visible_tiles.is_none()
            && self.max_final_counter_cancelled_stale_pending.is_none()
            && self.min_final_exact_coverage_ratio.is_none()
    }
}

/// One failing threshold evaluation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DebugRegressionFailure {
    /// Machine-readable metric key.
    pub metric: &'static str,
    /// Human-readable failure message.
    pub message: String,
}

/// Error returned while reading or parsing a debug regression CSV export.
#[derive(Debug)]
pub enum DebugRegressionError {
    /// Failed to read the CSV file from disk.
    Io(std::io::Error),
    /// The CSV header is missing a required field.
    MissingHeader(&'static str),
    /// The file did not contain a header row.
    EmptyInput,
    /// A row could not be parsed.
    InvalidRecord {
        /// 1-based line number in the CSV input.
        line: usize,
        /// Short parse explanation.
        reason: String,
    },
}

impl fmt::Display for DebugRegressionError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Io(err) => write!(f, "failed to read debug regression CSV: {err}"),
            Self::MissingHeader(name) => write!(
                f,
                "debug regression CSV is missing required header `{name}`"
            ),
            Self::EmptyInput => write!(f, "debug regression CSV is empty"),
            Self::InvalidRecord { line, reason } => {
                write!(
                    f,
                    "invalid debug regression CSV record at line {line}: {reason}"
                )
            }
        }
    }
}

impl std::error::Error for DebugRegressionError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Io(err) => Some(err),
            _ => None,
        }
    }
}

impl From<std::io::Error> for DebugRegressionError {
    fn from(value: std::io::Error) -> Self {
        Self::Io(value)
    }
}

/// Load and parse a Bevy debug regression CSV export from disk.
pub fn load_debug_regression_samples(
    path: impl AsRef<Path>,
) -> Result<Vec<DebugRegressionSample>, DebugRegressionError> {
    let csv = fs::read_to_string(path)?;
    parse_debug_regression_csv(&csv)
}

/// Parse a Bevy debug regression CSV export from a string.
pub fn parse_debug_regression_csv(
    csv: &str,
) -> Result<Vec<DebugRegressionSample>, DebugRegressionError> {
    let mut lines = csv
        .lines()
        .enumerate()
        .filter(|(_, line)| !line.trim().is_empty());
    let Some((_, header_line)) = lines.next() else {
        return Err(DebugRegressionError::EmptyInput);
    };

    let header_fields = parse_csv_line(header_line)
        .map_err(|reason| DebugRegressionError::InvalidRecord { line: 1, reason })?;
    let header_map = header_index_map(&header_fields);

    let mut samples = Vec::new();
    for (index, line) in lines {
        let fields =
            parse_csv_line(line).map_err(|reason| DebugRegressionError::InvalidRecord {
                line: index + 1,
                reason,
            })?;
        samples.push(DebugRegressionSample {
            sample_index: parse_required_u64(&fields, &header_map, "sample_index", index + 1)?,
            fps: parse_required_f32(&fields, &header_map, "fps", index + 1)?,
            selected_tiles: parse_required_usize(
                &fields,
                &header_map,
                "selected_tiles",
                index + 1,
            )?,
            loaded_tiles: parse_required_usize(&fields, &header_map, "loaded_tiles", index + 1)?,
            pending_tiles: parse_required_usize(&fields, &header_map, "pending_tiles", index + 1)?,
            visible_tiles: parse_required_usize(&fields, &header_map, "visible_tiles", index + 1)?,
            exact_visible_tiles: parse_required_usize(
                &fields,
                &header_map,
                "exact_visible_tiles",
                index + 1,
            )?,
            fallback_visible_tiles: parse_required_usize(
                &fields,
                &header_map,
                "fallback_visible_tiles",
                index + 1,
            )?,
            missing_visible_tiles: parse_required_usize(
                &fields,
                &header_map,
                "missing_visible_tiles",
                index + 1,
            )?,
            cache_renderable_entries: parse_required_usize(
                &fields,
                &header_map,
                "cache_renderable_entries",
                index + 1,
            )?,
            queued_requests: parse_required_usize(
                &fields,
                &header_map,
                "queued_requests",
                index + 1,
            )?,
            in_flight_requests: parse_required_usize(
                &fields,
                &header_map,
                "in_flight_requests",
                index + 1,
            )?,
            max_concurrent_requests: parse_required_usize(
                &fields,
                &header_map,
                "max_concurrent_requests",
                index + 1,
            )?,
            counter_cancelled_stale_pending: parse_required_u64(
                &fields,
                &header_map,
                "counter_cancelled_stale_pending",
                index + 1,
            )?,
        });
    }

    Ok(samples)
}

/// Compute aggregate regression metrics for a parsed debug route.
pub fn compute_debug_regression_metrics(
    samples: &[DebugRegressionSample],
) -> DebugRegressionMetrics {
    if samples.is_empty() {
        return DebugRegressionMetrics::default();
    }

    let mut metrics = DebugRegressionMetrics {
        total_samples: samples.len(),
        first_loaded_sample_index: samples
            .iter()
            .find(|sample| sample.loaded_tiles > 0)
            .map(|sample| sample.sample_index),
        first_renderable_sample_index: samples
            .iter()
            .find(|sample| sample.cache_renderable_entries > 0)
            .map(|sample| sample.sample_index),
        first_majority_visible_coverage_sample_index: samples
            .iter()
            .find(|sample| sample.visible_coverage_ratio() >= 0.5)
            .map(|sample| sample.sample_index),
        first_majority_exact_coverage_sample_index: samples
            .iter()
            .find(|sample| sample.exact_coverage_ratio() >= 0.5)
            .map(|sample| sample.sample_index),
        min_fps: f32::MAX,
        ..DebugRegressionMetrics::default()
    };

    let mut fallback_streak = 0usize;
    let mut missing_streak = 0usize;
    let mut saturated_streak = 0usize;

    for sample in samples {
        metrics.max_missing_visible_tiles = metrics
            .max_missing_visible_tiles
            .max(sample.missing_visible_tiles);
        metrics.max_queued_requests = metrics.max_queued_requests.max(sample.queued_requests);
        metrics.min_fps = metrics.min_fps.min(sample.fps);

        if sample.is_fallback_only() {
            fallback_streak += 1;
            metrics.longest_fallback_only_streak =
                metrics.longest_fallback_only_streak.max(fallback_streak);
        } else {
            fallback_streak = 0;
        }

        if sample.missing_visible_tiles > 0 {
            missing_streak += 1;
            metrics.longest_missing_visible_streak =
                metrics.longest_missing_visible_streak.max(missing_streak);
        } else {
            missing_streak = 0;
        }

        if sample.is_saturated() {
            saturated_streak += 1;
            metrics.longest_saturated_request_streak = metrics
                .longest_saturated_request_streak
                .max(saturated_streak);
        } else {
            saturated_streak = 0;
        }
    }

    if let Some(last) = samples.last() {
        metrics.final_counter_cancelled_stale_pending = last.counter_cancelled_stale_pending;
        metrics.final_exact_coverage_ratio = last.exact_coverage_ratio();
    }

    metrics
}

/// Evaluate metrics against an optional threshold set.
pub fn evaluate_debug_regression_thresholds(
    metrics: &DebugRegressionMetrics,
    thresholds: &DebugRegressionThresholds,
) -> Vec<DebugRegressionFailure> {
    let mut failures = Vec::new();

    push_max_optional_failure(
        &mut failures,
        "first_loaded_sample_index",
        thresholds.max_first_loaded_sample_index,
        metrics.first_loaded_sample_index,
    );
    push_max_optional_failure(
        &mut failures,
        "first_renderable_sample_index",
        thresholds.max_first_renderable_sample_index,
        metrics.first_renderable_sample_index,
    );
    push_max_optional_failure(
        &mut failures,
        "first_majority_visible_coverage_sample_index",
        thresholds.max_first_majority_visible_coverage_sample_index,
        metrics.first_majority_visible_coverage_sample_index,
    );
    push_max_optional_failure(
        &mut failures,
        "first_majority_exact_coverage_sample_index",
        thresholds.max_first_majority_exact_coverage_sample_index,
        metrics.first_majority_exact_coverage_sample_index,
    );
    push_max_failure(
        &mut failures,
        "longest_fallback_only_streak",
        thresholds.max_longest_fallback_only_streak,
        metrics.longest_fallback_only_streak,
    );
    push_max_failure(
        &mut failures,
        "longest_missing_visible_streak",
        thresholds.max_longest_missing_visible_streak,
        metrics.longest_missing_visible_streak,
    );
    push_max_failure(
        &mut failures,
        "longest_saturated_request_streak",
        thresholds.max_longest_saturated_request_streak,
        metrics.longest_saturated_request_streak,
    );
    push_max_failure(
        &mut failures,
        "max_missing_visible_tiles",
        thresholds.max_missing_visible_tiles,
        metrics.max_missing_visible_tiles,
    );
    push_max_failure(
        &mut failures,
        "final_counter_cancelled_stale_pending",
        thresholds.max_final_counter_cancelled_stale_pending,
        metrics.final_counter_cancelled_stale_pending,
    );

    if let Some(minimum) = thresholds.min_final_exact_coverage_ratio {
        if metrics.final_exact_coverage_ratio < minimum {
            failures.push(DebugRegressionFailure {
                metric: "final_exact_coverage_ratio",
                message: format!(
                    "expected final_exact_coverage_ratio >= {:.3}, got {:.3}",
                    minimum, metrics.final_exact_coverage_ratio
                ),
            });
        }
    }

    failures
}

fn option_or_na<T: fmt::Display>(value: Option<T>) -> String {
    match value {
        Some(value) => value.to_string(),
        None => "n/a".to_string(),
    }
}

fn push_max_optional_failure<T>(
    failures: &mut Vec<DebugRegressionFailure>,
    metric: &'static str,
    maximum: Option<T>,
    actual: Option<T>,
) where
    T: fmt::Display + PartialOrd + Copy,
{
    if let Some(maximum) = maximum {
        match actual {
            Some(actual) if actual > maximum => failures.push(DebugRegressionFailure {
                metric,
                message: format!("expected {metric} <= {maximum}, got {actual}"),
            }),
            None => failures.push(DebugRegressionFailure {
                metric,
                message: format!("expected {metric} <= {maximum}, got n/a"),
            }),
            _ => {}
        }
    }
}

fn push_max_failure<T>(
    failures: &mut Vec<DebugRegressionFailure>,
    metric: &'static str,
    maximum: Option<T>,
    actual: T,
) where
    T: fmt::Display + PartialOrd + Copy,
{
    if let Some(maximum) = maximum {
        if actual > maximum {
            failures.push(DebugRegressionFailure {
                metric,
                message: format!("expected {metric} <= {maximum}, got {actual}"),
            });
        }
    }
}

fn header_index_map(headers: &[String]) -> HashMap<&str, usize> {
    headers
        .iter()
        .enumerate()
        .map(|(index, value)| (value.as_str(), index))
        .collect()
}

fn parse_required_usize(
    fields: &[String],
    headers: &HashMap<&str, usize>,
    header: &'static str,
    line: usize,
) -> Result<usize, DebugRegressionError> {
    let raw = parse_required_field(fields, headers, header)?;
    raw.parse::<usize>()
        .map_err(|_| DebugRegressionError::InvalidRecord {
            line,
            reason: format!("field `{header}` is not a valid usize: `{raw}`"),
        })
}

fn parse_required_u64(
    fields: &[String],
    headers: &HashMap<&str, usize>,
    header: &'static str,
    line: usize,
) -> Result<u64, DebugRegressionError> {
    let raw = parse_required_field(fields, headers, header)?;
    raw.parse::<u64>()
        .map_err(|_| DebugRegressionError::InvalidRecord {
            line,
            reason: format!("field `{header}` is not a valid u64: `{raw}`"),
        })
}

fn parse_required_f32(
    fields: &[String],
    headers: &HashMap<&str, usize>,
    header: &'static str,
    line: usize,
) -> Result<f32, DebugRegressionError> {
    let raw = parse_required_field(fields, headers, header)?;
    raw.parse::<f32>()
        .map_err(|_| DebugRegressionError::InvalidRecord {
            line,
            reason: format!("field `{header}` is not a valid f32: `{raw}`"),
        })
}

fn parse_required_field<'a>(
    fields: &'a [String],
    headers: &HashMap<&str, usize>,
    header: &'static str,
) -> Result<&'a str, DebugRegressionError> {
    let Some(index) = headers.get(header).copied() else {
        return Err(DebugRegressionError::MissingHeader(header));
    };
    let Some(value) = fields.get(index) else {
        return Err(DebugRegressionError::InvalidRecord {
            line: 0,
            reason: format!("row does not contain field `{header}`"),
        });
    };
    Ok(value.as_str())
}

fn parse_csv_line(line: &str) -> Result<Vec<String>, String> {
    let mut fields = Vec::new();
    let mut current = String::new();
    let mut chars = line.chars().peekable();
    let mut in_quotes = false;

    while let Some(ch) = chars.next() {
        match ch {
            '"' => {
                if in_quotes {
                    if matches!(chars.peek(), Some('"')) {
                        current.push('"');
                        chars.next();
                    } else {
                        in_quotes = false;
                    }
                } else if current.is_empty() {
                    in_quotes = true;
                } else {
                    return Err("unexpected quote in unquoted field".to_string());
                }
            }
            ',' if !in_quotes => {
                fields.push(std::mem::take(&mut current));
            }
            _ => current.push(ch),
        }
    }

    if in_quotes {
        return Err("unterminated quoted field".to_string());
    }

    fields.push(current);
    Ok(fields)
}

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

    #[test]
    fn parse_debug_csv_handles_quoted_fields() {
        let csv = "sample_index,sample_image,fps,selected_tiles,loaded_tiles,pending_tiles,visible_tiles,exact_visible_tiles,fallback_visible_tiles,missing_visible_tiles,cache_renderable_entries,queued_requests,in_flight_requests,max_concurrent_requests,counter_cancelled_stale_pending\n1,\"docs/debug/sample_0001.jpg\",9.143,82,82,0,82,42,0,0,207,0,8,32,0\n";
        let samples = parse_debug_regression_csv(csv).unwrap();
        assert_eq!(samples.len(), 1);
        assert_eq!(samples[0].sample_index, 1);
        assert_eq!(samples[0].fps, 9.143);
        assert_eq!(samples[0].exact_visible_tiles, 42);
        assert_eq!(samples[0].cache_renderable_entries, 207);
    }

    #[test]
    fn compute_metrics_tracks_streaks_and_thresholds() {
        let csv = "sample_index,sample_image,fps,selected_tiles,loaded_tiles,pending_tiles,visible_tiles,exact_visible_tiles,fallback_visible_tiles,missing_visible_tiles,cache_renderable_entries,queued_requests,in_flight_requests,max_concurrent_requests,counter_cancelled_stale_pending\n1,\"a\",10.0,10,0,10,10,0,10,0,0,5,4,4,0\n2,\"b\",9.0,10,0,10,10,0,10,2,0,7,4,4,2\n3,\"c\",8.0,10,8,2,10,6,2,0,8,2,2,4,3\n4,\"d\",7.0,10,10,0,10,8,2,0,8,1,1,4,4\n";
        let samples = parse_debug_regression_csv(csv).unwrap();
        let metrics = compute_debug_regression_metrics(&samples);
        assert_eq!(metrics.total_samples, 4);
        assert_eq!(metrics.first_loaded_sample_index, Some(3));
        assert_eq!(metrics.first_renderable_sample_index, Some(3));
        assert_eq!(
            metrics.first_majority_visible_coverage_sample_index,
            Some(1)
        );
        assert_eq!(metrics.first_majority_exact_coverage_sample_index, Some(3));
        assert_eq!(metrics.longest_fallback_only_streak, 2);
        assert_eq!(metrics.longest_missing_visible_streak, 1);
        assert_eq!(metrics.longest_saturated_request_streak, 2);
        assert_eq!(metrics.max_missing_visible_tiles, 2);
        assert_eq!(metrics.final_counter_cancelled_stale_pending, 4);

        let thresholds = DebugRegressionThresholds {
            max_first_majority_exact_coverage_sample_index: Some(2),
            max_longest_fallback_only_streak: Some(1),
            max_missing_visible_tiles: Some(1),
            max_final_counter_cancelled_stale_pending: Some(3),
            min_final_exact_coverage_ratio: Some(0.9),
            ..DebugRegressionThresholds::default()
        };
        let failures = evaluate_debug_regression_thresholds(&metrics, &thresholds);
        assert_eq!(failures.len(), 5);
    }

    #[test]
    fn workspace_capture_structural_invariants() {
        let csv = include_str!(concat!(
            env!("CARGO_MANIFEST_DIR"),
            "/../../docs/debug/rustial_debug_values.csv"
        ));
        let samples = parse_debug_regression_csv(csv).unwrap();
        let metrics = compute_debug_regression_metrics(&samples);

        // The CSV is mutable demo output; only assert structural invariants
        // that hold regardless of how well the engine performs.
        assert!(metrics.total_samples >= 300);
        assert_eq!(metrics.first_loaded_sample_index, Some(1));
        assert_eq!(metrics.first_renderable_sample_index, Some(1));
    }
}