graphql 1.10.1 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/generators/graphql/core.rb +18 -2
- data/lib/generators/graphql/install_generator.rb +36 -6
- data/lib/generators/graphql/loader_generator.rb +1 -0
- data/lib/generators/graphql/mutation_generator.rb +2 -1
- data/lib/generators/graphql/object_generator.rb +54 -9
- data/lib/generators/graphql/relay.rb +63 -0
- data/lib/generators/graphql/relay_generator.rb +21 -0
- data/lib/generators/graphql/templates/base_argument.erb +2 -0
- data/lib/generators/graphql/templates/base_connection.erb +8 -0
- data/lib/generators/graphql/templates/base_edge.erb +8 -0
- data/lib/generators/graphql/templates/base_enum.erb +2 -0
- data/lib/generators/graphql/templates/base_field.erb +2 -0
- data/lib/generators/graphql/templates/base_input_object.erb +2 -0
- data/lib/generators/graphql/templates/base_interface.erb +2 -0
- data/lib/generators/graphql/templates/base_mutation.erb +2 -0
- data/lib/generators/graphql/templates/base_object.erb +2 -0
- data/lib/generators/graphql/templates/base_scalar.erb +2 -0
- data/lib/generators/graphql/templates/base_union.erb +2 -0
- data/lib/generators/graphql/templates/enum.erb +2 -0
- data/lib/generators/graphql/templates/graphql_controller.erb +16 -12
- data/lib/generators/graphql/templates/interface.erb +2 -0
- data/lib/generators/graphql/templates/loader.erb +2 -0
- data/lib/generators/graphql/templates/mutation.erb +2 -0
- data/lib/generators/graphql/templates/mutation_type.erb +2 -0
- data/lib/generators/graphql/templates/node_type.erb +9 -0
- data/lib/generators/graphql/templates/object.erb +3 -1
- data/lib/generators/graphql/templates/query_type.erb +3 -3
- data/lib/generators/graphql/templates/scalar.erb +2 -0
- data/lib/generators/graphql/templates/schema.erb +21 -33
- data/lib/generators/graphql/templates/union.erb +3 -1
- data/lib/generators/graphql/type_generator.rb +1 -1
- data/lib/graphql/analysis/analyze_query.rb +7 -0
- data/lib/graphql/analysis/ast/field_usage.rb +24 -1
- data/lib/graphql/analysis/ast/query_complexity.rb +126 -109
- data/lib/graphql/analysis/ast/visitor.rb +13 -5
- data/lib/graphql/analysis/ast.rb +11 -2
- data/lib/graphql/argument.rb +3 -3
- data/lib/graphql/backtrace/inspect_result.rb +0 -1
- data/lib/graphql/backtrace/legacy_tracer.rb +56 -0
- data/lib/graphql/backtrace/table.rb +34 -3
- data/lib/graphql/backtrace/traced_error.rb +0 -1
- data/lib/graphql/backtrace/tracer.rb +40 -9
- data/lib/graphql/backtrace.rb +28 -19
- data/lib/graphql/backwards_compatibility.rb +2 -1
- data/lib/graphql/base_type.rb +1 -1
- data/lib/graphql/compatibility/execution_specification/specification_schema.rb +2 -2
- data/lib/graphql/compatibility/execution_specification.rb +1 -0
- data/lib/graphql/compatibility/lazy_execution_specification.rb +2 -0
- data/lib/graphql/compatibility/query_parser_specification.rb +2 -0
- data/lib/graphql/compatibility/schema_parser_specification.rb +2 -0
- data/lib/graphql/dataloader/null_dataloader.rb +22 -0
- data/lib/graphql/dataloader/request.rb +19 -0
- data/lib/graphql/dataloader/request_all.rb +19 -0
- data/lib/graphql/dataloader/source.rb +155 -0
- data/lib/graphql/dataloader.rb +308 -0
- data/lib/graphql/define/assign_global_id_field.rb +2 -2
- data/lib/graphql/define/defined_object_proxy.rb +1 -1
- data/lib/graphql/define/instance_definable.rb +34 -4
- data/lib/graphql/define/type_definer.rb +5 -5
- data/lib/graphql/deprecated_dsl.rb +18 -5
- data/lib/graphql/deprecation.rb +9 -0
- data/lib/graphql/directive.rb +4 -4
- data/lib/graphql/enum_type.rb +7 -1
- data/lib/graphql/execution/errors.rb +110 -7
- data/lib/graphql/execution/execute.rb +8 -1
- data/lib/graphql/execution/instrumentation.rb +1 -1
- data/lib/graphql/execution/interpreter/argument_value.rb +28 -0
- data/lib/graphql/execution/interpreter/arguments.rb +88 -0
- data/lib/graphql/execution/interpreter/arguments_cache.rb +103 -0
- data/lib/graphql/execution/interpreter/handles_raw_value.rb +18 -0
- data/lib/graphql/execution/interpreter/resolve.rb +37 -25
- data/lib/graphql/execution/interpreter/runtime.rb +685 -421
- data/lib/graphql/execution/interpreter.rb +42 -13
- data/lib/graphql/execution/lazy.rb +5 -1
- data/lib/graphql/execution/lookahead.rb +25 -110
- data/lib/graphql/execution/multiplex.rb +37 -25
- data/lib/graphql/field.rb +5 -1
- data/lib/graphql/function.rb +4 -0
- data/lib/graphql/input_object_type.rb +6 -0
- data/lib/graphql/integer_decoding_error.rb +17 -0
- data/lib/graphql/integer_encoding_error.rb +18 -2
- data/lib/graphql/interface_type.rb +7 -0
- data/lib/graphql/internal_representation/document.rb +2 -2
- data/lib/graphql/internal_representation/rewrite.rb +1 -1
- data/lib/graphql/internal_representation/scope.rb +2 -2
- data/lib/graphql/internal_representation/visit.rb +2 -2
- data/lib/graphql/introspection/directive_type.rb +8 -4
- data/lib/graphql/introspection/entry_points.rb +2 -2
- data/lib/graphql/introspection/enum_value_type.rb +2 -2
- data/lib/graphql/introspection/field_type.rb +9 -5
- data/lib/graphql/introspection/input_value_type.rb +15 -3
- data/lib/graphql/introspection/introspection_query.rb +6 -92
- data/lib/graphql/introspection/schema_type.rb +4 -4
- data/lib/graphql/introspection/type_type.rb +16 -12
- data/lib/graphql/introspection.rb +96 -0
- data/lib/graphql/invalid_null_error.rb +18 -0
- data/lib/graphql/language/block_string.rb +20 -5
- data/lib/graphql/language/cache.rb +37 -0
- data/lib/graphql/language/document_from_schema_definition.rb +73 -25
- data/lib/graphql/language/lexer.rb +4 -3
- data/lib/graphql/language/lexer.rl +3 -3
- data/lib/graphql/language/nodes.rb +51 -89
- data/lib/graphql/language/parser.rb +552 -530
- data/lib/graphql/language/parser.y +114 -99
- data/lib/graphql/language/printer.rb +7 -2
- data/lib/graphql/language/sanitized_printer.rb +222 -0
- data/lib/graphql/language/token.rb +0 -4
- data/lib/graphql/language/visitor.rb +2 -2
- data/lib/graphql/language.rb +2 -0
- data/lib/graphql/name_validator.rb +2 -7
- data/lib/graphql/object_type.rb +44 -35
- data/lib/graphql/pagination/active_record_relation_connection.rb +14 -1
- data/lib/graphql/pagination/array_connection.rb +2 -2
- data/lib/graphql/pagination/connection.rb +75 -20
- data/lib/graphql/pagination/connections.rb +83 -31
- data/lib/graphql/pagination/relation_connection.rb +34 -14
- data/lib/graphql/parse_error.rb +0 -1
- data/lib/graphql/query/arguments.rb +4 -3
- data/lib/graphql/query/arguments_cache.rb +1 -2
- data/lib/graphql/query/context.rb +42 -7
- data/lib/graphql/query/executor.rb +0 -1
- data/lib/graphql/query/fingerprint.rb +26 -0
- data/lib/graphql/query/input_validation_result.rb +23 -6
- data/lib/graphql/query/literal_input.rb +1 -1
- data/lib/graphql/query/null_context.rb +24 -8
- data/lib/graphql/query/serial_execution/field_resolution.rb +1 -1
- data/lib/graphql/query/serial_execution.rb +1 -0
- data/lib/graphql/query/validation_pipeline.rb +5 -2
- data/lib/graphql/query/variable_validation_error.rb +1 -1
- data/lib/graphql/query/variables.rb +14 -4
- data/lib/graphql/query.rb +68 -13
- data/lib/graphql/railtie.rb +9 -1
- data/lib/graphql/rake_task.rb +12 -9
- data/lib/graphql/relay/array_connection.rb +10 -12
- data/lib/graphql/relay/base_connection.rb +26 -13
- data/lib/graphql/relay/connection_instrumentation.rb +4 -4
- data/lib/graphql/relay/connection_type.rb +1 -1
- data/lib/graphql/relay/edges_instrumentation.rb +0 -1
- data/lib/graphql/relay/mutation.rb +1 -0
- data/lib/graphql/relay/node.rb +3 -0
- data/lib/graphql/relay/range_add.rb +23 -9
- data/lib/graphql/relay/relation_connection.rb +8 -10
- data/lib/graphql/relay/type_extensions.rb +2 -0
- data/lib/graphql/rubocop/graphql/base_cop.rb +36 -0
- data/lib/graphql/rubocop/graphql/default_null_true.rb +43 -0
- data/lib/graphql/rubocop/graphql/default_required_true.rb +43 -0
- data/lib/graphql/rubocop.rb +4 -0
- data/lib/graphql/scalar_type.rb +16 -1
- data/lib/graphql/schema/addition.rb +247 -0
- data/lib/graphql/schema/argument.rb +210 -12
- data/lib/graphql/schema/base_64_encoder.rb +2 -0
- data/lib/graphql/schema/build_from_definition/resolve_map.rb +3 -1
- data/lib/graphql/schema/build_from_definition.rb +213 -86
- data/lib/graphql/schema/default_type_error.rb +2 -0
- data/lib/graphql/schema/directive/deprecated.rb +1 -1
- data/lib/graphql/schema/directive/feature.rb +1 -1
- data/lib/graphql/schema/directive/flagged.rb +57 -0
- data/lib/graphql/schema/directive/include.rb +1 -1
- data/lib/graphql/schema/directive/skip.rb +1 -1
- data/lib/graphql/schema/directive/transform.rb +14 -2
- data/lib/graphql/schema/directive.rb +78 -2
- data/lib/graphql/schema/enum.rb +80 -9
- data/lib/graphql/schema/enum_value.rb +17 -6
- data/lib/graphql/schema/field/connection_extension.rb +46 -30
- data/lib/graphql/schema/field/scope_extension.rb +1 -1
- data/lib/graphql/schema/field.rb +285 -133
- data/lib/graphql/schema/find_inherited_value.rb +4 -1
- data/lib/graphql/schema/finder.rb +5 -5
- data/lib/graphql/schema/input_object.rb +97 -89
- data/lib/graphql/schema/interface.rb +24 -19
- data/lib/graphql/schema/late_bound_type.rb +2 -2
- data/lib/graphql/schema/list.rb +7 -1
- data/lib/graphql/schema/loader.rb +137 -103
- data/lib/graphql/schema/member/accepts_definition.rb +8 -1
- data/lib/graphql/schema/member/base_dsl_methods.rb +15 -19
- data/lib/graphql/schema/member/build_type.rb +14 -7
- data/lib/graphql/schema/member/has_arguments.rb +205 -12
- data/lib/graphql/schema/member/has_ast_node.rb +4 -1
- data/lib/graphql/schema/member/has_deprecation_reason.rb +25 -0
- data/lib/graphql/schema/member/has_directives.rb +98 -0
- data/lib/graphql/schema/member/has_fields.rb +95 -30
- data/lib/graphql/schema/member/has_interfaces.rb +90 -0
- data/lib/graphql/schema/member/has_unresolved_type_error.rb +15 -0
- data/lib/graphql/schema/member/has_validators.rb +31 -0
- data/lib/graphql/schema/member/instrumentation.rb +0 -1
- data/lib/graphql/schema/member/type_system_helpers.rb +3 -3
- data/lib/graphql/schema/member.rb +6 -0
- data/lib/graphql/schema/middleware_chain.rb +1 -1
- data/lib/graphql/schema/mutation.rb +4 -0
- data/lib/graphql/schema/non_null.rb +5 -0
- data/lib/graphql/schema/object.rb +47 -46
- data/lib/graphql/schema/possible_types.rb +9 -4
- data/lib/graphql/schema/printer.rb +16 -34
- data/lib/graphql/schema/relay_classic_mutation.rb +32 -4
- data/lib/graphql/schema/resolver/has_payload_type.rb +34 -4
- data/lib/graphql/schema/resolver.rb +123 -63
- data/lib/graphql/schema/scalar.rb +11 -1
- data/lib/graphql/schema/subscription.rb +57 -21
- data/lib/graphql/schema/timeout.rb +29 -15
- data/lib/graphql/schema/timeout_middleware.rb +3 -1
- data/lib/graphql/schema/type_expression.rb +1 -1
- data/lib/graphql/schema/type_membership.rb +18 -4
- data/lib/graphql/schema/union.rb +41 -1
- data/lib/graphql/schema/unique_within_type.rb +1 -2
- data/lib/graphql/schema/validation.rb +12 -2
- data/lib/graphql/schema/validator/allow_blank_validator.rb +29 -0
- data/lib/graphql/schema/validator/allow_null_validator.rb +26 -0
- data/lib/graphql/schema/validator/exclusion_validator.rb +33 -0
- data/lib/graphql/schema/validator/format_validator.rb +48 -0
- data/lib/graphql/schema/validator/inclusion_validator.rb +35 -0
- data/lib/graphql/schema/validator/length_validator.rb +59 -0
- data/lib/graphql/schema/validator/numericality_validator.rb +82 -0
- data/lib/graphql/schema/validator/required_validator.rb +68 -0
- data/lib/graphql/schema/validator.rb +174 -0
- data/lib/graphql/schema/warden.rb +153 -28
- data/lib/graphql/schema.rb +364 -330
- data/lib/graphql/static_validation/all_rules.rb +1 -0
- data/lib/graphql/static_validation/base_visitor.rb +8 -5
- data/lib/graphql/static_validation/definition_dependencies.rb +0 -1
- data/lib/graphql/static_validation/error.rb +3 -1
- data/lib/graphql/static_validation/literal_validator.rb +51 -26
- data/lib/graphql/static_validation/rules/argument_literals_are_compatible.rb +44 -87
- data/lib/graphql/static_validation/rules/argument_literals_are_compatible_error.rb +22 -6
- data/lib/graphql/static_validation/rules/arguments_are_defined.rb +28 -22
- data/lib/graphql/static_validation/rules/arguments_are_defined_error.rb +4 -2
- data/lib/graphql/static_validation/rules/directives_are_defined.rb +1 -1
- data/lib/graphql/static_validation/rules/fields_will_merge.rb +79 -43
- data/lib/graphql/static_validation/rules/fields_will_merge_error.rb +25 -4
- data/lib/graphql/static_validation/rules/fragments_are_finite.rb +2 -2
- data/lib/graphql/static_validation/rules/input_object_names_are_unique.rb +30 -0
- data/lib/graphql/static_validation/rules/input_object_names_are_unique_error.rb +30 -0
- data/lib/graphql/static_validation/rules/required_arguments_are_present.rb +1 -1
- data/lib/graphql/static_validation/rules/required_input_object_attributes_are_present.rb +6 -7
- data/lib/graphql/static_validation/rules/variable_default_values_are_correctly_typed.rb +9 -10
- data/lib/graphql/static_validation/rules/variable_usages_are_allowed.rb +8 -8
- data/lib/graphql/static_validation/rules/variables_are_used_and_defined.rb +4 -2
- data/lib/graphql/static_validation/validation_context.rb +9 -3
- data/lib/graphql/static_validation/validation_timeout_error.rb +25 -0
- data/lib/graphql/static_validation/validator.rb +42 -8
- data/lib/graphql/static_validation.rb +1 -0
- data/lib/graphql/string_encoding_error.rb +13 -3
- data/lib/graphql/subscriptions/action_cable_subscriptions.rb +118 -19
- data/lib/graphql/subscriptions/broadcast_analyzer.rb +81 -0
- data/lib/graphql/subscriptions/default_subscription_resolve_extension.rb +21 -0
- data/lib/graphql/subscriptions/event.rb +81 -30
- data/lib/graphql/subscriptions/instrumentation.rb +0 -1
- data/lib/graphql/subscriptions/serialize.rb +33 -6
- data/lib/graphql/subscriptions/subscription_root.rb +15 -4
- data/lib/graphql/subscriptions.rb +88 -45
- data/lib/graphql/tracing/active_support_notifications_tracing.rb +2 -1
- data/lib/graphql/tracing/appoptics_tracing.rb +173 -0
- data/lib/graphql/tracing/appsignal_tracing.rb +15 -0
- data/lib/graphql/tracing/new_relic_tracing.rb +1 -12
- data/lib/graphql/tracing/platform_tracing.rb +43 -17
- data/lib/graphql/tracing/prometheus_tracing/graphql_collector.rb +4 -1
- data/lib/graphql/tracing/scout_tracing.rb +11 -0
- data/lib/graphql/tracing/skylight_tracing.rb +1 -1
- data/lib/graphql/tracing/statsd_tracing.rb +42 -0
- data/lib/graphql/tracing.rb +9 -33
- data/lib/graphql/types/big_int.rb +5 -1
- data/lib/graphql/types/int.rb +10 -3
- data/lib/graphql/types/iso_8601_date.rb +3 -3
- data/lib/graphql/types/iso_8601_date_time.rb +25 -10
- data/lib/graphql/types/relay/base_connection.rb +6 -90
- data/lib/graphql/types/relay/base_edge.rb +2 -34
- data/lib/graphql/types/relay/connection_behaviors.rb +156 -0
- data/lib/graphql/types/relay/default_relay.rb +27 -0
- data/lib/graphql/types/relay/edge_behaviors.rb +53 -0
- data/lib/graphql/types/relay/has_node_field.rb +41 -0
- data/lib/graphql/types/relay/has_nodes_field.rb +41 -0
- data/lib/graphql/types/relay/node.rb +2 -4
- data/lib/graphql/types/relay/node_behaviors.rb +15 -0
- data/lib/graphql/types/relay/node_field.rb +2 -20
- data/lib/graphql/types/relay/nodes_field.rb +2 -20
- data/lib/graphql/types/relay/page_info.rb +2 -14
- data/lib/graphql/types/relay/page_info_behaviors.rb +25 -0
- data/lib/graphql/types/relay.rb +11 -3
- data/lib/graphql/types/string.rb +8 -2
- data/lib/graphql/unauthorized_error.rb +2 -2
- data/lib/graphql/union_type.rb +2 -0
- data/lib/graphql/upgrader/member.rb +1 -0
- data/lib/graphql/upgrader/schema.rb +1 -0
- data/lib/graphql/version.rb +1 -1
- data/lib/graphql.rb +65 -31
- data/readme.md +3 -6
- metadata +77 -112
- data/lib/graphql/execution/interpreter/hash_response.rb +0 -46
- data/lib/graphql/literal_validation_error.rb +0 -6
- data/lib/graphql/types/relay/base_field.rb +0 -22
- data/lib/graphql/types/relay/base_interface.rb +0 -29
- data/lib/graphql/types/relay/base_object.rb +0 -26
data/lib/graphql/schema/union.rb
CHANGED
@@ -3,17 +3,25 @@ module GraphQL
|
|
3
3
|
class Schema
|
4
4
|
class Union < GraphQL::Schema::Member
|
5
5
|
extend GraphQL::Schema::Member::AcceptsDefinition
|
6
|
+
extend GraphQL::Schema::Member::HasUnresolvedTypeError
|
6
7
|
|
7
8
|
class << self
|
9
|
+
def inherited(child_class)
|
10
|
+
add_unresolved_type_error(child_class)
|
11
|
+
super
|
12
|
+
end
|
13
|
+
|
8
14
|
def possible_types(*types, context: GraphQL::Query::NullContext, **options)
|
9
15
|
if types.any?
|
10
16
|
types.each do |t|
|
17
|
+
assert_valid_union_member(t)
|
11
18
|
type_memberships << type_membership_class.new(self, t, **options)
|
12
19
|
end
|
13
20
|
else
|
14
21
|
visible_types = []
|
22
|
+
warden = Warden.from_context(context)
|
15
23
|
type_memberships.each do |type_membership|
|
16
|
-
if
|
24
|
+
if warden.visible_type_membership?(type_membership, context)
|
17
25
|
visible_types << type_membership.object_type
|
18
26
|
end
|
19
27
|
end
|
@@ -21,6 +29,10 @@ module GraphQL
|
|
21
29
|
end
|
22
30
|
end
|
23
31
|
|
32
|
+
def all_possible_types
|
33
|
+
type_memberships.map(&:object_type)
|
34
|
+
end
|
35
|
+
|
24
36
|
def to_graphql
|
25
37
|
type_defn = GraphQL::UnionType.new
|
26
38
|
type_defn.name = graphql_name
|
@@ -49,6 +61,34 @@ module GraphQL
|
|
49
61
|
def type_memberships
|
50
62
|
@type_memberships ||= []
|
51
63
|
end
|
64
|
+
|
65
|
+
# Update a type membership whose `.object_type` is a string or late-bound type
|
66
|
+
# so that the type membership's `.object_type` is the given `object_type`.
|
67
|
+
# (This is used for updating the union after the schema as lazily loaded the union member.)
|
68
|
+
# @api private
|
69
|
+
def assign_type_membership_object_type(object_type)
|
70
|
+
assert_valid_union_member(object_type)
|
71
|
+
type_memberships.each { |tm|
|
72
|
+
possible_type = tm.object_type
|
73
|
+
if possible_type.is_a?(String) && (possible_type == object_type.name)
|
74
|
+
# This is a match of Ruby class names, not graphql names,
|
75
|
+
# since strings are used to refer to constants.
|
76
|
+
tm.object_type = object_type
|
77
|
+
elsif possible_type.is_a?(LateBoundType) && possible_type.graphql_name == object_type.graphql_name
|
78
|
+
tm.object_type = object_type
|
79
|
+
end
|
80
|
+
}
|
81
|
+
nil
|
82
|
+
end
|
83
|
+
|
84
|
+
private
|
85
|
+
|
86
|
+
def assert_valid_union_member(type_defn)
|
87
|
+
if type_defn.is_a?(Module) && !type_defn.is_a?(Class)
|
88
|
+
# it's an interface type, defined as a module
|
89
|
+
raise ArgumentError, "Union possible_types can only be object types (not interface types), remove #{type_defn.graphql_name} (#{type_defn.inspect})"
|
90
|
+
end
|
91
|
+
end
|
52
92
|
end
|
53
93
|
end
|
54
94
|
end
|
@@ -27,8 +27,7 @@ module GraphQL
|
|
27
27
|
# @param node_id [String] A unique ID generated by {.encode}
|
28
28
|
# @return [Array<(String, String)>] The type name & value passed to {.encode}
|
29
29
|
def decode(node_id, separator: self.default_id_separator)
|
30
|
-
|
31
|
-
Base64Bp.urlsafe_decode64(node_id).split(separator, 2)
|
30
|
+
GraphQL::Schema::Base64Encoder.decode(node_id).split(separator, 2)
|
32
31
|
end
|
33
32
|
end
|
34
33
|
end
|
@@ -6,6 +6,8 @@ module GraphQL
|
|
6
6
|
# Its {RULES} contain objects that respond to `#call(type)`. Rules are
|
7
7
|
# looked up for given types (by class ancestry), then applied to
|
8
8
|
# the object until an error is returned.
|
9
|
+
#
|
10
|
+
# Remove this in GraphQL-Ruby 2.0 when schema instances are removed.
|
9
11
|
class Validation
|
10
12
|
# Lookup the rules for `object` based on its class,
|
11
13
|
# Then returns an error message or `nil`
|
@@ -133,6 +135,12 @@ module GraphQL
|
|
133
135
|
end
|
134
136
|
}
|
135
137
|
|
138
|
+
DEPRECATED_ARGUMENTS_ARE_OPTIONAL = ->(argument) {
|
139
|
+
if argument.deprecation_reason && argument.type.non_null?
|
140
|
+
"must be optional because it's deprecated"
|
141
|
+
end
|
142
|
+
}
|
143
|
+
|
136
144
|
TYPE_IS_VALID_INPUT_TYPE = ->(type) {
|
137
145
|
outer_type = type.type
|
138
146
|
inner_type = outer_type.respond_to?(:unwrap) ? outer_type.unwrap : nil
|
@@ -195,7 +203,7 @@ module GraphQL
|
|
195
203
|
RESERVED_TYPE_NAME = ->(type) {
|
196
204
|
if type.name.start_with?('__') && !type.introspection?
|
197
205
|
# TODO: make this a hard failure in a later version
|
198
|
-
warn("Name #{type.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
|
206
|
+
GraphQL::Deprecation.warn("Name #{type.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
|
199
207
|
nil
|
200
208
|
else
|
201
209
|
# ok name
|
@@ -205,7 +213,7 @@ module GraphQL
|
|
205
213
|
RESERVED_NAME = ->(named_thing) {
|
206
214
|
if named_thing.name.start_with?('__')
|
207
215
|
# TODO: make this a hard failure in a later version
|
208
|
-
warn("Name #{named_thing.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
|
216
|
+
GraphQL::Deprecation.warn("Name #{named_thing.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
|
209
217
|
nil
|
210
218
|
else
|
211
219
|
# no worries
|
@@ -265,8 +273,10 @@ module GraphQL
|
|
265
273
|
Rules::NAME_IS_STRING,
|
266
274
|
Rules::RESERVED_NAME,
|
267
275
|
Rules::DESCRIPTION_IS_STRING_OR_NIL,
|
276
|
+
Rules.assert_property(:deprecation_reason, String, NilClass),
|
268
277
|
Rules::TYPE_IS_VALID_INPUT_TYPE,
|
269
278
|
Rules::DEFAULT_VALUE_IS_VALID_FOR_TYPE,
|
279
|
+
Rules::DEPRECATED_ARGUMENTS_ARE_OPTIONAL,
|
270
280
|
],
|
271
281
|
GraphQL::BaseType => [
|
272
282
|
Rules::NAME_IS_STRING,
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this to specifically reject values that respond to `.blank?` and respond truthy for that method.
|
7
|
+
#
|
8
|
+
# @example Require a non-empty string for an argument
|
9
|
+
# argument :name, String, required: true, validate: { allow_blank: false }
|
10
|
+
class AllowBlankValidator < Validator
|
11
|
+
def initialize(allow_blank_positional, allow_blank: nil, message: "%{validated} can't be blank", **default_options)
|
12
|
+
@message = message
|
13
|
+
super(**default_options)
|
14
|
+
@allow_blank = allow_blank.nil? ? allow_blank_positional : allow_blank
|
15
|
+
end
|
16
|
+
|
17
|
+
def validate(_object, _context, value)
|
18
|
+
if value.respond_to?(:blank?) && value.blank?
|
19
|
+
if (value.nil? && @allow_null) || @allow_blank
|
20
|
+
# pass
|
21
|
+
else
|
22
|
+
@message
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this to specifically reject or permit `nil` values (given as `null` from GraphQL).
|
7
|
+
#
|
8
|
+
# @example require a non-null value for an argument if it is provided
|
9
|
+
# argument :name, String, required: false, validates: { allow_null: false }
|
10
|
+
class AllowNullValidator < Validator
|
11
|
+
MESSAGE = "%{validated} can't be null"
|
12
|
+
def initialize(allow_null_positional, allow_null: nil, message: MESSAGE, **default_options)
|
13
|
+
@message = message
|
14
|
+
super(**default_options)
|
15
|
+
@allow_null = allow_null.nil? ? allow_null_positional : allow_null
|
16
|
+
end
|
17
|
+
|
18
|
+
def validate(_object, _context, value)
|
19
|
+
if value.nil? && !@allow_null
|
20
|
+
@message
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this to specifically reject values from an argument.
|
7
|
+
#
|
8
|
+
# @example disallow certain values
|
9
|
+
#
|
10
|
+
# argument :favorite_non_prime, Integer, required: true,
|
11
|
+
# validates: { exclusion: { in: [2, 3, 5, 7, ... ]} }
|
12
|
+
#
|
13
|
+
class ExclusionValidator < Validator
|
14
|
+
# @param message [String]
|
15
|
+
# @param in [Array] The values to reject
|
16
|
+
def initialize(message: "%{validated} is reserved", in:, **default_options)
|
17
|
+
# `in` is a reserved word, so work around that
|
18
|
+
@in_list = binding.local_variable_get(:in)
|
19
|
+
@message = message
|
20
|
+
super(**default_options)
|
21
|
+
end
|
22
|
+
|
23
|
+
def validate(_object, _context, value)
|
24
|
+
if permitted_empty_value?(value)
|
25
|
+
# pass
|
26
|
+
elsif @in_list.include?(value)
|
27
|
+
@message
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this to assert that string values match (or don't match) the given RegExp.
|
7
|
+
#
|
8
|
+
# @example requiring input to match a pattern
|
9
|
+
#
|
10
|
+
# argument :handle, String, required: true,
|
11
|
+
# validates: { format: { with: /\A[a-z0-9_]+\Z/ } }
|
12
|
+
#
|
13
|
+
# @example reject inputs that match a pattern
|
14
|
+
#
|
15
|
+
# argument :word_that_doesnt_begin_with_a_vowel, String, required: true,
|
16
|
+
# validates: { format: { without: /\A[aeiou]/ } }
|
17
|
+
#
|
18
|
+
# # It's pretty hard to come up with a legitimate use case for `without:`
|
19
|
+
#
|
20
|
+
class FormatValidator < Validator
|
21
|
+
# @param with [RegExp, nil]
|
22
|
+
# @param without [Regexp, nil]
|
23
|
+
# @param message [String]
|
24
|
+
def initialize(
|
25
|
+
with: nil,
|
26
|
+
without: nil,
|
27
|
+
message: "%{validated} is invalid",
|
28
|
+
**default_options
|
29
|
+
)
|
30
|
+
@with_pattern = with
|
31
|
+
@without_pattern = without
|
32
|
+
@message = message
|
33
|
+
super(**default_options)
|
34
|
+
end
|
35
|
+
|
36
|
+
def validate(_object, _context, value)
|
37
|
+
if permitted_empty_value?(value)
|
38
|
+
# Do nothing
|
39
|
+
elsif value.nil? ||
|
40
|
+
(@with_pattern && !value.match?(@with_pattern)) ||
|
41
|
+
(@without_pattern && value.match?(@without_pattern))
|
42
|
+
@message
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# You can use this to allow certain values for an argument.
|
7
|
+
#
|
8
|
+
# Usually, a {GraphQL::Schema::Enum} is better for this, because it's self-documenting.
|
9
|
+
#
|
10
|
+
# @example only allow certain values for an argument
|
11
|
+
#
|
12
|
+
# argument :favorite_prime, Integer, required: true,
|
13
|
+
# validates: { inclusion: { in: [2, 3, 5, 7, 11, ... ] } }
|
14
|
+
#
|
15
|
+
class InclusionValidator < Validator
|
16
|
+
# @param message [String]
|
17
|
+
# @param in [Array] The values to allow
|
18
|
+
def initialize(in:, message: "%{validated} is not included in the list", **default_options)
|
19
|
+
# `in` is a reserved word, so work around that
|
20
|
+
@in_list = binding.local_variable_get(:in)
|
21
|
+
@message = message
|
22
|
+
super(**default_options)
|
23
|
+
end
|
24
|
+
|
25
|
+
def validate(_object, _context, value)
|
26
|
+
if permitted_empty_value?(value)
|
27
|
+
# pass
|
28
|
+
elsif !@in_list.include?(value)
|
29
|
+
@message
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this to enforce a `.length` restriction on incoming values. It works for both Strings and Lists.
|
7
|
+
#
|
8
|
+
# @example Allow no more than 10 IDs
|
9
|
+
#
|
10
|
+
# argument :ids, [ID], required: true, validates: { length: { maximum: 10 } }
|
11
|
+
#
|
12
|
+
# @example Require three selections
|
13
|
+
#
|
14
|
+
# argument :ice_cream_preferences, [ICE_CREAM_FLAVOR], required: true, validates: { length: { is: 3 } }
|
15
|
+
#
|
16
|
+
class LengthValidator < Validator
|
17
|
+
# @param maximum [Integer]
|
18
|
+
# @param too_long [String] Used when `maximum` is exceeded or value is greater than `within`
|
19
|
+
# @param minimum [Integer]
|
20
|
+
# @param too_short [String] Used with value is less than `minimum` or less than `within`
|
21
|
+
# @param is [Integer] Exact length requirement
|
22
|
+
# @param wrong_length [String] Used when value doesn't match `is`
|
23
|
+
# @param within [Range] An allowed range (becomes `minimum:` and `maximum:` under the hood)
|
24
|
+
# @param message [String]
|
25
|
+
def initialize(
|
26
|
+
maximum: nil, too_long: "%{validated} is too long (maximum is %{count})",
|
27
|
+
minimum: nil, too_short: "%{validated} is too short (minimum is %{count})",
|
28
|
+
is: nil, within: nil, wrong_length: "%{validated} is the wrong length (should be %{count})",
|
29
|
+
message: nil,
|
30
|
+
**default_options
|
31
|
+
)
|
32
|
+
if within && (minimum || maximum)
|
33
|
+
raise ArgumentError, "`length: { ... }` may include `within:` _or_ `minimum:`/`maximum:`, but not both"
|
34
|
+
end
|
35
|
+
# Under the hood, `within` is decomposed into `minimum` and `maximum`
|
36
|
+
@maximum = maximum || (within && within.max)
|
37
|
+
@too_long = message || too_long
|
38
|
+
@minimum = minimum || (within && within.min)
|
39
|
+
@too_short = message || too_short
|
40
|
+
@is = is
|
41
|
+
@wrong_length = message || wrong_length
|
42
|
+
super(**default_options)
|
43
|
+
end
|
44
|
+
|
45
|
+
def validate(_object, _context, value)
|
46
|
+
return if permitted_empty_value?(value) # pass in this case
|
47
|
+
length = value.nil? ? 0 : value.length
|
48
|
+
if @maximum && length > @maximum
|
49
|
+
partial_format(@too_long, { count: @maximum })
|
50
|
+
elsif @minimum && length < @minimum
|
51
|
+
partial_format(@too_short, { count: @minimum })
|
52
|
+
elsif @is && length != @is
|
53
|
+
partial_format(@wrong_length, { count: @is })
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
module GraphQL
|
3
|
+
class Schema
|
4
|
+
class Validator
|
5
|
+
# Use this to assert numerical comparisons hold true for inputs.
|
6
|
+
#
|
7
|
+
# @example Require a number between 0 and 1
|
8
|
+
#
|
9
|
+
# argument :batting_average, Float, required: true, validates: { numericality: { within: 0..1 } }
|
10
|
+
#
|
11
|
+
# @example Require the number 42
|
12
|
+
#
|
13
|
+
# argument :the_answer, Integer, required: true, validates: { numericality: { equal_to: 42 } }
|
14
|
+
#
|
15
|
+
# @example Require a real number
|
16
|
+
#
|
17
|
+
# argument :items_count, Integer, required: true, validates: { numericality: { greater_than_or_equal_to: 0 } }
|
18
|
+
#
|
19
|
+
class NumericalityValidator < Validator
|
20
|
+
# @param greater_than [Integer]
|
21
|
+
# @param greater_than_or_equal_to [Integer]
|
22
|
+
# @param less_than [Integer]
|
23
|
+
# @param less_than_or_equal_to [Integer]
|
24
|
+
# @param equal_to [Integer]
|
25
|
+
# @param other_than [Integer]
|
26
|
+
# @param odd [Boolean]
|
27
|
+
# @param even [Boolean]
|
28
|
+
# @param within [Range]
|
29
|
+
# @param message [String] used for all validation failures
|
30
|
+
def initialize(
|
31
|
+
greater_than: nil, greater_than_or_equal_to: nil,
|
32
|
+
less_than: nil, less_than_or_equal_to: nil,
|
33
|
+
equal_to: nil, other_than: nil,
|
34
|
+
odd: nil, even: nil, within: nil,
|
35
|
+
message: "%{validated} must be %{comparison} %{target}",
|
36
|
+
null_message: Validator::AllowNullValidator::MESSAGE,
|
37
|
+
**default_options
|
38
|
+
)
|
39
|
+
|
40
|
+
@greater_than = greater_than
|
41
|
+
@greater_than_or_equal_to = greater_than_or_equal_to
|
42
|
+
@less_than = less_than
|
43
|
+
@less_than_or_equal_to = less_than_or_equal_to
|
44
|
+
@equal_to = equal_to
|
45
|
+
@other_than = other_than
|
46
|
+
@odd = odd
|
47
|
+
@even = even
|
48
|
+
@within = within
|
49
|
+
@message = message
|
50
|
+
@null_message = null_message
|
51
|
+
super(**default_options)
|
52
|
+
end
|
53
|
+
|
54
|
+
def validate(object, context, value)
|
55
|
+
if permitted_empty_value?(value)
|
56
|
+
# pass in this case
|
57
|
+
elsif value.nil? # @allow_null is handled in the parent class
|
58
|
+
@null_message
|
59
|
+
elsif @greater_than && value <= @greater_than
|
60
|
+
partial_format(@message, { comparison: "greater than", target: @greater_than })
|
61
|
+
elsif @greater_than_or_equal_to && value < @greater_than_or_equal_to
|
62
|
+
partial_format(@message, { comparison: "greater than or equal to", target: @greater_than_or_equal_to })
|
63
|
+
elsif @less_than && value >= @less_than
|
64
|
+
partial_format(@message, { comparison: "less than", target: @less_than })
|
65
|
+
elsif @less_than_or_equal_to && value > @less_than_or_equal_to
|
66
|
+
partial_format(@message, { comparison: "less than or equal to", target: @less_than_or_equal_to })
|
67
|
+
elsif @equal_to && value != @equal_to
|
68
|
+
partial_format(@message, { comparison: "equal to", target: @equal_to })
|
69
|
+
elsif @other_than && value == @other_than
|
70
|
+
partial_format(@message, { comparison: "something other than", target: @other_than })
|
71
|
+
elsif @even && !value.even?
|
72
|
+
(partial_format(@message, { comparison: "even", target: "" })).strip
|
73
|
+
elsif @odd && !value.odd?
|
74
|
+
(partial_format(@message, { comparison: "odd", target: "" })).strip
|
75
|
+
elsif @within && !@within.include?(value)
|
76
|
+
partial_format(@message, { comparison: "within", target: @within })
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module GraphQL
|
4
|
+
class Schema
|
5
|
+
class Validator
|
6
|
+
# Use this validator to require _one_ of the named arguments to be present.
|
7
|
+
# Or, use Arrays of symbols to name a valid _set_ of arguments.
|
8
|
+
#
|
9
|
+
# (This is for specifying mutually exclusive sets of arguments.)
|
10
|
+
#
|
11
|
+
# @example Require exactly one of these arguments
|
12
|
+
#
|
13
|
+
# field :update_amount, IngredientAmount, null: false do
|
14
|
+
# argument :ingredient_id, ID, required: true
|
15
|
+
# argument :cups, Integer, required: false
|
16
|
+
# argument :tablespoons, Integer, required: false
|
17
|
+
# argument :teaspoons, Integer, required: true
|
18
|
+
# validates required: { one_of: [:cups, :tablespoons, :teaspoons] }
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
# @example Require one of these _sets_ of arguments
|
22
|
+
#
|
23
|
+
# field :find_object, Node, null: true do
|
24
|
+
# argument :node_id, ID, required: false
|
25
|
+
# argument :object_type, String, required: false
|
26
|
+
# argument :object_id, Integer, required: false
|
27
|
+
# # either a global `node_id` or an `object_type`/`object_id` pair is required:
|
28
|
+
# validates required: { one_of: [:node_id, [:object_type, :object_id]] }
|
29
|
+
# end
|
30
|
+
#
|
31
|
+
class RequiredValidator < Validator
|
32
|
+
# @param one_of [Symbol, Array<Symbol>] An argument, or a list of arguments, that represents a valid set of inputs for this field
|
33
|
+
# @param message [String]
|
34
|
+
def initialize(one_of:, message: "%{validated} has the wrong arguments", **default_options)
|
35
|
+
@one_of = one_of
|
36
|
+
@message = message
|
37
|
+
super(**default_options)
|
38
|
+
end
|
39
|
+
|
40
|
+
def validate(_object, _context, value)
|
41
|
+
matched_conditions = 0
|
42
|
+
|
43
|
+
@one_of.each do |one_of_condition|
|
44
|
+
case one_of_condition
|
45
|
+
when Symbol
|
46
|
+
if value.key?(one_of_condition)
|
47
|
+
matched_conditions += 1
|
48
|
+
end
|
49
|
+
when Array
|
50
|
+
if one_of_condition.all? { |k| value.key?(k) }
|
51
|
+
matched_conditions += 1
|
52
|
+
break
|
53
|
+
end
|
54
|
+
else
|
55
|
+
raise ArgumentError, "Unknown one_of condition: #{one_of_condition.inspect}"
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
if matched_conditions == 1
|
60
|
+
nil # OK
|
61
|
+
else
|
62
|
+
@message
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|