Class: GraphQL::Schema

Inherits:
Object
  • Object
show all
Extended by:
FindInheritedValue, Member::HasAstNode
Defined in:
lib/graphql/schema.rb,
lib/graphql/schema/enum.rb,
lib/graphql/schema/list.rb,
lib/graphql/schema/field.rb,
lib/graphql/schema/union.rb,
lib/graphql/schema/finder.rb,
lib/graphql/schema/loader.rb,
lib/graphql/schema/member.rb,
lib/graphql/schema/object.rb,
lib/graphql/schema/scalar.rb,
lib/graphql/schema/warden.rb,
lib/graphql/schema/printer.rb,
lib/graphql/schema/timeout.rb,
lib/graphql/schema/wrapper.rb,
lib/graphql/schema/addition.rb,
lib/graphql/schema/argument.rb,
lib/graphql/schema/mutation.rb,
lib/graphql/schema/non_null.rb,
lib/graphql/schema/resolver.rb,
lib/graphql/schema/directive.rb,
lib/graphql/schema/interface.rb,
lib/graphql/schema/null_mask.rb,
lib/graphql/schema/validator.rb,
lib/graphql/schema/enum_value.rb,
lib/graphql/schema/input_object.rb,
lib/graphql/schema/subscription.rb,
lib/graphql/schema/member/scoped.rb,
lib/graphql/schema/built_in_types.rb,
lib/graphql/schema/directive/skip.rb,
lib/graphql/schema/base_64_encoder.rb,
lib/graphql/schema/field_extension.rb,
lib/graphql/schema/late_bound_type.rb,
lib/graphql/schema/member/has_path.rb,
lib/graphql/schema/type_expression.rb,
lib/graphql/schema/type_membership.rb,
lib/graphql/schema/directive/feature.rb,
lib/graphql/schema/directive/flagged.rb,
lib/graphql/schema/directive/include.rb,
lib/graphql/schema/member/build_type.rb,
lib/graphql/schema/member/has_fields.rb,
lib/graphql/schema/invalid_type_error.rb,
lib/graphql/schema/unique_within_type.rb,
lib/graphql/schema/directive/transform.rb,
lib/graphql/schema/member/has_ast_node.rb,
lib/graphql/schema/directive/deprecated.rb,
lib/graphql/schema/find_inherited_value.rb,
lib/graphql/schema/introspection_system.rb,
lib/graphql/schema/member/has_arguments.rb,
lib/graphql/schema/build_from_definition.rb,
lib/graphql/schema/field/scope_extension.rb,
lib/graphql/schema/member/has_directives.rb,
lib/graphql/schema/member/has_interfaces.rb,
lib/graphql/schema/member/has_validators.rb,
lib/graphql/schema/member/relay_shortcuts.rb,
lib/graphql/schema/member/validates_input.rb,
lib/graphql/schema/relay_classic_mutation.rb,
lib/graphql/schema/member/base_dsl_methods.rb,
lib/graphql/schema/member/graphql_type_names.rb,
lib/graphql/schema/resolver/has_payload_type.rb,
lib/graphql/schema/field/connection_extension.rb,
lib/graphql/schema/member/type_system_helpers.rb,
lib/graphql/schema/validator/format_validator.rb,
lib/graphql/schema/validator/length_validator.rb,
lib/graphql/schema/validator/required_validator.rb,
lib/graphql/schema/member/has_deprecation_reason.rb,
lib/graphql/schema/validator/exclusion_validator.rb,
lib/graphql/schema/validator/inclusion_validator.rb,
lib/graphql/schema/validator/allow_null_validator.rb,
lib/graphql/schema/validator/allow_blank_validator.rb,
lib/graphql/schema/member/has_unresolved_type_error.rb,
lib/graphql/schema/validator/numericality_validator.rb,
lib/graphql/schema/build_from_definition/resolve_map.rb,
lib/graphql/schema/build_from_definition/resolve_map/default_resolve.rb

Overview

Extend this class to define GraphQL enums in your schema.

By default, GraphQL enum values are translated into Ruby strings. You can provide a custom value with the value: keyword.

Examples:

# equivalent to
# enum PizzaTopping {
#   MUSHROOMS
#   ONIONS
#   PEPPERS
# }
class PizzaTopping < GraphQL::Enum
  value :MUSHROOMS
  value :ONIONS
  value :PEPPERS
end

Direct Known Subclasses

Query::NullContext::NullSchema

Defined Under Namespace

Modules: Base64Encoder, BuildFromDefinition, FindInheritedValue, Interface, Loader, NullMask, ResolveTypeWithType, TypeExpression, UniqueWithinType Classes: Addition, Argument, Directive, DuplicateNamesError, Enum, EnumValue, Field, FieldExtension, Finder, InputObject, IntrospectionSystem, InvalidDocumentError, InvalidTypeError, LateBoundType, List, Member, Mutation, NonNull, Object, Printer, RelayClassicMutation, Resolver, Scalar, Subscription, Timeout, TypeMembership, Union, UnresolvedLateBoundTypeError, Validator, Warden, Wrapper

Constant Summary collapse

NEW_HANDLER_HASH = 
->(h, k) {
  h[k] = {
    class: k,
    handler: nil,
    subclass_handlers: Hash.new(&NEW_HANDLER_HASH),
   }
}
BUILT_IN_TYPES = 
{
  "Int" => GraphQL::Types::Int,
  "String" => GraphQL::Types::String,
  "Float" => GraphQL::Types::Float,
  "Boolean" => GraphQL::Types::Boolean,
  "ID" => GraphQL::Types::ID,
}

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Member::HasAstNode

ast_node

Class Attribute Details

.analysis_engine ⇒ Object 



602
603
604
 
