Class: GraphQL::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/client.rb,
lib/graphql/client/http.rb,
lib/graphql/client/erubis.rb,
lib/graphql/client/railtie.rb,
lib/graphql/client/view_module.rb,
lib/graphql/client/query_result.rb,
lib/graphql/client/log_subscriber.rb

Defined Under Namespace

Modules: LazyName, ViewModule Classes: Definition, Error, Erubis, FailedResponse, FragmentDefinition, HTTP, LogSubscriber, OperationDefinition, PartialResponse, Query, QueryResult, Railtie, Response, ResponseError, ResponseErrors, SuccessfulResponse, ValidationError

Constant Summary collapse

IntrospectionDocument = 
GraphQL.parse(GraphQL::Introspection::INTROSPECTION_QUERY).deep_freeze
IntrospectionQuery = 
Query.new(IntrospectionDocument)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema: nil, fetch: nil) ⇒ Client

Returns a new instance of Client.



58
59
60
61
62
63
 
# File 'lib/graphql/client.rb', line 58

def initialize(schema: nil, fetch: nil)
  @schema = self.class.load_schema(schema)
  @fetch = fetch
  @document = GraphQL::Language::Nodes::Document.new(definitions: [])
  @document_tracking_enabled = false
end

Instance Attribute Details

#document_tracking_enabled ⇒ Object

Returns the value of attribute document_tracking_enabled.



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

def document_tracking_enabled
  @document_tracking_enabled
end

#fetch ⇒ Object (readonly)

Returns the value of attribute fetch.



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

def fetch
  @fetch
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



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

def schema
  @schema
end

Class Method Details

.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")
      load_schema(File.read(schema))
    else
      load_schema(JSON.parse(schema))
    end
  else
    nil
  end
end

Instance Method Details

#document ⇒ Object 



203
204
205
 
# File 'lib/graphql/client.rb', line 203

def document
  @document
end

#fetch_schema ⇒ Object 



315
316
317
 
# File 'lib/graphql/client.rb', line 315

def fetch_schema
  fetch.call(IntrospectionQuery)
end

#parse(str) ⇒ Object 



130
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
 
# File 'lib/graphql/client.rb', line 130

def parse(str)
  definition_dependencies = Set.new

  str = str.gsub(/\.\.\.([a-zA-Z0-9_]+(::[a-zA-Z0-9_]+)+)/) { |m|
    const_name = $1
    case fragment = ActiveSupport::Inflector.safe_constantize(const_name)
    when FragmentDefinition
      definition_dependencies.merge(fragment.document.definitions)
      "...#{fragment.definition_name}"
    when nil
      raise NameError, "uninitialized constant #{const_name}\n#{str}"
    else
      raise TypeError, "expected #{const_name} to be a #{FragmentDefinition}, but was a #{fragment.class}"
    end
  }

  doc = GraphQL.parse(str)

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

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

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

    errors = validator.validate(query)
    errors.fetch(:errors).each do |error|
      raise ValidationError, error["message"] + "\n\n" + str
    end
  end

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

  rename_node = -> (node, parent) {
    if definition = definitions[node.name]
      node.extend(LazyName)
      node.name = -> { definition.definition_name }
    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

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

  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 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/graphql/client.rb', line 274

def query(definition, variables: {}, context: {})
  unless fetch
    raise Error, "client network fetching not configured"
  end

  query = Query.new(definition.document,
    operation_name: definition.operation_name,
    variables: variables,
    context: context
  )

  result = ActiveSupport::Notifications.instrument("query.graphql", query.payload) do
    fetch.call(query)
  end

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

  if data && errors
    PartialResponse.new(
      data: definition.new(data),
      errors: ResponseErrors.new(definition, errors),
      extensions: extensions
    )
  elsif data && !errors
    SuccessfulResponse.new(
      data: definition.new(data),
      extensions: extensions
    )
  elsif !data && errors
    FailedResponse.new(
      errors: ResponseErrors.new(definition, errors),
      extensions: extensions
    )
  else
    raise Error, "invalid GraphQL response, expected data or errors"
  end
end