Class: GraphQL::Client

Inherits:
Object
  • Object
show all
Extended by:
CollocatedEnforcement
Defined in:
lib/graphql/client.rb,
lib/graphql/client/erb.rb,
lib/graphql/client/http.rb,
lib/graphql/client/list.rb,
lib/graphql/client/error.rb,
lib/graphql/client/errors.rb,
lib/graphql/client/erubis.rb,
lib/graphql/client/schema.rb,
lib/graphql/client/railtie.rb,
lib/graphql/client/response.rb,
lib/graphql/client/definition.rb,
lib/graphql/client/type_stack.rb,
lib/graphql/client/view_module.rb,
lib/graphql/client/document_types.rb,
lib/graphql/client/erubi_enhancer.rb,
lib/graphql/client/log_subscriber.rb,
lib/graphql/client/query_typename.rb,
lib/graphql/client/erubis_enhancer.rb,
lib/graphql/client/schema/base_type.rb,
lib/graphql/client/schema/enum_type.rb,
lib/graphql/client/schema/list_type.rb,
lib/graphql/client/schema/union_type.rb,
lib/graphql/client/schema/object_type.rb,
lib/graphql/client/schema/scalar_type.rb,
lib/graphql/client/fragment_definition.rb,
lib/graphql/client/definition_variables.rb,
lib/graphql/client/operation_definition.rb,
lib/graphql/client/schema/non_null_type.rb,
lib/graphql/client/schema/interface_type.rb,
lib/graphql/client/schema/possible_types.rb,
lib/graphql/client/schema/skip_directive.rb,
lib/graphql/client/collocated_enforcement.rb,
lib/graphql/client/schema/include_directive.rb,
lib/graphql/client/hash_with_indifferent_access.rb

Overview

GraphQL Client helps build and execute queries against a GraphQL backend.

A client instance SHOULD be configured with a schema to enable query validation. And SHOULD also be configured with a backend “execute” adapter to point at a remote GraphQL HTTP service or execute directly against a Schema object.

Defined Under Namespace

Modules: CollocatedEnforcement, DefinitionVariables, DocumentTypes, ErubiEnhancer, ErubisEnhancer, LazyName, QueryTypename, Schema, TypeStack, ViewModule Classes: Definition, DynamicQueryError, Error, Errors, FragmentDefinition, GatherNamesVisitor, HTTP, HashWithIndifferentAccess, ImplicitlyFetchedFieldError, InvariantError, List, LogSubscriber, NonCollocatedCallerError, NotImplementedError, OperationDefinition, Railtie, RenameNodeVisitor, Response, UnfetchedFieldError, UnimplementedFieldError, ValidationError

Constant Summary collapse

IntrospectionDocument = 
GraphQL.parse(GraphQL::Introspection::INTROSPECTION_QUERY)
Erubis = 
GraphQL::Client::ERB
WHITELISTED_GEM_NAMES =

Collocation will not be enforced if a stack trace includes any of these gems.

%w{pry byebug}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CollocatedEnforcement

allow_noncollocated_callers, verify_collocated_path

Constructor Details

#initialize(schema:, execute: nil, enforce_collocated_callers: false, raise_on_unknown_enum_value: true) ⇒ Client

Returns a new instance of Client.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/graphql/client.rb', line 94

def initialize(schema:, execute: nil, enforce_collocated_callers: false, raise_on_unknown_enum_value: true)
  @schema = self.class.load_schema(schema)
  @execute = execute
  @document = GraphQL::Language::Nodes::Document.new(definitions: [])
  @document_tracking_enabled = false
  @allow_dynamic_queries = false
  @enforce_collocated_callers = enforce_collocated_callers
  if schema.is_a?(Class)
    @possible_types = schema.possible_types
    key, _types = @possible_types.first
    # GraphQL-Ruby 2.3.5+ has classes here instead of strings
    if key.is_a?(Module)
      @possible_types = @possible_types.transform_keys(&:graphql_name)
    end
  end
  @types = Schema.generate(@schema, raise_on_unknown_enum_value: raise_on_unknown_enum_value)
end

Instance Attribute Details

#allow_dynamic_queries ⇒ Object

Deprecated: Allow dynamically generated queries to be passed to Client#query.

This ability will eventually be removed in future versions.



46
47
48
 
# File 'lib/graphql/client.rb', line 46

def allow_dynamic_queries
  @allow_dynamic_queries
end

#document ⇒ Object (readonly)

Returns the value of attribute document.



336
337
338
 
# File 'lib/graphql/client.rb', line 336

def document
  @document
end

#document_tracking_enabled ⇒ Object

Returns the value of attribute document_tracking_enabled.



37
38
39
 
# File 'lib/graphql/client.rb', line 37

def document_tracking_enabled
  @document_tracking_enabled
end

#enforce_collocated_callers ⇒ Object (readonly)

Public: Check if collocated caller enforcement is enabled.



40
41
42
 
# File 'lib/graphql/client.rb', line 40

def enforce_collocated_callers
  @enforce_collocated_callers
end

#execute ⇒ Object (readonly)

