freeswitch-types 1.7.0-rc2

//! Bridge dial string builder for multi-endpoint bridge commands.
//!
//! Supports simultaneous ring (`,`) and sequential failover (`|`)
//! with per-endpoint channel variables and global default variables.

use std::fmt;
use std::str::FromStr;

use super::endpoint::{DialString, Endpoint};
use super::originate::OriginateError;
use super::variables::{
    installed_variables, read_error, BlockParse, DialStringCarrier, DialStringTarget, Variables,
};
use crate::switch_passes::brackets::Block;
use crate::switch_passes::originate_legs::Leg;
use crate::switch_passes::pipeline;

/// A bridge dial string is the argument of a dialplan application, which
/// receives it whole, so it renders and parses one escaping level shallower
/// than the [`DialStringCarrier::EslApi`] default the endpoint types use on
/// their own.
const CARRIER: DialStringCarrier = DialStringCarrier::Dialplan;

/// Typed bridge dial string.
///
/// Format: `{global_vars}[ep1_vars]ep1,[ep2_vars]ep2|[ep3_vars]ep3`
///
/// - `,` separates endpoints rung simultaneously (within a group)
/// - `|` separates groups tried sequentially (failover)
/// - Each endpoint may have channel-scope `[variables]`
/// - Global `{variables}` apply to all endpoints
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(try_from = "config::BridgeDialString"))]
pub struct BridgeDialString {
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    variables: Option<Variables>,
    groups: Vec<Vec<Endpoint>>,
}

impl BridgeDialString {
    /// Create a new bridge dial string with the given failover groups.
    pub fn new(groups: Vec<Vec<Endpoint>>) -> Self {
        Self {
            variables: None,
            groups,
        }
    }

    /// Set global default-scope variables.
    pub fn with_variables(mut self, variables: Variables) -> Self {
        self.variables = Some(variables);
        self
    }

    /// Default-scope variables applied to all endpoints.
    pub fn variables(&self) -> Option<&Variables> {
        self.variables
            .as_ref()
    }

    /// Sequential failover groups (`|`-separated). Within each group,
    /// endpoints ring simultaneously (`,`-separated).
    pub fn groups(&self) -> &[Vec<Endpoint>] {
        &self.groups
    }

    /// Mutable reference to the default-scope variables.
    pub fn variables_mut(&mut self) -> &mut Option<Variables> {
        &mut self.variables
    }

    /// Mutable reference to the failover groups.
    pub fn groups_mut(&mut self) -> &mut Vec<Vec<Endpoint>> {
        &mut self.groups
    }
}

/// Renders a [`BridgeDialString`] for one parser revision. Returned by
/// [`BridgeDialString::display_with`].
#[derive(Debug, Clone, Copy)]
pub struct BridgeDialStringDisplay<'a> {
    bridge: &'a BridgeDialString,
    block_parse: BlockParse,
}

impl fmt::Display for BridgeDialStringDisplay<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.bridge
            .write_with(f, self.block_parse)
    }
}

impl fmt::Display for BridgeDialString {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.write_with(f, BlockParse::default())
    }
}

impl FromStr for BridgeDialString {
    type Err = OriginateError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Self::parse_with(s, BlockParse::default())
    }
}