# File 'lib/graphql/schema.rb', line 602

def analysis_engine
  @analysis_engine || find_inherited_value(:analysis_engine, self.default_analysis_engine)
end

.connections ⇒ GraphQL::Pagination::Connections

Returns if installed.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/graphql/schema.rb', line 287

def connections
  if defined?(@connections)
    @connections
  else
    inherited_connections = find_inherited_value(:connections, nil)
    # This schema is part of an inheritance chain which is using new connections,
    # make a new instance, so we don't pollute the upstream one.
    if inherited_connections
      @connections = Pagination::Connections.new(schema: self)
    else
      nil
    end
  end
end

.dataloader_class ⇒ Object

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.

See Also:



417
418
419
 
# File 'lib/graphql/schema.rb', line 417

def dataloader_class
  @dataloader_class || GraphQL::Dataloader::NullDataloader
end

.error_bubbling(new_error_bubbling = nil) ⇒ Object 



616
617
618
619
620
621
622
 
# File 'lib/graphql/schema.rb', line 616

def error_bubbling(new_error_bubbling = nil)
  if !new_error_bubbling.nil?
    @error_bubbling = new_error_bubbling
  else
    @error_bubbling.nil? ? find_inherited_value(:error_bubbling) : @error_bubbling
  end
end

.interpreter=(value) ⇒ Object (writeonly)

Sets the attribute interpreter

Parameters:

  • value —

    the value to set the attribute interpreter to.



614
615
616
 
# File 'lib/graphql/schema.rb', line 614

def interpreter=(value)
  @interpreter = value
end

.max_complexity(max_complexity = nil) ⇒ Object 



590
591
592
593
594
595
596
597
598
 
# File 'lib/graphql/schema.rb', line 590

def max_complexity(max_complexity = nil)
  if max_complexity
    @max_complexity = max_complexity
  elsif defined?(@max_complexity)
    @max_complexity
  else
    find_inherited_value(:max_complexity)
  end
end

.max_depth(new_max_depth = nil) ⇒ Object 



628
629
630
631
632
633
634
635
636
 
# File 'lib/graphql/schema.rb', line 628

def max_depth(new_max_depth = nil)
  if new_max_depth
    @max_depth = new_max_depth
  elsif defined?(@max_depth)
    @max_depth
  else
    find_inherited_value(:max_depth)
  end
end

.validate_max_errors(new_validate_max_errors = nil) ⇒ Object 



578
579
580
581
582
583
584
585
586
 
# File 'lib/graphql/schema.rb', line 578

def validate_max_errors(new_validate_max_errors = nil)
  if new_validate_max_errors
    @validate_max_errors = new_validate_max_errors
  elsif defined?(@validate_max_errors)
    @validate_max_errors
  else
    find_inherited_value(:validate_max_errors)
  end
end

.validate_timeout(new_validate_timeout = nil) ⇒ Object 



549
550
551
552
553
554
555
556
557
 
# File 'lib/graphql/schema.rb', line 549

def validate_timeout(new_validate_timeout = nil)
  if new_validate_timeout
    @validate_timeout = new_validate_timeout
  elsif defined?(@validate_timeout)
    @validate_timeout
  else
    find_inherited_value(:validate_timeout)
  end
end

Class Method Details

.accessible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean) 


814
815
816
 
# File 'lib/graphql/schema.rb', line 814

def accessible?(member, ctx)
  member.accessible?(ctx)
end

.add_subscription_extension_if_necessary ⇒ Object

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. 



1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/graphql/schema.rb', line 1004

def add_subscription_extension_if_necessary
  if !defined?(@subscription_extension_added) && subscription && self.subscriptions
    @subscription_extension_added = true
    subscription.all_field_definitions.each do |field|
      if !field.extensions.any? { |ext| ext.is_a?(Subscriptions::DefaultSubscriptionResolveExtension) }
        field.extension(Subscriptions::DefaultSubscriptionResolveExtension)
      end
    end
  end
end

.after_any_lazies(maybe_lazies) ⇒ Object

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.

Return a lazy if any of maybe_lazies are lazy, otherwise, call the block eagerly and return the result.

Parameters:

  • maybe_lazies (Array) 


1063
1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/graphql/schema.rb', line 1063

def after_any_lazies(maybe_lazies)
  if maybe_lazies.any? { |l| lazy?(l) }
    GraphQL::Execution::Lazy.all(maybe_lazies).then do |result|
      yield result
    end
  else
    yield maybe_lazies
  end
end

.after_lazy(value, &block) ⇒ Object

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.

Call the given block at the right time, either: - Right away, if value is not registered with lazy_resolve - After resolving value, if it’s registered with lazy_resolve (eg, Promise)



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/graphql/schema.rb', line 1023

def after_lazy(value, &block)
  if lazy?(value)
    GraphQL::Execution::Lazy.new do
      result = sync_lazy(value)
      # The returned result might also be lazy, so check it, too
      after_lazy(result, &block)
    end
  else
    yield(value) if block_given?
  end
end

.as_json(only: nil, except: nil, context: {}) ⇒ Hash

Return the Hash response of Introspection::INTROSPECTION_QUERY.

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (Hash) —

    GraphQL result



155
156
157
 
# File 'lib/graphql/schema.rb', line 155

def as_json(only: nil, except: nil, context: {})
  execute(Introspection.query(include_deprecated_args: true), only: only, except: except, context: context).to_h
end

.context_class(new_context_class = nil) ⇒ Object 



706
707
708
709
710
711
712
 
# File 'lib/graphql/schema.rb', line 706

def context_class(new_context_class = nil)
  if new_context_class
    @context_class = new_context_class
  else
    @context_class || find_inherited_value(:context_class, GraphQL::Query::Context)
  end
end

