apollographql / apollo-rs

Spec compliant GraphQL Tools in Rust.

apollo-rs

Rust tooling for low-level manipulation of the GraphQL language.

Tools included

This project is intended to house a number of tools related to the low-level workings of GraphQL according to the GraphQL specification. Nothing in these libraries is specific to Apollo, and can freely be used by other projects which need standards-compliant GraphQL tooling written in Rust. The following crates currently exist:

• apollo-compiler - a library to compile and semantically analyze GraphQL query language.
• apollo-parser - a library to parse the GraphQL query language.
• apollo-smith - a test case generator to test GraphQL code (SDL).

Please check out their respective READMEs for usage examples.

Status

apollo-rs is a work in progress. Please check out the ROADMAP for upcoming features we are working on building.

If you do end up trying out apollo-rs and run into trouble, we encourage you to open an issue.

Design Principles

1. Prioritizing developer experience. Elegant and ergonomic APIs is the theme for Rust as a language, and we want to make sure that all component APIs we provide are aligned with these principles.

2. Stability and reliability. Spec-compliant, and idempotent APIs which, when complete, can be used safely in enterprise-grade codebases.

3. Diagnostics. The tools are to be written in a way that will allow us to produce detailed diagnostics. It does not panic or return early if there is a lexical or a syntactic error. Instead, the parser is meant to gather as much context and information as possible and return errors alongside the output that is valid. Coincidentally, this allows for easily debuggable code for those maintaining this project.

4. Extensibility. The parser is written to work with different use cases in our budding Rust GraphQL ecosystem, be it building schema-diagnostics for Rover, or writing out query planning and composition algorithms in Rust. These all have quite different requirements when it comes to AST manipulation. We wanted to make sure we account for them early on.

Rust versions

apollo-rs is tested on the latest stable version of Rust. Older version may or may not be compatible.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

apollo-rs's Issues

parse Selection

parse BooleanValue (in lexer)

parse ObjectTypeExtension

parse TypeCondition

parse NonNullType

parse Type

parse Variable

typed ast: allow for the AST to be walked

This needs a bit of design, before we start parsing the rest of language types.

parse StringValue (in lexer)

parse Argument

Parser

Description

Tracking issue for the parser.

Requirements

Specified elsewhere.

Subtasks

• TODO

parse DefaultValue

parse ObjectValue

parse fragment

• parse FragmentSpread
• parse InlineFragment
• parse FragmentDefinition
• parse FragmentName

parse OperationTypeDefinition

parse scalars

• parse ScalarTypeDefinition
• parse ScalarTypeExtension

parse TypeDefinition

parse VariableDefinition

parse TypeSystemExtension

typed ast: use xtask to run codegen

parse Document

typed ast: use generated nodes when creating AstNodes in parser

This needs a bit of design, as we should have a certain pattern that is very reproducible, as we have lots and lots of language types to create.

parse TypeExtension

parse ObjectField

typed ast: use ungrammar to define graphql language

parse FloatValue (in lexer)

parse SchemaExtension

typed ast: parse graphql types

using generated nodes from #3 and syntax kinds from #2 we need to be able to create parse rules for the following graphql types:

• #9
• #10
• #11
• #12
  • #13
  • parse OperationDefinition
  • #44
• #20
  • parse InlineFragment
  • parse FragmentDefinition
  • parse FragmentName
• #21
• #22
  • #23
  • #24
  • #25
  • #26
  • #27
  • #28
  • #29
  • #30
• #31
• #32
• #33
• #34
• #35
• #36
• #37
• #38
• #39
• #40
• #42
• #41
• #43
• #45
• #46
• #47
• #48
  • parse ScalarTypeDefinition
  • parse ScalarTypeExtension
• #49
• #50
• #51
• #52
  • #14
  • #15
  • #16
  • #17
  • #18
  • #19
  • #68
  • #68
• #53
  • parse InterfaceTypeDefinition
  • parse InterfaceTypeExtension
• #54
  • parse UnionTypeDefinition
  • parse UnionMemberTypes
  • parse UnionTypeExtension
• #55
  • parse EnumTypeDefinition
  • parse EnumValuesDefinition
  • parse EnumValueDefinition
  • parse EnumTypeExtension
• #56
  • parse ArgumentsDefinition
  • parse InputValueDefinition
  • parse InputObjectTypeDefinition
  • parse InputFieldsDefinition
  • parse InputObjectTypeExtension
• #57
  • parse Directives
  • parse Directive
  • parse DirectiveDefinition
  • parse DirectiveLocations
  • parse DirectiveLocation
  • parse ExecutableDirectiveLocation
  • parse TypeSystemDirectiveLocation
• parse whitespace and other ignored tokens #79
• #72
• #71
• #83

parse NullValue

parse values

• parse Value
• parse StringValue (in lexer)
• parse FloatValue (in lexer)
• parse IntValue (in lexer)
• parse BooleanValue (in lexer)
• parse NullValue
• parse EnumValue
• parse ListValue
• parse ObjectValue

parse Alias

parse Description

• parse string character
• parse block string character
• parse comment

The distinction can be done in the lexer. It can create two different tokens: StringValue and Comment.

parse ListValue

typed ast: codegen to generate nodes based on ungrammar

parse Definition

parse SchemaDefinition

parse VariableDefinitions

parse Field

parse TypeSystemDefinition

parse NamedType

parse ListType

parse ObjectTypeDefinition

parse IntValue (in lexer)

parse operations

• parse OperationDefinition
• parse OperationType
• parse OperationTypeDefinition

parse OperationType

parse ExecutableDefinition

parse SelectionSet

parse EnumValue

typed ast: codegen to generate SyntaxKinds

parse Arguments