impl BridgeDialString {
    /// Render for a switch running `block_parse`, rather than the default
    /// revision [`Display`](fmt::Display) uses.
    pub fn display_with(&self, block_parse: BlockParse) -> BridgeDialStringDisplay<'_> {
        BridgeDialStringDisplay {
            bridge: self,
            block_parse,
        }
    }

    fn write_with(&self, f: &mut fmt::Formatter<'_>, block_parse: BlockParse) -> fmt::Result {
        let target = DialStringTarget::new(CARRIER).with_block_parse(block_parse);
        if let Some(vars) = &self.variables {
            if !vars.is_empty() {
                write!(f, "{}", vars.display_for(target))?;
            }
        }
        for (gi, group) in self
            .groups
            .iter()
            .enumerate()
        {
            if gi > 0 {
                f.write_str("|")?;
            }
            for (ei, ep) in group
                .iter()
                .enumerate()
            {
                if ei > 0 {
                    f.write_str(",")?;
                }
                write!(f, "{}", ep.display_for(target))?;
            }
        }
        Ok(())
    }

    /// Parse a dial string written for a switch running `block_parse`, mirroring
    /// [`display_with`](Self::display_with).
    pub fn parse_with(s: &str, block_parse: BlockParse) -> Result<Self, OriginateError> {
        let target = DialStringTarget::new(CARRIER).with_block_parse(block_parse);
        let s = s.trim_matches(' ');
        if s.is_empty() {
            return Err(OriginateError::ParseError(
                "empty bridge dial string".into(),
            ));
        }

        let list = pipeline::read(s, target).map_err(read_error)?;
        let [thread] = &list.threads[..] else {
            return Err(OriginateError::ParseError(
                "a bridge dial string has no enterprise threads".into(),
            ));
        };
        if !list
            .blocks
            .is_empty()
            || thread
                .blocks
                .len()
                > 1
        {
            return Err(OriginateError::ParseError(
                "a bridge dial string carries one leading variable block".into(),
            ));
        }
        let variables = installed_variables(
            thread
                .blocks
                .first(),
        )?;

        let mut groups = Vec::new();
        for group in &thread.groups {
            let legs: Vec<&Leg> = group
                .iter()
                .filter(|leg| {
                    !leg.blocks
                        .is_empty()
                        || !leg
                            .endpoint
                            .is_empty()
                })
                .collect();
            let texts: Option<Vec<&str>> = legs
                .iter()
                .map(|leg| {
                    s.get(
                        leg.raw
                            .clone(),
                    )
                })
                .collect();
            if let Some(texts) = texts {
                let joined = legs
                    .iter()
                    .map(|leg| reading(leg))
                    .collect();
                if legs_interfere(texts, Some(joined), target) {
                    return Err(OriginateError::BracketSpansLegs {
                        group: groups.len(),
                    });
                }
            }
            let mut endpoints = Vec::new();
            for leg in legs {
                if leg
                    .blocks
                    .len()
                    > 1
                {
                    return Err(OriginateError::ParseError(
                        "an endpoint carries one variable block".into(),
                    ));
                }
                let vars = installed_variables(
                    leg.blocks
                        .first(),
                )?;
                let mut endpoint = Endpoint::parse_bare(&leg.endpoint)?;
                if vars.is_some() {
                    endpoint.set_variables(vars);
                    if endpoint
                        .variables()
                        .is_none()
                    {
                        return Err(OriginateError::VariablesNotSupported(endpoint.kind()));
                    }
                }
                endpoints.push(endpoint);
            }
            if !endpoints.is_empty() {
                groups.push(endpoints);
            }
        }

        let bridge = Self { variables, groups };
        bridge.check_legs(block_parse)?;
        Ok(bridge)
    }

    /// Refuse a group whose legs the switch's comma scan reads across.
    fn check_legs(&self, block_parse: BlockParse) -> Result<(), OriginateError> {
        let target = DialStringTarget::new(CARRIER).with_block_parse(block_parse);
        match self
            .groups
            .iter()
            .position(|group| endpoints_interfere(group, target))
        {
            Some(group) => Err(OriginateError::BracketSpansLegs { group }),
            None => Ok(()),
        }
    }
}

/// What the switch installs on a leg and the endpoint text it dials.
type LegReading = (Vec<Block>, String);

fn reading(leg: &Leg) -> LegReading {
    (
        leg.blocks
            .clone(),
        leg.endpoint
            .clone(),
    )
}

/// Each leg the switch reads of `text`, as one group.
fn read_group(text: &str, target: DialStringTarget) -> Option<Vec<LegReading>> {
    let list = pipeline::read(text, target).ok()?;
    let [thread] = &list.threads[..] else {
        return None;
    };
    let [group] = &thread.groups[..] else {
        return None;
    };
    Some(
        group
            .iter()
            .map(reading)
            .collect(),
    )
}