.cursor_encoder(new_encoder = nil) ⇒ Object 



500
501
502
503
504
505
 
# File 'lib/graphql/schema.rb', line 500

def cursor_encoder(new_encoder = nil)
  if new_encoder
    @cursor_encoder = new_encoder
  end
  @cursor_encoder || find_inherited_value(:cursor_encoder, Base64Encoder)
end

.default_analysis_engine ⇒ Object 



698
699
700
701
702
703
704
 
# File 'lib/graphql/schema.rb', line 698

def default_analysis_engine
  if superclass <= GraphQL::Schema
    superclass.default_analysis_engine
  else
    @default_analysis_engine ||= GraphQL::Analysis::AST
  end
end

.default_directives ⇒ Object 



911
912
913
914
915
916
917
 
# File 'lib/graphql/schema.rb', line 911

def default_directives
  @default_directives ||= {
    "include" => GraphQL::Schema::Directive::Include,
    "skip" => GraphQL::Schema::Directive::Skip,
    "deprecated" => GraphQL::Schema::Directive::Deprecated,
  }.freeze
end

.default_execution_strategy ⇒ Object 



690
691
692
693
694
695
696
 
# File 'lib/graphql/schema.rb', line 690

def default_execution_strategy
  if superclass <= GraphQL::Schema
    superclass.default_execution_strategy
  else
    @default_execution_strategy ||= GraphQL::Execution::Interpreter
  end
end

.default_filter ⇒ Object 



193
194
195
 
# File 'lib/graphql/schema.rb', line 193

def default_filter
  GraphQL::Filter.new(except: default_mask)
end

.default_mask(new_mask = nil) ⇒ Object 



197
198
199
200
201
202
203
 
# File 'lib/graphql/schema.rb', line 197

def default_mask(new_mask = nil)
  if new_mask
    @own_default_mask = new_mask
  else
    @own_default_mask || find_inherited_value(:default_mask, Schema::NullMask)
  end
end

.default_max_page_size(new_default_max_page_size = nil) ⇒ Object 



507
508
509
510
511
512
513
 
# File 'lib/graphql/schema.rb', line 507

def default_max_page_size(new_default_max_page_size = nil)
  if new_default_max_page_size
    @default_max_page_size = new_default_max_page_size
  else
    @default_max_page_size || find_inherited_value(:default_max_page_size)
  end
end

.default_page_size(new_default_page_size = nil) ⇒ Object 



515
516
517
518
519
520
521
 
# File 'lib/graphql/schema.rb', line 515

def default_page_size(new_default_page_size = nil)
  if new_default_page_size
    @default_page_size = new_default_page_size
  else
    @default_page_size || find_inherited_value(:default_page_size)
  end
end

.deprecated_graphql_definition ⇒ Object 



130
131
132
 
# File 'lib/graphql/schema.rb', line 130

def deprecated_graphql_definition
  graphql_definition(silence_deprecation_warning: true)
end

.description(new_description = nil) ⇒ String?

Returns:

  • (String, nil) 


175
176
177
178
179
180
181
182
183
 
# File 'lib/graphql/schema.rb', line 175

def description(new_description = nil)
  if new_description
    @description = new_description
  elsif defined?(@description)
    @description
  else
    find_inherited_value(:description, nil)
  end
end

.directive(new_directive) ⇒ Object

Attach a single directive to this schema

Parameters:

  • new_directive (Class)

Returns:

  • void



907
908
909
 
# File 'lib/graphql/schema.rb', line 907

def directive(new_directive)
  add_type_and_traverse(new_directive, root: false)
end

.directives(*new_directives) ⇒ Object

Add several directives at once

Parameters:

  • new_directives (Class) 


896
897
898
899
900
901
902
 
# File 'lib/graphql/schema.rb', line 896

def directives(*new_directives)
  if new_directives.any?
    new_directives.flatten.each { |d| directive(d) }
  end

  find_inherited_value(:directives, default_directives).merge(own_directives)
end

.disable_introspection_entry_points ⇒ Object 



638
639
640
641
642
 
# File 'lib/graphql/schema.rb', line 638

def disable_introspection_entry_points
  @disable_introspection_entry_points = true
  # TODO: this clears the cache made in `def types`. But this is not a great solution.
  @introspection_system = nil
end

.disable_introspection_entry_points? ⇒ Boolean

Returns:

  • (Boolean) 


656
657
658
659
660
661
662
 
# File 'lib/graphql/schema.rb', line 656

def disable_introspection_entry_points?
  if instance_variable_defined?(:@disable_introspection_entry_points)
    @disable_introspection_entry_points
  else
    find_inherited_value(:disable_introspection_entry_points?, false)
  end
end

.disable_schema_introspection_entry_point ⇒ Object 



644
645
646
647
648
 
# File 'lib/graphql/schema.rb', line 644

def disable_schema_introspection_entry_point
  @disable_schema_introspection_entry_point = true
  # TODO: this clears the cache made in `def types`. But this is not a great solution.
  @introspection_system = nil
end

.disable_schema_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


664
665
666
667
668
669
670
 
# File 'lib/graphql/schema.rb', line 664

def disable_schema_introspection_entry_point?
  if instance_variable_defined?(:@disable_schema_introspection_entry_point)
    @disable_schema_introspection_entry_point
  else
    find_inherited_value(:disable_schema_introspection_entry_point?, false)
  end
end

.disable_type_introspection_entry_point ⇒ Object 



650
651
652
653
654
 
# File 'lib/graphql/schema.rb', line 650

def disable_type_introspection_entry_point
  @disable_type_introspection_entry_point = true
  # TODO: this clears the cache made in `def types`. But this is not a great solution.
  @introspection_system = nil
end

