Class: GraphQL::Relay::Mutation

Inherits:
Object
  • Object
show all
Includes:
Define::InstanceDefinable
Defined in:
lib/graphql/relay/mutation.rb

Overview

Define a Relay mutation:

- give it a name (used for derived inputs & outputs)
- declare its inputs
- declare its outputs
- declare the mutation procedure

‘resolve` should return a hash with a key for each of the `return_field`s

Inputs may also contain a ‘clientMutationId`

Examples:

Updating the name of an item

UpdateNameMutation = GraphQL::Relay::Mutation.define do
  name "UpdateName"

  input_field :name, !types.String
  input_field :itemId, !types.ID

  return_field :item, ItemType

  resolve -> (inputs, ctx) {
    item = Item.find_by_id(inputs[:id])
    item.update(name: inputs[:name])
    {item: item}
  }
end

MutationType = GraphQL::ObjectType.define do
  # The mutation object exposes a field:
  field :updateName, field: UpdateNameMutation.field
end

# Then query it:
query_string = %|
  mutation updateName {
    updateName(input: {itemId: 1, name: "new name", clientMutationId: "1234"}) {
      item { name }
      clientMutationId
  }|

 GraphQL::Query.new(MySchema, query_string).result
 # {"data" => {
 #   "updateName" => {
 #     "item" => { "name" => "new name"},
 #     "clientMutationId" => "1234"
 #   }
 # }}

Defined Under Namespace

Classes: Result

Instance Method Summary collapse

Methods included from Define::InstanceDefinable

#definition_proc=, included

Constructor Details

#initialize ⇒ Mutation

Returns a new instance of Mutation.



64
65
66
67
 
# File 'lib/graphql/relay/mutation.rb', line 64

def initialize
  @fields = {}
  @arguments = {}
end

Instance Method Details

#field ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/graphql/relay/mutation.rb', line 74

def field
  @field ||= begin
    ensure_defined
    field_return_type = self.return_type
    field_input_type = self.input_type
    field_resolve_proc = -> (obj, args, ctx){
      results_hash = @resolve_proc.call(args[:input], ctx)
      Result.new(arguments: args, result: results_hash)
    }
    GraphQL::Field.define do
      type(field_return_type)
      argument :input, !field_input_type
      resolve(field_resolve_proc)
    end
  end
end

#input_type ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/graphql/relay/mutation.rb', line 108

def input_type
  @input_type ||= begin
    ensure_defined
    mutation_name = name
    type_name = "#{mutation_name}Input"
    type_fields = input_fields
    GraphQL::InputObjectType.define do
      name(type_name)
      description("Autogenerated input type of #{mutation_name}")
      input_field :clientMutationId, types.String, "A unique identifier for the client performing the mutation."
      type_fields.each do |name, field_obj|
        input_field name, field_obj.type, field_obj.description, default_value: field_obj.default_value
      end
    end
  end
end

#resolve=(proc) ⇒ Object 



69
70
71
72
 
# File 'lib/graphql/relay/mutation.rb', line 69

def resolve=(proc)
  ensure_defined
  @resolve_proc = proc
end

#return_type ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/graphql/relay/mutation.rb', line 91

def return_type
  @return_type ||= begin
    ensure_defined
    mutation_name = name
    type_name = "#{mutation_name}Payload"
    type_fields = return_fields
    GraphQL::ObjectType.define do
      name(type_name)
      description("Autogenerated return type of #{mutation_name}")
      field :clientMutationId, types.String, "A unique identifier for the client performing the mutation."
      type_fields.each do |name, field_obj|
        field name, field: field_obj
      end
    end
  end
end