graphql_tools/ast/

ext.rs

use std::collections::HashMap;

use lazy_static::lazy_static;

use crate::static_graphql::query::{
    self, Directive, FragmentSpread, OperationDefinition, SelectionSet, Type, Value,
    VariableDefinition,
};
use crate::static_graphql::schema::{
    self, DirectiveDefinition, EnumValue, Field, InputValue, InterfaceType, ObjectType,
    TypeDefinition, TypeExtension, UnionType,
};

lazy_static! {
    static ref QUERY_TYPE_DEFAULT_NAME: String = "Query".to_string();
    static ref MUTATION_TYPE_DEFAULT_NAME: String = "Mutation".to_string();
    static ref SUBSCRIPTION_TYPE_DEFAULT_NAME: String = "Subscription".to_string();
}

impl TypeDefinition {
    pub fn field_by_name(&self, name: &str) -> Option<&schema::Field> {
        match self {
            TypeDefinition::Object(object) => {
                object.fields.iter().find(|field| field.name.eq(name))
            }
            TypeDefinition::Interface(interface) => {
                interface.fields.iter().find(|field| field.name.eq(name))
            }
            _ => None,
        }
    }

    pub fn input_field_by_name(&self, name: &str) -> Option<&InputValue> {
        match self {
            TypeDefinition::InputObject(input_object) => {
                input_object.fields.iter().find(|field| field.name.eq(name))
            }
            _ => None,
        }
    }

    /// Whether this is an input object type with `@oneOf`.
    pub fn is_one_of(&self) -> bool {
        match self {
            TypeDefinition::InputObject(input_object) => input_object
                .directives
                .iter()
                .any(|directive| directive.name == "oneOf"),
            _ => false,
        }
    }
}

impl OperationDefinition {
    pub fn variable_definitions(&self) -> &[VariableDefinition] {
        match self {
            OperationDefinition::Query(query) => &query.variable_definitions,
            OperationDefinition::SelectionSet(_) => &[],
            OperationDefinition::Mutation(mutation) => &mutation.variable_definitions,
            OperationDefinition::Subscription(subscription) => &subscription.variable_definitions,
        }
    }

    pub fn selection_set(&self) -> &SelectionSet {
        match self {
            OperationDefinition::Query(query) => &query.selection_set,
            OperationDefinition::SelectionSet(selection_set) => selection_set,
            OperationDefinition::Mutation(mutation) => &mutation.selection_set,
            OperationDefinition::Subscription(subscription) => &subscription.selection_set,
        }
    }

    pub fn directives(&self) -> &[Directive] {
        match self {
            OperationDefinition::Query(query) => &query.directives,
            OperationDefinition::SelectionSet(_) => &[],
            OperationDefinition::Mutation(mutation) => &mutation.directives,
            OperationDefinition::Subscription(subscription) => &subscription.directives,
        }
    }
}

impl schema::Document {
    pub fn type_by_name(&self, name: &str) -> Option<&TypeDefinition> {
        for def in &self.definitions {
            if let schema::Definition::TypeDefinition(type_def) = def {
                if type_def.name().eq(name) {
                    return Some(type_def);
                }
            }
        }

        None
    }

    pub fn directive_by_name(&self, name: &str) -> Option<&DirectiveDefinition> {
        for def in &self.definitions {
            if let schema::Definition::DirectiveDefinition(directive_def) = def {
                if directive_def.name.eq(name) {
                    return Some(directive_def);
                }
            }
        }

        None
    }

    pub fn query_type(&self) -> &ObjectType {
        self.query_type_name()
            .and_then(|name| self.object_type_by_name(name))
            .expect("invariant violation: every valid schema must define a query type")
    }

    pub fn mutation_type(&self) -> Option<&ObjectType> {
        self.mutation_type_name()
            .and_then(|name| self.object_type_by_name(name))
    }

    pub fn subscription_type(&self) -> Option<&ObjectType> {
        self.subscription_type_name()
            .and_then(|name| self.object_type_by_name(name))
    }