/// Whether the switch reads a group otherwise than each of its leg `texts` dialled alone, as a
/// bracket range `switch_ivr_originate`'s comma scan runs from one leg into another makes it.
fn legs_interfere<'a>(
    texts: impl IntoIterator<Item = &'a str>,
    joined: Option<Vec<LegReading>>,
    target: DialStringTarget,
) -> bool {
    let Some(alone) = texts
        .into_iter()
        .map(|text| read_group(text, target))
        .collect::<Option<Vec<_>>>()
    else {
        return false;
    };
    joined != Some(alone.concat())
}

/// [`legs_interfere`] for a group's endpoints as they render.
fn endpoints_interfere(group: &[Endpoint], target: DialStringTarget) -> bool {
    let rendered: Vec<String> = group
        .iter()
        .map(|endpoint| {
            endpoint
                .display_for(target)
                .to_string()
        })
        .collect();
    let joined = read_group(&rendered.join(","), target);
    legs_interfere(
        rendered
            .iter()
            .map(String::as_str),
        joined,
        target,
    )
}

#[cfg(feature = "serde")]
mod config {
    use crate::commands::endpoint::Endpoint;
    use crate::commands::variables::Variables;

    #[derive(serde::Deserialize)]
    pub(super) struct BridgeDialString {
        #[serde(default)]
        pub(super) variables: Option<Variables>,
        pub(super) groups: Vec<Vec<Endpoint>>,
    }
}

#[cfg(feature = "serde")]
impl TryFrom<config::BridgeDialString> for BridgeDialString {
    type Error = OriginateError;

