Fix GraphQL::ExecutionError: Field 'user' doesn't accept argument 'id' of type 'String' (expected 'ID!'|) in Rails

This error occurs when a GraphQL query passes an argument with the wrong type. The schema expects a specific type like ID! but receives a String. Review your GraphQL type definitions and ensure arguments match the expected types. Use proper type coercion in your resolvers and validate input types in your schema.

Reading the Stack Trace

Here's what each line means:

• graphql (2.2.5) lib/graphql/schema/argument.rb:182:in `coerce_input': GraphQL cannot coerce the String input to the expected ID! type.
• app/graphql/types/query_type.rb:12:in `resolve': The query type resolver for the user field is where the type mismatch occurs.
• app/controllers/graphql_controller.rb:18:in `execute': The GraphQL controller executes the query which triggers the type validation.

Common Causes

# Client query:
# query { user(id: "abc") { name } }

# Schema expects:
field :user, Types::UserType, null: true do
  argument :id, ID, required: true
end

module Types
  class QueryType < Types::BaseObject
    field :user, Types::UserType, null: true do
      argument :id, ID, required: true
    end

    def user(id:)
      User.find(id)  # May raise if ID coercion fails
    end
  end
end

# query { user { name } }  # Missing required 'id' argument

The Fix

Use find_by instead of find to handle missing records gracefully, and raise a GraphQL::ExecutionError with a helpful message. The ID type accepts both strings and integers and coerces them appropriately.

module Types
  class QueryType < Types::BaseObject
    field :user, Types::UserType, null: true do
      argument :id, ID, required: true
    end

    def user(id:)
      User.find(id)
    end
  end
end

module Types
  class QueryType < Types::BaseObject
    field :user, Types::UserType, null: true do
      argument :id, ID, required: true
    end

    def user(id:)
      User.find_by(id: id)
    rescue ActiveRecord::RecordNotFound
      raise GraphQL::ExecutionError, "User not found with id: #{id}"
    end
  end
end

Testing the Fix

require 'rails_helper'

RSpec.describe Types::QueryType do
  describe 'user field' do
    let(:user) { create(:user, name: 'Alice') }

    it 'returns user by ID' do
      result = MyAppSchema.execute(
        '{ user(id: "' + user.id.to_s + '") { name } }'
      )
      expect(result['data']['user']['name']).to eq('Alice')
    end

    it 'returns error for missing user' do
      result = MyAppSchema.execute('{ user(id: "999999") { name } }')
      expect(result['errors'].first['message']).to include('User not found')
    end
  end
end

Run your tests:

bundle exec rspec spec/graphql/types/query_type_spec.rb

Pushing Through CI/CD

git checkout -b fix/rails-graphql-type,git add app/graphql/types/query_type.rb,git commit -m "fix: handle GraphQL ID type coercion and missing records",git push origin fix/rails-graphql-type

Your CI config should look something like this:

name: CI
on:
  pull_request:
    branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres:16
        env:
          POSTGRES_PASSWORD: postgres
        ports: ['5432:5432']
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.3'
          bundler-cache: true
      - run: bin/rails db:setup
      - run: bundle exec rspec

The Full Manual Process: 18 Steps

Here's every step you just went through to fix this one bug:

1. Notice the error alert or see it in your monitoring tool
2. Open the error dashboard and read the stack trace
3. Identify the file and line number from the stack trace
4. Open your IDE and navigate to the file
5. Read the surrounding code to understand context
6. Reproduce the error locally
7. Identify the root cause
8. Write the fix
9. Run the test suite locally
10. Fix any failing tests
11. Write new tests covering the edge case
12. Run the full test suite again
13. Create a new git branch
14. Commit and push your changes
15. Open a pull request
16. Wait for code review
17. Merge and deploy to production
18. Monitor production to confirm the error is resolved

Total time: 30-60 minutes. For one bug.

gem install bugstack

require 'bugstack'

Bugstack.init(api_key: ENV['BUGSTACK_API_KEY'])

Deploying the Fix (Manual Path)

1. Fix type definitions in your GraphQL schema.
2. Add error handling for missing records in resolvers.
3. Write GraphQL query specs.
4. Open a pull request.
5. Merge and verify queries work in staging.

Frequently Asked Questions