    fn object_type_by_name(&self, name: &str) -> Option<&ObjectType> {
        match self.type_by_name(name) {
            Some(TypeDefinition::Object(object_def)) => Some(object_def),
            _ => None,
        }
    }

    pub fn type_map(&self) -> HashMap<&str, &TypeDefinition> {
        let mut type_map = HashMap::new();

        for def in &self.definitions {
            if let schema::Definition::TypeDefinition(type_def) = def {
                type_map.insert(type_def.name(), type_def);
            }
        }

        type_map
    }

    pub fn is_named_subtype(&self, sub_type_name: &str, super_type_name: &str) -> bool {
        if sub_type_name == super_type_name {
            true
        } else if let (Some(sub_type), Some(super_type)) = (
            self.type_by_name(sub_type_name),
            self.type_by_name(super_type_name),
        ) {
            super_type.is_abstract_type() && self.is_possible_type(super_type, sub_type)
        } else {
            false
        }
    }

    fn is_possible_type(
        &self,
        abstract_type: &TypeDefinition,
        possible_type: &TypeDefinition,
    ) -> bool {
        match abstract_type {
            TypeDefinition::Union(union_typedef) => union_typedef
                .types
                .iter()
                .any(|t| t == possible_type.name()),
            TypeDefinition::Interface(interface_typedef) => {
                let implementes_interfaces = possible_type.interfaces();

                implementes_interfaces.contains(&interface_typedef.name)
            }
            _ => false,
        }
    }

    pub fn is_subtype(&self, sub_type: &Type, super_type: &Type) -> bool {
        // Equivalent type is a valid subtype
        if sub_type == super_type {
            return true;
        }

        // If superType is non-null, maybeSubType must also be non-null.
        if super_type.is_non_null() {
            if sub_type.is_non_null() {
                return self.is_subtype(sub_type.of_type(), super_type.of_type());
            }
            return false;
        }

        if sub_type.is_non_null() {
            // If superType is nullable, maybeSubType may be non-null or nullable.
            return self.is_subtype(sub_type.of_type(), super_type);
        }

        // If superType type is a list, maybeSubType type must also be a list.
        if super_type.is_list_type() {
            if sub_type.is_list_type() {
                return self.is_subtype(sub_type.of_type(), super_type.of_type());
            }

            return false;
        }

        if sub_type.is_list_type() {
            // If superType is nullable, maybeSubType may be non-null or nullable.
            return false;
        }

        // If superType type is an abstract type, check if it is super type of maybeSubType.
        // Otherwise, the child type is not a valid subtype of the parent type.
        if let (Some(sub_type), Some(super_type)) = (
            self.type_by_name(sub_type.inner_type()),
            self.type_by_name(super_type.inner_type()),
        ) {
            return super_type.is_abstract_type()
                && (sub_type.is_interface_type() || sub_type.is_object_type())
                && self.is_possible_type(super_type, sub_type);
        }

        false
    }
}

impl Type {
    pub fn inner_type(&self) -> &str {
        match self {
            Type::NamedType(name) => name.as_str(),
            Type::ListType(child) => child.inner_type(),
            Type::NonNullType(child) => child.inner_type(),
        }
    }

    fn of_type(&self) -> &Type {
        match self {
            Type::ListType(child) => child,
            Type::NonNullType(child) => child,
            Type::NamedType(_) => self,
        }
    }

    pub fn is_non_null(&self) -> bool {
        matches!(self, Type::NonNullType(_))
    }

    fn is_list_type(&self) -> bool {
        matches!(self, Type::ListType(_))
    }

    pub fn is_named_type(&self) -> bool {
        matches!(self, Type::NamedType(_))
    }
}

