apollo-router 1.61.13

A configurable, high-performance routing runtime for Apollo Federation 🚀
Documentation
use apollo_compiler::executable;
use serde::Deserialize;
use serde::Serialize;
use serde_json_bytes::ByteString;

use super::Fragments;
use crate::json_ext::Object;
use crate::json_ext::PathElement;
use crate::spec::FieldType;
use crate::spec::Schema;
use crate::spec::SpecError;
use crate::spec::query::DeferStats;
use crate::spec::query::subselections::DEFER_DIRECTIVE_NAME;

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub(crate) enum Selection {
    Field {
        name: ByteString,
        alias: Option<ByteString>,
        selection_set: Option<Vec<Selection>>,
        field_type: FieldType,
        include_skip: IncludeSkip,
    },
    InlineFragment {
        // Optional in specs but we fill it with the current type if not specified
        type_condition: String,
        include_skip: IncludeSkip,
        defer: Condition,
        defer_label: Option<String>,
        known_type: Option<String>,
        selection_set: Vec<Selection>,
    },
    FragmentSpread {
        name: String,
        known_type: Option<String>,
        include_skip: IncludeSkip,
        defer: Condition,
        defer_label: Option<String>,
    },
}

impl Selection {
    pub(crate) fn from_hir(
        selection: &executable::Selection,
        current_type: &str,
        schema: &Schema,
        mut count: usize,
        defer_stats: &mut DeferStats,
        fragments: &Fragments,
    ) -> Result<Option<Self>, SpecError> {
        // The RECURSION_LIMIT is chosen to be:
        //   < # expected to cause stack overflow &&
        //   > # expected in a legitimate query
        const RECURSION_LIMIT: usize = 512;
        if count > RECURSION_LIMIT {
            tracing::error!("selection processing recursion limit({RECURSION_LIMIT}) exceeded");
            return Err(SpecError::RecursionLimitExceeded);
        }
        count += 1;
        Ok(match selection {
            // Spec: https://spec.graphql.org/draft/#Field
            executable::Selection::Field(field) => {
                let include_skip = IncludeSkip::parse(&field.directives);
                if include_skip.statically_skipped() {
                    return Ok(None);
                }
                let field_type = FieldType::from(field.ty());

                let alias = field.alias.as_ref().map(|x| x.as_str().into());

                let selection_set = if field.selection_set.selections.is_empty() {
                    None
                } else {
                    Some(
                        field
                            .selection_set
                            .selections
                            .iter()
                            .filter_map(|selection| {
                                Selection::from_hir(
                                    selection,
                                    field_type.0.inner_named_type(),
                                    schema,
                                    count,
                                    defer_stats,
                                    fragments,
                                )
                                .transpose()
                            })
                            .collect::<Result<_, _>>()?,
                    )
                };

                Some(Self::Field {
                    alias,
                    name: field.name.as_str().into(),
                    selection_set,
                    field_type,
                    include_skip,
                })
            }
            // Spec: https://spec.graphql.org/draft/#InlineFragment
            executable::Selection::InlineFragment(inline_fragment) => {
                let include_skip = IncludeSkip::parse(&inline_fragment.directives);
                if include_skip.statically_skipped() {
                    return Ok(None);
                }
                let (defer, defer_label) = parse_defer(&inline_fragment.directives, defer_stats);

                let type_condition = inline_fragment
                    .type_condition
                    .as_ref()
                    .map(|s| s.as_str())
                    .unwrap_or(current_type)
                    .to_owned();

                let fragment_type = &type_condition;

                // this is the type we pass when extracting the fragment's selections
                // If the type condition is a union or interface and the current type implements it, then we want
                // to keep the current type when extracting the fragment's selections, as it is more precise
                // than the interface.
                // If it is not, then we use the type condition
                let relevant_type = if schema.is_interface(type_condition.as_str()) {
                    let relevant_type = schema.most_precise(current_type, fragment_type);
                    relevant_type.unwrap_or(fragment_type)
                } else {
                    fragment_type
                };

                let selection_set: Vec<Selection> = inline_fragment
                    .selection_set
                    .selections
                    .iter()
                    .filter_map(|selection| {
                        Selection::from_hir(
                            selection,
                            relevant_type,
                            schema,
                            count,
                            defer_stats,
                            fragments,
                        )
                        .transpose()
                    })
                    .collect::<Result<_, _>>()?;

                let known_type = Some(inline_fragment.selection_set.ty.as_str().to_owned());

                // Can be empty with a statically skipped selection set
                if selection_set.is_empty() {
                    return Ok(None);
                }

                Some(Self::InlineFragment {
                    type_condition,
                    selection_set,
                    include_skip,
                    defer,
                    defer_label,
                    known_type,
                })
            }
            // Spec: https://spec.graphql.org/draft/#FragmentSpread
            executable::Selection::FragmentSpread(fragment_spread) => {
                let include_skip = IncludeSkip::parse(&fragment_spread.directives);
                if include_skip.statically_skipped() {
                    return Ok(None);
                }
                let (defer, defer_label) = parse_defer(&fragment_spread.directives, defer_stats);
                let name = fragment_spread.fragment_name.as_str().to_owned();
                // Can be empty with a statically skipped selection set
                if fragments
                    .get(&name)
                    .map(|f| f.selection_set.is_empty())
                    .unwrap_or_default()
                {
                    return Ok(None);
                }

                Some(Self::FragmentSpread {
                    name,
                    known_type: Some(current_type.to_owned()),
                    include_skip,
                    defer,
                    defer_label,
                })
            }
        })
    }

