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/always_visible.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/one_of.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/directive/specified_by.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/has_single_input_argument.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

A GraphQL schema which may be queried with Query.

The Schema contains:

  • types for exposing your application
  • query analyzers for assessing incoming queries (including max depth & max complexity restrictions)
  • execution strategies for running incoming queries

Schemas start with root types, Schema.query, Schema.mutation and Schema.subscription. The schema will traverse the tree of fields & types, using those as starting points. Any undiscoverable types may be provided with the types configuration.

Schemas can restrict large incoming queries with max_depth and max_complexity configurations. (These configurations can be overridden by specific calls to Schema.execute)

Examples:

defining a schema

class MySchema < GraphQL::Schema
  query QueryType
  # If types are only connected by way of interfaces, they must be added here
  orphan_types ImageType, AudioType
end

Direct Known Subclasses

Query::NullContext::NullSchema

Defined Under Namespace

Modules: Base64Encoder, BuildFromDefinition, FindInheritedValue, HasSingleInputArgument, Interface, Loader, NullMask, ResolveTypeWithType, SubclassGetReferencesTo, TypeExpression, UniqueWithinType Classes: Addition, AlwaysVisible, 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

Attributes included from Member::HasAstNode

#ast_node

Class Method Summary collapse

Methods included from Member::HasAstNode

inherited

Class Attribute Details

.analysis_engineObject



773
774
775
# File 'lib/graphql/schema.rb', line 773

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

.connectionsGraphQL::Pagination::Connections

Returns if installed.

Returns:



407
408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/graphql/schema.rb', line 407

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_classObject

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:



549
550
551
# File 'lib/graphql/schema.rb', line 549

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

.error_bubbling(new_error_bubbling = nil) ⇒ Object



787
788
789
790
791
792
793
794
# File 'lib/graphql/schema.rb', line 787

def error_bubbling(new_error_bubbling = nil)
  if !new_error_bubbling.nil?
    warn("error_bubbling(#{new_error_bubbling.inspect}) is deprecated; the default value of `false` will be the only option in GraphQL-Ruby 3.0")
    @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.



785
786
787
# File 'lib/graphql/schema.rb', line 785

def interpreter=(value)
  @interpreter = value
end

.max_complexity(max_complexity = nil, count_introspection_fields: true) ⇒ Object



752
753
754
755
756
757
758
759
760
761
# File 'lib/graphql/schema.rb', line 752

def max_complexity(max_complexity = nil, count_introspection_fields: true)
  if max_complexity
    @max_complexity = max_complexity
    @max_complexity_count_introspection_fields = count_introspection_fields
  elsif defined?(@max_complexity)
    @max_complexity
  else
    find_inherited_value(:max_complexity)
  end
end

.max_depth(new_max_depth = nil, count_introspection_fields: true) ⇒ Object



800
801
802
803
804
805
806
807
808
809
# File 'lib/graphql/schema.rb', line 800

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

.validate_max_errors(new_validate_max_errors = nil) ⇒ Object



740
741
742
743
744
745
746
747
748
# File 'lib/graphql/schema.rb', line 740

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



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

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

.warden_classObject



488
489
490
491
492
493
494
495
496
# File 'lib/graphql/schema.rb', line 488

def warden_class
  if defined?(@warden_class)
    @warden_class
  elsif superclass.respond_to?(:warden_class)
    superclass.warden_class
  else
    GraphQL::Schema::Warden
  end
end

Class Method Details

.add_subscription_extension_if_necessaryObject

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.



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
# File 'lib/graphql/schema.rb', line 1343

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)


1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'lib/graphql/schema.rb', line 1402

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)



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
# File 'lib/graphql/schema.rb', line 1362

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(context: {}, include_deprecated_args: true, include_schema_description: false, include_is_repeatable: false, include_specified_by_url: false, include_is_one_of: false) ⇒ Hash

Return the Hash response of Introspection::INTROSPECTION_QUERY.

