rig-core 0.45.0

//! Checks every completion family runs against its own wire: a reply decoded
//! whole and the same reply restated as a stream fold into one assistant
//! turn, and a wire enum's every variant is sampled.
//!
//! ```
//! use rig_core::test_utils::history::assert_every_variant;
//!
//! enum Item {
//!     Text,
//!     Call,
//! }
//!
//! let index = |item: &Item| match item {
//!     Item::Text => 0,
//!     Item::Call => 1,
//! };
//! assert_every_variant(&[Item::Text, Item::Call], index, 2);
//! ```

use crate::completion::{CompletionRequest, CompletionResponse};
use crate::error::ProviderError;
use crate::operation::Completion;
use crate::wire::{Mode, Wire};

/// The response `frames` fold into through `wire`'s decoder, as one reply
/// in `mode`, without a transport.
///
/// # Errors
///
/// What the reply fails with ([`decode_reply`](crate::wire::decode_reply)).
pub fn decode<W: Wire<Op = Completion>>(
    wire: &W,
    mode: Mode,
    frames: impl IntoIterator<Item = W::Frame>,
) -> Result<CompletionResponse, ProviderError> {
    crate::wire::decode_reply(wire, &CompletionRequest::new("restate"), mode, frames)
}

/// Assert a reply decoded whole (`whole`) and the same reply restated as a
/// stream (`streamed`) fold into the same assistant turn: the same blocks
/// in the same order, the same provider items, origin and stop. Each decode
/// issues its own ids for calls the wire sent without one, so rig-issued ids
/// are compared by position.
///
/// # Panics
///
/// When either reply fails to decode or the turns differ.
pub fn assert_restated_agrees<W: Wire<Op = Completion>>(
    wire: &W,
    whole: impl IntoIterator<Item = W::Frame>,
    streamed: impl IntoIterator<Item = W::Frame>,
) {
    let unary = decode(wire, Mode::Unary, whole);
    let stream = decode(wire, Mode::Streaming, streamed);
    match (unary, stream) {
        (Ok(unary), Ok(stream)) => assert_eq!(
            numbered(serde_json::json!(unary.message())),
            numbered(serde_json::json!(stream.message())),
            "a whole reply and its restatement as a stream fold into the same turn"
        ),
        (unary, stream) => {
            assert!(
                unary.is_ok() && stream.is_ok(),
                "both replies decode: unary {unary:?}, streamed {stream:?}"
            );
        }
    }
}

/// `turn` with each rig-issued call id replaced by its position, and the
/// fingerprints that cover those ids left out.
fn numbered(mut turn: serde_json::Value) -> serde_json::Value {
    fn walk(value: &mut serde_json::Value, next: &mut usize) {
        match value {
            serde_json::Value::Object(fields) => {
                fields.shift_remove("fingerprint");
                if let Some(local) = fields.get_mut("local") {
                    *local = serde_json::json!(*next);
                    *next += 1;
                }
                fields.values_mut().for_each(|value| walk(value, next));
            }
            serde_json::Value::Array(values) => {
                values.iter_mut().for_each(|value| walk(value, next));
            }
            _ => {}
        }
    }
    walk(&mut turn, &mut 0);
    turn
}

/// Assert `samples` exercise every one of the `count` variants `index`
/// numbers. Pair it with an exhaustive, wildcard-free `index`: a new
/// variant then fails to compile until it is numbered, and fails here
/// until a sample decodes to it.
///
/// # Panics
///
/// When a variant has no sample or an index is out of range.
pub fn assert_every_variant<T>(samples: &[T], index: impl Fn(&T) -> usize, count: usize) {
    let seen: std::collections::BTreeSet<usize> = samples.iter().map(index).collect();
    let missing: Vec<usize> = (0..count).filter(|at| !seen.contains(at)).collect();
    assert!(missing.is_empty(), "no sample for variants {missing:?}");
    assert!(
        seen.iter().all(|at| *at < count),
        "a variant index is out of range"
    );
}

#[cfg(test)]
mod tests;