async-graphql/src/validation/visitor.rs

715 lines
22 KiB
Rust

use crate::error::RuleError;
use crate::parser::ast::{
Definition, Directive, Document, Field, FragmentDefinition, FragmentSpread, InlineFragment,
OperationDefinition, Selection, SelectionSet, TypeCondition, VariableDefinition,
};
use crate::registry::{self, Type, TypeName};
use crate::{Pos, Positioned, Value};
use std::collections::HashMap;
pub struct VisitorContext<'a> {
pub registry: &'a registry::Registry,
pub errors: Vec<RuleError>,
type_stack: Vec<Option<&'a registry::Type>>,
input_type: Vec<Option<TypeName<'a>>>,
fragments: HashMap<&'a str, &'a Positioned<FragmentDefinition>>,
}
impl<'a> VisitorContext<'a> {
pub fn new(registry: &'a registry::Registry, doc: &'a Document) -> Self {
Self {
registry,
errors: Default::default(),
type_stack: Default::default(),
input_type: Default::default(),
fragments: doc
.definitions()
.iter()
.filter_map(|d| match &d.node {
Definition::Fragment(fragment) => Some((fragment.name.node, fragment)),
_ => None,
})
.collect(),
}
}
pub fn report_error<T: Into<String>>(&mut self, locations: Vec<Pos>, msg: T) {
self.errors.push(RuleError {
locations,
message: msg.into(),
})
}
pub fn append_errors(&mut self, errors: Vec<RuleError>) {
self.errors.extend(errors);
}
pub fn with_type<F: FnMut(&mut VisitorContext<'a>)>(
&mut self,
ty: Option<&'a registry::Type>,
mut f: F,
) {
self.type_stack.push(ty);
f(self);
self.type_stack.pop();
}
pub fn with_input_type<F: FnMut(&mut VisitorContext<'a>)>(
&mut self,
ty: Option<TypeName<'a>>,
mut f: F,
) {
self.input_type.push(ty);
f(self);
self.input_type.pop();
}
pub fn parent_type(&self) -> Option<&'a registry::Type> {
if self.type_stack.len() >= 2 {
self.type_stack
.get(self.type_stack.len() - 2)
.copied()
.flatten()
} else {
None
}
}
pub fn current_type(&self) -> Option<&'a registry::Type> {
self.type_stack.last().copied().flatten()
}
pub fn is_known_fragment(&self, name: &str) -> bool {
self.fragments.contains_key(name)
}
pub fn fragment(&self, name: &str) -> Option<&'a Positioned<FragmentDefinition>> {
self.fragments.get(name).copied()
}
}
pub trait Visitor<'a> {
fn enter_document(&mut self, _ctx: &mut VisitorContext<'a>, _doc: &'a Document) {}
fn exit_document(&mut self, _ctx: &mut VisitorContext<'a>, _doc: &'a Document) {}
fn enter_operation_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_operation_definition: &'a Positioned<OperationDefinition>,
) {
}
fn exit_operation_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_operation_definition: &'a Positioned<OperationDefinition>,
) {
}
fn enter_fragment_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_fragment_definition: &'a Positioned<FragmentDefinition>,
) {
}
fn exit_fragment_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_fragment_definition: &'a Positioned<FragmentDefinition>,
) {
}
fn enter_variable_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_variable_definition: &'a Positioned<VariableDefinition>,
) {
}
fn exit_variable_definition(
&mut self,
_ctx: &mut VisitorContext<'a>,
_variable_definition: &'a Positioned<VariableDefinition>,
) {
}
fn enter_directive(
&mut self,
_ctx: &mut VisitorContext<'a>,
_directive: &'a Positioned<Directive>,
) {
}
fn exit_directive(
&mut self,
_ctx: &mut VisitorContext<'a>,
_directive: &'a Positioned<Directive>,
) {
}
fn enter_argument(
&mut self,
_ctx: &mut VisitorContext<'a>,
_name: &'a Positioned<&str>,
_value: &'a Positioned<Value>,
) {
}
fn exit_argument(
&mut self,
_ctx: &mut VisitorContext<'a>,
_name: &'a Positioned<&str>,
_value: &'a Positioned<Value>,
) {
}
fn enter_selection_set(
&mut self,
_ctx: &mut VisitorContext<'a>,
_selection_set: &'a Positioned<SelectionSet>,
) {
}
fn exit_selection_set(
&mut self,
_ctx: &mut VisitorContext<'a>,
_selection_set: &'a Positioned<SelectionSet>,
) {
}
fn enter_selection(
&mut self,
_ctx: &mut VisitorContext<'a>,
_selection: &'a Positioned<Selection>,
) {
}
fn exit_selection(
&mut self,
_ctx: &mut VisitorContext<'a>,
_selection: &'a Positioned<Selection>,
) {
}
fn enter_field(&mut self, _ctx: &mut VisitorContext<'a>, _field: &'a Positioned<Field>) {}
fn exit_field(&mut self, _ctx: &mut VisitorContext<'a>, _field: &'a Positioned<Field>) {}
fn enter_fragment_spread(
&mut self,
_ctx: &mut VisitorContext<'a>,
_fragment_spread: &'a Positioned<FragmentSpread>,
) {
}
fn exit_fragment_spread(
&mut self,
_ctx: &mut VisitorContext<'a>,
_fragment_spread: &'a Positioned<FragmentSpread>,
) {
}
fn enter_inline_fragment(
&mut self,
_ctx: &mut VisitorContext<'a>,
_inline_fragment: &'a Positioned<InlineFragment>,
) {
}
fn exit_inline_fragment(
&mut self,
_ctx: &mut VisitorContext<'a>,
_inline_fragment: &'a Positioned<InlineFragment>,
) {
}
fn enter_input_value(
&mut self,
_ctx: &mut VisitorContext<'a>,
_pos: Pos,
_expected_type: &Option<TypeName<'a>>,
_value: &'a Value,
) {
}
fn exit_input_value(
&mut self,
_ctx: &mut VisitorContext<'a>,
_pos: Pos,
_expected_type: &Option<TypeName<'a>>,
_value: &Value,
) {
}
}
pub struct VisitorNil;
impl VisitorNil {
pub fn with<V>(self, visitor: V) -> VisitorCons<V, Self> {
VisitorCons(visitor, self)
}
}
pub struct VisitorCons<A, B>(A, B);
impl<A, B> VisitorCons<A, B> {
pub fn with<V>(self, visitor: V) -> VisitorCons<V, Self> {
VisitorCons(visitor, self)
}
}
impl<'a> Visitor<'a> for VisitorNil {}
impl<'a, A, B> Visitor<'a> for VisitorCons<A, B>
where
A: Visitor<'a> + 'a,
B: Visitor<'a> + 'a,
{
fn enter_document(&mut self, ctx: &mut VisitorContext<'a>, doc: &'a Document) {
self.0.enter_document(ctx, doc);
self.1.enter_document(ctx, doc);
}
fn exit_document(&mut self, ctx: &mut VisitorContext<'a>, doc: &'a Document) {
self.0.exit_document(ctx, doc);
self.1.exit_document(ctx, doc);
}
fn enter_operation_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
operation_definition: &'a Positioned<OperationDefinition>,
) {
self.0.enter_operation_definition(ctx, operation_definition);
self.1.enter_operation_definition(ctx, operation_definition);
}
fn exit_operation_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
operation_definition: &'a Positioned<OperationDefinition>,
) {
self.0.exit_operation_definition(ctx, operation_definition);
self.1.exit_operation_definition(ctx, operation_definition);
}
fn enter_fragment_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
fragment_definition: &'a Positioned<FragmentDefinition>,
) {
self.0.enter_fragment_definition(ctx, fragment_definition);
self.1.enter_fragment_definition(ctx, fragment_definition);
}
fn exit_fragment_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
fragment_definition: &'a Positioned<FragmentDefinition>,
) {
self.0.exit_fragment_definition(ctx, fragment_definition);
self.1.exit_fragment_definition(ctx, fragment_definition);
}
fn enter_variable_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
variable_definition: &'a Positioned<VariableDefinition>,
) {
self.0.enter_variable_definition(ctx, variable_definition);
self.1.enter_variable_definition(ctx, variable_definition);
}
fn exit_variable_definition(
&mut self,
ctx: &mut VisitorContext<'a>,
variable_definition: &'a Positioned<VariableDefinition>,
) {
self.0.exit_variable_definition(ctx, variable_definition);
self.1.exit_variable_definition(ctx, variable_definition);
}
fn enter_directive(
&mut self,
ctx: &mut VisitorContext<'a>,
directive: &'a Positioned<Directive>,
) {
self.0.enter_directive(ctx, directive);
self.1.enter_directive(ctx, directive);
}
fn exit_directive(
&mut self,
ctx: &mut VisitorContext<'a>,
directive: &'a Positioned<Directive>,
) {
self.0.exit_directive(ctx, directive);
self.1.exit_directive(ctx, directive);
}
fn enter_argument(
&mut self,
ctx: &mut VisitorContext<'a>,
name: &'a Positioned<&str>,
value: &'a Positioned<Value>,
) {
self.0.enter_argument(ctx, name, value);
self.1.enter_argument(ctx, name, value);
}
fn exit_argument(
&mut self,
ctx: &mut VisitorContext<'a>,
name: &'a Positioned<&str>,
value: &'a Positioned<Value>,
) {
self.0.exit_argument(ctx, name, value);
self.1.exit_argument(ctx, name, value);
}
fn enter_selection_set(
&mut self,
ctx: &mut VisitorContext<'a>,
selection_set: &'a Positioned<SelectionSet>,
) {
self.0.enter_selection_set(ctx, selection_set);
self.1.enter_selection_set(ctx, selection_set);
}
fn exit_selection_set(
&mut self,
ctx: &mut VisitorContext<'a>,
selection_set: &'a Positioned<SelectionSet>,
) {
self.0.exit_selection_set(ctx, selection_set);
self.1.exit_selection_set(ctx, selection_set);
}
fn enter_selection(
&mut self,
ctx: &mut VisitorContext<'a>,
selection: &'a Positioned<Selection>,
) {
self.0.enter_selection(ctx, selection);
self.1.enter_selection(ctx, selection);
}
fn exit_selection(
&mut self,
ctx: &mut VisitorContext<'a>,
selection: &'a Positioned<Selection>,
) {
self.0.exit_selection(ctx, selection);
self.1.exit_selection(ctx, selection);
}
fn enter_field(&mut self, ctx: &mut VisitorContext<'a>, field: &'a Positioned<Field>) {
self.0.enter_field(ctx, field);
self.1.enter_field(ctx, field);
}
fn exit_field(&mut self, ctx: &mut VisitorContext<'a>, field: &'a Positioned<Field>) {
self.0.exit_field(ctx, field);
self.1.exit_field(ctx, field);
}
fn enter_fragment_spread(
&mut self,
ctx: &mut VisitorContext<'a>,
fragment_spread: &'a Positioned<FragmentSpread>,
) {
self.0.enter_fragment_spread(ctx, fragment_spread);
self.1.enter_fragment_spread(ctx, fragment_spread);
}
fn exit_fragment_spread(
&mut self,
ctx: &mut VisitorContext<'a>,
fragment_spread: &'a Positioned<FragmentSpread>,
) {
self.0.exit_fragment_spread(ctx, fragment_spread);
self.1.exit_fragment_spread(ctx, fragment_spread);
}
fn enter_inline_fragment(
&mut self,
ctx: &mut VisitorContext<'a>,
inline_fragment: &'a Positioned<InlineFragment>,
) {
self.0.enter_inline_fragment(ctx, inline_fragment);
self.1.enter_inline_fragment(ctx, inline_fragment);
}
fn exit_inline_fragment(
&mut self,
ctx: &mut VisitorContext<'a>,
inline_fragment: &'a Positioned<InlineFragment>,
) {
self.0.exit_inline_fragment(ctx, inline_fragment);
self.1.exit_inline_fragment(ctx, inline_fragment);
}
}
pub fn visit<'a, V: Visitor<'a>>(v: &mut V, ctx: &mut VisitorContext<'a>, doc: &'a Document) {
v.enter_document(ctx, doc);
visit_definitions(v, ctx, doc);
v.exit_document(ctx, doc);
}
fn visit_definitions<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
doc: &'a Document,
) {
for d in doc.definitions() {
match &d.node {
Definition::Operation(operation) => {
visit_operation_definition(v, ctx, operation);
}
Definition::Fragment(fragment) => {
let TypeCondition::On(name) = &fragment.type_condition.node;
ctx.with_type(ctx.registry.types.get(name.node), |ctx| {
visit_fragment_definition(v, ctx, fragment)
});
}
}
}
}
fn visit_operation_definition<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
operation: &'a Positioned<OperationDefinition>,
) {
v.enter_operation_definition(ctx, operation);
match &operation.node {
OperationDefinition::SelectionSet(selection_set) => {
ctx.with_type(Some(&ctx.registry.types[&ctx.registry.query_type]), |ctx| {
visit_selection_set(v, ctx, selection_set)
});
}
OperationDefinition::Query(query) => {
ctx.with_type(Some(&ctx.registry.types[&ctx.registry.query_type]), |ctx| {
visit_variable_definitions(v, ctx, &query.variable_definitions);
visit_directives(v, ctx, &query.directives);
visit_selection_set(v, ctx, &query.selection_set);
});
}
OperationDefinition::Mutation(mutation) => {
if let Some(mutation_type) = &ctx.registry.mutation_type {
ctx.with_type(Some(&ctx.registry.types[mutation_type]), |ctx| {
visit_variable_definitions(v, ctx, &mutation.variable_definitions);
visit_directives(v, ctx, &mutation.directives);
visit_selection_set(v, ctx, &mutation.selection_set);
});
} else {
ctx.report_error(
vec![mutation.position()],
"Schema is not configured for mutations.",
);
}
}
OperationDefinition::Subscription(subscription) => {
if let Some(subscription_type) = &ctx.registry.subscription_type {
ctx.with_type(Some(&ctx.registry.types[subscription_type]), |ctx| {
visit_variable_definitions(v, ctx, &subscription.variable_definitions);
visit_directives(v, ctx, &subscription.directives);
visit_selection_set(v, ctx, &subscription.selection_set);
});
} else {
ctx.report_error(
vec![subscription.position()],
"Schema is not configured for subscriptions.",
);
}
}
}
v.exit_operation_definition(ctx, operation);
}
fn visit_selection_set<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
selection_set: &'a Positioned<SelectionSet>,
) {
if !selection_set.items.is_empty() {
v.enter_selection_set(ctx, selection_set);
for selection in &selection_set.items {
visit_selection(v, ctx, selection);
}
v.exit_selection_set(ctx, selection_set);
}
}
fn visit_selection<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
selection: &'a Positioned<Selection>,
) {
v.enter_selection(ctx, selection);
match &selection.node {
Selection::Field(field) => {
if field.name.node != "__typename" {
ctx.with_type(
ctx.current_type()
.and_then(|ty| ty.field_by_name(&field.name))
.and_then(|schema_field| {
ctx.registry.concrete_type_by_name(&schema_field.ty)
}),
|ctx| {
visit_field(v, ctx, field);
},
);
}
}
Selection::FragmentSpread(fragment_spread) => {
visit_fragment_spread(v, ctx, fragment_spread)
}
Selection::InlineFragment(inline_fragment) => {
if let Some(TypeCondition::On(name)) =
&inline_fragment.type_condition.as_ref().map(|c| &c.node)
{
ctx.with_type(ctx.registry.types.get(name.node), |ctx| {
visit_inline_fragment(v, ctx, inline_fragment)
});
}
}
}
v.exit_selection(ctx, selection);
}
fn visit_field<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
field: &'a Positioned<Field>,
) {
v.enter_field(ctx, field);
for (name, value) in &field.arguments {
v.enter_argument(ctx, name, value);
let expected_ty = ctx
.parent_type()
.and_then(|ty| ty.field_by_name(&field.name))
.and_then(|schema_field| schema_field.args.get(name.node))
.map(|input_ty| TypeName::create(&input_ty.ty));
ctx.with_input_type(expected_ty, |ctx| {
visit_input_value(v, ctx, field.position(), expected_ty, value)
});
v.exit_argument(ctx, name, value);
}
visit_directives(v, ctx, &field.directives);
visit_selection_set(v, ctx, &field.selection_set);
v.exit_field(ctx, field);
}
fn visit_input_value<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
pos: Pos,
expected_ty: Option<TypeName<'a>>,
value: &'a Value,
) {
v.enter_input_value(ctx, pos, &expected_ty, value);
match value {
Value::List(values) => {
if let Some(expected_ty) = expected_ty {
let elem_ty = expected_ty.unwrap_non_null();
if let TypeName::List(expected_ty) = elem_ty {
values.iter().for_each(|value| {
visit_input_value(v, ctx, pos, Some(TypeName::create(expected_ty)), value)
});
}
}
}
Value::Object(values) => {
if let Some(expected_ty) = expected_ty {
let expected_ty = expected_ty.unwrap_non_null();
if let TypeName::Named(expected_ty) = expected_ty {
if let Some(ty) = ctx
.registry
.types
.get(TypeName::concrete_typename(expected_ty))
{
if let Type::InputObject { input_fields, .. } = ty {
for (item_key, item_value) in values {
if let Some(input_value) = input_fields.get(item_key.as_ref()) {
visit_input_value(
v,
ctx,
pos,
Some(TypeName::create(&input_value.ty)),
item_value,
);
}
}
}
}
}
}
}
_ => {}
}
v.exit_input_value(ctx, pos, &expected_ty, value);
}
fn visit_variable_definitions<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
variable_definitions: &'a [Positioned<VariableDefinition>],
) {
for d in variable_definitions {
v.enter_variable_definition(ctx, d);
v.exit_variable_definition(ctx, d);
}
}
fn visit_directives<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
directives: &'a [Positioned<Directive>],
) {
for d in directives {
v.enter_directive(ctx, d);
let schema_directive = ctx.registry.directives.get(d.name.node);
for (name, value) in &d.arguments {
v.enter_argument(ctx, name, value);
let expected_ty = schema_directive
.and_then(|schema_directive| schema_directive.args.get(name.node))
.map(|input_ty| TypeName::create(&input_ty.ty));
ctx.with_input_type(expected_ty, |ctx| {
visit_input_value(v, ctx, d.position(), expected_ty, value)
});
v.exit_argument(ctx, name, value);
}
v.exit_directive(ctx, d);
}
}
fn visit_fragment_definition<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
fragment: &'a Positioned<FragmentDefinition>,
) {
v.enter_fragment_definition(ctx, fragment);
visit_directives(v, ctx, &fragment.directives);
visit_selection_set(v, ctx, &fragment.selection_set);
v.exit_fragment_definition(ctx, fragment);
}
fn visit_fragment_spread<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
fragment_spread: &'a Positioned<FragmentSpread>,
) {
v.enter_fragment_spread(ctx, fragment_spread);
visit_directives(v, ctx, &fragment_spread.directives);
v.exit_fragment_spread(ctx, fragment_spread);
}
fn visit_inline_fragment<'a, V: Visitor<'a>>(
v: &mut V,
ctx: &mut VisitorContext<'a>,
inline_fragment: &'a Positioned<InlineFragment>,
) {
v.enter_inline_fragment(ctx, inline_fragment);
visit_directives(v, ctx, &inline_fragment.directives);
visit_selection_set(v, ctx, &inline_fragment.selection_set);
v.exit_inline_fragment(ctx, inline_fragment);
}