Parameters:

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

    If true, deprecated arguments will be included in the JSON response

  • include_schema_description (Boolean) (defaults to: false)

    If true, the schema’s description will be queried and included in the response

  • include_is_repeatable (Boolean) (defaults to: false)

    If true, isRepeatable: true|false will be included with the schema’s directives

  • include_specified_by_url (Boolean) (defaults to: false)

    If true, scalar types’ specifiedByUrl: will be included in the response

  • include_is_one_of (Boolean) (defaults to: false)

    If true, isOneOf: true|false will be included with input objects

Returns:

  • (Hash)

    GraphQL result



276
277
278
279
280
281
282
283
284
285
286
# File 'lib/graphql/schema.rb', line 276

def as_json(context: {}, include_deprecated_args: true, include_schema_description: false, include_is_repeatable: false, include_specified_by_url: false, include_is_one_of: false)
  introspection_query = Introspection.query(
    include_deprecated_args: include_deprecated_args,
    include_schema_description: include_schema_description,
    include_is_repeatable: include_is_repeatable,
    include_is_one_of: include_is_one_of,
    include_specified_by_url: include_specified_by_url,
  )

  execute(introspection_query, context: context).to_h
end

.build_trace_mode(mode) ⇒ Object



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

def build_trace_mode(mode)
  case mode
  when :default
    # Use the superclass's default mode if it has one, or else start an inheritance chain at the built-in base class.
    base_class = (superclass.respond_to?(:trace_class_for) && superclass.trace_class_for(mode)) || GraphQL::Tracing::Trace
    Class.new(base_class) do
      include DefaultTraceClass
    end
  when :default_backtrace
    schema_base_class = trace_class_for(:default, build: true)
    Class.new(schema_base_class) do
      include(GraphQL::Backtrace::Trace)
    end
  else
    # First, see if the superclass has a custom-defined class for this.
    # Then, if it doesn't, use this class's default trace
    base_class = (superclass.respond_to?(:trace_class_for) && superclass.trace_class_for(mode)) || trace_class_for(:default, build: true)
    # Prepare the default trace class if it hasn't been initialized yet
    base_class ||= (own_trace_modes[:default] = build_trace_mode(:default))
    mods = trace_modules_for(mode)
    if base_class < DefaultTraceClass
      mods = trace_modules_for(:default) + mods
    end
    # Copy the existing default options into this mode's options
    default_options = trace_options_for(:default)
    add_trace_options_for(mode, default_options)

    Class.new(base_class) do
      mods.any? && include(*mods)
    end
  end
end

.context_class(new_context_class = nil) ⇒ Object



947
948
949
950
951
952
953
# File 'lib/graphql/schema.rb', line 947

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

.count_introspection_fieldsObject



811
812
813
814
815
816
817
# File 'lib/graphql/schema.rb', line 811

def count_introspection_fields
  if defined?(@count_introspection_fields)
    @count_introspection_fields
  else
    find_inherited_value(:count_introspection_fields, true)
  end
end

.cursor_encoder(new_encoder = nil) ⇒ Object



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

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_engineObject



919
920
921
922
923
924
925
# File 'lib/graphql/schema.rb', line 919

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

.default_directivesObject



1153
1154
1155
1156
1157
1158
1159
1160
1161
# File 'lib/graphql/schema.rb', line 1153

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

.default_execution_strategyObject



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

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

.default_logger(new_default_logger = NOT_CONFIGURED) ⇒ Object



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
# File 'lib/graphql/schema.rb', line 927

def default_logger(new_default_logger = NOT_CONFIGURED)
  if NOT_CONFIGURED.equal?(new_default_logger)
    if defined?(@default_logger)
      @default_logger
    elsif superclass.respond_to?(:default_logger)
      superclass.default_logger
    elsif defined?(Rails) && Rails.respond_to?(:logger) && (rails_logger = Rails.logger)
      rails_logger
    else
      def_logger = Logger.new($stdout)
      def_logger.info! # It doesn't output debug info by default
      def_logger
    end
  elsif new_default_logger == nil
    @default_logger = Logger.new(IO::NULL)
  else
    @default_logger = new_default_logger
  end
end