    pub(crate) fn matching_error_path_length(
        &self,
        path: &[PathElement],
        fragments: &Fragments,
    ) -> usize {
        match (path.split_first(), self) {
            (None, _) => 0,
            (
                Some((PathElement::Key(key, _), rest)),
                Selection::Field {
                    name,
                    alias,
                    selection_set,
                    ..
                },
            ) => {
                if alias.as_ref().unwrap_or(name).as_str() == key.as_str() {
                    match selection_set {
                        // if we don't select after that field, the path should stop there
                        None => 1,
                        Some(set) => {
                            set.iter()
                                .map(|selection| {
                                    selection.matching_error_path_length(rest, fragments)
                                })
                                .max()
                                .unwrap_or(0)
                                + 1
                        }
                    }
                } else {
                    0
                }
            }
            (
                Some((PathElement::Fragment(fragment), rest)),
                Selection::InlineFragment {
                    type_condition,
                    selection_set,
                    ..
                },
            ) => {
                if fragment.as_str() == type_condition.as_str() {
                    selection_set
                        .iter()
                        .map(|selection| selection.matching_error_path_length(rest, fragments))
                        .max()
                        .unwrap_or(0)
                        + 1
                } else {
                    0
                }
            }
            (Some((PathElement::Fragment(fragment), rest)), Self::FragmentSpread { name, .. }) => {
                if let Some(f) = fragments.get(name) {
                    if fragment.as_str() == f.type_condition.as_str() {
                        f.selection_set
                            .iter()
                            .map(|selection| selection.matching_error_path_length(rest, fragments))
                            .max()
                            .unwrap_or(0)
                            + 1
                    } else {
                        0
                    }
                } else {
                    0
                }
            }
            (_, Self::FragmentSpread { name, .. }) => {
                if let Some(f) = fragments.get(name) {
                    f.selection_set
                        .iter()
                        .map(|selection| selection.matching_error_path_length(path, fragments))
                        .max()
                        .unwrap_or(0)
                } else {
                    0
                }
            }
            (Some((PathElement::Index(_), rest)), _)
            | (Some((PathElement::Flatten(_), rest)), _) => {
                self.matching_error_path_length(rest, fragments) + 1
            }
            (
                Some((PathElement::Key(_, _), _)),
                Selection::InlineFragment { selection_set, .. },
            ) => selection_set
                .iter()
                .map(|selection| selection.matching_error_path_length(path, fragments))
                .max()
                .unwrap_or(0),
            (Some((PathElement::Fragment(_), _)), Selection::Field { .. }) => 0,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub(crate) struct IncludeSkip {
    include: Condition,
    skip: Condition,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub(crate) enum Condition {
    Yes,
    No,
    Variable(String),
}

/// Returns the `if` condition and the `label`
fn parse_defer(
    directives: &executable::DirectiveList,
    defer_stats: &mut DeferStats,
) -> (Condition, Option<String>) {
    if let Some(directive) = directives.get(DEFER_DIRECTIVE_NAME) {
        let condition = Condition::parse(directive).unwrap_or(Condition::Yes);
        match &condition {
            Condition::Yes => {
                defer_stats.has_defer = true;
                defer_stats.has_unconditional_defer = true;
            }
            Condition::No => {}
            Condition::Variable(name) => {
                defer_stats.has_defer = true;
                defer_stats
                    .conditional_defer_variable_names
                    .insert(name.clone());
            }
        }
        let label = if condition != Condition::No {
            directive
                .specified_argument_by_name("label")
                .and_then(|value| value.as_str())
                .map(|str| str.to_owned())
        } else {
            None
        };
        (condition, label)
    } else {
        (Condition::No, None)
    }
}

impl IncludeSkip {
    pub(crate) fn parse(directives: &executable::DirectiveList) -> Self {
        let mut include = None;
        let mut skip = None;
        for directive in &directives.0 {
            if include.is_none() && directive.name == "include" {
                include = Condition::parse(directive)
            }
            if skip.is_none() && directive.name == "skip" {
                skip = Condition::parse(directive)
            }
        }
        Self {
            include: include.unwrap_or(Condition::Yes),
            skip: skip.unwrap_or(Condition::No),
        }
    }

    pub(crate) fn default() -> Self {
        Self {
            include: Condition::Yes,
            skip: Condition::No,
        }
    }

    pub(crate) fn statically_skipped(&self) -> bool {
        matches!(self.skip, Condition::Yes) || matches!(self.include, Condition::No)
    }

    pub(crate) fn should_skip(&self, variables: &Object) -> bool {
        // Using .unwrap_or is legit here because
        // validate_variables should have already checked that
        // the variable is present and it is of the correct type
        self.skip.eval(variables).unwrap_or(false) || !self.include.eval(variables).unwrap_or(true)
    }
}

impl Condition {
    pub(crate) fn parse(directive: &executable::Directive) -> Option<Self> {
        match directive.specified_argument_by_name("if")?.as_ref() {
            executable::Value::Boolean(true) => Some(Condition::Yes),
            executable::Value::Boolean(false) => Some(Condition::No),
            executable::Value::Variable(variable) => {
                Some(Condition::Variable(variable.as_str().to_owned()))
            }
            _ => None,
        }
    }

    pub(crate) fn eval(&self, variables: &Object) -> Option<bool> {
        match self {
            Condition::Yes => Some(true),
            Condition::No => Some(false),
            Condition::Variable(variable_name) => variables
                .get(variable_name.as_str())
                .and_then(|v| v.as_bool()),
        }
    }
}