Skip to content

feat(compiler, parser): support executable document descriptions #974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(compiler, parser): support executable document descriptions #974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8105a7
feat(compiler, parser): support executable document descriptions
goto-bus-stop Jul 2, 2025
48480d1
Merge branch 'main' into renee/executable-descriptions
goto-bus-stop Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/apollo-compiler/src/ast/from_cst.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ impl Convert for cst::OperationDefinition {
ast::OperationType::Query
};
Some(Self::Target {
description: self.description().convert(file_id)?,
operation_type,
name: self.name().convert(file_id)?,
variables: collect_opt(file_id, self.variable_definitions(), |x| {
Expand All @@ -147,6 +148,7 @@ impl Convert for cst::FragmentDefinition {

fn convert(&self, file_id: FileId) -> Option<Self::Target> {
Some(Self::Target {
description: self.description().convert(file_id)?,
name: self.fragment_name()?.name()?.convert(file_id)?,
type_condition: self.type_condition()?.convert(file_id)?,
directives: ast::DirectiveList(collect_opt(file_id, self.directives(), |x| {
Expand Down Expand Up @@ -530,6 +532,7 @@ impl Convert for cst::VariableDefinition {
};
let ty = &self.ty()?;
Some(Self::Target {
description: self.description().convert(file_id)?,
name: self.variable()?.name()?.convert(file_id)?,
ty: with_location(file_id, ty.syntax(), ty.convert(file_id)?),
default_value,
Expand Down
3 changes: 3 additions & 0 deletions crates/apollo-compiler/src/ast/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ pub enum Definition {
/// [_OperationDefinition_](https://spec.graphql.org/draft/#OperationDefinition).
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct OperationDefinition {
pub description: Option<Node<str>>,
pub operation_type: OperationType,
pub name: Option<Name>,
pub variables: Vec<Node<VariableDefinition>>,
Expand All @@ -127,6 +128,7 @@ pub struct OperationDefinition {
/// [_FragmentDefinition_](https://spec.graphql.org/draft/#FragmentDefinition).
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct FragmentDefinition {
pub description: Option<Node<str>>,
pub name: Name,
pub type_condition: NamedType,
pub directives: DirectiveList,
Expand Down Expand Up @@ -335,6 +337,7 @@ pub enum DirectiveLocation {
/// in an [`OperationDefinition`].
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct VariableDefinition {
pub description: Option<Node<str>>,
pub name: Name,
pub ty: Node<Type>,
pub default_value: Option<Node<Value>>,
Expand Down
6 changes: 6 additions & 0 deletions crates/apollo-compiler/src/ast/serialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ impl OperationDefinition {
fn serialize_impl(&self, state: &mut State) -> fmt::Result {
// Deconstruct to get a warning if we forget to serialize something
let Self {
description,
operation_type,
name,
variables,
Expand All @@ -208,6 +209,7 @@ impl OperationDefinition {
&& variables.is_empty()
&& directives.is_empty();
if !shorthand {
serialize_description(state, description)?;
state.write(operation_type.name())?;
if let Some(name) = &name {
state.write(" ")?;
Expand All @@ -230,11 +232,13 @@ impl OperationDefinition {
impl FragmentDefinition {
fn serialize_impl(&self, state: &mut State) -> fmt::Result {
let Self {
description,
name,
type_condition,
directives,
selection_set,
} = self;
serialize_description(state, description)?;
display!(state, "fragment {} on {}", name, type_condition)?;
directives.serialize_impl(state)?;
state.write(" ")?;
Expand Down Expand Up @@ -581,11 +585,13 @@ impl Directive {
impl VariableDefinition {
fn serialize_impl(&self, state: &mut State) -> fmt::Result {
let Self {
description,
name,
ty,
default_value,
directives,
} = self;
serialize_description(state, description)?;
state.write("$")?;
state.write(name)?;
state.write(": ")?;
Expand Down
2 changes: 2 additions & 0 deletions crates/apollo-compiler/src/executable/from_ast.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ impl Operation {
let mut selection_set = SelectionSet::new(ty);
selection_set.extend_from_ast(schema, errors, &ast.selection_set);
Some(Self {
description: ast.description.clone(),
operation_type: ast.operation_type,
name: ast.name.clone(),
variables: ast.variables.clone(),
Expand Down Expand Up @@ -170,6 +171,7 @@ impl Fragment {
let mut selection_set = SelectionSet::new(ast.type_condition.clone());
selection_set.extend_from_ast(schema, errors, &ast.selection_set);
Some(Self {
description: ast.description.clone(),
name: ast.name.clone(),
directives: ast.directives.clone(),
selection_set,
Expand Down
2 changes: 2 additions & 0 deletions crates/apollo-compiler/src/executable/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ pub struct FieldSet {
/// annotated with type information.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Operation {
pub description: Option<Node<str>>,
pub operation_type: OperationType,
pub name: Option<Name>,
pub variables: Vec<Node<VariableDefinition>>,
Expand All @@ -134,6 +135,7 @@ pub struct Operation {
/// annotated with type information.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Fragment {
pub description: Option<Node<str>>,
pub name: Name,
pub directives: DirectiveList,
pub selection_set: SelectionSet,
Expand Down
2 changes: 2 additions & 0 deletions crates/apollo-compiler/src/executable/serialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ impl ExecutableDocument {
impl Operation {
fn to_ast(&self, location: Option<SourceSpan>) -> ast::Definition {
let def = ast::OperationDefinition {
description: self.description.clone(),
operation_type: self.operation_type,
name: self.name.clone(),
variables: self.variables.clone(),
Expand All @@ -45,6 +46,7 @@ impl Operation {
impl Fragment {
fn to_ast(&self, location: Option<SourceSpan>) -> ast::Definition {
let def = ast::FragmentDefinition {
description: self.description.clone(),
name: self.name.clone(),
type_condition: self.selection_set.ty.clone(),
directives: self.directives.clone(),
Expand Down
14 changes: 14 additions & 0 deletions crates/apollo-compiler/test_data/diagnostics/0125_query_shorthand_description.graphql
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this missing a matching .txt file?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also, should we have this test case in the parser's test_data directory for posterity?

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"Get all our time machine models."
{
timeMachines {
model
}
}

type TimeMachine {
id: ID!
model: String
}
type Query {
timeMachines: [TimeMachine]
}
1 change: 1 addition & 0 deletions crates/apollo-compiler/test_data/ok/0001_annonymous_operation_definition.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ ExecutableDocument {
operations: OperationMap {
anonymous: Some(
1..31 @3 Operation {
description: None,
operation_type: Query,
name: None,
variables: [],
Expand Down
2 changes: 2 additions & 0 deletions crates/apollo-compiler/test_data/ok/0002_multiple_named_operation_definitions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ ExecutableDocument {
anonymous: None,
named: {
"getCatName": 0..41 @4 Operation {
description: None,
operation_type: Query,
name: Some(
"getCatName",
Expand Down Expand Up @@ -189,6 +190,7 @@ ExecutableDocument {
},
},
"getOwnerName": 43..106 @4 Operation {
description: None,
operation_type: Query,
name: Some(
"getOwnerName",
Expand Down
1 change: 1 addition & 0 deletions crates/apollo-compiler/test_data/ok/0010_operation_with_defined_fields.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ ExecutableDocument {
anonymous: None,
named: {
"getProduct": 0..68 @12 Operation {
description: None,
operation_type: Query,
name: Some(
"getProduct",
Expand Down
3 changes: 3 additions & 0 deletions crates/apollo-compiler/test_data/ok/0011_fragment_spreads_in_fragment_definitions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ ExecutableDocument {
anonymous: None,
named: {
"IntrospectionQuery": 0..51 @13 Operation {
description: None,
operation_type: Query,
name: Some(
"IntrospectionQuery",
Expand Down Expand Up @@ -166,6 +167,7 @@ ExecutableDocument {
},
fragments: {
"Bar": 53..100 @13 Fragment {
description: None,
name: "Bar",
directives: [],
selection_set: SelectionSet {
Expand Down Expand Up @@ -203,6 +205,7 @@ ExecutableDocument {
},
},
"Quux": 102..131 @13 Fragment {
description: None,
name: "Quux",
directives: [],
selection_set: SelectionSet {
Expand Down
4 changes: 4 additions & 0 deletions crates/apollo-compiler/test_data/ok/0012_introspection_query.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ ExecutableDocument {
anonymous: None,
named: {
"IntrospectionQuery": 0..271 @14 Operation {
description: None,
operation_type: Query,
name: Some(
"IntrospectionQuery",
Expand Down Expand Up @@ -418,6 +419,7 @@ ExecutableDocument {
},
fragments: {
"FullType": 272..723 @14 Fragment {
description: None,
name: "FullType",
directives: [],
selection_set: SelectionSet {
Expand Down Expand Up @@ -924,6 +926,7 @@ ExecutableDocument {
},
},
"InputValue": 724..821 @14 Fragment {
description: None,
name: "InputValue",
directives: [],
selection_set: SelectionSet {
Expand Down Expand Up @@ -1026,6 +1029,7 @@ ExecutableDocument {
},
},
"TypeRef": 822..1265 @14 Fragment {
description: None,
name: "TypeRef",
directives: [],
selection_set: SelectionSet {
Expand Down
3 changes: 3 additions & 0 deletions crates/apollo-compiler/test_data/ok/0013_operation_with_used_variable_in_fragment.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,12 +210,14 @@ ExecutableDocument {
anonymous: None,
named: {
"ExampleQuery": 0..81 @15 Operation {
description: None,
operation_type: Query,
name: Some(
"ExampleQuery",
),
variables: [
19..33 @15 VariableDefinition {
description: None,
name: "variable",
ty: 30..33 @15 Named(
"Int",
Expand Down Expand Up @@ -294,6 +296,7 @@ ExecutableDocument {
},
fragments: {
"subFrag": 83..163 @15 Fragment {
description: None,
name: "subFrag",
directives: [],
selection_set: SelectionSet {
Expand Down
5 changes: 5 additions & 0 deletions crates/apollo-compiler/test_data/ok/0016_same_variables_in_multiple_operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,14 @@ ExecutableDocument {
anonymous: None,
named: {
"A": 0..61 @18 Operation {
description: None,
operation_type: Query,
name: Some(
"A",
),
variables: [
8..30 @18 VariableDefinition {
description: None,
name: "atOtherHomes",
ty: 23..30 @18 Named(
"Boolean",
Expand All @@ -174,12 +176,14 @@ ExecutableDocument {
},
},
"B": 63..124 @18 Operation {
description: None,
operation_type: Query,
name: Some(
"B",
),
variables: [
71..93 @18 VariableDefinition {
description: None,
name: "atOtherHomes",
ty: 86..93 @18 Named(
"Boolean",
Expand All @@ -205,6 +209,7 @@ ExecutableDocument {
},
fragments: {
"HouseTrainedFragment": 126..228 @18 Fragment {
description: None,
name: "HouseTrainedFragment",
directives: [],
selection_set: SelectionSet {
Expand Down
6 changes: 6 additions & 0 deletions crates/apollo-compiler/test_data/ok/0017_variables_are_input_types.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,12 +225,14 @@ ExecutableDocument {
anonymous: None,
named: {
"takesBoolean": 0..106 @19 Operation {
description: None,
operation_type: Query,
name: Some(
"takesBoolean",
),
variables: [
19..41 @19 VariableDefinition {
description: None,
name: "atOtherHomes",
ty: 34..41 @19 Named(
"Boolean",
Expand Down Expand Up @@ -307,12 +309,14 @@ ExecutableDocument {
},
},
"takesComplexInput": 108..213 @19 Operation {
description: None,
operation_type: Query,
name: Some(
"takesComplexInput",
),
variables: [
132..159 @19 VariableDefinition {
description: None,
name: "complexInput",
ty: 147..159 @19 Named(
"ComplexInput",
Expand Down Expand Up @@ -389,12 +393,14 @@ ExecutableDocument {
},
},
"TakesListOfBooleanBang": 215..311 @19 Operation {
description: None,
operation_type: Query,
name: Some(
"TakesListOfBooleanBang",
),
variables: [
244..265 @19 VariableDefinition {
description: None,
name: "booleans",
ty: 255..265 @19 List(
NonNullNamed(
Expand Down
2 changes: 2 additions & 0 deletions crates/apollo-compiler/test_data/ok/0018_non_clashing_names.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ ExecutableDocument {
anonymous: None,
named: {
"A": 173..203 @20 Operation {
description: None,
operation_type: Query,
name: Some(
"A",
Expand Down Expand Up @@ -161,6 +162,7 @@ ExecutableDocument {
},
fragments: {
"A": 148..171 @20 Fragment {
description: None,
name: "A",
directives: [],
selection_set: SelectionSet {
Expand Down
3 changes: 3 additions & 0 deletions crates/apollo-compiler/test_data/ok/0020_merge_identical_fields.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ ExecutableDocument {
anonymous: None,
named: {
"queryPupper": 76..175 @22 Operation {
description: None,
operation_type: Query,
name: Some(
"queryPupper",
Expand Down Expand Up @@ -161,6 +162,7 @@ ExecutableDocument {
},
fragments: {
"mergeIdenticalFields": 177..231 @22 Fragment {
description: None,
name: "mergeIdenticalFields",
directives: [],
selection_set: SelectionSet {
Expand Down Expand Up @@ -212,6 +214,7 @@ ExecutableDocument {
},
},
"mergeIdenticalAliasesAndFields": 233..319 @22 Fragment {
description: None,
name: "mergeIdenticalAliasesAndFields",
directives: [],
selection_set: SelectionSet {
Expand Down
Loading