.default_max_page_size(new_default_max_page_size = nil) ⇒ Object



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

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



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

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

.default_trace_mode(new_mode = nil) ⇒ Object

Parameters:

  • new_mode (Symbol) (defaults to: nil)

    If configured, this will be used when context: { trace_mode: ... } isn’t set.



147
148
149
150
151
152
153
154
155
156
157
# File 'lib/graphql/schema.rb', line 147

def default_trace_mode(new_mode = nil)
  if new_mode
    @default_trace_mode = new_mode
  elsif defined?(@default_trace_mode)
    @default_trace_mode
  elsif superclass.respond_to?(:default_trace_mode)
    superclass.default_trace_mode
  else
    :default
  end
end

.deprecated_graphql_definitionObject



133
134
135
# File 'lib/graphql/schema.rb', line 133

def deprecated_graphql_definition
  graphql_definition(silence_deprecation_warning: true)
end

.description(new_description = nil) ⇒ String?

Returns:

  • (String, nil)


302
303
304
305
306
307
308
309
310
# File 'lib/graphql/schema.rb', line 302

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



1149
1150
1151
# File 'lib/graphql/schema.rb', line 1149

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)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
# File 'lib/graphql/schema.rb', line 1133

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

  inherited_dirs = find_inherited_value(:directives, default_directives)
  if own_directives.any?
    inherited_dirs.merge(own_directives)
  else
    inherited_dirs
  end
end

.disable_introspection_entry_pointsObject



819
820
821
822
823
# File 'lib/graphql/schema.rb', line 819

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)


837
838
839
840
841
842
843
# File 'lib/graphql/schema.rb', line 837

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_pointObject



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

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)


845
846
847
848
849
850
851
# File 'lib/graphql/schema.rb', line 845

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_pointObject



831
832
833
834
835
# File 'lib/graphql/schema.rb', line 831

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)


853
854
855
856
857
858
859
# File 'lib/graphql/schema.rb', line 853

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_handlersObject



969
970
971
972
973
974
975
# File 'lib/graphql/schema.rb', line 969

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.


1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'lib/graphql/schema.rb', line 1291

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],
      trace: ctx[:trace],
      dataloader: ctx[:dataloader],
      trace_mode: ctx[:trace_mode],
    }
  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

.extra_types(*new_extra_types) ⇒ Array<Module>

Returns Type definitions added to this schema.

Parameters:

  • new_extra_types (Module)

    Type definitions to include in printing and introspection, even though they aren’t referenced in the schema

Returns:

  • (Array<Module>)

    Type definitions added to this schema



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
# File 'lib/graphql/schema.rb', line 863

def extra_types(*new_extra_types)
  if new_extra_types.any?
    new_extra_types = new_extra_types.flatten
    @own_extra_types ||= []
    @own_extra_types.concat(new_extra_types)
  end
  inherited_et = find_inherited_value(:extra_types, nil)
  if inherited_et
    if @own_extra_types
      inherited_et + @own_extra_types
    else
      inherited_et
    end
  else
    @own_extra_types || EMPTY_ARRAY
  end
end

.find(path) ⇒ Object



312
313
314
315
316
317
318
# File 'lib/graphql/schema.rb', line 312

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



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

def from_definition(definition_or_path, default_resolve: nil, parser: GraphQL.default_parser, using: {})
  # If the file ends in `.graphql` or `.graphqls`, treat it like a filepath
  if definition_or_path.end_with?(".graphql") || definition_or_path.end_with?(".graphqls")
    GraphQL::Schema::BuildFromDefinition.from_definition_path(
      self,
      definition_or_path,
      default_resolve: default_resolve,
      parser: parser,
      using: using,
    )
  else
    GraphQL::Schema::BuildFromDefinition.from_definition(
      self,
      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:



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

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

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



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/graphql/schema.rb', line 586

def get_field(type_or_name, field_name, context = GraphQL::Query::NullContext.instance)
  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.instance) ⇒ Object



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

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

.get_type(type_name, context = GraphQL::Query::NullContext.instance) ⇒ 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



