Skip to content
This repository has been archived by the owner on Apr 8, 2020. It is now read-only.


Repository files navigation


⚠️ This gem is deprecated in favor of the new GraphQL::Execution::Errors in the graphql gem. See more details rmosolgo/graphql-ruby#2458.

Build Status Coverage Status Downloads Latest Version

This gem provides a simple error handling for graphql-ruby.


  • Error handling for each field.
  • Logic inside the rescue_from block, similarly to Rails.
  • Catching exceptions by ancestors, e.g. CustomError with rescue_from StandardError.
  • Per schema configuration.
  • No dependencies.


Once you defined your GraphQL schema:

Schema = GraphQL::Schema.define do
  query QueryType

You can add rescue_from error handlers with GraphQL::Errors. For example:

GraphQL::Errors.configure(Schema) do
  rescue_from ActiveRecord::RecordNotFound do |exception|

  rescue_from ActiveRecord::RecordInvalid do |exception|"\n"))

  # uses Module to handle several similar errors with single rescue_from
  rescue_from MyNetworkErrors do |_|"Don't mind, just retry the mutation")

  rescue_from StandardError do |exception|"Please try to execute the query for this field later")

  rescue_from CustomError do |exception, object, arguments, context|
    error ="Error found!")
    firstError.path = context.path + ["myError"]

It'll handle exceptions raised from each resolver in the schema:

QueryType = GraphQL::ObjectType.define do
  name "Query"

  field :post, PostType do
    argument :id, !types.ID
    resolve ->(obj, args, ctx) { Post.find(args['id']) } # <= will raise ActiveRecord::RecordNotFound

Schema.execute('query { post(id: "1") { title } }') # handles the error without failing the whole query
# => { data: { post: nil } }


Add this line to your application's Gemfile:

gem 'graphql-errors'

And then execute:

$ bundle

Or install it yourself as:

$ gem install graphql-errors


After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to


Bug reports and pull requests are welcome on GitHub at This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.


The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Graphql::Errors project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.