    fn try_from(config: config::BridgeDialString) -> Result<Self, Self::Error> {
        let bridge = Self {
            variables: config.variables,
            groups: config.groups,
        };
        bridge.check_legs(BlockParse::default())?;
        Ok(bridge)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::commands::endpoint::{
        AudioEndpoint, DialString, ErrorEndpoint, LoopbackEndpoint, SofiaEndpoint, SofiaGateway,
    };
    use crate::commands::variables::{BlockParse, VariablesType};

    /// The comma scan runs after the application's argument is expanded, which here unescapes the
    /// quote that kept the `[` and `]` apart, so the switch dials both endpoints as one leg.
    #[cfg(feature = "serde")]
    #[test]
    fn a_bracket_spanning_legs_after_expansion_is_refused() {
        let bridge = BridgeDialString::new(vec![vec![
            crate::commands::endpoint::UserEndpoint::new("['").into(),
            SofiaGateway::new("", "]")
                .with_profile(" ")
                .into(),
        ]]);
        let json = serde_json::to_value(&bridge).unwrap();
        assert!(matches!(
            serde_json::from_value::<BridgeDialString>(json)
                .map_err(|e| e.to_string()),
            Err(e) if e.contains("group 0")
        ));
    }

    // === Display ===

    /// `Display` and `FromStr` are the default revision, not a second render path.
    #[test]
    fn display_and_from_str_are_the_default_revision() {
        let mut vars = Variables::new(VariablesType::Default);
        vars.insert("cid", "it's");
        let mut ep_vars = Variables::new(VariablesType::Channel);
        ep_vars.insert("path", r"C:\path");
        let bridge = BridgeDialString::new(vec![vec![SofiaGateway::new("gw", "1234")
            .with_variables(ep_vars)
            .into()]])
        .with_variables(vars);

        let rendered = bridge
            .display_with(BlockParse::PairSplitCleans)
            .to_string();
        assert_eq!(rendered, bridge.to_string());
        assert_eq!(
            BridgeDialString::parse_with(&rendered, BlockParse::PairSplitCleans)
                .unwrap_or_else(|e| panic!("{rendered} failed to parse: {e}")),
            bridge
        );
    }

    /// The block reaches a dialplan application whole, one tokenizer pass
    /// shallower than an `originate` argument, so a quoted value carries one
    /// backslash fewer here than the same value rendered on its own.
    #[test]
    fn bridge_renders_one_level_shallower_than_the_default() {
        let mut vars = Variables::new(VariablesType::Default);
        vars.insert("cid", "it's");
        let ep = SofiaGateway::new("gw", "18005551234");
        let bridge = BridgeDialString::new(vec![vec![ep.into()]]).with_variables(vars.clone());

        assert_eq!(
            bridge.to_string(),
            r"{cid=it\\\\\\'s}sofia/gateway/gw/18005551234"
        );
        assert_eq!(vars.to_string(), r"{cid=it\\\\\\\'s}");
    }

    /// Both halves have to agree on the carrier. Rendering at dialplan depth
    /// and parsing back at the default would unescape one level too deep and
    /// silently return a different value than was put in.
    #[test]
    fn per_endpoint_escaped_values_round_trip() {
        let mut ep_vars = Variables::new(VariablesType::Channel);
        ep_vars.insert("path", r"C:\path");
        ep_vars.insert("other", "a,b");
        let bridge = BridgeDialString::new(vec![vec![SofiaGateway::new("gw", "1234")
            .with_variables(ep_vars)
            .into()]]);

        let rendered = bridge.to_string();
        let back: BridgeDialString = rendered
            .parse()
            .unwrap_or_else(|e| panic!("{rendered} failed to parse: {e}"));
        assert_eq!(back, bridge, "rendered {rendered}");
    }

    /// A quote in a `[]` block pairs across values before the switch parses the
    /// block, at any escaping depth, so the parser refuses one rather than hand
    /// back a value the wire would not deliver.
    #[test]
    fn per_endpoint_quoted_value_is_refused() {
        let err = r"[cid=it\\\\\\'s]sofia/gateway/gw/1234"
            .parse::<BridgeDialString>()
            .unwrap_err()
            .to_string();
        assert!(
            err.contains("cid") && err.contains("channel scope"),
            "error does not name the variable and scope: {err}"
        );
    }

    #[test]
    fn display_single_endpoint() {
        let bridge =
            BridgeDialString::new(vec![vec![
                SofiaGateway::new("my_provider", "18005551234").into()
            ]]);
        assert_eq!(bridge.to_string(), "sofia/gateway/my_provider/18005551234");
    }

    #[test]
    fn display_simultaneous_ring() {
        let bridge = BridgeDialString::new(vec![vec![
            SofiaGateway::new("primary", "18005551234").into(),
            SofiaGateway::new("secondary", "18005551234").into(),
        ]]);
        assert_eq!(
            bridge.to_string(),
            "sofia/gateway/primary/18005551234,sofia/gateway/secondary/18005551234"
        );
    }

    #[test]
    fn display_sequential_failover() {
        let bridge = BridgeDialString::new(vec![
            vec![SofiaGateway::new("primary", "18005551234").into()],
            vec![SofiaGateway::new("backup", "18005551234").into()],
        ]);
        assert_eq!(
            bridge.to_string(),
            "sofia/gateway/primary/18005551234|sofia/gateway/backup/18005551234"
        );
    }

    #[test]
    fn display_mixed_simultaneous_and_sequential() {
        let bridge = BridgeDialString::new(vec![
            vec![
                SofiaGateway::new("primary", "1234").into(),
                SofiaGateway::new("secondary", "1234").into(),
            ],
            vec![SofiaGateway::new("backup", "1234").into()],
        ]);
        assert_eq!(
            bridge.to_string(),
            "sofia/gateway/primary/1234,sofia/gateway/secondary/1234|sofia/gateway/backup/1234"
        );
    }

    #[test]
    fn display_with_global_variables() {
        let mut vars = Variables::new(VariablesType::Default);
        vars.insert("hangup_after_bridge", "true");
        let bridge =
            BridgeDialString::new(vec![vec![
                SofiaEndpoint::new("internal", "1000@domain").into()
            ]])
            .with_variables(vars);
        assert_eq!(
            bridge.to_string(),
            "{hangup_after_bridge=true}sofia/internal/1000@domain"
        );
    }

    #[test]
    fn display_with_per_endpoint_variables() {
        let mut ep_vars = Variables::new(VariablesType::Channel);
        ep_vars.insert("leg_timeout", "30");
        let bridge = BridgeDialString::new(vec![vec![
            SofiaGateway::new("gw1", "1234")
                .with_variables(ep_vars)
                .into(),
            SofiaGateway::new("gw2", "1234").into(),
        ]]);
        assert_eq!(
            bridge.to_string(),
            "[leg_timeout=30]sofia/gateway/gw1/1234,sofia/gateway/gw2/1234"
        );
    }

    #[test]
    fn display_with_error_endpoint_failover() {
        let bridge = BridgeDialString::new(vec![
            vec![SofiaGateway::new("primary", "1234").into()],
            vec![ErrorEndpoint::new(crate::channel::HangupCause::UserBusy).into()],
        ]);
        assert_eq!(
            bridge.to_string(),
            "sofia/gateway/primary/1234|error/USER_BUSY"
        );
    }

    #[test]
    fn display_with_loopback() {
        let bridge = BridgeDialString::new(vec![vec![LoopbackEndpoint::new("9199")
            .with_context("default")
            .into()]]);
        assert_eq!(bridge.to_string(), "loopback/9199/default");
    }

    // === FromStr ===

    #[test]
    fn from_str_single_endpoint() {
        let bridge: BridgeDialString = "sofia/gateway/my_provider/18005551234"
            .parse()
            .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
        assert_eq!(bridge.groups()[0].len(), 1);
        assert!(bridge
            .variables()
            .is_none());
    }

    #[test]
    fn from_str_simultaneous_ring() {
        let bridge: BridgeDialString = "sofia/gateway/primary/1234,sofia/gateway/secondary/1234"
            .parse()
            .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
        assert_eq!(bridge.groups()[0].len(), 2);
    }

    #[test]
    fn from_str_sequential_failover() {
        let bridge: BridgeDialString = "sofia/gateway/primary/1234|sofia/gateway/backup/1234"
            .parse()
            .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            2
        );
        assert_eq!(bridge.groups()[0].len(), 1);
        assert_eq!(bridge.groups()[1].len(), 1);
    }