367
368
369
370
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
# File 'lib/graphql/schema.rb', line 367

def get_type(type_name, context = GraphQL::Query::NullContext.instance)
  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.



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
# File 'lib/graphql/schema.rb', line 978

def handle_or_reraise(context, err)
  handler = Execution::Errors.find_handler_for(self, err.class)
  if handler
    obj = context[:current_object]
    args = context[:current_arguments]
    args = args && args.respond_to?(:keyword_arguments) ? args.keyword_arguments : nil
    field = context[: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

.has_defined_type?(type_name) ⇒ Boolean

Returns Does this schema have any definition for a type named type_name, regardless of visibility?.

Returns:

  • (Boolean)

    Does this schema have any definition for a type named type_name, regardless of visibility?



399
400
401
# File 'lib/graphql/schema.rb', line 399

def has_defined_type?(type_name)
  own_types.key?(type_name) || introspection_system.types.key?(type_name) || (superclass.respond_to?(:has_defined_type?) ? superclass.has_defined_type?(type_name) : false)
end

.id_from_object(object, type, ctx) ⇒ Object



1044
1045
1046
# File 'lib/graphql/schema.rb', line 1044

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

.inherited(child_class) ⇒ Object

rubocop:enable Lint/DuplicateMethods



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'lib/graphql/schema.rb', line 1026

def inherited(child_class)
  if self == GraphQL::Schema
    child_class.directives(default_directives.values)
    child_class.extend(SubclassGetReferencesTo)
  end
  # Make sure the child class has these built out, so that
  # subclasses can be modified by later calls to `trace_with`
  own_trace_modes.each do |name, _class|
    child_class.own_trace_modes[name] = child_class.build_trace_mode(name)
  end
  child_class.singleton_class.prepend(ResolveTypeWithType)
  super
end

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



1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'lib/graphql/schema.rb', line 1121

def instrument(instrument_step, instrumenter, options = {})
  warn <<~WARN
  Schema.instrument is deprecated, use `trace_with` instead: https://graphql-ruby.org/queries/tracing.html"
    (From `#{self}.instrument(#{instrument_step}, #{instrumenter})` at #{caller(1, 1).first})

  WARN
  trace_with(Tracing::LegacyHooksTrace)
  own_instrumenters[instrument_step] << instrumenter
end

.instrumentersObject



1335
1336
1337
1338
1339
1340
# File 'lib/graphql/schema.rb', line 1335

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)


781
782
783
# File 'lib/graphql/schema.rb', line 781

def interpreter?
  true
end

.introspection(new_introspection_namespace = nil) ⇒ Object



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

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_systemObject



623
624
625
626
627
628
629
# File 'lib/graphql/schema.rb', line 623

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



1394
1395
1396
# File 'lib/graphql/schema.rb', line 1394

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.



1389
1390
1391
# File 'lib/graphql/schema.rb', line 1389

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

.lazy_resolve(lazy_class, value_method) ⇒ Object



1117
1118
1119
# File 'lib/graphql/schema.rb', line 1117

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

.max_complexity_count_introspection_fieldsObject



763
764
765
766
767
768
769
# File 'lib/graphql/schema.rb', line 763

def max_complexity_count_introspection_fields
  if defined?(@max_complexity_count_introspection_fields)
    @max_complexity_count_introspection_fields
  else
    find_inherited_value(:max_complexity_count_introspection_fields, true)
  end
end

.max_query_string_tokens(new_max_tokens = NOT_CONFIGURED) ⇒ nil, Integer

A limit on the number of tokens to accept on incoming query strings. Use this to prevent parsing maliciously-large query strings.

Returns:

  • (nil, Integer)


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

def max_query_string_tokens(new_max_tokens = NOT_CONFIGURED)
  if NOT_CONFIGURED.equal?(new_max_tokens)
    defined?(@max_query_string_tokens) ? @max_query_string_tokens : find_inherited_value(:max_query_string_tokens)
  else
    @max_query_string_tokens = new_max_tokens
  end
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


1331
1332
1333
# File 'lib/graphql/schema.rb', line 1331

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

.multiplex_analyzer(new_analyzer) ⇒ Object



1272
1273
1274
# File 'lib/graphql/schema.rb', line 1272

def multiplex_analyzer(new_analyzer)
  own_multiplex_analyzers << new_analyzer
end

.multiplex_analyzersObject



1276
1277
1278
# File 'lib/graphql/schema.rb', line 1276

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

.mutation(new_mutation_object = nil) ⇒ Object



440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'lib/graphql/schema.rb', line 440

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, deprecation_warning: true) ⇒ Object



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