impl Value {
    pub fn compare(&self, other: &Self) -> bool {
        match (self, other) {
            (Value::Null, Value::Null) => true,
            (Value::Boolean(a), Value::Boolean(b)) => a == b,
            (Value::Int(a), Value::Int(b)) => a == b,
            (Value::Float(a), Value::Float(b)) => a == b,
            (Value::String(a), Value::String(b)) => a.eq(b),
            (Value::Enum(a), Value::Enum(b)) => a.eq(b),
            (Value::List(a), Value::List(b)) => a.iter().zip(b.iter()).all(|(a, b)| a.compare(b)),
            (Value::Object(a), Value::Object(b)) => {
                if a.len() != b.len() {
                    return false;
                }
                let mut matched = vec![false; b.len()];
                for (k_a, v_a) in a.iter() {
                    let found = b
                        .iter()
                        .enumerate()
                        .find(|(idx, (k_b, v_b))| !matched[*idx] && k_a == k_b && v_a.compare(v_b));
                    match found {
                        Some((idx, _)) => matched[idx] = true,
                        None => return false,
                    }
                }
                true
            }
            (Value::Variable(a), Value::Variable(b)) => a.eq(b),
            _ => false,
        }
    }

    pub fn variables_in_use(&self) -> Vec<&str> {
        match self {
            Value::Variable(v) => vec![v],
            Value::List(list) => list.iter().flat_map(|v| v.variables_in_use()).collect(),
            Value::Object(object) => object
                .iter()
                .flat_map(|(_, v)| v.variables_in_use())
                .collect(),
            _ => vec![],
        }
    }
}

impl InputValue {
    pub fn is_required(&self) -> bool {
        if let Type::NonNullType(_inner_type) = &self.value_type {
            if self.default_value.is_none() {
                return true;
            }
        }

        false
    }
}

impl TypeDefinition {
    fn interfaces(&self) -> Vec<String> {
        match self {
            schema::TypeDefinition::Object(o) => o.interfaces(),
            schema::TypeDefinition::Interface(i) => i.interfaces(),
            _ => vec![],
        }
    }

    pub fn has_sub_type(&self, other_type: &TypeDefinition) -> bool {
        match self {
            TypeDefinition::Interface(interface_type) => {
                interface_type.is_implemented_by(other_type)
            }
            TypeDefinition::Union(union_type) => union_type.has_sub_type(other_type.name()),
            _ => false,
        }
    }

    pub fn has_concrete_sub_type(&self, concrete_type: &TypeDefinition) -> bool {
        match self {
            TypeDefinition::Interface(interface_type) => {
                interface_type.is_implemented_by(concrete_type)
            }
            TypeDefinition::Union(union_type) => union_type.has_sub_type(concrete_type.name()),
            _ => false,
        }
    }
}

impl TypeDefinition {
    pub fn possible_types<'a>(&self, schema: &'a schema::Document) -> Vec<&'a TypeDefinition> {
        match self {
            TypeDefinition::Object(_) => vec![],
            TypeDefinition::InputObject(_) => vec![],
            TypeDefinition::Enum(_) => vec![],
            TypeDefinition::Scalar(_) => vec![],
            TypeDefinition::Interface(i) => schema
                .type_map()
                .values()
                .filter_map(|type_def| {
                    if i.is_implemented_by(type_def) {
                        return Some(*type_def);
                    }

                    None
                })
                .collect(),
            TypeDefinition::Union(u) => u
                .types
                .iter()
                .filter_map(|type_name| {
                    if let Some(type_def) = schema.type_by_name(type_name) {
                        return Some(type_def);
                    }

                    None
                })
                .collect(),
        }
    }
}

impl InterfaceType {
    fn interfaces(&self) -> Vec<String> {
        self.implements_interfaces.clone()
    }

    pub fn has_sub_type(&self, other_type: &TypeDefinition) -> bool {
        self.is_implemented_by(other_type)
    }

    pub fn has_concrete_sub_type(&self, concrete_type: &TypeDefinition) -> bool {
        self.is_implemented_by(concrete_type)
    }
}

impl ObjectType {
    fn interfaces(&self) -> Vec<String> {
        self.implements_interfaces.clone()
    }

    pub fn has_sub_type(&self, _other_type: &TypeDefinition) -> bool {
        false
    }

    pub fn has_concrete_sub_type(&self, _concrete_type: &ObjectType) -> bool {
        false
    }
}

impl UnionType {
    pub fn has_sub_type(&self, other_type_name: &str) -> bool {
        self.types.iter().any(|v| other_type_name.eq(v))
    }
}