    #[test]
    fn from_str_mixed() {
        let bridge: BridgeDialString =
            "sofia/gateway/primary/1234,sofia/gateway/secondary/1234|sofia/gateway/backup/1234"
                .parse()
                .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            2
        );
        assert_eq!(bridge.groups()[0].len(), 2);
        assert_eq!(bridge.groups()[1].len(), 1);
    }

    #[test]
    fn from_str_with_global_variables() {
        let bridge: BridgeDialString = "{hangup_after_bridge=true}sofia/internal/1000@domain"
            .parse()
            .unwrap();
        assert!(bridge
            .variables()
            .is_some());
        assert_eq!(
            bridge
                .variables()
                .unwrap()
                .get("hangup_after_bridge"),
            Some("true")
        );
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
        assert_eq!(bridge.groups()[0].len(), 1);
    }

    #[test]
    fn from_str_with_per_endpoint_variables() {
        let bridge: BridgeDialString =
            "[leg_timeout=30]sofia/gateway/gw1/1234,sofia/gateway/gw2/1234"
                .parse()
                .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
        assert_eq!(bridge.groups()[0].len(), 2);
        let ep = &bridge.groups()[0][0];
        if let Endpoint::SofiaGateway(gw) = ep {
            assert!(gw
                .variables
                .is_some());
        } else {
            panic!("expected SofiaGateway");
        }
    }

    /// An enterprise block is global too. Read as part of the first endpoint it
    /// either fails the parse or lands on one leg of a forked dial.
    #[test]
    fn from_str_with_enterprise_global_variables() {
        let bridge: BridgeDialString = "<originate_timeout=60>sofia/internal/1000@domain"
            .parse()
            .unwrap();
        assert_eq!(
            bridge
                .variables()
                .expect("enterprise block is global")
                .get("originate_timeout"),
            Some("60")
        );
        assert_eq!(bridge.groups()[0].len(), 1);
    }

    /// A channel block binds to the endpoint that follows it, so the global
    /// slot must not take it.
    #[test]
    fn from_str_leaves_a_channel_block_on_its_endpoint() {
        let bridge: BridgeDialString = "[leg_timeout=30]sofia/gateway/gw1/1234"
            .parse()
            .unwrap();
        assert!(bridge
            .variables()
            .is_none());
        assert!(bridge.groups()[0][0]
            .variables()
            .is_some());
    }

    #[test]
    fn from_str_round_trip_single() {
        let input = "sofia/gateway/my_provider/18005551234";
        let bridge: BridgeDialString = input
            .parse()
            .unwrap();
        assert_eq!(bridge.to_string(), input);
    }

    #[test]
    fn from_str_round_trip_mixed() {
        let input =
            "sofia/gateway/primary/1234,sofia/gateway/secondary/1234|sofia/gateway/backup/1234";
        let bridge: BridgeDialString = input
            .parse()
            .unwrap();
        assert_eq!(bridge.to_string(), input);
    }

    #[test]
    fn from_str_round_trip_with_global_vars() {
        let input = "{hangup_after_bridge=true}sofia/internal/1000@domain";
        let bridge: BridgeDialString = input
            .parse()
            .unwrap();
        assert_eq!(bridge.to_string(), input);
    }

    // === Serde ===

    #[test]
    fn serde_round_trip_single() {
        let bridge =
            BridgeDialString::new(vec![vec![
                SofiaGateway::new("my_provider", "18005551234").into()
            ]]);
        let json = serde_json::to_string(&bridge).unwrap();
        let parsed: BridgeDialString = serde_json::from_str(&json).unwrap();
        assert_eq!(bridge, parsed);
    }

    #[test]
    fn serde_round_trip_multi_group() {
        let mut vars = Variables::new(VariablesType::Default);
        vars.insert("hangup_after_bridge", "true");
        let bridge = BridgeDialString::new(vec![
            vec![
                SofiaGateway::new("primary", "1234").into(),
                SofiaGateway::new("secondary", "1234").into(),
            ],
            vec![ErrorEndpoint::new(crate::channel::HangupCause::UserBusy).into()],
        ])
        .with_variables(vars);
        let json = serde_json::to_string(&bridge).unwrap();
        let parsed: BridgeDialString = serde_json::from_str(&json).unwrap();
        assert_eq!(bridge, parsed);
    }

    // === Edge cases ===

    #[test]
    fn from_str_empty_string_rejected() {
        let result = "".parse::<BridgeDialString>();
        assert!(result.is_err());
    }

    #[test]
    fn from_str_whitespace_only_rejected() {
        let result = "   ".parse::<BridgeDialString>();
        assert!(result.is_err());
    }

    #[test]
    fn from_str_empty_groups_from_trailing_pipe() {
        // "ep1|" should parse as one group (empty trailing group is skipped)
        let bridge: BridgeDialString = "sofia/gateway/gw1/1234|"
            .parse()
            .unwrap();
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
    }

    #[test]
    fn from_str_empty_variable_block() {
        let bridge: BridgeDialString = "{}sofia/gateway/gw1/1234"
            .parse()
            .unwrap();
        assert!(bridge
            .variables()
            .is_none());
        assert_eq!(
            bridge
                .groups()
                .len(),
            1
        );
    }

    #[test]
    fn from_str_mismatched_bracket_rejected() {
        let result = "{unclosed=true sofia/gateway/gw1/1234".parse::<BridgeDialString>();
        assert!(result.is_err());
    }

    /// A separator inside endpoint text is escaped for the leg split that would read it.
    #[test]
    fn a_separator_in_endpoint_text_round_trips() {
        let bridge = BridgeDialString::new(vec![
            vec![
                SofiaEndpoint::new("internal", "a,b").into(),
                SofiaEndpoint::new("internal", "c|d").into(),
            ],
            vec![LoopbackEndpoint::new("it's a").into()],
        ]);
        let rendered = bridge.to_string();
        let back: BridgeDialString = rendered
            .parse()
            .unwrap_or_else(|e| panic!("{rendered} failed to parse: {e}"));
        assert_eq!(back, bridge, "rendered {rendered}");
    }

    /// The switch's comma scan protects commas from a `[` to its matching `]`, whichever leg
    /// holds either, so a range crossing a leg separator merges the legs.
    #[test]
    fn a_bracket_spanning_legs_is_refused_at_config_load() {
        let spanning = r#"{"groups":[[{"sofia":{"profile":"internal","destination":"x["}},{"sofia":{"profile":"internal","destination":"y]"}}]]}"#;
        assert!(serde_json::from_str::<BridgeDialString>(spanning).is_err());
        for fine in [
            r#"{"groups":[[{"sofia":{"profile":"internal","destination":"x[]"}},{"sofia":{"profile":"internal","destination":"y]"}}]]}"#,
            r#"{"groups":[[{"sofia":{"profile":"internal","destination":"x["}}],[{"sofia":{"profile":"internal","destination":"y]"}}]]}"#,
        ] {
            assert!(
                serde_json::from_str::<BridgeDialString>(fine).is_ok(),
                "{fine}"
            );
        }
    }

    /// A `[` in an earlier leg, its `]` in a later leg's endpoint, and a `^^` block between.
    fn bracket_around_block(sep: char, value: &str) -> BridgeDialString {
        let mut vars = Variables::new(VariablesType::Channel)
            .with_separator(sep)
            .unwrap();
        vars.insert("v0", value);
        BridgeDialString::new(vec![vec![
            Endpoint::PortAudio(AudioEndpoint::new().with_destination("[\\")),
            SofiaGateway::new("]", "")
                .with_variables(vars)
                .into(),
        ]])
    }

    /// The comma scan takes the `^^,` head inside the range for a plain comma and writes the
    /// block's own default, which the block then splits on alike.
    #[test]
    fn a_comma_head_the_scan_rewrites_round_trips() {
        let bridge = bracket_around_block(',', "undef");
        let rendered = bridge.to_string();
        let back: BridgeDialString = rendered
            .parse()
            .unwrap_or_else(|e| panic!("{rendered} failed to parse: {e}"));
        assert_eq!(
            back.to_string(),
            r"portaudio/[\\\\\\\\,[v0=undef]sofia/gateway/]/"
        );
        let json = serde_json::to_value(&bridge).unwrap();
        assert_eq!(
            serde_json::from_value::<BridgeDialString>(json).unwrap(),
            bridge
        );
    }

    /// The range opened in the first leg decides how the scan rewrites a comma in the second
    /// leg's `^^:` value, which then reaches the channel as the scan's placeholder.
    #[test]
    fn a_range_rewriting_a_later_legs_value_is_refused() {
        let bridge = bracket_around_block(':', "a,b");
        let rendered = bridge.to_string();
        assert!(
            matches!(
                rendered.parse::<BridgeDialString>(),
                Err(OriginateError::BracketSpansLegs { group: 0 })
            ),
            "{rendered}: {:?}",
            rendered.parse::<BridgeDialString>()
        );
        let json = serde_json::to_value(&bridge).unwrap();
        assert!(serde_json::from_value::<BridgeDialString>(json).is_err());
    }

    /// The dialplan carrier's expansion, the leg splits over a `[]` block and both of a block's own
    /// splits each read `\\` as one backslash, and none reads `\b` or `\d`.
    #[test]
    fn parse_reads_blocks_as_the_switch_installs_them() {
        let bridge: BridgeDialString = r"{k=a\\\\b}[j=c\\\\\\\\d]loopback/9199/test"
            .parse()
            .unwrap_or_else(|e| panic!("{e}"));
        assert_eq!(
            bridge
                .variables()
                .and_then(|vars| vars.get("k")),
            Some(r"a\b")
        );
        assert_eq!(
            bridge.groups()[0][0]
                .variables()
                .and_then(|vars| vars.get("j")),
            Some(r"c\d")
        );
    }

    #[test]
    fn serde_to_display_wire_format() {
        let json = r#"{
            "groups": [[{
                "sofia_gateway": {
                    "gateway": "my_gw",
                    "destination": "18005551234"
                }
            }]]
        }"#;
        let bridge: BridgeDialString = serde_json::from_str(json).unwrap();
        assert_eq!(bridge.to_string(), "sofia/gateway/my_gw/18005551234");
    }
}