def mutation_execution_strategy(new_mutation_execution_strategy = nil, deprecation_warning: true)
  if deprecation_warning
    warn "GraphQL::Schema.mutation_execution_strategy is deprecated without replacement. Use `GraphQL::Query.new` directly to create and execute a custom query instead."
      warn "  #{caller(1, 1).first}"
  end
  if new_mutation_execution_strategy
    @mutation_execution_strategy = new_mutation_execution_strategy
  else
    @mutation_execution_strategy || (superclass.respond_to?(:mutation_execution_strategy) ? superclass.mutation_execution_strategy(deprecation_warning: false) : self.default_execution_strategy)
  end
end

.new_connections?Boolean

Returns:

  • (Boolean)


422
423
424
# File 'lib/graphql/schema.rb', line 422

def new_connections?
  !!connections
end

.new_trace(mode: nil, **options) ⇒ Tracing::Trace

Create a trace instance which will include the trace modules specified for the optional mode.

If no mode: is given, then default_trace_mode will be used.

Parameters:

  • mode (Symbol) (defaults to: nil)

    Trace modules for this trade mode will be included

  • options (Hash)

    Keywords that will be passed to the tracing class during #initialize

Returns:



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
# File 'lib/graphql/schema.rb', line 1239

def new_trace(mode: nil, **options)
  target = options[:query] || options[:multiplex]
  mode ||= target && target.context[:trace_mode]

  trace_mode = if mode
    mode
  elsif target && target.context[:backtrace]
    if default_trace_mode != :default
      raise ArgumentError, "Can't use `context[:backtrace]` with a custom default trace mode (`#{dm.inspect}`)"
    else
      own_trace_modes[:default_backtrace] ||= build_trace_mode(:default_backtrace)
      options_trace_mode = :default
      :default_backtrace
    end
  else
    default_trace_mode
  end

  options_trace_mode ||= trace_mode
  base_trace_options = trace_options_for(options_trace_mode)
  trace_options = base_trace_options.merge(options)
  trace_class_for_mode = trace_class_for(trace_mode, build: true)
  trace_class_for_mode.new(**trace_options)
end

.object_from_id(node_id, ctx) ⇒ Object



1040
1041
1042
# File 'lib/graphql/schema.rb', line 1040

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



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
# File 'lib/graphql/schema.rb', line 881

def orphan_types(*new_orphan_types)
  if new_orphan_types.any?
    new_orphan_types = new_orphan_types.flatten
    non_object_types = new_orphan_types.reject { |ot| ot.is_a?(Class) && ot < GraphQL::Schema::Object }
    if non_object_types.any?
      raise ArgumentError, <<~ERR
        Only object type classes should be added as `orphan_types(...)`.

        - Remove these no-op types from `orphan_types`: #{non_object_types.map { |t| "#{t.inspect} (#{t.kind.name})"}.join(", ")}
        - See https://graphql-ruby.org/type_definitions/interfaces.html#orphan-types

        To add other types to your schema, you might want `extra_types`: https://graphql-ruby.org/schema/definition.html#extra-types
      ERR
    end
    add_type_and_traverse(new_orphan_types, root: false)
    own_orphan_types.concat(new_orphan_types.flatten)
  end

  inherited_ot = find_inherited_value(:orphan_types, nil)
  if inherited_ot
    if own_orphan_types.any?
      inherited_ot + own_orphan_types
    else
      inherited_ot
    end
  else
    own_orphan_types
  end
end

.own_trace_modesObject



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

