apollo-federation 2.13.1

//! Validates `@source` directives

use apollo_compiler::ast::Directive;
use apollo_compiler::schema::Component;
use hashbrown::HashMap;

use super::coordinates::SourceDirectiveCoordinate;
use super::errors::ErrorsCoordinate;
use super::errors::IsSuccessArgument;
use super::http::UrlProperties;
use crate::connectors::SourceName;
use crate::connectors::spec::http::HTTP_ARGUMENT_NAME;
use crate::connectors::spec::source::BaseUrl;
use crate::connectors::spec::source::SOURCE_NAME_ARGUMENT_NAME;
use crate::connectors::string_template::Part;
use crate::connectors::validation::Code;
use crate::connectors::validation::Message;
use crate::connectors::validation::coordinates::BaseUrlCoordinate;
use crate::connectors::validation::coordinates::HttpHeadersCoordinate;
use crate::connectors::validation::coordinates::source_http_argument_coordinate;
use crate::connectors::validation::errors::Errors;
use crate::connectors::validation::expression;
use crate::connectors::validation::expression::Context;
use crate::connectors::validation::expression::scalars;
use crate::connectors::validation::graphql::SchemaInfo;
use crate::connectors::validation::http::headers::Headers;
use crate::connectors::validation::http::url::validate_url_scheme;

/// A `@source` directive along with any errors related to it.
pub(super) struct SourceDirective<'schema> {
    pub(crate) name: SourceName,
    directive: &'schema Component<Directive>,
    base_url: Option<BaseUrl>,
    url_properties: Option<UrlProperties<'schema>>,
    headers: Option<Headers<'schema>>,
    is_success: Option<IsSuccessArgument<'schema>>,
    errors: Option<Errors<'schema>>,
    schema: &'schema SchemaInfo<'schema>,
}

impl<'schema> SourceDirective<'schema> {
    pub(super) fn find(schema: &'schema SchemaInfo) -> (Vec<Self>, Vec<Message>) {
        let source_directive_name = schema.source_directive_name();
        let mut directives = Vec::new();
        let mut messages = Vec::new();
        for directive in &schema.schema_definition.directives {
            if directive.name != *source_directive_name {
                continue;
            }
            let (directive, new_messages) = Self::from_directive(directive, schema);
            directives.extend(directive);
            messages.extend(new_messages);
        }
        let mut valid_source_names = HashMap::new();
        for directive in &directives {
            valid_source_names
                .entry(directive.name.as_str())
                .or_insert_with(Vec::new)
                .extend(directive.directive.node.line_column_range(&schema.sources));
        }
        for (name, locations) in valid_source_names {
            if locations.len() > 1 {
                messages.push(Message {
                    message: format!("Every `@{source_directive_name}({SOURCE_NAME_ARGUMENT_NAME}:)` must be unique. Found duplicate name \"{name}\"."),
                    code: Code::DuplicateSourceName,
                    locations,
                });
            }
        }
        (directives, messages)
    }

    fn from_directive(
        directive: &'schema Component<Directive>,
        schema: &'schema SchemaInfo<'schema>,
    ) -> (Option<SourceDirective<'schema>>, Vec<Message>) {
        let mut messages = Vec::new();
        let (name, name_messages) = SourceName::from_directive(directive, &schema.sources);
        messages.extend(name_messages);
        let Some(name) = name else {
            return (None, messages);
        };

        let coordinate = SourceDirectiveCoordinate {
            directive,
            name: name.clone(),
        };

        let errors = match Errors::parse(
            ErrorsCoordinate::Source {
                source: coordinate.clone(),
            },
            schema,
        ) {
            Ok(errors) => Some(errors),
            Err(errs) => {
                messages.extend(errs);
                None
            }
        };

        let is_success = match IsSuccessArgument::parse_for_source(coordinate.clone(), schema) {
            Ok(is_success) => is_success,
            Err(err) => {
                messages.push(err);
                None
            }
        };

        let Some(http_arg) = directive
            .specified_argument_by_name(&HTTP_ARGUMENT_NAME)
            .and_then(|arg| arg.as_object())
        else {
            messages.push(Message {
                code: Code::GraphQLError,
                message: format!(
                    "{coordinate} must have a `{HTTP_ARGUMENT_NAME}` argument.",
                    coordinate = source_http_argument_coordinate(&directive.name),
                ),
                locations: directive
                    .line_column_range(&schema.sources)
                    .into_iter()
                    .collect(),
            });
            return (
                Some(SourceDirective {
                    name,
                    schema,
                    directive,
                    is_success,
                    base_url: None,
                    url_properties: None,
                    headers: None,
                    errors: None,
                }),
                messages,
            );
        };

        let base_url = match BaseUrl::parse(
            http_arg,
            &directive.name,
            &schema.sources,
            schema.connect_link.spec,
        ) {
            Ok(base_url) => {
                // Only do URL validation for baseUrl if there are NO expressions. This is because with expressions,
                // we don't know the values at composition time so we can't tell if it is valid. This can result in us
                // saying it is NOT valid when at run time it would be.
                if base_url
                    .template
                    .parts
                    .iter()
                    .all(|p| !matches!(p, Part::Expression(_)))
                {
                    messages.extend(
                        validate_url_scheme(
                            &base_url.template,
                            BaseUrlCoordinate {
                                source_directive_name: &directive.name,
                            },
                            &base_url.node,
                            schema,
                        )
                        .err(),
                    );
                }

                Some(base_url)
            }
            Err(message) => {
                messages.push(message);
                None
            }
        };

        let url_properties = match UrlProperties::parse_for_source(coordinate, schema, http_arg) {
            Ok(url_properties) => Some(url_properties),
            Err(errs) => {
                messages.extend(errs);
                None
            }
        };

        let headers = match Headers::parse(
            http_arg,
            HttpHeadersCoordinate::Source {
                directive_name: &directive.name,
            },
            schema,
        ) {
            Ok(headers) => Some(headers),
            Err(header_messages) => {
                messages.extend(header_messages);
                None
            }
        };

        (
            Some(SourceDirective {
                name,
                directive,
                base_url,
                url_properties,
                is_success,
                headers,
                errors,
                schema,
            }),
            messages,
        )
    }

    /// Type-check each source, doing compile-time-only validations.
    ///
    /// Do not call this at runtime, as it may be prohibitively expensive.
    pub(crate) fn type_check(self) -> Vec<Message> {
        let mut messages = Vec::new();
        if let Some(errors) = self.errors {
            messages.extend(errors.type_check(self.schema).err().into_iter().flatten());
        }
        if let Some(url) = self.base_url {
            let expression_context =
                Context::for_source_url(self.schema, &url.node, Code::InvalidUrl);
            for expression in url.template.expressions() {
                messages.extend(
                    expression::validate(expression, &expression_context, &scalars())
                        .err()
                        .into_iter()
                        .map(|mut err| {
                            err.message =
                                format!("Invalid @source `baseURL` template: {}", err.message);
                            err
                        }),
                );
            }
        }
        if let Some(is_success_argument) = self.is_success {
            messages.extend(is_success_argument.type_check(self.schema).err());
        }
        if let Some(url_properties) = self.url_properties {
            messages.extend(url_properties.type_check(self.schema));
        }
        if let Some(headers) = self.headers {
            messages.extend(headers.type_check(self.schema).err().into_iter().flatten());
        }
        messages
    }
}