Class: GraphQL::Client

Inherits:
Object
  • Object
show all
Extended by:
CollocatedEnforcement
Defined in:
lib/graphql/client.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/railtie.rb,
lib/graphql/client/response.rb,
lib/graphql/client/view_module.rb,
lib/graphql/client/query_result.rb,
lib/graphql/client/document_types.rb,
lib/graphql/client/log_subscriber.rb,
lib/graphql/client/query_typename.rb,
lib/graphql/client/collocated_enforcement.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, DocumentTypes, LazyName, QueryTypename, ViewModule Classes: Definition, DynamicQueryError, Error, Errors, Erubis, FragmentDefinition, HTTP, HashWithIndifferentAccess, List, LogSubscriber, NonCollocatedCallerError, NotImplementedError, OperationDefinition, QueryResult, Railtie, Response, ValidationError

Constant Summary collapse

IntrospectionDocument =
GraphQL.parse(GraphQL::Introspection::INTROSPECTION_QUERY).deep_freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CollocatedEnforcement

allow_noncollocated_callers

Constructor Details

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


81
82
83
84
85
86
87
88
# File 'lib/graphql/client.rb', line 81

def initialize(schema:, execute: nil, enforce_collocated_callers: false)
  @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
end

Instance Attribute Details

#allow_dynamic_queriesObject

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

This ability will eventually be removed in future versions.


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

def allow_dynamic_queries
  @allow_dynamic_queries
end

#documentObject (readonly)

Returns the value of attribute document


296
297
298
# File 'lib/graphql/client.rb', line 296

def document
  @document
end

#document_tracking_enabledObject

Returns the value of attribute document_tracking_enabled


30
31
32
# File 'lib/graphql/client.rb', line 30

def document_tracking_enabled
  @document_tracking_enabled
end

#enforce_collocated_callersObject (readonly)

Public: Check if collocated caller enforcement is enabled.


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

def enforce_collocated_callers
  @enforce_collocated_callers
end

#executeObject (readonly)

Returns the value of attribute execute


28
29
30
# File 'lib/graphql/client.rb', line 28

def execute
  @execute
end

#schemaObject (readonly)

Returns the value of attribute schema


28
29
30
# File 'lib/graphql/client.rb', line 28

def schema
  @schema
end

Class Method Details

.dump_schema(schema, io = nil) ⇒ Object


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/graphql/client.rb', line 60

def self.dump_schema(schema, io = nil)
  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: {}
  )

  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


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/graphql/client.rb', line 41

def self.load_schema(schema)
  case schema
  when GraphQL::Schema
    schema
  when Hash
    GraphQL::Schema::Loader.load(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))
    end
  else
    load_schema(dump_schema(schema)) if schema.respond_to?(:execute)
  end
end

Instance Method Details

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


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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/graphql/client.rb', line 180

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

  str = str.gsub(/\.\.\.([a-zA-Z0-9_]+(::[a-zA-Z0-9_]+)+)/) do
    match = Regexp.last_match
    const_name = match[1]
    begin
      fragment = ActiveSupport::Inflector.constantize(const_name)
    rescue NameError
      fragment = nil
    end

    case fragment
    when FragmentDefinition
      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

  doc = GraphQL.parse(str)

  doc.definitions.each do |node|
    node.name ||= "__anonymous__"
  end

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

  rules = GraphQL::StaticValidation::ALL_RULES - [GraphQL::StaticValidation::FragmentsAreUsed]
  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

  document_types = DocumentTypes.analyze_types(self.schema, doc).freeze

  QueryTypename.insert_typename_fields(doc, types: document_types)

  definitions = {}
  doc.definitions.each do |node|
    node.name = nil if node.name == "__anonymous__"
    sliced_document = Language::DefinitionSlice.slice(document_dependencies, node.name)
    definition = Definition.for(
      schema: self.schema,
      node: node,
      document: sliced_document,
      document_types: document_types,
      source_location: source_location,
      enforce_collocated_callers: enforce_collocated_callers
    )
    definitions[node.name] = definition
  end

  rename_node = ->(node, _parent) do
    definition = definitions[node.name]
    if definition
      node.extend(LazyName)
      node.name = -> { definition.definition_name }
    end
  end
  visitor = Language::Visitor.new(doc)
  visitor[Language::Nodes::FragmentDefinition].leave << rename_node
  visitor[Language::Nodes::OperationDefinition].leave << rename_node
  visitor[Language::Nodes::FragmentSpread].leave << rename_node
  visitor.visit

  doc.deep_freeze

  document.definitions.concat(doc.definitions) if document_tracking_enabled

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

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


298
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
335
336
337
338
339
340
341
342
343
344
345
346
# File 'lib/graphql/client.rb', line 298

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://git.io/vXXSE"
  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

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

  errors ||= []
  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(
    data: definition.new(data, Errors.new(errors, ["data"])),
    errors: Errors.new(errors),
    extensions: extensions
  )
end