def own_trace_modes
  @own_trace_modes ||= {}
end

.own_trace_modulesObject



245
246
247
# File 'lib/graphql/schema.rb', line 245

def own_trace_modules
  @own_trace_modules ||= Hash.new { |h, k| h[k] = [] }
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



1113
1114
1115
# File 'lib/graphql/schema.rb', line 1113

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

.pluginsObject



333
334
335
# File 'lib/graphql/schema.rb', line 333

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

.possible_types(type = nil, context = GraphQL::Query::NullContext.instance) ⇒ 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.



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
# File 'lib/graphql/schema.rb', line 503

def possible_types(type = nil, context = GraphQL::Query::NullContext.instance)
  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



426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'lib/graphql/schema.rb', line 426

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



1264
1265
1266
# File 'lib/graphql/schema.rb', line 1264

def query_analyzer(new_analyzer)
  own_query_analyzers << new_analyzer
end

.query_analyzersObject



1268
1269
1270
# File 'lib/graphql/schema.rb', line 1268

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

.query_class(new_query_class = NOT_CONFIGURED) ⇒ Object



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

def query_class(new_query_class = NOT_CONFIGURED)
  if NOT_CONFIGURED.equal?(new_query_class)
    @query_class || (superclass.respond_to?(:query_class) ? superclass.query_class : GraphQL::Query)
  else
    @query_class = new_query_class
  end
end

.query_execution_strategy(new_query_execution_strategy = nil, deprecation_warning: true) ⇒ Object



665
666
667
668
669
670
671
672
673
674
675
# File 'lib/graphql/schema.rb', line 665

def query_execution_strategy(new_query_execution_strategy = nil, deprecation_warning: true)
  if deprecation_warning
    warn "GraphQL::Schema.query_execution_strategy is deprecated without replacement. Use `GraphQL::Query.new` directly to create and execute a custom query instead."
    warn "  #{caller(1, 1).first}"
  end
  if new_query_execution_strategy
    @query_execution_strategy = new_query_execution_strategy
  else
    @query_execution_strategy || (superclass.respond_to?(:query_execution_strategy) ? superclass.query_execution_strategy(deprecation_warning: false) : self.default_execution_strategy)
  end
end

.query_stack_error(query, err) ⇒ Object



1354
1355
1356
# File 'lib/graphql/schema.rb', line 1354

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



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
# File 'lib/graphql/schema.rb', line 555

def references_to(to_type = nil, from: nil)
  @own_references_to ||= {}
  if to_type
    if !to_type.is_a?(String)
      to_type = to_type.graphql_name
    end

    if from
      refs = @own_references_to[to_type] ||= []
      refs << from
    else
      get_references_to(to_type) || EMPTY_ARRAY
    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



955
956
957
958
959
# File 'lib/graphql/schema.rb', line 955

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



1021
1022
1023
# File 'lib/graphql/schema.rb', line 1021

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

.root_type_for_operation(operation) ⇒ GraphQL::ObjectType?

Returns:

  • (GraphQL::ObjectType, nil)

See Also:

  • Restricted access to root types


471
472
473
474
475
476
477
478
479
480
481
482
# File 'lib/graphql/schema.rb', line 471

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_typesObject



484
485
486
# File 'lib/graphql/schema.rb', line 484

def root_types
  @root_types
end

.sanitized_printer(new_sanitized_printer = nil) ⇒ Object



1280
1281
1282
1283
1284
1285
1286
# File 'lib/graphql/schema.rb', line 1280

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

.schema_directive(dir_class, **options) ⇒ Object



1052
1053
1054
1055
# File 'lib/graphql/schema.rb', line 1052

def schema_directive(dir_class, **options)
  @own_schema_directives ||= []
  Member::HasDirectives.add_directive(self, @own_schema_directives, dir_class, options)
end

.schema_directivesObject



1057
1058
1059
# File 'lib/graphql/schema.rb', line 1057

def schema_directives
  Member::HasDirectives.get_directives(self, @own_schema_directives, :schema_directives)
end

.static_validatorObject