Returns the value of attribute execute.



33
34
35
 
# File 'lib/graphql/client.rb', line 33

def execute
  @execute
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



33
34
35
 
# File 'lib/graphql/client.rb', line 33

def schema
  @schema
end

#types ⇒ Object (readonly)

Returns the value of attribute types.



35
36
37
 
# File 'lib/graphql/client.rb', line 35

def types
  @types
end

Class Method Details

.dump_schema(schema, io = nil, context: {}) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/graphql/client.rb', line 73

def self.dump_schema(schema, io = nil, context: {})
  unless schema.respond_to?(:execute)
    raise TypeError, "expected schema to respond to #execute(), but was #{schema.class}"
  end

  result = schema.execute(
    document: IntrospectionDocument,
    operation_name: "IntrospectionQuery",
    variables: {},
    context: context
  ).to_h

  if io
    io = File.open(io, "w") if io.is_a?(String)
    io.write(JSON.pretty_generate(result))
    io.close_write
  end

  result
end

.load_schema(schema) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/graphql/client.rb', line 48

def self.load_schema(schema)
  case schema
  when GraphQL::Schema, Class
    schema
  when Hash
    GraphQL::Schema.from_introspection(schema)
  when String
    if schema.end_with?(".json") && File.exist?(schema)
      load_schema(File.read(schema))
    elsif schema =~ /\A\s*{/
      load_schema(JSON.parse(schema, freeze: true))
    end
  else
    if schema.respond_to?(:execute)
      load_schema(dump_schema(schema))
    elsif schema.respond_to?(:to_h)
      load_schema(schema.to_h)
    else
      nil
    end
  end
end

Instance Method Details

#create_operation(fragment, filename = nil, lineno = nil) ⇒ Object

Public: Create operation definition from a fragment definition.

Automatically determines operation variable set.

Examples

FooFragment = Client.parse <<-'GRAPHQL'
  fragment on Mutation {
    updateFoo(id: $id, content: $content)
  }
GRAPHQL

# mutation($id: ID!, $content: String!) {
#   updateFoo(id: $id, content: $content)
# }
FooMutation = Client.create_operation(FooFragment)

fragment - A FragmentDefinition definition.

Returns an OperationDefinition.



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/graphql/client.rb', line 299

def create_operation(fragment, filename = nil, lineno = nil)
  unless fragment.is_a?(GraphQL::Client::FragmentDefinition)
    raise TypeError, "expected fragment to be a GraphQL::Client::FragmentDefinition, but was #{fragment.class}"
  end

  if filename.nil? && lineno.nil?
    location = caller_locations(1, 1).first
    filename = location.path
    lineno = location.lineno
  end

  variables = GraphQL::Client::DefinitionVariables.operation_variables(self.schema, fragment.document, fragment.definition_name)
  type_name = fragment.definition_node.type.name

  if schema.query && type_name == schema.query.graphql_name
    operation_type = "query"
  elsif schema.mutation && type_name == schema.mutation.graphql_name
    operation_type = "mutation"
  elsif schema.subscription && type_name == schema.subscription.graphql_name
    operation_type = "subscription"
  else
    types = [schema.query, schema.mutation, schema.subscription].compact
    raise Error, "Fragment must be defined on #{types.map(&:graphql_name).join(", ")}"
  end

  doc_ast = GraphQL::Language::Nodes::Document.new(definitions: [
    GraphQL::Language::Nodes::OperationDefinition.new(
      operation_type: operation_type,
      variables: variables,
      selections: [
        GraphQL::Language::Nodes::FragmentSpread.new(name: fragment.name)
      ]
    )
  ])
  parse(doc_ast.to_query_string, filename, lineno)
end

#get_type(type_name) ⇒ Object

Public: A wrapper to use the more-efficient ‘.get_type` when it’s available from GraphQL-Ruby (1.10+)



275
276
277
 
# File 'lib/graphql/client.rb', line 275

def get_type(type_name)
  @schema.get_type(type_name)
end

#parse(str, filename = nil, lineno = nil) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/graphql/client.rb', line 131

def parse(str, filename = nil, lineno = nil)
  if filename.nil? && lineno.nil?
    location = caller_locations(1, 1).first
    filename = location.path
    lineno = location.lineno
  end

  unless filename.is_a?(String)
    raise TypeError, "expected filename to be a String, but was #{filename.class}"
  end

  unless lineno.is_a?(Integer)
    raise TypeError, "expected lineno to be a Integer, but was #{lineno.class}"
  end

  source_location = [filename, lineno].freeze

  definition_dependencies = Set.new

  # Replace Ruby constant reference with GraphQL fragment names,
  # while populating `definition_dependencies` with
  # GraphQL Fragment ASTs which this operation depends on
  str = str.gsub(/\.\.\.([a-zA-Z0-9_]+(::[a-zA-Z0-9_]+)*)/) do
    match = Regexp.last_match
    const_name = match[1]

    if str.match(/fragment\s*#{const_name}/)
      # It's a fragment _definition_, not a fragment usage
      match[0]
    else
      # It's a fragment spread, so we should load the fragment
      # which corresponds to the spread.
      # We depend on ActiveSupport to either find the already-loaded
      # constant, or to load the constant by name
      fragment = ActiveSupport::Inflector.safe_constantize(const_name)

      case fragment
      when FragmentDefinition
        # We found the fragment definition that this fragment spread belongs to.
        # So, register the AST of this fragment in `definition_dependencies`
        # and update the query string to valid GraphQL syntax,
        # replacing the Ruby constant
        definition_dependencies.merge(fragment.document.definitions)
        "...#{fragment.definition_name}"
      else
        if fragment
          message = "expected #{const_name} to be a #{FragmentDefinition}, but was a #{fragment.class}."
          if fragment.is_a?(Module) && fragment.constants.any?
            message += " Did you mean #{fragment}::#{fragment.constants.first}?"
          end
        else
          message = "uninitialized constant #{const_name}"
        end

        error = ValidationError.new(message)
        error.set_backtrace(["#{filename}:#{lineno + match.pre_match.count("\n") + 1}"] + caller)
        raise error
      end
    end
  end

  doc = GraphQL.parse(str)

  document_types = DocumentTypes.analyze_types(self.schema, doc).freeze
  doc = QueryTypename.insert_typename_fields(doc, types: document_types)

  doc.definitions.each do |node|
    if node.name.nil?
      node_with_name = node.merge(name: "__anonymous__")
      doc = doc.replace_child(node, node_with_name)
    end
  end

  document_dependencies = Language::Nodes::Document.new(definitions: doc.definitions + definition_dependencies.to_a)

  rules = GraphQL::StaticValidation::ALL_RULES - [
    GraphQL::StaticValidation::FragmentsAreUsed,
    GraphQL::StaticValidation::FieldsHaveAppropriateSelections
  ]
  validator = GraphQL::StaticValidation::Validator.new(schema: self.schema, rules: rules)
  query = GraphQL::Query.new(self.schema, document: document_dependencies)

  errors = validator.validate(query)
  errors.fetch(:errors).each do |error|
    error_hash = error.to_h
    validation_line = error_hash["locations"][0]["line"]
    error = ValidationError.new(error_hash["message"])
    error.set_backtrace(["#{filename}:#{lineno + validation_line}"] + caller)
    raise error
  end

  definitions = sliced_definitions(document_dependencies, doc, source_location: source_location)

  visitor = RenameNodeVisitor.new(document_dependencies, definitions: definitions)
  visitor.visit

  if document_tracking_enabled
    @document = @document.merge(definitions: @document.definitions + doc.definitions)
  end

  if definitions["__anonymous__"]
    definitions["__anonymous__"]
  else
    Module.new do
      definitions.each do |name, definition|
        const_set(name, definition)
      end
    end
  end
end

#possible_types(type_condition = nil) ⇒ Object

A cache of the schema’s merged possible types

Parameters:

  • type_condition (Class, String) (defaults to: nil) —

    a type definition or type name



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/graphql/client.rb', line 114

def possible_types(type_condition = nil)
  if type_condition
    if defined?(@possible_types)
      if type_condition.respond_to?(:graphql_name)
        type_condition = type_condition.graphql_name
      end
      @possible_types[type_condition]
    else
      @schema.possible_types(type_condition)
    end
  elsif defined?(@possible_types)
    @possible_types
  else
    @schema.possible_types(type_condition)
  end
end

#query(definition, variables: {}, context: {}) ⇒ Object

Raises:



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/graphql/client.rb', line 338

def query(definition, variables: {}, context: {})
  raise NotImplementedError, "client network execution not configured" unless execute

  unless definition.is_a?(OperationDefinition)
    raise TypeError, "expected definition to be a #{OperationDefinition.name} but was #{document.class.name}"
  end

  if allow_dynamic_queries == false && definition.name.nil?
    raise DynamicQueryError, "expected definition to be assigned to a static constant https://github.com/github-community-projects/graphql-client/blob/master/guides/dynamic-query-error.md"
  end

  variables = deep_stringify_keys(variables)

  document = definition.document
  operation = definition.definition_node

  payload = {
    document: document,
    operation_name: operation.name,
    operation_type: operation.operation_type,
    variables: variables,
    context: context
  }

  result = ActiveSupport::Notifications.instrument("query.graphql", payload) do
    execute.execute(
      document: document,
      operation_name: operation.name,
      variables: variables,
      context: context
    )
  end

  deep_freeze_json_object(result)

  data, errors, extensions = result.values_at("data", "errors", "extensions")

  errors ||= []
  errors = errors.map(&:dup)
  GraphQL::Client::Errors.normalize_error_paths(data, errors)

  errors.each do |error|
    error_payload = payload.merge(message: error["message"], error: error)
    ActiveSupport::Notifications.instrument("error.graphql", error_payload)
  end
  Response.new(
    result,
    data: definition.new(data, Errors.new(errors, ["data"])),
    errors: Errors.new(errors),
    extensions: extensions,
    full_response: execute.respond_to?("last_response") ? execute.last_response : nil
  )
end