impl InterfaceType {
    pub fn is_implemented_by(&self, other_type: &TypeDefinition) -> bool {
        other_type.interfaces().iter().any(|v| self.name.eq(v))
    }
}

impl schema::TypeDefinition {
    pub fn name(&self) -> &str {
        match self {
            schema::TypeDefinition::Object(o) => &o.name,
            schema::TypeDefinition::Interface(i) => &i.name,
            schema::TypeDefinition::Union(u) => &u.name,
            schema::TypeDefinition::Scalar(s) => &s.name,
            schema::TypeDefinition::Enum(e) => &e.name,
            schema::TypeDefinition::InputObject(i) => &i.name,
        }
    }

    pub fn is_abstract_type(&self) -> bool {
        matches!(
            self,
            schema::TypeDefinition::Interface(_) | schema::TypeDefinition::Union(_)
        )
    }

    fn is_interface_type(&self) -> bool {
        matches!(self, schema::TypeDefinition::Interface(_))
    }

    pub fn is_leaf_type(&self) -> bool {
        matches!(
            self,
            schema::TypeDefinition::Scalar(_) | schema::TypeDefinition::Enum(_)
        )
    }

    pub fn is_input_type(&self) -> bool {
        matches!(
            self,
            schema::TypeDefinition::Scalar(_)
                | schema::TypeDefinition::Enum(_)
                | schema::TypeDefinition::InputObject(_)
        )
    }

    pub fn is_composite_type(&self) -> bool {
        matches!(
            self,
            schema::TypeDefinition::Object(_)
                | schema::TypeDefinition::Interface(_)
                | schema::TypeDefinition::Union(_)
        )
    }

    pub fn is_object_type(&self) -> bool {
        matches!(self, schema::TypeDefinition::Object(_o))
    }

    pub fn is_union_type(&self) -> bool {
        matches!(self, schema::TypeDefinition::Union(_o))
    }

    pub fn is_enum_type(&self) -> bool {
        matches!(self, schema::TypeDefinition::Enum(_o))
    }

    pub fn is_scalar_type(&self) -> bool {
        matches!(self, schema::TypeDefinition::Scalar(_o))
    }
}

pub trait AstNodeWithName {
    fn node_name(&self) -> Option<&str>;
}

impl AstNodeWithName for query::OperationDefinition {
    fn node_name(&self) -> Option<&str> {
        match self {
            query::OperationDefinition::Query(q) => q.name.as_deref(),
            query::OperationDefinition::SelectionSet(_s) => None,
            query::OperationDefinition::Mutation(m) => m.name.as_deref(),
            query::OperationDefinition::Subscription(s) => s.name.as_deref(),
        }
    }
}

impl AstNodeWithName for query::FragmentDefinition {
    fn node_name(&self) -> Option<&str> {
        Some(&self.name)
    }
}

impl AstNodeWithName for query::FragmentSpread {
    fn node_name(&self) -> Option<&str> {
        Some(&self.fragment_name)
    }
}

impl query::SelectionSet {
    pub fn get_recursive_fragment_spreads(&self) -> Vec<&FragmentSpread> {
        self.items
            .iter()
            .flat_map(|v| match v {
                query::Selection::FragmentSpread(f) => vec![f],
                query::Selection::Field(f) => f.selection_set.get_fragment_spreads(),
                query::Selection::InlineFragment(f) => f.selection_set.get_fragment_spreads(),
            })
            .collect()
    }

    fn get_fragment_spreads(&self) -> Vec<&FragmentSpread> {
        self.items
            .iter()
            .flat_map(|v| match v {
                query::Selection::FragmentSpread(f) => vec![f],
                _ => vec![],
            })
            .collect()
    }
}

impl query::Selection {
    pub fn directives(&self) -> &[Directive] {
        match self {
            query::Selection::Field(f) => &f.directives,
            query::Selection::FragmentSpread(f) => &f.directives,
            query::Selection::InlineFragment(f) => &f.directives,
        }
    }
    pub fn selection_set(&self) -> Option<&SelectionSet> {
        match self {
            query::Selection::Field(f) => Some(&f.selection_set),
            query::Selection::FragmentSpread(_) => None,
            query::Selection::InlineFragment(f) => Some(&f.selection_set),
        }
    }
}

