apollo-federation 2.13.1

#![allow(dead_code)]

use crate::operation::Selection;
use crate::query_graph::graph_path::operation::ClosedBranch;
use crate::query_graph::graph_path::operation::OpenBranchAndSelections;
use crate::query_graph::graph_path::operation::SimultaneousPathsWithLazyIndirectPaths;

/// This macro is a wrapper around `tracing::trace!` and should not be confused with our snapshot
/// testing. This primary goal of this macro is to add the necessary context to logging statements
/// so that external tools (like the snapshot log visualizer) can show how various key data
/// structures evolve over the course of planning a query.
///
/// There are two ways of creating a snapshot. The easiest is by passing the macro a identifier
/// for the value you'd like to take a snapshot of. This will tag the snapshot type with the type
/// name of the value, create data that is JSON string using serde_json, and add the message
/// literal that you pass in. EX:
/// ```no_test
/// snapshot!(dependency_graph, "updated dependency graph");
/// // Generates:
/// // trace!(snapshot = "FetchDependencyGraph", data = "{ .. }", "updated dependency graph");
/// ```
/// If you do not want to serialize the data, you can pass the name tag for the snapshot and data
/// in directly. Note that the data needs to implement the tracing crate's `Value` trait. Ideally,
/// this is a string representation of the data you're snapshotting. EX:
/// ```no_test
/// snapshot!("FetchDependencyGraph", dependency_graph.to_string(), "updated dependency graph");
/// // Generates:
/// // trace!(snapshot = "FetchDependencyGraph", data = dependency_graph.to_string(), "updated dependency graph");
/// ```
macro_rules! snapshot {
    ($value:expr, $msg:literal) => {
        #[cfg(feature = "snapshot_tracing")]
        tracing::trace!(
            snapshot = std::any::type_name_of_val(&$value),
            data = ron::ser::to_string(&$value).expect(concat!(
                "Could not serialize value for a snapshot with message: ",
                $msg
            )),
            $msg
        );
    };
    ($name:literal, $value:expr, $msg:literal) => {
        #[cfg(feature = "snapshot_tracing")]
        tracing::trace!(snapshot = $name, data = $value, $msg);
    };
}

pub(crate) use snapshot;

pub(crate) fn make_string<T: ?Sized>(
    data: &T,
    writer: fn(&mut std::fmt::Formatter<'_>, &T) -> std::fmt::Result,
) -> String {
    // One-off struct to implement `Display` for `data` using `writer`.
    struct Stringify<'a, T: ?Sized> {
        data: &'a T,
        writer: fn(&mut std::fmt::Formatter<'_>, &T) -> std::fmt::Result,
    }

    impl<T: ?Sized> std::fmt::Display for Stringify<'_, T> {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            (self.writer)(f, self.data)
        }
    }

    Stringify { data, writer }.to_string()
}

// PORT_NOTE: This is a (partial) port of `QueryPlanningTraversal.debugStack` JS method.
pub(crate) fn format_open_branch(
    f: &mut std::fmt::Formatter<'_>,
    (selection, options): &(&Selection, &[SimultaneousPathsWithLazyIndirectPaths]),
) -> std::fmt::Result {
    writeln!(f, "{selection}")?;
    writeln!(f, " * Options:")?;
    for option in *options {
        writeln!(f, "   - {option}")?;
    }
    Ok(())
}

pub(crate) fn open_branch_to_string(
    selection: &Selection,
    options: &[SimultaneousPathsWithLazyIndirectPaths],
) -> String {
    make_string(&(selection, options), format_open_branch)
}

// PORT_NOTE: This is a port of `QueryPlanningTraversal.debugStack` JS method.
pub(crate) fn format_open_branches(
    f: &mut std::fmt::Formatter<'_>,
    open_branches: &[OpenBranchAndSelections],
) -> std::fmt::Result {
    // Print from the stack top to the bottom.
    for branch in open_branches.iter().rev() {
        writeln!(f, "{branch}")?;
    }
    Ok(())
}

pub(crate) fn open_branches_to_string(open_branches: &[OpenBranchAndSelections]) -> String {
    make_string(open_branches, format_open_branches)
}

pub(crate) fn format_closed_branches(
    f: &mut std::fmt::Formatter<'_>,
    closed_branches: &[ClosedBranch],
) -> std::fmt::Result {
    writeln!(f, "All branches:")?;
    for (i, closed_branch) in closed_branches.iter().enumerate() {
        writeln!(f, "{i}:")?;
        for closed_path in &closed_branch.0 {
            writeln!(f, " - {closed_path}")?;
        }
    }
    Ok(())
}

pub(crate) fn closed_branches_to_string(closed_branches: &[ClosedBranch]) -> String {
    make_string(closed_branches, format_closed_branches)
}