320
321
322
# File 'lib/graphql/schema.rb', line 320

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

.subscription(new_subscription_object = nil) ⇒ Object



454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/graphql/schema.rb', line 454

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, deprecation_warning: true) ⇒ Object



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

def subscription_execution_strategy(new_subscription_execution_strategy = nil, deprecation_warning: true)
  if deprecation_warning
    warn "GraphQL::Schema.subscription_execution_strategy is deprecated without replacement. Use `GraphQL::Query.new` directly to create and execute a custom query instead."
    warn "  #{caller(1, 1).first}"
  end
  if new_subscription_execution_strategy
    @subscription_execution_strategy = new_subscription_execution_strategy
  else
    @subscription_execution_strategy || (superclass.respond_to?(:subscription_execution_strategy) ? superclass.subscription_execution_strategy(deprecation_warning: false) : self.default_execution_strategy)
  end
end

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



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

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

.subscriptions=(new_implementation) ⇒ Object



142
143
144
# File 'lib/graphql/schema.rb', line 142

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



1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'lib/graphql/schema.rb', line 1378

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(context: {}) ⇒ String

Return the GraphQL IDL for the schema

Parameters:

  • context (Hash) (defaults to: {})

Returns:

  • (String)


291
292
293
# File 'lib/graphql/schema.rb', line 291

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

.to_documentGraphQL::Language::Document

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

Returns:

  • (GraphQL::Language::Document)


297
298
299
# File 'lib/graphql/schema.rb', line 297

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}


262
263
264
# File 'lib/graphql/schema.rb', line 262

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

.trace_class(new_class = nil) ⇒ Object



159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/graphql/schema.rb', line 159

def trace_class(new_class = nil)
  if new_class
    # If any modules were already added for `:default`,
    # re-apply them here
    mods = trace_modules_for(:default)
    mods.each { |mod| new_class.include(mod) }
    trace_mode(:default, new_class)
    backtrace_class = Class.new(new_class)
    backtrace_class.include(GraphQL::Backtrace::Trace)
    trace_mode(:default_backtrace, backtrace_class)
  end
  trace_class_for(:default, build: true)
end

.trace_class_for(mode, build: false) ⇒ Class

Return the trace class to use for this mode, looking one up on the superclass if this Schema doesn’t have one defined.

Returns:

  • (Class)

    Return the trace class to use for this mode, looking one up on the superclass if this Schema doesn’t have one defined.



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

def trace_class_for(mode, build: false)
  if (trace_class = own_trace_modes[mode])
    trace_class
  elsif superclass.respond_to?(:trace_class_for) && (trace_class = superclass.trace_class_for(mode, build: false))
    trace_class
  elsif build
    own_trace_modes[mode] = build_trace_mode(mode)
  else
    nil
  end
end

.trace_mode(mode_name, trace_class) ⇒ Object

Configure trace_class to be used whenever context: { trace_mode: mode_name } is requested. default_trace_mode is used when no trace_mode: ... is requested.

When a trace_class is added this way, it will not receive other modules added with trace_with(...) unless trace_mode is explicitly given. (This class will not recieve any default trace modules.)

Subclasses of the schema will use trace_class as a base class for this mode and those subclass also will not receive default tracing modules.

Parameters:

  • mode_name (Symbol)
  • trace_class (Class)

    subclass of GraphQL::Tracing::Trace

Returns:

  • void



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

def trace_mode(mode_name, trace_class)
  own_trace_modes[mode_name] = trace_class
  nil
end

.trace_modules_for(trace_mode) ⇒ Array<Module>

Returns Modules added for tracing in trace_mode, including inherited ones.

Returns:

  • (Array<Module>)

    Modules added for tracing in trace_mode, including inherited ones



250
251
252
253
254
255
256
# File 'lib/graphql/schema.rb', line 250

def trace_modules_for(trace_mode)
  modules = own_trace_modules[trace_mode]
  if superclass.respond_to?(:trace_modules_for)
    modules += superclass.trace_modules_for(trace_mode)
  end
  modules
end

.trace_options_for(mode) ⇒ Hash