impl schema::Definition<'static, String> {
    pub fn name(&self) -> Option<&str> {
        match self {
            schema::Definition::SchemaDefinition(_) => None,
            schema::Definition::TypeDefinition(type_def) => Some(type_def.name()),
            schema::Definition::TypeExtension(type_ext) => Some(type_ext.name()),
            schema::Definition::DirectiveDefinition(directive_def) => Some(&directive_def.name),
        }
    }
    pub fn fields<'a>(&'a self) -> Option<TypeDefinitionFields<'a>> {
        match self {
            schema::Definition::SchemaDefinition(_) => None,
            schema::Definition::TypeDefinition(type_def) => type_def.fields(),
            schema::Definition::TypeExtension(type_ext) => type_ext.fields(),
            schema::Definition::DirectiveDefinition(_) => None,
        }
    }
    pub fn directives(&self) -> Option<&[Directive]> {
        match self {
            schema::Definition::SchemaDefinition(schema_def) => Some(&schema_def.directives),
            schema::Definition::TypeDefinition(type_def) => type_def.directives(),
            schema::Definition::TypeExtension(type_ext) => type_ext.directives(),
            schema::Definition::DirectiveDefinition(_) => None,
        }
    }
}

pub enum TypeDefinitionFields<'a> {
    Fields(&'a [Field]),
    InputValues(&'a [InputValue]),
    EnumValues(&'a [EnumValue]),
}

impl TypeDefinition {
    pub fn fields<'a>(&'a self) -> Option<TypeDefinitionFields<'a>> {
        match self {
            TypeDefinition::Scalar(_) => None,
            TypeDefinition::Object(object) => Some(TypeDefinitionFields::Fields(&object.fields)),
            TypeDefinition::Interface(interface) => {
                Some(TypeDefinitionFields::Fields(&interface.fields))
            }
            TypeDefinition::Union(_) => None,
            TypeDefinition::Enum(enum_) => Some(TypeDefinitionFields::EnumValues(&enum_.values)),
            TypeDefinition::InputObject(input_object) => {
                Some(TypeDefinitionFields::InputValues(&input_object.fields))
            }
        }
    }
    pub fn directives(&self) -> Option<&[Directive]> {
        match self {
            TypeDefinition::Scalar(_) => None,
            TypeDefinition::Object(object) => Some(&object.directives),
            TypeDefinition::Interface(interface) => Some(&interface.directives),
            TypeDefinition::Union(union) => Some(&union.directives),
            TypeDefinition::Enum(enum_) => Some(&enum_.directives),
            TypeDefinition::InputObject(input_object) => Some(&input_object.directives),
        }
    }
}

impl TypeExtension<'static, String> {
    pub fn name(&self) -> &str {
        match self {
            TypeExtension::Object(object) => &object.name,
            TypeExtension::Interface(interface) => &interface.name,
            TypeExtension::Union(union) => &union.name,
            TypeExtension::Scalar(scalar) => &scalar.name,
            TypeExtension::Enum(enum_) => &enum_.name,
            TypeExtension::InputObject(input_object) => &input_object.name,
        }
    }
    pub fn fields<'a>(&'a self) -> Option<TypeDefinitionFields<'a>> {
        match self {
            TypeExtension::Object(object) => Some(TypeDefinitionFields::Fields(&object.fields)),
            TypeExtension::Interface(interface) => {
                Some(TypeDefinitionFields::Fields(&interface.fields))
            }
            _ => None,
        }
    }
    pub fn directives(&self) -> Option<&[Directive]> {
        match self {
            TypeExtension::Object(object) => Some(&object.directives),
            TypeExtension::Interface(interface) => Some(&interface.directives),
            TypeExtension::Union(union) => Some(&union.directives),
            TypeExtension::Enum(enum_) => Some(&enum_.directives),
            TypeExtension::InputObject(input_object) => Some(&input_object.directives),
            TypeExtension::Scalar(scalar) => Some(&scalar.directives),
        }
    }
}