execute_graphql.md

Executing GraphQL with Helper Method execute_graphql

Simplifies execution of a graphql query, using context / describe level helper methods for configuring the query.

RSPec.describe Cool::Stuff, type: :graphql do
  let(:user) { create(:graphql_user) }
  let(:search_name) { "Pet" }

  graphql_operation <<-GQL
    query SomeThing($name: String) {
      characters(name: $name) {
        id
        name
      }
    }
  GQL

  graphql_variables do
    {
      name: search_name
    }
  end

  graphql_context do
    {
      current_user: user
    }
  end

  it "executes and does the thing with the vars and context" do
    # ... expect things here
  end
end

Available Configuration Methods

graphql_operation

A string - most commonly a ruby heredoc - for the graphql query to execute

graphql_variables

A hash of keys and values that the query expects to use

graphql_context

A hash of keys and values that are passed to a query or mutation, as context, in that query or mutation's resolver method.