.disable_type_introspection_entry_point? ⇒ Boolean

Returns:

  • (Boolean) 


672
673
674
675
676
677
678
 
# File 'lib/graphql/schema.rb', line 672

def disable_type_introspection_entry_point?
  if instance_variable_defined?(:@disable_type_introspection_entry_point)
    @disable_type_introspection_entry_point
  else
    find_inherited_value(:disable_type_introspection_entry_point?, false)
  end
end

.error_handlers ⇒ Object 



728
729
730
731
732
733
734
 
# File 'lib/graphql/schema.rb', line 728

def error_handlers
  @error_handlers ||= {
    class: nil,
    handler: nil,
    subclass_handlers: Hash.new(&NEW_HANDLER_HASH),
  }
end

.execute(query_str = nil, **kwargs) ⇒ Hash

Execute a query on itself.

Returns:

  • (Hash) —

    query result, ready to be serialized as JSON

See Also:

  • for arguments.


954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
 
# File 'lib/graphql/schema.rb', line 954

def execute(query_str = nil, **kwargs)
  if query_str
    kwargs[:query] = query_str
  end
  # Some of the query context _should_ be passed to the multiplex, too
  multiplex_context = if (ctx = kwargs[:context])
    {
      backtrace: ctx[:backtrace],
      tracers: ctx[:tracers],
      dataloader: ctx[:dataloader],
    }
  else
    {}
  end
  # Since we're running one query, don't run a multiplex-level complexity analyzer
  all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context)
  all_results[0]
end

.find(path) ⇒ Object 



185
186
187
188
189
190
191
 
# File 'lib/graphql/schema.rb', line 185

def find(path)
  if !@finder
    @find_cache = {}
    @finder ||= GraphQL::Schema::Finder.new(self)
  end
  @find_cache[path] ||= @finder.find(path)
end

.from_definition(definition_or_path, default_resolve: nil, parser: GraphQL.default_parser, using: {}) ⇒ Class

Create schema from an IDL schema or file containing an IDL definition.

