Crate apollo_compiler

source ·
Expand description

apollo-compiler

A query-based compiler for the GraphQL query language.

Crates.io version Download docs.rs docs

Features

  • A (comparatively) low-level AST for GraphQL grammar, and high-level representation of Schema and ExecutableDocument.
  • All three can be parsed (using apollo-parser internally), created or modified programatically, and serialized.
  • Validation of schemas and executable documents, as defined in the GraphQL specification.

Getting started

Add the dependency to start using apollo-compiler:

cargo add apollo-compiler

Or add this to your Cargo.toml for a manual installation:

# Just an example, change to the necessary package version.
# Using an exact dependency is recommended for beta versions
[dependencies]
apollo-compiler = "=1.0.0-beta.7"

Rust versions

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

Usage

You can get started with apollo-compiler:

use apollo_compiler::Schema;

let input = r#"
  interface Pet {
    name: String
  }

  type Dog implements Pet {
    name: String
    nickname: String
    barkVolume: Int
  }

  type Cat implements Pet {
    name: String
    nickname: String
    meowVolume: Int
  }

  union CatOrDog = Cat | Dog

  type Human {
    name: String
    pets: [Pet]
  }

  type Query {
    human: Human
  }
"#;

let schema = Schema::parse(input, "document.graphql");

/// In case of validation errors, the panic message will be nicely formatted
/// to point at relevant parts of the source file(s)
schema.validate().unwrap();

Examples

Accessing fragment definition field types
use apollo_compiler::{Schema, ExecutableDocument, Node, executable};

fn main() {
    let schema_input = r#"
    type User {
      id: ID
      name: String
      profilePic(size: Int): URL
    }

    schema { query: User }

    scalar URL @specifiedBy(url: "https://tools.ietf.org/html/rfc3986")
    "#;
    let query_input = r#"
    query getUser {
      ... vipCustomer
    }

    #fragment definition where we want to know the field types.
    fragment vipCustomer on User {
      id
      name
      profilePic(size: 50)
    }
    "#;

    let schema = Schema::parse(schema_input, "schema.graphql");
    let document = ExecutableDocument::parse(&schema, query_input, "query.graphql");

    schema.validate().unwrap();
    document.validate(&schema).unwrap();

    let op = document.get_operation(Some("getUser")).expect("getUser query does not exist");
    let fragment_in_op = op.selection_set.selections.iter().filter_map(|sel| match sel {
        executable::Selection::FragmentSpread(spread) => {
            Some(document.fragments.get(&spread.fragment_name)?.as_ref())
        }
        _ => None
    }).collect::<Vec<&executable::Fragment>>();

    let fragment_fields = fragment_in_op.iter().flat_map(|frag| {
        frag.selection_set.fields()
    }).collect::<Vec<&Node<executable::Field>>>();
    let field_ty = fragment_fields
        .iter()
        .map(|f| f.ty().inner_named_type().as_str())
        .collect::<Vec<&str>>();
    assert_eq!(field_ty, ["ID", "String", "URL"]);
}
Get a directive defined on a field used in a query operation definition.
use apollo_compiler::{Schema, ExecutableDocument, Node, executable};

fn main() {
    let schema_input = r#"
    type Query {
      topProducts: Product
      name: String
      size: Int
    }

    type Product {
      inStock: Boolean @join__field(graph: INVENTORY)
      name: String @join__field(graph: PRODUCTS)
      price: Int
      shippingEstimate: Int
      upc: String!
      weight: Int
    }

    enum join__Graph {
      INVENTORY,
      PRODUCTS,
    }
    scalar join__FieldSet
    directive @join__field(graph: join__Graph, requires: join__FieldSet, provides: join__FieldSet) on FIELD_DEFINITION
    "#;
    let query_input = r#"
    query getProduct {
      size
      topProducts {
        name
        inStock
      }
    }
    "#;

    let schema = Schema::parse(schema_input, "schema.graphql");
    let document = ExecutableDocument::parse(&schema, query_input, "query.graphql");

    schema.validate().unwrap();
    document.validate(&schema).unwrap();

    let get_product_op = document
        .get_operation(Some("getProduct"))
        .expect("getProduct query does not exist");

    let in_stock_field = &get_product_op
        .selection_set
        .fields()
        .find(|f| f.name == "topProducts")
        .expect("topProducts field does not exist")
        .selection_set
        .fields()
        .find(|f| f.name == "inStock")
        .expect("inStock field does not exist")
        .definition;
    let in_stock_directive: Vec<_> = in_stock_field
        .directives
        .iter()
        .map(|dir| &dir.name)
        .collect();
    assert_eq!(in_stock_directive, ["join__field"]);
}
Printing diagnostics for a faulty GraphQL document
let input = r#"
query {
  cat {
    name
  }
}

query getPet {
  cat {
    owner {
      name
    }
  }
}

query getPet {
  cat {
    treat
  }
}

subscription sub {
  newMessage {
    body
    sender
  }
  disallowedSecondRootField
}

type Query {
  cat: Pet
}

type Subscription {
  newMessage: Result
}

interface Pet {
  name: String
}

type Dog implements Pet {
  name: String
  nickname: String
  barkVolume: Int
}

type Cat implements Pet {
  name: String
  nickname: String
  meowVolume: Int
}

union CatOrDog = Cat | Dog
"#;

let (schema, executable) = apollo_compiler::parse_mixed(input, "document.graphql");

if let Err(diagnostics) = schema.validate() {
    println!("{diagnostics}")
}
if let Err(diagnostics) = executable.validate(&schema) {
    println!("{diagnostics}")
}

License

Licensed under either of

at your option.

Re-exports

Modules

  • ast
    Abstract Syntax Tree for GraphQL documents. Lower-level than Schema or ExecutableDocument.
  • executable
    High-level representation of an executable document, which can contain operations and fragments.
  • schema
    High-level representation of a GraphQL schema

Macros

  • name
    Create a Name from a string literal or identifier, checked for validity at compile time.
  • ty
    Create a static Type with GraphQL-like syntax

Structs

  • Diagnostic
  • DiagnosticList
    A collection of diagnostics returned by some validation method
  • FileId
    Integer identifier for a parsed source file.
  • GraphQLError
    A serializable GraphQL error.
  • GraphQLLocation
    A source location (line + column) for a GraphQL error.
  • Node
    A thread-safe reference-counted smart pointer for GraphQL nodes.
  • NodeLocation
    The source location of a parsed node: file ID and range within that file.
  • NodeStr
    Smart string type for names and string values in a GraphQL document
  • Parser
    Configuration for parsing an input string as GraphQL syntax
  • SourceFile
    Records for validation information about a file that was parsed

Functions

  • parse_mixed
    Parse a schema and executable document from the given source text containing a mixture of type system definitions and executable definitions. This is mostly useful for unit tests.

Type Aliases