Class: GraphQL::Query::Context

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
SharedMethods
Defined in:
lib/graphql/query/context.rb

Overview

Expose some query-specific info to field resolve functions. It delegates [] to the hash that's passed to GraphQL::Query#initialize.

Defined Under Namespace

Modules: SharedMethods Classes: ExecutionErrors, ScopedContext

Constant Summary collapse

UNSPECIFIED_FETCH_DEFAULT =
Object.new

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SharedMethods

#add_error, #backtrace, #execution_errors, #skip

Constructor Details

#initialize(query:, schema: query.schema, values:, object:) ⇒ Context

Make a new context which delegates key lookup to values

Parameters:

  • query (GraphQL::Query)

    the query who owns this context

  • values (Hash)

    A hash of arbitrary values which will be accessible at query-time


78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/graphql/query/context.rb', line 78

def initialize(query:, schema: query.schema, values:, object:)
  @query = query
  @schema = schema
  @provided_values = values || {}
  @object = object
  # Namespaced storage, where user-provided values are in `nil` namespace:
  @storage = Hash.new { |h, k| h[k] = {} }
  @storage[nil] = @provided_values
  @errors = []
  @path = []
  @value = nil
  @context = self # for SharedMethods TODO delete sharedmethods
  @scoped_context = ScopedContext.new(self)
end

Instance Attribute Details

#errorsArray<GraphQL::ExecutionError> (readonly)

Returns errors returned during execution.

Returns:


64
65
66
# File 'lib/graphql/query/context.rb', line 64

def errors
  @errors
end

#interpreter=(value) ⇒ Object (writeonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


178
179
180
# File 'lib/graphql/query/context.rb', line 178

def interpreter=(value)
  @interpreter = value
end

#pathArray<String, Integer> (readonly)

Returns The current position in the result.

Returns:

  • (Array<String, Integer>)

    The current position in the result


73
74
75
# File 'lib/graphql/query/context.rb', line 73

def path
  @path
end

#queryGraphQL::Query (readonly)

Returns The query whose context this is.

Returns:


67
68
69
# File 'lib/graphql/query/context.rb', line 67

def query
  @query
end

#schemaGraphQL::Schema (readonly)

Returns:


70
71
72
# File 'lib/graphql/query/context.rb', line 70

def schema
  @schema
end

#scoped_contextObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


184
185
186
# File 'lib/graphql/query/context.rb', line 184

def scoped_context
  @scoped_context
end

#value=(value) ⇒ Object (writeonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


181
182
183
# File 'lib/graphql/query/context.rb', line 181

def value=(value)
  @value = value
end

#wardenGraphQL::Schema::Warden


251
252
253
# File 'lib/graphql/query/context.rb', line 251

def warden
  @warden ||= (@query && @query.warden)
end

Instance Method Details

#[](key) ⇒ Object

Lookup key from the hash passed to Schema#execute as context:


196
197
198
199
200
201
202
# File 'lib/graphql/query/context.rb', line 196

def [](key)
  if @scoped_context.key?(key)
    @scoped_context[key]
  else
    @provided_values[key]
  end
end

#[]=(key, value) ⇒ Object

Reassign key to the hash passed to Schema#execute as context:


192
193
194
# File 'lib/graphql/query/context.rb', line 192

def []=(key, value)
  @provided_values[key] = value
end

#dataloaderObject


173
174
175
# File 'lib/graphql/query/context.rb', line 173

def dataloader
  @dataloader ||= self[:dataloader] || (query.multiplex ? query.multiplex.dataloader : schema.dataloader_class.new)
end

#delete(key) ⇒ Object


204
205
206
207
208
209
210
# File 'lib/graphql/query/context.rb', line 204

def delete(key)
  if @scoped_context.key?(key)
    @scoped_context.delete(key)
  else
    @provided_values.delete(key)
  end
end

#dig(key, *other_keys) ⇒ Object


228
229
230
231
232
233
234
# File 'lib/graphql/query/context.rb', line 228

def dig(key, *other_keys)
  if @scoped_context.key?(key)
    @scoped_context.dig(key, *other_keys)
  else
    @provided_values.dig(key, *other_keys)
  end
end

#fetch(key, default = UNSPECIFIED_FETCH_DEFAULT) ⇒ Object


214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/graphql/query/context.rb', line 214

def fetch(key, default = UNSPECIFIED_FETCH_DEFAULT)
  if @scoped_context.key?(key)
    scoped_context[key]
  elsif @provided_values.key?(key)
    @provided_values[key]
  elsif default != UNSPECIFIED_FETCH_DEFAULT
    default
  elsif block_given?
    yield(self, key)
  else
    raise KeyError.new(key: key)
  end
end

#inspectObject


270
271
272
# File 'lib/graphql/query/context.rb', line 270

def inspect
  "#<Query::Context ...>"
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean)

246
247
248
# File 'lib/graphql/query/context.rb', line 246

def key?(key)
  @scoped_context.key?(key) || @provided_values.key?(key)
end

#namespace(ns) ⇒ Hash

Get an isolated hash for ns. Doesn't affect user-provided storage.

Parameters:

  • ns (Object)

    a usage-specific namespace identifier

Returns:

  • (Hash)

    namespaced storage


261
262
263
# File 'lib/graphql/query/context.rb', line 261

def namespace(ns)
  @storage[ns]
end

#namespace?(ns) ⇒ Boolean

Returns true if this namespace was accessed before.

Returns:

  • (Boolean)

    true if this namespace was accessed before


266
267
268
# File 'lib/graphql/query/context.rb', line 266

def namespace?(ns)
  @storage.key?(ns)
end

#response_extensionsHash

Returns A hash that will be added verbatim to the result hash, as "extensions" => { ... }.

Returns:

  • (Hash)

    A hash that will be added verbatim to the result hash, as "extensions" => { ... }


169
170
171
# File 'lib/graphql/query/context.rb', line 169

def response_extensions
  namespace(:__query_result_extensions__)
end

#scoped_merge!(hash) ⇒ Object


274
275
276
# File 'lib/graphql/query/context.rb', line 274

def scoped_merge!(hash)
  @scoped_context.merge!(hash)
end

#scoped_set!(key, value) ⇒ Object


278
279
280
281
# File 'lib/graphql/query/context.rb', line 278

def scoped_set!(key, value)
  scoped_merge!(key => value)
  nil
end

#to_hObject Also known as: to_hash


236
237
238
239
240
241
242
# File 'lib/graphql/query/context.rb', line 236

def to_h
  if (current_scoped_context = @scoped_context.merged_context)
    @provided_values.merge(current_scoped_context)
  else
    @provided_values
  end
end