Parameters:

  • definition_or_path (String) —

    A schema definition string, or a path to a file containing the definition

  • default_resolve (<#call(type, field, obj, args, ctx)>) (defaults to: nil) —

    A callable for handling field resolution

  • parser (Object) (defaults to: GraphQL.default_parser) —

    An object for handling definition string parsing (must respond to parse)

  • using (Hash) (defaults to: {}) —

    Plugins to attach to the created schema with use(key, value)

Returns:

  • (Class) —

    the schema described by document



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

def from_definition(definition_or_path, default_resolve: nil, parser: GraphQL.default_parser, using: {})
  # If the file ends in `.graphql`, treat it like a filepath
  if definition_or_path.end_with?(".graphql")
    GraphQL::Schema::BuildFromDefinition.from_definition_path(
      definition_or_path,
      default_resolve: default_resolve,
      parser: parser,
      using: using,
    )
  else
    GraphQL::Schema::BuildFromDefinition.from_definition(
      definition_or_path,
      default_resolve: default_resolve,
      parser: parser,
      using: using,
    )
  end
end

.from_introspection(introspection_result) ⇒ Class<GraphQL::Schema>

Create schema with the result of an introspection query.

Parameters:

Returns:



101
102
103
 
# File 'lib/graphql/schema.rb', line 101

def from_introspection(introspection_result)
  GraphQL::Schema::Loader.load(introspection_result)
end

.get_field(type_or_name, field_name, context = GraphQL::Query::NullContext) ⇒ Object 



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/graphql/schema.rb', line 455

def get_field(type_or_name, field_name, context = GraphQL::Query::NullContext)
  parent_type = case type_or_name
  when LateBoundType
    get_type(type_or_name.name, context)
  when String
    get_type(type_or_name, context)
  when Module
    type_or_name
  else
    raise GraphQL::InvariantError, "Unexpected field owner for #{field_name.inspect}: #{type_or_name.inspect} (#{type_or_name.class})"
  end

  if parent_type.kind.fields? && (field = parent_type.get_field(field_name, context))
    field
  elsif parent_type == query && (entry_point_field = introspection_system.entry_point(name: field_name))
    entry_point_field
  elsif (dynamic_field = introspection_system.dynamic_field(name: field_name))
    dynamic_field
  else
    nil
  end
end

.get_fields(type, context = GraphQL::Query::NullContext) ⇒ Object 



478
479
480
 
# File 'lib/graphql/schema.rb', line 478

def get_fields(type, context = GraphQL::Query::NullContext)
  type.fields(context)
end

.get_type(type_name, context = GraphQL::Query::NullContext) ⇒ Module?

Returns A type, or nil if there’s no type called type_name.

Parameters:

  • type_name (String)

Returns:

  • (Module, nil) —

    A type, or nil if there’s no type called type_name



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

def get_type(type_name, context = GraphQL::Query::NullContext)
  local_entry = own_types[type_name]
  type_defn = case local_entry
  when nil
    nil
  when Array
    visible_t = nil
    warden = Warden.from_context(context)
    local_entry.each do |t|
      if warden.visible_type?(t, context)
        if visible_t.nil?
          visible_t = t
        else
          raise DuplicateNamesError.new(
            duplicated_name: type_name, duplicated_definition_1: visible_t.inspect, duplicated_definition_2: t.inspect
          )
        end
      end
    end
    visible_t
  when Module
    local_entry
  else
    raise "Invariant: unexpected own_types[#{type_name.inspect}]: #{local_entry.inspect}"
  end

  type_defn ||
    introspection_system.types[type_name] || # todo context-specific introspection?
    (superclass.respond_to?(:get_type) ? superclass.get_type(type_name, context) : nil)
end

.handle_or_reraise(context, err) ⇒ Object

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. 



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/graphql/schema.rb', line 737

def handle_or_reraise(context, err)
  handler = Execution::Errors.find_handler_for(self, err.class)
  if handler
    runtime_info = context.namespace(:interpreter) || {}
    obj = runtime_info[:current_object]
    args = runtime_info[:current_arguments]
    args = args && args.keyword_arguments
    field = runtime_info[:current_field]
    if obj.is_a?(GraphQL::Schema::Object)
      obj = obj.object
    end
    handler[:handler].call(err, obj, args, context, field)
  else
    raise err
  end
end

.id_from_object(object, type, ctx) ⇒ Object

Raises:



806
807
808
 
# File 'lib/graphql/schema.rb', line 806

def id_from_object(object, type, ctx)
  raise GraphQL::RequiredImplementationMissingError, "#{self.name}.id_from_object(object, type, ctx) must be implemented to create global ids (tried to create an id for `#{object.inspect}`)"
end

.inaccessible_fields(error) ⇒ AnalysisError?

This hook is called when a client tries to access one or more fields that fail the accessible? check.

By default, an error is added to the response. Override this hook to track metrics or return a different error to the client.

Parameters:

  • error (InaccessibleFieldsError) —

    The analysis error for this check

Returns:



826
827
828
 
# File 'lib/graphql/schema.rb', line 826

def inaccessible_fields(error)
  error
end

.inherited(child_class) ⇒ Object

rubocop:enable Lint/DuplicateMethods



794
795
796
797
798
799
800
 
# File 'lib/graphql/schema.rb', line 794

def inherited(child_class)
  if self == GraphQL::Schema
    child_class.directives(default_directives.values)
  end
  child_class.singleton_class.prepend(ResolveTypeWithType)
  super
end

.instrument(instrument_step, instrumenter, options = {}) ⇒ Object 



890
891
892
 
# File 'lib/graphql/schema.rb', line 890

def instrument(instrument_step, instrumenter, options = {})
  own_instrumenters[instrument_step] << instrumenter
end

.instrumenters ⇒ Object 



996
997
998
999
1000
1001
 
# File 'lib/graphql/schema.rb', line 996

def instrumenters
  inherited_instrumenters = find_inherited_value(:instrumenters) || Hash.new { |h,k| h[k] = [] }
  inherited_instrumenters.merge(own_instrumenters) do |_step, inherited, own|
    inherited + own
  end
end

.interpreter? ⇒ Boolean

Returns:

  • (Boolean) 


610
611
612
 
# File 'lib/graphql/schema.rb', line 610

def interpreter?
  true
end

.introspection(new_introspection_namespace = nil) ⇒ Object 



482
483
484
485
486
487
488
489
490
 
# File 'lib/graphql/schema.rb', line 482

def introspection(new_introspection_namespace = nil)
  if new_introspection_namespace
    @introspection = new_introspection_namespace
    # reset this cached value:
    @introspection_system = nil
  else
    @introspection || find_inherited_value(:introspection)
  end
end

.introspection_system ⇒ Object 



492
493
494
495
496
497
498
 
# File 'lib/graphql/schema.rb', line 492

def introspection_system
  if !@introspection_system
    @introspection_system = Schema::IntrospectionSystem.new(self)
    @introspection_system.resolve_late_bindings
  end
  @introspection_system
end

.lazy?(obj) ⇒ Boolean

Returns True if this object should be lazily resolved.

Returns:

  • (Boolean) —

    True if this object should be lazily resolved



1055
1056
1057
 
# File 'lib/graphql/schema.rb', line 1055

def lazy?(obj)
  !!lazy_method_name(obj)
end

.lazy_method_name(obj) ⇒ Symbol?

Returns The method name to lazily resolve obj, or nil if obj’s class wasn’t registered with #lazy_resolve.

Returns:

  • (Symbol, nil) —

    The method name to lazily resolve obj, or nil if obj’s class wasn’t registered with #lazy_resolve.



1050
1051
1052
 
# File 'lib/graphql/schema.rb', line 1050

def lazy_method_name(obj)
  lazy_methods.get(obj)
end

.lazy_resolve(lazy_class, value_method) ⇒ Object 



886
887
888
 
# File 'lib/graphql/schema.rb', line 886

def lazy_resolve(lazy_class, value_method)
  lazy_methods.set(lazy_class, value_method)
end

.multiplex(queries, **kwargs) ⇒ Array<Hash>

Execute several queries on itself, concurrently.

Examples:

Run several queries at once

context = { ... }
queries = [
  { query: params[:query_1], variables: params[:variables_1], context: context },
  { query: params[:query_2], variables: params[:variables_2], context: context },
]
results = MySchema.multiplex(queries)
render json: {
  result_1: results[0],
  result_2: results[1],
}

Parameters:

  • queries (Array<Hash>) —

    Keyword arguments for each query

  • context (Hash) —

    Multiplex-level context

Returns:

  • (Array<Hash>) —

    One result for each query in the input

See Also:

  • for query keyword arguments
  • for multiplex keyword arguments


992
993
994
 
# File 'lib/graphql/schema.rb', line 992

def multiplex(queries, **kwargs)
  GraphQL::Execution::Multiplex.run_all(self, queries, **kwargs)
end

.multiplex_analyzer(new_analyzer) ⇒ Object 



935
936
937
 
# File 'lib/graphql/schema.rb', line 935

def multiplex_analyzer(new_analyzer)
  own_multiplex_analyzers << new_analyzer
end

.multiplex_analyzers ⇒ Object 



939
940
941
 
# File 'lib/graphql/schema.rb', line 939

def multiplex_analyzers
  find_inherited_value(:multiplex_analyzers, EMPTY_ARRAY) + own_multiplex_analyzers
end

.mutation(new_mutation_object = nil) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/graphql/schema.rb', line 320

def mutation(new_mutation_object = nil)
  if new_mutation_object
    if @mutation_object
      raise GraphQL::Error, "Second definition of `mutation(...)` (#{new_mutation_object.inspect}) is invalid, already configured with #{@mutation_object.inspect}"
    else
      @mutation_object = new_mutation_object
      add_type_and_traverse(new_mutation_object, root: true)
      nil
    end
  else
    @mutation_object || find_inherited_value(:mutation)
  end
end

.mutation_execution_strategy(new_mutation_execution_strategy = nil) ⇒ Object 



531
532
533
534
535
536
537
 
# File 'lib/graphql/schema.rb', line 531

def mutation_execution_strategy(new_mutation_execution_strategy = nil)
  if new_mutation_execution_strategy
    @mutation_execution_strategy = new_mutation_execution_strategy
  else
    @mutation_execution_strategy || find_inherited_value(:mutation_execution_strategy, self.default_execution_strategy)
  end
end

.new_connections? ⇒ Boolean

Returns:

  • (Boolean) 


302
303
304
 
# File 'lib/graphql/schema.rb', line 302

def new_connections?
  !!connections
end

.object_from_id(node_id, ctx) ⇒ Object

Raises:



802
803
804
 
# File 'lib/graphql/schema.rb', line 802

def object_from_id(node_id, ctx)
  raise GraphQL::RequiredImplementationMissingError, "#{self.name}.object_from_id(node_id, ctx) must be implemented to load by ID (tried to load from id `#{node_id}`)"
end

.orphan_types(*new_orphan_types) ⇒ Object 



680
681
682
683
684
685
686
687
688
 
# File 'lib/graphql/schema.rb', line 680

def orphan_types(*new_orphan_types)
  if new_orphan_types.any?
    new_orphan_types = new_orphan_types.flatten
    add_type_and_traverse(new_orphan_types, root: false)
    own_orphan_types.concat(new_orphan_types.flatten)
  end

  find_inherited_value(:orphan_types, EMPTY_ARRAY) + own_orphan_types
end

.parse_error(parse_err, ctx) ⇒ Object

A function to call when #execute receives an invalid query string

The default is to add the error to context.errors

Parameters:

Returns:

  • void



882
883
884
 
# File 'lib/graphql/schema.rb', line 882

def parse_error(parse_err, ctx)
  ctx.errors.push(parse_err)
end

.plugins ⇒ Object 



218
219
220
 
# File 'lib/graphql/schema.rb', line 218

def plugins
  find_inherited_value(:plugins, EMPTY_ARRAY) + own_plugins
end

.possible_types(type = nil, context = GraphQL::Query::NullContext) ⇒ Hash<String, Module>, Array<Module>

Parameters:

  • type (Module) (defaults to: nil) —

    The type definition whose possible types you want to see

Returns:

  • (Hash<String, Module>) —

    All possible types, if no type is given.

  • (Array<Module>) —

    Possible types for type, if it’s given.



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/graphql/schema.rb', line 371

def possible_types(type = nil, context = GraphQL::Query::NullContext)
  if type
    # TODO duck-typing `.possible_types` would probably be nicer here
    if type.kind.union?
      type.possible_types(context: context)
    else
      stored_possible_types = own_possible_types[type.graphql_name]
      visible_possible_types = if stored_possible_types && type.kind.interface?
        stored_possible_types.select do |possible_type|
          possible_type.interfaces(context).include?(type)
        end
      else
        stored_possible_types
      end
      visible_possible_types ||
        introspection_system.possible_types[type.graphql_name] ||
        (
          superclass.respond_to?(:possible_types) ?
            superclass.possible_types(type, context) :
            EMPTY_ARRAY
        )
    end
  else
    find_inherited_value(:possible_types, EMPTY_HASH)
      .merge(own_possible_types)
      .merge(introspection_system.possible_types)
  end
end

.query(new_query_object = nil) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/graphql/schema.rb', line 306

def query(new_query_object = nil)
  if new_query_object
    if @query_object
      raise GraphQL::Error, "Second definition of `query(...)` (#{new_query_object.inspect}) is invalid, already configured with #{@query_object.inspect}"
    else
      @query_object = new_query_object
      add_type_and_traverse(new_query_object, root: true)
      nil
    end
  else
    @query_object || find_inherited_value(:query)
  end
end

.query_analyzer(new_analyzer) ⇒ Object 



927
928
929
 
# File 'lib/graphql/schema.rb', line 927

def query_analyzer(new_analyzer)
  own_query_analyzers << new_analyzer
end

.query_analyzers ⇒ Object 



931
932
933
 
# File 'lib/graphql/schema.rb', line 931

def query_analyzers
  find_inherited_value(:query_analyzers, EMPTY_ARRAY) + own_query_analyzers
end

.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object 



523
524
525
526
527
528
529
 
# File 'lib/graphql/schema.rb', line 523

def query_execution_strategy(new_query_execution_strategy = nil)
  if new_query_execution_strategy
    @query_execution_strategy = new_query_execution_strategy
  else
    @query_execution_strategy || find_inherited_value(:query_execution_strategy, self.default_execution_strategy)
  end
end

.query_stack_error(query, err) ⇒ Object 



1015
1016
1017
 
# File 'lib/graphql/schema.rb', line 1015

def query_stack_error(query, err)
  query.context.errors.push(GraphQL::ExecutionError.new("This query is too large to execute."))
end

.references_to(to_type = nil, from: nil) ⇒ Object 



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/graphql/schema.rb', line 423

def references_to(to_type = nil, from: nil)
  @own_references_to ||= Hash.new { |h, k| h[k] = [] }
  if to_type
    if !to_type.is_a?(String)
      to_type = to_type.graphql_name
    end

    if from
      @own_references_to[to_type] << from
    else
      own_refs = @own_references_to[to_type]
      inherited_refs = find_inherited_value(:references_to, EMPTY_HASH)[to_type] || EMPTY_ARRAY
      own_refs + inherited_refs
    end
  else
    # `@own_references_to` can be quite large for big schemas,
    # and generally speaking, we won't inherit any values.
    # So optimize the most common case -- don't create a duplicate Hash.
    inherited_value = find_inherited_value(:references_to, EMPTY_HASH)
    if inherited_value.any?
      inherited_value.merge(@own_references_to)
    else
      @own_references_to
    end
  end
end

.rescue_from(*err_classes, &handler_block) ⇒ Object 



714
715
716
717
718
 
# File 'lib/graphql/schema.rb', line 714

def rescue_from(*err_classes, &handler_block)
  err_classes.each do |err_class|
    Execution::Errors.register_rescue_from(err_class, error_handlers[:subclass_handlers], handler_block)
  end
end

.resolve_type(type, obj, ctx) ⇒ Object 



785
786
787
788
789
790
791
 
# File 'lib/graphql/schema.rb', line 785

def resolve_type(type, obj, ctx)
  if type.kind.object?
    type
  else
    raise GraphQL::RequiredImplementationMissingError, "#{self.name}.resolve_type(type, obj, ctx) must be implemented to use Union types or Interface types (tried to resolve: #{type.name})"
  end
end

.root_type_for_operation(operation) ⇒ GraphQL::ObjectType?

Returns:

  • (GraphQL::ObjectType, nil)

See Also:

  • Restricted access to root types


351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/graphql/schema.rb', line 351

def root_type_for_operation(operation)
  case operation
  when "query"
    query
  when "mutation"
    mutation
  when "subscription"
    subscription
  else
    raise ArgumentError, "unknown operation type: #{operation}"
  end
end

.root_types ⇒ Object 



364
365
366
 
# File 'lib/graphql/schema.rb', line 364

def root_types
  @root_types
end

.sanitized_printer(new_sanitized_printer = nil) ⇒ Object 



943
944
945
946
947
948
949
 
# File 'lib/graphql/schema.rb', line 943

def sanitized_printer(new_sanitized_printer = nil)
  if new_sanitized_printer
    @own_sanitized_printer = new_sanitized_printer
  else
    @own_sanitized_printer || GraphQL::Language::SanitizedPrinter
  end
end

.static_validator ⇒ Object 



205
206
207
 
# File 'lib/graphql/schema.rb', line 205

def static_validator
  GraphQL::StaticValidation::Validator.new(schema: self)
end

.subscription(new_subscription_object = nil) ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/graphql/schema.rb', line 334

def subscription(new_subscription_object = nil)
  if new_subscription_object
    if @subscription_object
      raise GraphQL::Error, "Second definition of `subscription(...)` (#{new_subscription_object.inspect}) is invalid, already configured with #{@subscription_object.inspect}"
    else
      @subscription_object = new_subscription_object
      add_subscription_extension_if_necessary
      add_type_and_traverse(new_subscription_object, root: true)
      nil
    end
  else
    @subscription_object || find_inherited_value(:subscription)
  end
end

.subscription_execution_strategy(new_subscription_execution_strategy = nil) ⇒ Object 



539
540
541
542
543
544
545
 
# File 'lib/graphql/schema.rb', line 539

def subscription_execution_strategy(new_subscription_execution_strategy = nil)
  if new_subscription_execution_strategy
    @subscription_execution_strategy = new_subscription_execution_strategy
  else
    @subscription_execution_strategy || find_inherited_value(:subscription_execution_strategy, self.default_execution_strategy)
  end
end

.subscriptions(inherited: true) ⇒ GraphQL::Subscriptions

Returns:



135
136
137
 
# File 'lib/graphql/schema.rb', line 135

def subscriptions(inherited: true)
  defined?(@subscriptions) ? @subscriptions : (inherited ? find_inherited_value(:subscriptions, nil) : nil)
end

.subscriptions=(new_implementation) ⇒ Object 



139
140
141
 
# File 'lib/graphql/schema.rb', line 139

def subscriptions=(new_implementation)
  @subscriptions = new_implementation
end

.sync_lazy(value) ⇒ Object

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.

Override this method to handle lazy objects in a custom way.

Parameters:

Returns:

  • (Object) —

    A GraphQL-ready (non-lazy) object



1039
1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/graphql/schema.rb', line 1039

def sync_lazy(value)
  lazy_method = lazy_method_name(value)
  if lazy_method
    synced_value = value.public_send(lazy_method)
    sync_lazy(synced_value)
  else
    value
  end
end

.to_definition(only: nil, except: nil, context: {}) ⇒ String

Return the GraphQL IDL for the schema

Parameters:

  • context (Hash) (defaults to: {})
  • only (<#call(member, ctx)>) (defaults to: nil)
  • except (<#call(member, ctx)>) (defaults to: nil)

Returns:

  • (String) 


164
165
166
 
# File 'lib/graphql/schema.rb', line 164

def to_definition(only: nil, except: nil, context: {})
  GraphQL::Schema::Printer.print_schema(self, only: only, except: except, context: context)
end

.to_document ⇒ GraphQL::Language::Document

Return the GraphQL::Language::Document IDL AST for the schema

Returns:

  • (GraphQL::Language::Document) 


170
171
172
 
# File 'lib/graphql/schema.rb', line 170

def to_document
  GraphQL::Language::DocumentFromSchemaDefinition.new(self).document
end

.to_json(**args) ⇒ String

Returns the JSON response of Introspection::INTROSPECTION_QUERY.

Returns:

  • (String)

See Also:

  • {{#as_json}


146
147
148
 
# File 'lib/graphql/schema.rb', line 146

def to_json(**args)
  JSON.pretty_generate(as_json(**args))
end

.tracer(new_tracer) ⇒ Object 



919
920
921
 
# File 'lib/graphql/schema.rb', line 919

def tracer(new_tracer)
  own_tracers << new_tracer
end

.tracers ⇒ Object 



923
924
925
 
# File 'lib/graphql/schema.rb', line 923

def tracers
  find_inherited_value(:tracers, EMPTY_ARRAY) + own_tracers
end

.type_error(type_error, ctx) ⇒ Object 



865
866
867
868
869
870
871
872
873
874
 
# File 'lib/graphql/schema.rb', line 865

def type_error(type_error, ctx)
  case type_error
  when GraphQL::InvalidNullError
    ctx.errors << type_error
  when GraphQL::UnresolvedTypeError, GraphQL::StringEncodingError, GraphQL::IntegerEncodingError
    raise type_error
  when GraphQL::IntegerDecodingError
    nil
  end
end

.type_from_ast(ast_node, context: nil) ⇒ Object 



450
451
452
453
 
# File 'lib/graphql/schema.rb', line 450

def type_from_ast(ast_node, context: nil)
  type_owner = context ? context.warden : self
  GraphQL::Schema::TypeExpression.build_type(type_owner, ast_node)
end

.types(context = GraphQL::Query::NullContext) ⇒ Hash<String => Class>

Build a map of { name => type } and return it

Returns:

  • (Hash<String => Class>) —

    A dictionary of type classes by their GraphQL name

See Also:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/graphql/schema.rb', line 225

def types(context = GraphQL::Query::NullContext)
  all_types = non_introspection_types.merge(introspection_system.types)
  visible_types = {}
  all_types.each do |k, v|
    visible_types[k] =if v.is_a?(Array)
      visible_t = nil
      v.each do |t|
        if t.visible?(context)
          if visible_t.nil?
            visible_t = t
          else
            raise DuplicateNamesError.new(
              duplicated_name: k, duplicated_definition_1: visible_t.inspect, duplicated_definition_2: t.inspect
            )
          end
        end
      end
      visible_t
    else
      v
    end
  end
  visible_types
end

.unauthorized_field(unauthorized_error) ⇒ Field

This hook is called when a field fails an authorized? check.

By default, this hook implements the same behavior as unauthorized_object.

Whatever value is returned from this method will be used instead of the unauthorized field . If an error is raised, then nil will be used.

If you want to add an error to the "errors" key, raise a ExecutionError in this hook.

Parameters:

Returns:

  • (Field) —

    The returned field will be put in the GraphQL response



861
862
863
 
# File 'lib/graphql/schema.rb', line 861

def unauthorized_field(unauthorized_error)
  unauthorized_object(unauthorized_error)
end

.unauthorized_object(unauthorized_error) ⇒ Object

This hook is called when an object fails an authorized? check. You might report to your bug tracker here, so you can correct the field resolvers not to return unauthorized objects.

By default, this hook just replaces the unauthorized object with nil.

Whatever value is returned from this method will be used instead of the unauthorized object (accessible as unauthorized_error.object). If an error is raised, then nil will be used.

If you want to add an error to the "errors" key, raise a ExecutionError in this hook.

Parameters:

Returns:

  • (Object) —

    The returned object will be put in the GraphQL response



845
846
847
 
# File 'lib/graphql/schema.rb', line 845

def unauthorized_object(unauthorized_error)
  nil
end

.union_memberships(type = nil) ⇒ Object 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/graphql/schema.rb', line 400

def union_memberships(type = nil)
  if type
    own_um = own_union_memberships.fetch(type.graphql_name, EMPTY_ARRAY)
    inherited_um = find_inherited_value(:union_memberships, EMPTY_HASH).fetch(type.graphql_name, EMPTY_ARRAY)
    own_um + inherited_um
  else
    joined_um = own_union_memberships.dup
    find_inherited_value(:union_memberhips, EMPTY_HASH).each do |k, v|
      um = joined_um[k] ||= []
      um.concat(v)
    end
    joined_um
  end
end

.use(plugin, **kwargs) ⇒ Object 



209
210
211
212
213
214
215
216
 
# File 'lib/graphql/schema.rb', line 209

def use(plugin, **kwargs)
  if kwargs.any?
    plugin.use(self, **kwargs)
  else
    plugin.use(self)
  end
  own_plugins << [plugin, kwargs]
end

.using_ast_analysis? ⇒ Boolean

Returns:

  • (Boolean) 


606
607
608
 
# File 'lib/graphql/schema.rb', line 606

def using_ast_analysis?
  true
end

.validate(string_or_document, rules: nil, context: nil) ⇒ Array<GraphQL::StaticValidation::Error >

Validate a query string according to this schema.

Parameters:

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/graphql/schema.rb', line 562

def validate(string_or_document, rules: nil, context: nil)
  doc = if string_or_document.is_a?(String)
    GraphQL.parse(string_or_document)
  else
    string_or_document
  end
  query = GraphQL::Query.new(self, document: doc, context: context)
  validator_opts = { schema: self }
  rules && (validator_opts[:rules] = rules)
  validator = GraphQL::StaticValidation::Validator.new(**validator_opts)
  res = validator.validate(query, timeout: validate_timeout, max_errors: validate_max_errors)
  res[:errors]
end

.visible?(member, ctx) ⇒ Boolean

Returns:

  • (Boolean) 


810
811
812
 
# File 'lib/graphql/schema.rb', line 810

def visible?(member, ctx)
  member.visible?(ctx)
end