Class: GraphQL::Schema
- Inherits:
-
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)
Schemas can specify how queries should be executed against them.
query_execution_strategy
, mutation_execution_strategy
and subscription_execution_strategy
each apply to corresponding root types.
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
#ast_node
Class Method Summary
collapse
-
.add_subscription_extension_if_necessary ⇒ Object
private
-
.after_any_lazies(maybe_lazies) ⇒ Object
private
Return a lazy if any of maybe_lazies
are lazy, otherwise, call the block eagerly and return the result.
-
.after_lazy(value, &block) ⇒ Object
private
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
).
-
.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
-
.build_trace_mode(mode) ⇒ Object
-
.context_class(new_context_class = nil) ⇒ Object
-
.count_introspection_fields ⇒ Object
-
.cursor_encoder(new_encoder = nil) ⇒ Object
-
.default_analysis_engine ⇒ Object
-
.default_directives ⇒ Object
-
.default_execution_strategy ⇒ Object
-
.default_logger(new_default_logger = NOT_CONFIGURED) ⇒ Object
-
.default_max_page_size(new_default_max_page_size = nil) ⇒ Object
-
.default_page_size(new_default_page_size = nil) ⇒ Object
-
.default_trace_mode(new_mode = nil) ⇒ Object
-
.deprecated_graphql_definition ⇒ Object
-
.description(new_description = nil) ⇒ String?
-
.directive(new_directive) ⇒ Object
Attach a single directive to this schema.
-
.directives(*new_directives) ⇒ Object
Add several directives at once.
-
.disable_introspection_entry_points ⇒ Object
-
.disable_introspection_entry_points? ⇒ Boolean
-
.disable_schema_introspection_entry_point ⇒ Object
-
.disable_schema_introspection_entry_point? ⇒ Boolean
-
.disable_type_introspection_entry_point ⇒ Object
-
.disable_type_introspection_entry_point? ⇒ Boolean
-
.error_handlers ⇒ Object
-
.execute(query_str = nil, **kwargs) ⇒ Hash
Execute a query on itself.
-
.extra_types(*new_extra_types) ⇒ Array<Module>
Type definitions added to this schema.
-
.find(path) ⇒ Object
-
.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.
-
.from_introspection(introspection_result) ⇒ Class<GraphQL::Schema>
Create schema with the result of an introspection query.
-
.get_field(type_or_name, field_name, context = GraphQL::Query::NullContext.instance) ⇒ Object
-
.get_fields(type, context = GraphQL::Query::NullContext.instance) ⇒ Object
-
.get_type(type_name, context = GraphQL::Query::NullContext.instance) ⇒ Module?
A type, or nil if there’s no type called type_name
.
-
.handle_or_reraise(context, err) ⇒ Object
private
-
.has_defined_type?(type_name) ⇒ Boolean
Does this schema have any definition for a type named type_name
, regardless of visibility?.
-
.id_from_object(object, type, ctx) ⇒ Object
-
.inherited(child_class) ⇒ Object
rubocop:enable Lint/DuplicateMethods.
-
.instrument(instrument_step, instrumenter, options = {}) ⇒ Object
-
.instrumenters ⇒ Object
-
.interpreter? ⇒ Boolean
-
.introspection(new_introspection_namespace = nil) ⇒ Object
-
.introspection_system ⇒ Object
-
.lazy?(obj) ⇒ Boolean
True if this object should be lazily resolved.
-
.lazy_method_name(obj) ⇒ Symbol?
The method name to lazily resolve obj
, or nil if obj
’s class wasn’t registered with #lazy_resolve.
-
.lazy_resolve(lazy_class, value_method) ⇒ Object
-
.multiplex(queries, **kwargs) ⇒ Array<Hash>
Execute several queries on itself, concurrently.
-
.multiplex_analyzer(new_analyzer) ⇒ Object
-
.multiplex_analyzers ⇒ Object
-
.mutation(new_mutation_object = nil) ⇒ Object
-
.mutation_execution_strategy(new_mutation_execution_strategy = nil) ⇒ Object
-
.new_connections? ⇒ Boolean
-
.new_trace(mode: nil, **options) ⇒ Tracing::Trace
Create a trace instance which will include the trace modules specified for the optional mode.
-
.object_from_id(node_id, ctx) ⇒ Object
-
.orphan_types(*new_orphan_types) ⇒ Object
-
.own_trace_modes ⇒ Object
-
.own_trace_modules ⇒ Object
-
.parse_error(parse_err, ctx) ⇒ Object
A function to call when #execute receives an invalid query string.
-
.plugins ⇒ Object
-
.possible_types(type = nil, context = GraphQL::Query::NullContext.instance) ⇒ Hash<String, Module>, Array<Module>
-
.query(new_query_object = nil) ⇒ Object
-
.query_analyzer(new_analyzer) ⇒ Object
-
.query_analyzers ⇒ Object
-
.query_class(new_query_class = NOT_CONFIGURED) ⇒ Object
-
.query_execution_strategy(new_query_execution_strategy = nil) ⇒ Object
-
.query_stack_error(query, err) ⇒ Object
-
.references_to(to_type = nil, from: nil) ⇒ Object
-
.rescue_from(*err_classes, &handler_block) ⇒ Object
-
.resolve_type(type, obj, ctx) ⇒ Object
-
.root_type_for_operation(operation) ⇒ GraphQL::ObjectType?
-
.root_types ⇒ Object
-
.sanitized_printer(new_sanitized_printer = nil) ⇒ Object
-
.schema_directive(dir_class, **options) ⇒ Object
-
.schema_directives ⇒ Object
-
.static_validator ⇒ Object
-
.subscription(new_subscription_object = nil) ⇒ Object
-
.subscription_execution_strategy(new_subscription_execution_strategy = nil) ⇒ Object
-
.subscriptions(inherited: true) ⇒ GraphQL::Subscriptions
-
.subscriptions=(new_implementation) ⇒ Object
-
.sync_lazy(value) ⇒ Object
private
Override this method to handle lazy objects in a custom way.
-
.to_definition(context: {}) ⇒ String
Return the GraphQL IDL for the schema.
-
.to_document ⇒ GraphQL::Language::Document
Return the GraphQL::Language::Document IDL AST for the schema.
-
.to_json(**args) ⇒ String
-
.trace_class(new_class = nil) ⇒ Object
-
.trace_class_for(mode, build: true) ⇒ Class
Return the trace class to use for this mode, looking one up on the superclass if this Schema doesn’t have one defined.
-
.trace_mode(mode_name, trace_class) ⇒ Object
Configure trace_class
to be used whenever context: { trace_mode: mode_name }
is requested.
-
.trace_modules_for(trace_mode) ⇒ Array<Module>
Modules added for tracing in trace_mode
, including inherited ones.
-
.trace_options_for(mode) ⇒ Hash
The options hash for this trace mode.
-
.trace_with(trace_mod, mode: :default, **options) ⇒ void
Mix trace_mod
into this schema’s Trace
class so that its methods will be called at runtime.
-
.tracer(new_tracer) ⇒ Object
-
.tracers ⇒ Object
-
.type_error(type_error, ctx) ⇒ Object
-
.type_from_ast(ast_node, context: nil) ⇒ Object
-
.types(context = GraphQL::Query::NullContext.instance) ⇒ Hash<String => Class>
Build a map of { name => type }
and return it.
-
.unauthorized_field(unauthorized_error) ⇒ Field
This hook is called when a field fails an authorized?
check.
-
.unauthorized_object(unauthorized_error) ⇒ Object
This hook is called when an object fails an authorized?
check.
-
.union_memberships(type = nil) ⇒ Object
-
.use(plugin, **kwargs) ⇒ Object
-
.using_ast_analysis? ⇒ Boolean
-
.validate(string_or_document, rules: nil, context: nil) ⇒ Array<GraphQL::StaticValidation::Error >
Validate a query string according to this schema.
-
.visible?(member, ctx) ⇒ Boolean
inherited
Class Attribute Details
.analysis_engine ⇒ Object
730
731
732
|
# File 'lib/graphql/schema.rb', line 730
def analysis_engine
@analysis_engine || find_inherited_value(:analysis_engine, self.default_analysis_engine)
end
|
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
# File 'lib/graphql/schema.rb', line 396
def connections
if defined?(@connections)
@connections
else
inherited_connections = find_inherited_value(:connections, nil)
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.
.error_bubbling(new_error_bubbling = nil) ⇒ Object
744
745
746
747
748
749
750
751
|
# File 'lib/graphql/schema.rb', line 744
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
Sets the attribute interpreter
742
743
744
|
# File 'lib/graphql/schema.rb', line 742
def interpreter=(value)
@interpreter = value
end
|
.max_complexity(max_complexity = nil) ⇒ Object
718
719
720
721
722
723
724
725
726
|
# File 'lib/graphql/schema.rb', line 718
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, count_introspection_fields: true) ⇒ Object
757
758
759
760
761
762
763
764
765
766
|
# File 'lib/graphql/schema.rb', line 757
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
706
707
708
709
710
711
712
713
714
|
# File 'lib/graphql/schema.rb', line 706
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
669
670
671
672
673
674
675
676
677
|
# File 'lib/graphql/schema.rb', line 669
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_class ⇒ Object
477
478
479
480
481
482
483
484
485
|
# File 'lib/graphql/schema.rb', line 477
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_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.
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
|
# File 'lib/graphql/schema.rb', line 1276
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.
1335
1336
1337
1338
1339
1340
1341
1342
1343
|
# File 'lib/graphql/schema.rb', line 1335
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
)
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
|
# File 'lib/graphql/schema.rb', line 1295
def after_lazy(value, &block)
if lazy?(value)
GraphQL::Execution::Lazy.new do
result = sync_lazy(value)
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
265
266
267
268
269
270
271
272
273
274
275
|
# File 'lib/graphql/schema.rb', line 265
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
# File 'lib/graphql/schema.rb', line 205
def build_trace_mode(mode)
case mode
when :default
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)
Class.new(schema_base_class) do
include(GraphQL::Backtrace::Trace)
end
else
base_class = (superclass.respond_to?(:trace_class_for) && superclass.trace_class_for(mode, build: false)) || trace_class_for(:default)
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
Class.new(base_class) do
mods.any? && include(*mods)
end
end
end
|
.context_class(new_context_class = nil) ⇒ Object
893
894
895
896
897
898
899
|
# File 'lib/graphql/schema.rb', line 893
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_fields ⇒ Object
768
769
770
771
772
773
774
|
# File 'lib/graphql/schema.rb', line 768
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
620
621
622
623
624
625
|
# File 'lib/graphql/schema.rb', line 620
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
865
866
867
868
869
870
871
|
# File 'lib/graphql/schema.rb', line 865
def default_analysis_engine
if superclass <= GraphQL::Schema
superclass.default_analysis_engine
else
@default_analysis_engine ||= GraphQL::Analysis::AST
end
end
|
.default_execution_strategy ⇒ Object
857
858
859
860
861
862
863
|
# File 'lib/graphql/schema.rb', line 857
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
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
|
# File 'lib/graphql/schema.rb', line 873
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! 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
627
628
629
630
631
632
633
|
# File 'lib/graphql/schema.rb', line 627
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
635
636
637
638
639
640
641
|
# File 'lib/graphql/schema.rb', line 635
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
151
152
153
154
155
156
157
158
159
160
161
|
# File 'lib/graphql/schema.rb', line 151
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_definition ⇒ Object
137
138
139
|
# File 'lib/graphql/schema.rb', line 137
def deprecated_graphql_definition
graphql_definition(silence_deprecation_warning: true)
end
|
.description(new_description = nil) ⇒ String?
291
292
293
294
295
296
297
298
299
|
# File 'lib/graphql/schema.rb', line 291
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
1095
1096
1097
|
# File 'lib/graphql/schema.rb', line 1095
def directive(new_directive)
add_type_and_traverse(new_directive, root: false)
end
|
.directives(*new_directives) ⇒ Object
Add several directives at once
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
|
# File 'lib/graphql/schema.rb', line 1079
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_points ⇒ Object
776
777
778
779
780
|
# File 'lib/graphql/schema.rb', line 776
def disable_introspection_entry_points
@disable_introspection_entry_points = true
@introspection_system = nil
end
|
.disable_introspection_entry_points? ⇒ Boolean
794
795
796
797
798
799
800
|
# File 'lib/graphql/schema.rb', line 794
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
782
783
784
785
786
|
# File 'lib/graphql/schema.rb', line 782
def disable_schema_introspection_entry_point
@disable_schema_introspection_entry_point = true
@introspection_system = nil
end
|
.disable_schema_introspection_entry_point? ⇒ Boolean
802
803
804
805
806
807
808
|
# File 'lib/graphql/schema.rb', line 802
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
788
789
790
791
792
|
# File 'lib/graphql/schema.rb', line 788
def disable_type_introspection_entry_point
@disable_type_introspection_entry_point = true
@introspection_system = nil
end
|
.disable_type_introspection_entry_point? ⇒ Boolean
810
811
812
813
814
815
816
|
# File 'lib/graphql/schema.rb', line 810
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
915
916
917
918
919
920
921
|
# File 'lib/graphql/schema.rb', line 915
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.
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
|
# File 'lib/graphql/schema.rb', line 1224
def execute(query_str = nil, **kwargs)
if query_str
kwargs[:query] = query_str
end
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
all_results = multiplex([kwargs], max_complexity: nil, context: multiplex_context)
all_results[0]
end
|
Returns Type definitions added to this schema.
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
|
# File 'lib/graphql/schema.rb', line 820
def (*)
if .any?
= .flatten
@own_extra_types ||= []
@own_extra_types.concat()
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
301
302
303
304
305
306
307
|
# File 'lib/graphql/schema.rb', line 301
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.
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
# File 'lib/graphql/schema.rb', line 116
def from_definition(definition_or_path, default_resolve: nil, parser: GraphQL.default_parser, using: {})
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.
106
107
108
|
# File 'lib/graphql/schema.rb', line 106
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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
|
# File 'lib/graphql/schema.rb', line 575
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
598
599
600
|
# File 'lib/graphql/schema.rb', line 598
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
.
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
# File 'lib/graphql/schema.rb', line 356
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] || (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.
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
|
# File 'lib/graphql/schema.rb', line 924
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?.
388
389
390
|
# File 'lib/graphql/schema.rb', line 388
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
990
991
992
|
# File 'lib/graphql/schema.rb', line 990
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
972
973
974
975
976
977
978
979
980
981
982
983
984
|
# File 'lib/graphql/schema.rb', line 972
def inherited(child_class)
if self == GraphQL::Schema
child_class.directives(default_directives.values)
child_class.extend(SubclassGetReferencesTo)
end
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
1067
1068
1069
1070
1071
1072
1073
1074
1075
|
# File 'lib/graphql/schema.rb', line 1067
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
|
.instrumenters ⇒ Object
1268
1269
1270
1271
1272
1273
|
# File 'lib/graphql/schema.rb', line 1268
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
738
739
740
|
# File 'lib/graphql/schema.rb', line 738
def interpreter?
true
end
|
.introspection(new_introspection_namespace = nil) ⇒ Object
602
603
604
605
606
607
608
609
610
|
# File 'lib/graphql/schema.rb', line 602
def introspection(new_introspection_namespace = nil)
if new_introspection_namespace
@introspection = new_introspection_namespace
@introspection_system = nil
else
@introspection || find_inherited_value(:introspection)
end
end
|
.introspection_system ⇒ Object
612
613
614
615
616
617
618
|
# File 'lib/graphql/schema.rb', line 612
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.
1327
1328
1329
|
# File 'lib/graphql/schema.rb', line 1327
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.
1322
1323
1324
|
# File 'lib/graphql/schema.rb', line 1322
def lazy_method_name(obj)
lazy_methods.get(obj)
end
|
.lazy_resolve(lazy_class, value_method) ⇒ Object
1063
1064
1065
|
# File 'lib/graphql/schema.rb', line 1063
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.
.multiplex_analyzer(new_analyzer) ⇒ Object
1205
1206
1207
|
# File 'lib/graphql/schema.rb', line 1205
def multiplex_analyzer(new_analyzer)
own_multiplex_analyzers << new_analyzer
end
|
.multiplex_analyzers ⇒ Object
1209
1210
1211
|
# File 'lib/graphql/schema.rb', line 1209
def multiplex_analyzers
find_inherited_value(:multiplex_analyzers, EMPTY_ARRAY) + own_multiplex_analyzers
end
|
.mutation(new_mutation_object = nil) ⇒ Object
429
430
431
432
433
434
435
436
437
438
439
440
441
|
# File 'lib/graphql/schema.rb', line 429
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
651
652
653
654
655
656
657
|
# File 'lib/graphql/schema.rb', line 651
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
411
412
413
|
# File 'lib/graphql/schema.rb', line 411
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.
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
|
# File 'lib/graphql/schema.rb', line 1174
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)
:default_backtrace
end
else
default_trace_mode
end
base_trace_options = trace_options_for(trace_mode)
trace_options = base_trace_options.merge(options)
trace_class_for_mode = trace_class_for(trace_mode) || raise(ArgumentError, "#{self} has no trace class for mode: #{trace_mode.inspect}")
trace_class_for_mode.new(**trace_options)
end
|
.object_from_id(node_id, ctx) ⇒ Object
986
987
988
|
# File 'lib/graphql/schema.rb', line 986
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
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
|
# File 'lib/graphql/schema.rb', line 838
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
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_modes ⇒ Object
196
197
198
|
# File 'lib/graphql/schema.rb', line 196
def own_trace_modes
@own_trace_modes ||= {}
end
|
.own_trace_modules ⇒ Object
234
235
236
|
# File 'lib/graphql/schema.rb', line 234
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
1059
1060
1061
|
# File 'lib/graphql/schema.rb', line 1059
def parse_error(parse_err, ctx)
ctx.errors.push(parse_err)
end
|
322
323
324
|
# File 'lib/graphql/schema.rb', line 322
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>
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
|
# File 'lib/graphql/schema.rb', line 492
def possible_types(type = nil, context = GraphQL::Query::NullContext.instance)
if type
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
415
416
417
418
419
420
421
422
423
424
425
426
427
|
# File 'lib/graphql/schema.rb', line 415
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
1197
1198
1199
|
# File 'lib/graphql/schema.rb', line 1197
def query_analyzer(new_analyzer)
own_query_analyzers << new_analyzer
end
|
.query_analyzers ⇒ Object
1201
1202
1203
|
# File 'lib/graphql/schema.rb', line 1201
def query_analyzers
find_inherited_value(:query_analyzers, EMPTY_ARRAY) + own_query_analyzers
end
|
.query_class(new_query_class = NOT_CONFIGURED) ⇒ Object
696
697
698
699
700
701
702
|
# File 'lib/graphql/schema.rb', line 696
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) ⇒ Object
643
644
645
646
647
648
649
|
# File 'lib/graphql/schema.rb', line 643
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
1287
1288
1289
|
# File 'lib/graphql/schema.rb', line 1287
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
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
# File 'lib/graphql/schema.rb', line 544
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
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
901
902
903
904
905
|
# File 'lib/graphql/schema.rb', line 901
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
967
968
969
|
# File 'lib/graphql/schema.rb', line 967
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?
460
461
462
463
464
465
466
467
468
469
470
471
|
# File 'lib/graphql/schema.rb', line 460
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
473
474
475
|
# File 'lib/graphql/schema.rb', line 473
def root_types
@root_types
end
|
.sanitized_printer(new_sanitized_printer = nil) ⇒ Object
1213
1214
1215
1216
1217
1218
1219
|
# File 'lib/graphql/schema.rb', line 1213
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
998
999
1000
1001
|
# File 'lib/graphql/schema.rb', line 998
def schema_directive(dir_class, **options)
@own_schema_directives ||= []
Member::HasDirectives.add_directive(self, @own_schema_directives, dir_class, options)
end
|
.schema_directives ⇒ Object
1003
1004
1005
|
# File 'lib/graphql/schema.rb', line 1003
def schema_directives
Member::HasDirectives.get_directives(self, @own_schema_directives, :schema_directives)
end
|
.subscription(new_subscription_object = nil) ⇒ Object
443
444
445
446
447
448
449
450
451
452
453
454
455
456
|
# File 'lib/graphql/schema.rb', line 443
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
659
660
661
662
663
664
665
|
# File 'lib/graphql/schema.rb', line 659
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
|
142
143
144
|
# File 'lib/graphql/schema.rb', line 142
def subscriptions(inherited: true)
defined?(@subscriptions) ? @subscriptions : (inherited ? find_inherited_value(:subscriptions, nil) : nil)
end
|
.subscriptions=(new_implementation) ⇒ Object
146
147
148
|
# File 'lib/graphql/schema.rb', line 146
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.
1311
1312
1313
1314
1315
1316
1317
1318
1319
|
# File 'lib/graphql/schema.rb', line 1311
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
.to_document ⇒ GraphQL::Language::Document
Return the GraphQL::Language::Document IDL AST for the schema
.to_json(**args) ⇒ String
251
252
253
|
# File 'lib/graphql/schema.rb', line 251
def to_json(**args)
JSON.pretty_generate(as_json(**args))
end
|
.trace_class(new_class = nil) ⇒ Object
163
164
165
166
167
168
169
170
171
|
# File 'lib/graphql/schema.rb', line 163
def trace_class(new_class = nil)
if new_class
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)
end
|
.trace_class_for(mode, build: true) ⇒ 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
|
# File 'lib/graphql/schema.rb', line 174
def trace_class_for(mode, build: true)
own_trace_modes[mode] ||
(superclass.respond_to?(:trace_class_for) ? superclass.trace_class_for(mode, build: build) : (build ? (own_trace_modes[mode] = build_trace_mode(mode)) : nil))
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.
191
192
193
194
|
# File 'lib/graphql/schema.rb', line 191
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.
239
240
241
242
243
244
245
|
# File 'lib/graphql/schema.rb', line 239
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
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
|
# File 'lib/graphql/schema.rb', line 1156
def trace_options_for(mode)
@trace_options_for_mode ||= {}
@trace_options_for_mode[mode] ||= begin
if superclass.respond_to?(:trace_options_for)
superclass.trace_options_for(mode).dup
else
{}
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.
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
|
# File 'lib/graphql/schema.rb', line 1129
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
if mode == :default
own_trace_modes.each do |other_mode_name, other_mode_class|
if other_mode_class < DefaultTraceClass && !(other_mode_class < trace_mod)
other_mode_class.include(trace_mod)
end
end
end
t_opts = trace_options_for(mode)
t_opts.merge!(options)
end
nil
end
|
1118
1119
1120
|
# File 'lib/graphql/schema.rb', line 1118
def tracers
find_inherited_value(:tracers, EMPTY_ARRAY) + own_tracers
end
|
.type_error(type_error, ctx) ⇒ Object
.type_from_ast(ast_node, context: nil) ⇒ Object
570
571
572
573
|
# File 'lib/graphql/schema.rb', line 570
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
# File 'lib/graphql/schema.rb', line 329
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.
1038
1039
1040
|
# File 'lib/graphql/schema.rb', line 1038
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.
1022
1023
1024
|
# File 'lib/graphql/schema.rb', line 1022
def unauthorized_object(unauthorized_error)
nil
end
|
.union_memberships(type = nil) ⇒ Object
521
522
523
524
525
526
527
528
529
530
531
532
533
534
|
# File 'lib/graphql/schema.rb', line 521
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
313
314
315
316
317
318
319
320
|
# File 'lib/graphql/schema.rb', line 313
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
734
735
736
|
# File 'lib/graphql/schema.rb', line 734
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.
682
683
684
685
686
687
688
689
690
691
692
693
694
|
# File 'lib/graphql/schema.rb', line 682
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
994
995
996
|
# File 'lib/graphql/schema.rb', line 994
def visible?(member, ctx)
member.visible?(ctx)
end
|