The options hash for this trace mode

Returns:

  • (Hash)


1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
# File 'lib/graphql/schema.rb', line 1217

def trace_options_for(mode)
  @trace_options_for_mode ||= {}
  @trace_options_for_mode[mode] ||= begin
    # It may be time to create an options hash for a mode that wasn't registered yet.
    # Mix in the default options in that case.
    default_options = mode == :default ? EMPTY_HASH : trace_options_for(:default)
    # Make sure this returns a new object so that other hashes aren't modified later
    if superclass.respond_to?(:trace_options_for)
      superclass.trace_options_for(mode).merge(default_options)
    else
      default_options.dup
    end
  end
end

.trace_with(trace_mod, mode: :default, **options) ⇒ void

This method returns an undefined value.

Mix trace_mod into this schema’s Trace class so that its methods will be called at runtime.

Parameters:

  • trace_mod (Module)

    A module that implements tracing methods

  • mode (Symbol) (defaults to: :default)

    Trace module will only be used for this trade mode

  • options (Hash)

    Keywords that will be passed to the tracing class during #initialize



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
# File 'lib/graphql/schema.rb', line 1187

def trace_with(trace_mod, mode: :default, **options)
  if mode.is_a?(Array)
    mode.each { |m| trace_with(trace_mod, mode: m, **options) }
  else
    tc = own_trace_modes[mode] ||= build_trace_mode(mode)
    tc.include(trace_mod)
    own_trace_modules[mode] << trace_mod
    add_trace_options_for(mode, options)
    if mode == :default
      # This module is being added as a default tracer. If any other mode classes
      # have already been created, but get their default behavior from a superclass,
      # Then mix this into this schema's subclass.
      # (But don't mix it into mode classes that aren't default-based.)
      own_trace_modes.each do |other_mode_name, other_mode_class|
        if other_mode_class < DefaultTraceClass
          # Don't add it back to the inheritance tree if it's already there
          if !(other_mode_class < trace_mod)
            other_mode_class.include(trace_mod)
          end
          # Add any options so they'll be available
          add_trace_options_for(other_mode_name, options)
        end
      end
    end
  end
  nil
end

.tracer(new_tracer, silence_deprecation_warning: false) ⇒ Object



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
# File 'lib/graphql/schema.rb', line 1163

def tracer(new_tracer, silence_deprecation_warning: false)
  if !silence_deprecation_warning
    warn("`Schema.tracer(#{new_tracer.inspect})` is deprecated; use module-based `trace_with` instead. See: https://graphql-ruby.org/queries/tracing.html")
    warn "  #{caller(1, 1).first}"
  end
  default_trace = trace_class_for(:default, build: true)
  if default_trace.nil? || !(default_trace < GraphQL::Tracing::CallLegacyTracers)
    trace_with(GraphQL::Tracing::CallLegacyTracers)
  end

  own_tracers << new_tracer
end

.tracersObject



1176
1177
1178
# File 'lib/graphql/schema.rb', line 1176

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

.type_error(type_error, ctx) ⇒ Object



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
# File 'lib/graphql/schema.rb', line 1096

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



581
582
583
584
# File 'lib/graphql/schema.rb', line 581

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.instance) ⇒ 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:



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/graphql/schema.rb', line 340

def types(context = GraphQL::Query::NullContext.instance)
  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



1092
1093
1094
# File 'lib/graphql/schema.rb', line 1092

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



1076
1077
1078
# File 'lib/graphql/schema.rb', line 1076

def unauthorized_object(unauthorized_error)
  nil
end

.union_memberships(type = nil) ⇒ Object



532
533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'lib/graphql/schema.rb', line 532

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



324
325
326
327
328
329
330
331
# File 'lib/graphql/schema.rb', line 324

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)


777
778
779
# File 'lib/graphql/schema.rb', line 777

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:



716
717
718
719
720
721
722
723
724
725
726
727
728
# File 'lib/graphql/schema.rb', line 716

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 = query_class.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)


1048
1049
1050
# File 'lib/graphql/schema.rb', line 1048

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