Changelog
Breaking changes
Deprecations
New features
Bug fixes
2.1.3 (12 Oct 2023)
Bug fixes
- Tracing: fix legacy tracers added to
GraphQL::Schema
#4663 - Add
racc
as a dependency because it's not included by default in Ruby 3.3 #4661
2.1.2 (11 Oct 2023)
New features
- Depth: accept
count_introspection_fields: false
#4658 - Dataloader: add
get_fiber_variables
andset_fiber_variables
#4593 - Trace: Add
Schema.default_trace_mode
#4642
Bug fixes
- Fix merging results after calling directives #4639 #4660
- Visibility: don't reveal implementors of hidden abstract types #4589
- Bump required Ruby version to 2.7 since numbered block arguments are used #4659
hash_key:
: use the configured hash key when the underlying Hash has a default value Proc #4656
2.1.1 (2 Oct 2023)
New features
- Mutations:
HasSingleInput
provides Relay Classic-likeinput: ...
argument behavior #4581 - Add
@specifiedBy
default directive #4633 - Analysis: support
visit?
hook to skip visit but still return a value - Add
context.scoped
for a long-lived reference to the current scoped context #4605
Bug fixes
- Sanitized printer: Correctly print enum variable defaults #4652
- Schema printer: use
extend schema
when the schema has directives #4647 - Performance: pass runtime state through interpreter code #4621
- Performance: add
StaticVisitor
for faster AST visits #4645 - Performance: faster field lookup #4626
- Improve generator templates #4627
- Dataloader: clear cache between root mutation fields #4617
- Performance: Improve argument checks #4622
- Remove unused legacy connection code #4606
2.1.0 (30 Aug 2023)
Breaking changes
- Visitor: legacy-style proc-based visitors are no longer supported #4577 #4583
- Deprecated
GraphQL::Filter
is removed #4325 - Language::Printer has been re-written to append to a buffer; custom printers will need to be updated #4394
New features
- Authorization: Items in a list can skip object-level
.authorized?
checks if the type is configured withreauthorize_scoped_objects(false)
#3994 - Subscriptions:
unsubscribe(...)
accepts a value to be used to return a result along with unsubscribing #4283 - Language::Printer is much faster #4394
2.0.27 (30 Aug 2023)
New features
- Validators: Support
%{value}
in custom messages #4601
Bug fixes
- Resolvers: Support
return false, nil
fromready?
andauthorized?
#4585 - Enums: properly load directives from Schema IDL #4596
- Language: faster scanner #4576
- Language: support fields and arguments named
"null"
#4586 - Language: fix block string quote unescaping #4580
- Generator: use generated node type in Relay-related fields #4598
2.0.26 (8 Aug 2023)
Bug fixes
- Datadog Tracing: fix LocalJumpError #4579
2.0.25 (7 Aug 2023)
New features
- Tracing: add trace modes #4571
- Dataloader: add
Source#result_key_for
for customizing cache keys in sources #4569
Bug fixes
- Tracing: Support multiple tracing platforms at once #4543
2.0.24 (27 Jun 2023)
New features
Schema::Object.wrap
can be used to customize how objects are (or aren't) wrapped byGraphQL::Schema::Object
instances at runtime #4524Query
: accept astatic_validator:
option in#initialize
to use instead of the default validation configuration.
Bug fixes
- Performance: Reduce memory usage when adding types to a schema #4533
- Performance,
Dataloader
: when loading specific keys, only run dataloader until those specific keys are resolved #4519
2.0.23 (19 Jun 2023)
New features
- Printer: print extensions in SDL #4516
- Trace: accept trace instances during query execution #4497
- AlwaysVisible: Make a way to bypass type visibility #4442, #4491
Bug fixes
- Tests: fix assertion for Ruby 3.3.0-dev #4515
- Performance: improve fragment possible type lookup #4506
- Docs: document Timeout can handle floats #4505
- Performance: use a dedicated object for field extension state #4401
- Backtrace: fix
backtrace: true
with other trace modules #4505 - Handle
context.warden
being nil #4503 - Dev: disable Minitest::Reporters for RubyMin #4494
- Trace: fix compatibility with inheritance #4487
- Context: fix NullContext compatibility with fetch, dig and key? #4483
2.0.22 (17 May 2023)
New features
- Warden: manually instantiating doesn't require a
filter
instance #4462
Bug fixes
- Enum: fix procs for enum values #4474
- Lexer: force UTF-8 encoding #4467
- Trace: inherit superclass
trace_options
#4470 - Dataloader: properly run mutations in sequence #4461
- NotificationsTrace: Add
execute_multiplex.graphql
event #4460 - Fix
Context#dig
when called with one key #4458 - Performance: Use a plain hash for selection sets at runtime #4453
- Performance: Memoize current trace #4450, #4452
- Performance: Pass is_non_null to runtime check #4449
- Performance: Use
compare_by_identity
on some runtime caches - Properly support nested queries (fix
Thread.current
clash) #4445
2.0.21 (11 April 2023)
Deprecations
- Deprecate
GraphQL::Filter
(usevisible?
methods instead) #4424
New features
- PrometheusTracing: support histograms #4418
Bug fixes
- Backtrace: improve compatibility with
trace_with
#4437 - Consolidate internally-used empty value constants #4434
- Fix some warnings #4422
- Performance: improve runtime speed #4436 #4433 #4428 #4430 #4427 #4399
- Validation: fix inline fragment selection on scalar #4429
@oneOf
: print definition in the SDL when it's used- SDL: load schema directives when they're used
- Appsignal tracing: Fix
resolve_type
definition
2.0.20 (30 March 2023)
Bug fixes
.resolve_type
: fix returning[Type, false]
from resolve_type #4412- Parsing: improve usage of
GraphQL.default_parser
#4411 - AppsignalTrace: implement missing methods #4390
- Runtime: Fix
current_depth
method in some lazy lists #4386 - Performance: improve
Object
object shape #4365 - Tracing: return execution errors raised from field resolution to
execute_field
hooks #4398
2.0.19 (14 March 2023)
Bug fixes
- Scoped context: fix
context.scoped_context.current_path
#4376 - Tracing: fix
tracer
inheritance in Schema classes #4379 - Timeout: fix
Timeout
plugin when other tracers are used #4383 - Performance: use Arrays instead of
GraphQL::Language::Token
s when scanning #4366
2.0.18 (9 March 2023)
Breaking Changes
- Tracing:
"execute_field"
events on fields defined on interface types will now receive the interface type asdata[:owner]
instead of the current object type. To get the old behavior, usedata[:object].class
instead. #4292
New features
- Add
TypeKind#leaf?
#4352
Bug fixes
- Tracing: use the interface type as
data[:owner]
instead of the object type #4292 - Performance: improve Shape compatibility of
GraphQL::Schema::Field
#4360 - Performance: improve Shape compatibility of
GraphQL::Schema::Warden
#4361 - Performance: rewrite the token scanner in plain Ruby #4369
- Performance: make
deprecation_reason
faster #4356 - Performance: improve lazy value resolution in execution #4333
- Performance: create
current_path
only when the application needs it #4342 - Performance: add
GraphQL::Tracing::Trace
as a lower-overhead tracing API #4344 - Connections: fix
hasNextPage
for already-loaded ActiveRecord Relations #4349
2.0.17.2 (29 March 2023)
Bug fixes
- Unions and Interfaces: support returning
[type_module, false]
fromresolve_type
#4413
2.0.17.1 (27 March 2023)
Bug fixes
- Tracing: restore behavior returning execution errors raised during field resolution #4402
2.0.17 (14 February 2023)
Breaking changes
- Enums: require at least one value in a definition #4278
New features
- Enums: support
nil
as a Ruby value #4311
Bug fixes
- Don't re-encode ASCII strings as UTF-8 #4319, #4343
- Fix
handle_or_reraise
with arguments validation #4341 - Performance: Remove error handling from
Lazy#value
(unused) #4335 - Performance: Use codegen instead of dynamic dispatch in
Language::Visitor
andAnalysis::AST::Visitor
#4338 - Performance: reduce indirection in
#introspection?
and#graphql_name
#4327 - Clean up thread-based state after running queries #4329
- JSON types: don't pass raw NullValue AST nodes to
coerce_input
#4324, #4320 - Performance: reduce
.is_a?
calls at runtime #4318 - Performance: cache interface type memberships #4311
- Performance: eagerly define some type instance variables for Shape friendliness #4300 #4295 #4297
- Performance: reduce argument overhead, don't scope introspection by default, reduce duplicate call to Field#type #4317
- Fix anonymous
eval
usage #4288 - Authorization: fix field auth fail call after lazy #4289
- Subscriptions: fix
loads:
/as:
2.0.16 (19 December 2022)
Breaking changes
Union
: Only accept Object types inpossible_types
(previously, other types were also accepted, but this was against the spec) #4269
New features
- Rake: support introspection query options in the
RakeTask
#4247 - Subscriptions: Merge
.trigger(... context: { ... })
into the query context when running updates #4242
Bug fixes
- Make BaseEdge and subclasses return true for
.default_relay?
#4272 - Validation: return a proper error for duplicate-named fragments when used indirectly #4268
- Don't re-apply
scope_items
tonodes { ... }
oredges { ... }
arrays #4263 - Fix
Concurrent::Map
initialization to prevent race conditions - Speed up scoped context lookup #4245
- Support overriding built-in context keys #4239
- Context: properly
dig
into:current_arguments
#4249
2.0.15 (22 October 2022)
New features
- SDL: support extensions on the schema itself #4203
- SDL: recognize
.graphqls
files in.from_definition
#4204 - Schema: add a reader method of
TypeMembership#options
#4209
Bug fixes
- Node Behaviors: call the id-from-object hook with the type definition, not the type instance #4233
- RelayClassicMutation: add a period to the generated description of the payload type #4229
- Dataloader: make scoped context work with Dataloader #4220
- SDL: fix parsing repeatable directives #4218
- Lookahead: reduce more allocations in
.selects?
#4212 - Introspection Query: strip blank lines from generated query strings #4208
- Enums: Add error handling to result coercion #4206
- Lookahead: add
selected_type:
to.selects?
#4194 - Lookahead: fix
.selects?
on unions #4193 - Fields: use field-local
connection:
config over resolver config #4191
2.0.14 (8 September 2022)
New features
- Input Objects: support
one_of
for input objects that allow exactly one argument #4184 - Dataloader: add
source.merge({ ... })
for adding objects to dataloader source caches #4186 - Validation: generate new schemas with a suggested
validate_max_errors
of 100 #4179
Bug fixes
- Lookahead: improve performance when field names are given as symbols #4189
- Runtime: simplify some internal code #4183
- Datadog tracing: remove deprecated options #4159
2.0.13 (12 August 2022)
New features
- Fields: add configuration methods for
default_value
andprepare
#4156 - Static validation: merge directive errors when they're on the same location or directive
Bug fixes
- Subscriptions: properly use the given
.trigger(... context: )
for determining subscription root field visibility #4160 - Fix fields that use
hash_key:
and have a falsy value for that key #4132 - Variable validation: respect
validate_max_error
limit - Performance: use
Array#+
to add objects during execution #4142
2.0.12 (19 July 2022)
New features
- Support returning
[Type, nil]
fromresolve_type
#4130
Bug fixes
- SDL: Don't print empty braces for input objects with no arguments #4138
- Arguments: always call
prepare
before loading objects based on ID (loads:
) #4128 - Don't support re-assigning
Query#validate=
after validation has run #4127
2.0.11 (20 June 2022)
New features
- Support full unicode range #4090
Bug fixes
- Subscriptions: support overriding subscriptions in subclasses #4108
- Schema: support types with duplicate names and cyclical references #4107
- Connections: don't exceed application-applied
LIMIT
withmax_page_size
#4104 - Field: add
Field#relay_nodes_field
config reader #4103 - Remove partial
opentelementry
implementation, oops #4086 - Remove unused method
Lazy.resolve
2.0.10 (20 June 2022)
Oops, this version was accidentally released to RubyGems as "2.10.0". I yanked it. See 2.0.11 instead.
2.0.9 (31 May 2022)
New features
- Connections: use
Schema.default_page_size
,Field#default_page_size
, orResolver.default_page_size
when one of them is available and nofirst
orlast
is given #4081 - Tracing: Add
OpenTelementryTracing
#4077
Bug fixes
- Field usage analyzer: don't crash on null input objects #4078
- Complexity: properly handle
ExecutionError
s raised inprepare:
hooks #4079
2.0.8 (24 May 2022)
New Features
- Fields: return
fallback_value:
when method or hash key field resolution fails #4069 - Support
hash_key:
lookups on Hash-like objects #4072 - Datadog tracing: support
prepare_span
hook for adding custom tags #4067
Bug fixes
- Fields: When
hash_key:
is given, populate#method_str
based on it #4072 - Errors: rescue errors raised when calling
.each
on list values #4052 - Date type: continue accepting dates without hyphens #4061
- Parser: properly parse empty type definitions #4046
2.0.7 (25 April 2022)
New Features
- Subscriptions: support
validate_update: false
to disable validation when running subscription updates #4039 - Expose duplicated name on
DuplicateNamesError
#4022
Bug Fixes
- Datadog: improve tracer #4038
hash_key:
try stringified hash key when resolving fields (this restores previous behavior) #4043- Printer: Don't print empty field set when types have no fields (
{\n}
) #4042 - Dataloader: improve handoff between lazy resolution and dataloader resolution #4036
- Remove unused
Lazy::Resolve
module from legacy execution code #4035
2.0.6 (14 April 2022)
Bug fixes
- Dataloader: make multiplexes use custom dataloaders #4026
- ISO8601Date: properly accept
nil
as input #4025 - Mutation: fix error message when
ready?
returns an invalid result #4029 - ISO8601 scalars: add
specified_by_url
configs #4014 - Array connection: don't return all items when
before
is the first cursor #4012 - Introspection: fix typo
specifiedByUrl
->specifiedByURL
- Fields: fix
hash_key
to take priority over method lookup #4015
2.0.5 (28 March 2022)
Bug Fixes
- Resolvers: fix inheriting arguments when parent classes aren't hooked up directly to the schema #4006
2.0.4 (21 March 2022)
Bug fixes
- Fields: make sure
null:
config overrides a default from a resolver #4000
2.0.3 (21 March 2022)
Bug fixes
- Fields: make sure field configs override resolver defaults #3975
- Fix
Field#scoped?
when the field uses a resolver #3990 - Allow schema members to have multiple of
repeatable
directives #3986 - Remove some legacy code #3979 #9995
- SDL: fix indirect interface implementation when loading a schema #3982
- Datadog tracing: Support ddtrace 1.0 #3978
- Fix
Node
implementation when connection types include built-in behavior modules #3967 - Small stack trace size reduction #3957
2.0.2 (1 March 2022)
New features
- Reduce schema memory footprint #3959
Bug fixes
- Mutation: Correctly use a configured
type(...)
#3965 - Interfaces: De-duplicate indirectly implemented interfaces #3932
- Remove an unnecessary require #3961
2.0.1 (21 February 2022)
Breaking changes
- Resolvers: refactored so that, instead of copying configurations to
field ...
instances,GraphQL::Schema::Field
s reference their providedresolver: ...
,mutation: ...
, orsubscription: ...
classes for many properties. This shouldn't break anything -- all of graphql-ruby's own tests passed just fine -- but it's mentioned here in case you notice anything out-of-sorts in your own application #3916 - Remove deprecated field options
field:
,function:
, andresolve:
(these were already no-ops, but they were overlooked in 2.0.0) #3917
Bug fixes
- Scoped context: fix usage with dataloader #3950
- Subscriptions: support multiple definitions for subscription root fields with
.trigger
#3897 #3935 - Improve some error messages #3920 #3923
- Clean up scalar validation code #3982
2.0.0 (9 February 2022)
Breaking Changes
- None, ideally. If you have an application that ran without warnings on v1.13, you should be able to update to 2.0.0 without a hitch. If this isn't the case, please open an issue and let me know what happened! I plan to maintain 1.13 for a while in order to ensure a smooth transition.
- But, many legacy code components were removed, so if there are any more references to those, there will be name errors! See #3729 for a list of removed components.
1.13.19 (2 February 2023)
Bug fixes
- Performance: don't re-encode schema member names #4323
- Performance: fix a duplicate field.type call #4316
- Performance: use
scope: false
for introspection types #4315 - Performance: improve argument coercion and validation #4312
- Performance: improve interface type membership lookup #4309
1.13.18 (10 January 2023)
New Features
hash_key:
: perform[...]
lookups even when the underlying object isn't a Hash #4286
1.13.17 (17 November 2022)
Bug fixes
- Handle ExecutionErrors from prepare hooks when calculating complexity #4248
1.13.16 (31 August 2022)
New Features
- Make variable validation respect
validate_max_errors
#4178
1.13.15 (30 June 2022)
Bug fixes
- Remove partial OpenTelementry tracing #4086
- Properly use
Query#validate
to skip static validation #3881
1.13.14 (20 June 2022)
New Features
- Add
Field#relay_nodes_field
reader #4103 - Datadog: detect tracing module #4100
1.13.13 (31 May 2022)
New features
- Datadog: update tracer for ddtrace 1.0 #4038
- Datadog: Add
#prepare_span
hook for custom tags #4067 - Tracing: Add
OpenTelementry
tracing #4077
1.13.12 (14 April 2022)
- Pass
context[:dataloader]
to multiplex context #4026 - Add a deprecation warning to
.accepts_definitions
#4002
1.13.11 (21 March 2022)
Deprecations
RangeAdd
warns whencontext:
isn't provided (it's required in GraphQL-Ruby 2.0) #3996
1.13.10
Breaking changes
id
fields: #3914 Previously, when a field was created withglobal_id_field
, it would pass a legacy-style type definition (an instance ofGraphQL::ObjectType
) toSchema.id_from_object(...)
. Now, it passes a class-based definition instead. If yourid_from_object(...)
method was using any methods from those legacy definitions, they should be migrated. (Most notably, uses oftype.name
should be migrated totype.graphql_name
.)
Deprecations
- Connections: deprecation warnings were added to configuration methods
.bidirectional_pagination = ...
and.default_nodes_field = ...
. These two configurations don't apply to the new pagination implementation, so they can be removed. #3918
1.13.9 (9 February 2022)
Breaking changes
Authorization: #3903 In graphql-ruby v1.12.17-1.13.8, when input objects used
prepare: -> { ... }
, the returned values were not authorized at all. However, this release goes back to the behavior from 1.12.16 and before, where a returnedHash
is validated just like an input object that didn't have aprepare:
hook. To get the previous behavior, you can implementdef self.authorized?
in the input object you want to skip authorization in:class Types::BaseInputObject < GraphQL::Schema::InputObject def self.(obj, value, ctx) if value.is_a?(self) super else true # graphql-ruby skipped auth in this case for v1.12.17-v1.13.8 end end end
Bug fixes
- Support re-setting
query.validate = ...
after a query is initialized #3881 - Handle validation errors in connection complexity calculations #3906
- Input Objects: try to authorize values when
prepare:
returns a Hash (this was default < v1.12.16) #3903 - SDL: fix when a type has two directives
1.13.8 (1 February 2022)
Bug fixes
- Introspection query: hide newly-supported fields behind arguments, maintain backwards-compatible INTROSPECTION_QUERY #3877
1.13.7 (28 January 2022)
New Features
- Arguments:
replace_null_with_default: true
replaces incomingnull
s with the configureddefault_value:
#3871 - Arguments: support
dig: [key1, key2, ...]
for nested hash key access #3856 - Generators: support more Postgresql field types #3577
- Generators: support downcased generator argument types #3577
- Generators: add an input type generator #3577
- Generators: support namespaces in generators #3577
Bug Fixes
- Field: better error for nil
owner
#3870 - ISO8601DateTime: don't accept inputs with partial time parts #3862
- SDL: fix for base connection classes that implement interfaces #3859
- Cops: find
required: true
onf.argument
calls (with explicit receiver) #3858 - Analysis: handle undefined or hidden fields with
nil
invisitor.field_definition
#3857
1.13.6 (20 January 2022)
New features
- Introspection: support
__Schema.description
,__Directive.isRepeatable
,__Type.specifiedByUrl
, and__DirectiveLocation.VARIABLE_DEFINITION
#3854 - Directives: Call
Directive.resolve_each
for list items #3853 - Dataloader: Run each list item in its own fiber (to support batching across list items) #3841
Bug fixes
- RelationConnection: Preserve
OFFSET
when it's already set on the relation #3846 Types::ISO8601Date
: Accept default values as Ruby date objects #3563
1.13.5 (13 January 2022)
New features
- Directives: support
repeatable
directives #3837 - Tracing: use
context[:fallback_transaction_name]
when operations aren't named #3778
Bug fixes
- Performance: improve performance of queries with directives #3835
- Fix crash on undefined constant
NodeField
#3832 - Fix crash on partially-required
ActiveSupport
#3829
1.13.4 (7 January 2022)
Bug fixes
- Connections: Fix regression in 1.13.3 on unbounded Relation connections #3822
1.13.3 (6 January 2022)
Deprecations
GraphQL::Relay::NodeField
andGraphQL::Relay::NodesField
are deprecated; useGraphQL::Types::Relay::HasNodesField
orGraphQL::Types::Relay::HasNodeField
instead. (The underlying field instances require a reference to their owner type, butNodeField
andNodesField
can't do that, since they're shared instances) #3791
New features
- Arguments: support
required: :nullable
to make an argument required to be present, even if it'snull
#3784 - Connections: When paginating an AR::Relation, use already-loaded results if possible #3790
- Tracing: Support DRY::Notifications #3776
- Improve the error when a Ruby method doesn't support the defined GraphQL arguments #3785
- Input Objects: call
.authorized?
on them at runtime #3786 - Field extensions: add
extras(...)
for extension-related extras with automatic cleanup #3787
Bug fixes
- Validation: accept nullable variable types for arguments with default values #3819
- Validation: raise a better error when a schema receives a
query { ... }
but has no query root #3815 - Improve the error message when
Schema.get_field
can't make sense of the arguments #3815 - Subscriptions: losslessly serialize Rails 7 TimeWithZone #3774
- Field Usage analyzer: handle errors from
prepare:
hooks #3794 - Schema from definition: fix default values with camelized arguments #3780
1.13.2 (15 December 2021)
Bug fixes
- Authorization: only authorize arguments once, after they've been loaded with
loads:
#3782 - Execution: always provide an
Interpreter::Arguments
instance ascontext[:current_arguments]
#3783
1.13.1 (13 December 2021)
Deprecations
.to_graphql
and.graphql_definition
are deprecated and will be removed in GraphQL-Ruby 2.0. All features using those legacy definitions are already removed and all behaviors should have been ported to class-based definitions. So, you should be able to remove those calls entirely. Please open an issue if you have trouble with it! #3750 #3765
New features
context.response_extensions[...] = ...
adds key-value pairs to the"extensions" => {...}
hash in the final response #3770- Connections:
node_type
andedge_type
acceptfield_options:
to pass custom options to generated fields #3756 - Field extensions: Support
default_argument ...
configuration for adding arguments if the field doesn't already have them #3751
Bug fixes
- fix
rails destroy graphql:install
#3739 - ActionCable subscriptions: close channel when unsubscribing from server #3737
- Mutations: call
.authorized?
on arguments frominput_object_class
,input_type
, too #3738 - Prevent blank strings with
validates: { length: ... }, allow_blank: false
#3747 - Lexer: return mutable strings when strings are empty #3741
- Errors: don't send execution errors to schema-defined handlers from inside lazies #3749
- Complexity: don't multiple
edges
andnodes
fields by page size #3758 - Performance: fix validation performance degradation from 1.12.20 #3762
1.13.0 (24 November 2021)
Since this version, GraphQL-Ruby is tested on Ruby 2.4+ and Rails 4+ only.
Breaking changes
- ActionCable Subscriptions: No update is delivered if all subscriptions return
NO_UPDATE
#3713 - Subscription classes: If a subscription has a
scope ...
configuration, then ascope:
option is required in.trigger(...)
. Usescope ..., optional: true
to get the old behavior. #3692 - Arguments whose default values are used aren't checked for authorization #3665
- Complexity: Connection fields have a default complexity implementation based on
first
/last
/max_page_size
#3609 - Arguments: if arguments are configured to return
false
for.visible?(context)
, their default values won't be applied
New features
- Visibility: A schema may contain multiple members with the same name. For each name, GraphQL-Ruby will use the one that returns true for
.visible?(context)
for each query (and raise an error if multiple objects with the same name are visible). #3651 #3716 #3725 - Dataloader:
nonblocking: true
will make GraphQL::Dataloader useFiber.scheduler
to run fields and load data with sources, supporting non-blocking IO. #3482 null: true
andrequired: true
are now default. GraphQL-Ruby includes some RuboCop cops,GraphQL/DefaultNullTrue
andGraphQL/DefaultRequiredTrue
, which identify and remove those needless configurations. #3612- Interfaces may
implement ...
other interfaces #3613
Bug fixes
- Enum
value(...)
and Input Objectargument(...)
methods return the defined object #3727 - When a field returns an array of mixed errors and values, the result will contain
nil
where there were errors in the list #3656
1.12.24 (4 February 2022)
Bug fixes
- SDL: fix parsing schemas where types have multiple directives #3886
1.12.23 (20 December 2021)
Bug fixes
- FieldUsage analyzer: handle arguments that raise an error during
prepare:
#3795
1.12.22 (8 December 2021)
Bug fixes
- Static validation: fix regression and improve performance of fields_will_merge validation #3761
1.12.21 (23 November 2021)
Bug fixes
- Validators: Fix
format:
/allow_blank: true
to correctly accept a blank string #3726 - Generators: generate a correct
Schema.type_error
hook #3722
1.12.20 (17 November 2021)
New Features
- Static validation: improve error messages when fields won't merge #3698
- Generators: improve id_from_object and type_error suggested implementations #3710
- Connections: make the new connections module fall back to old connections #3704
Bug fixes
- Dataloader: re-enqueue sources when one call to
yield
didn't satisfy their pending requests #3707 - Subscriptions: Fix when JSON-typed arguments are used #3705
1.12.19 (5 November 2021)
New Features
- Argument validation: Make
allow_null
andallow_blank
work standalone #3671 - Add field and path info to Encoding errors #3697
- Add
Resolver#unauthorized_object
for handling loaded but unauthorized objects #3689
Bug fixes
- Properly hook up
Schema.validate_max_errors
at runtime #3691
1.12.18 (2 November 2021)
New features
- Subscriptions: Add
NO_UPDATE
constant for skipping subscription updates #3664 - Validation: Add
Schema.validate_max_errors(integer)
for halting validation when it reaches a certain number #3683 - Call
self.load_...
methods on Input objects for loading arguments #3682 - Use
import_methods
in Refinements when available #3674 AppsignalTracing
: Addset_action_name
#3659
Bug fixes
- Authorize objects returned from custom
def load_...
methods #3682 - Fix
context[:current_field]
when argumentprepare:
hooks raise an error #3666 - Raise a helpful error when a Resolver doesn't have a configured
type(...)
#3679 - Better error message when subscription clients are using ActionCable #3668
- Dataloader: Fix dataloading of input object arguments #3666
- Subscriptions: Fix parsing time zones #3667
- Subscriptions: Fix parsing with non-null arguments #3620
- Authorization: Call
schema.unauthorized_field
for unauthorized resolvers - Fix when literal
null
is used as a value for a list argument #3660
1.12.17 (15 October 2021)
New features
- Support
extras: [:parent]
#3645 - Support ranges in
NumericalityValidator
#3635 - Add some Dataloader methods for testing #3335
Bug fixes
- Support input object arguments called
context
#3654 - Support single-item default values for list arguments #3652
- Ensure query strings are strings before running a query #3628
- Fix empty hash kwargs for Ruby 3 #3610
- Fix wrongly detecting Ipnut objects in authorization #3606
1.12.16 (31 August 2021)
New features
- Connections: automatically support Mongoid 7.3 #3599
- Support
def self.topic_for
in Subscription classes for server-filtered streams #3597 - When a list item or object field has an invalid null, stop executing that list or
Bug fixes
- Perf: don't refine String when unnecessary #3593
- BigInt: always parse as base 10 #3586
- Errors: only return one error when a node in a non-null connection has an invalid null #3601
1.12.15 (23 August 2021)
New Features
- Subscriptions: add support for multi-tenant setups when deserializing context #3574
- Analyzers: also track deprecated arguments #3549
1.12.14 (22 July 2021)
Bug fixes
- SDL: support directive arguments referencing overridden built-in scalars #3564
- Use
"_"
as the name forfield :_, ...
fields #3560 - Support
sanitized_printer(...)
in the schema definition forQuery#sanitized_query_string
GraphQL::Backtrace
: fix multiplex support
1.12.13 (20 June 2021)
Breaking changes
- Add a trailing newline to the
Schema.to_definition
output string #3541
Bug fixes
- Properly handled list results in GraphQL::Backtrace #3540
- Return plain
Hash
es andArray
s from queries instead of customized subclasses #3533 - Fix errors raised from non-null fields #3537
- Resolver: don't pass frozen array of extensions when none were configured #3515
- Configure the right
owner
fornode
andnodes
fields #3509 - Improve error message for invalid enum value #3507
- Properly halt on lazily-returned
context.skip
s #3514 - Fix: call overridden
to_h
methods on InputObject classes #3539 - Halt execution when a runtime directive argument raises a
GraphQL::ExecutionError
#3542
1.12.12 (31 May 2021)
Bug fixes
- Directives on inline fragments and fragment spreads receive
.resolve(...)
calls #3499
1.12.11 (28 May 2021)
Bug fixes
- Validate argument default values when adding them to the schema #3496
- Resolvers inherit extensions from superclasses #3500
- Greatly reduce runtime overhead #3494, #3505
- Remove hidden directives from introspection #3488
1.12.10 (18 May 2021)
New features
- Use
GlobalID::Locator.locate_many
for arrays of global Ids #3481 - Support runtime directives (call
.resolve
) onQUERY
#3474
Bug fixes
- Don't override Resolver
#load_*
methods when they're inherited #3486 - Fix validation of runtime directive arguments that have input objects #3485
- Add a final newline to rake task output
- Don't add connection arguments to fields loaded from introspection responses #3470
- Fix
rescue_from
on loading arguments #3471
1.12.9 (7 May 2021)
New features
- Overriding
.authorized_new(...)
to call.new(...)
effectively skips object authorization #3446 - Dataloader copies Fiber-local values from
Thread.current[...]
when initializing new Fibers #3461
Bug fixes
- Fix introspection of default value input objects #3456
- Add
StandardError => ...
condition to the generated GraphqlController #3460 - Fix
Dataloader::Source
on Ruby 3 with keyword arguments - Respect directive visibility at runtime #3450
- ActionCable subscriptions: only deserialize the broadcast payload once #3443
- Don't re-add
graphiql-rails
whengenerate graphql:install
is run twice #3441 - Allow differing selections on mutually exclusive interfaces #3063
- Respect
max_page_size: nil
override in fields #3438
1.12.8 (12 Apr 2021)
Bug fixes
- Fix loading single-key hashes in Subscriptions #3428
- Fix looking up
rescue_from
handlers inherited from parent schema classes #3431
1.12.7 (7 Apr 2021)
Breaking changes
Execution::Errors
(which implementsrescue_from
) was refactored so that, when an error matches more than one registered handler, it picks the most specific handler instead of the first match in the underlying Hash. This might "break" your code if your application registered a handler for a parent class and a child class, but expects instances of the child class to be handled by the handler for the parent class. (This seems very unlikely -- I consider the change to be a "breaking fix.") #3404
New features
- Errors: pick the most specific error handlers (instead of an order-dependent selection) #3404
- Add
node_nullable(...)
connection configuration options #3389 - Add
has_nodes_field(true|false)
connection configuration option #3388 - Store more metadata in argument-related static validation errors #3406
Bug fixes
- Fix connection nullability settings to properly handle
false
#3386 - Fix returning
RawValue
s as part of a list #3403 - Fix introspection for deprecated directive arguments #3416
- Optimize
has_next_page
for ActiveRecord::Relation connections #3414 - Tracing: consistent event sequencing when queries are executed with
Query#result
#3408
1.12.6 (11 March 2021)
Breaking changes
- Static validation: previously, variables passed as arguments to input objects were not properly type-checked. #3370 fixed type checking in this case, but may case existing (invalid) queries to break.
New features
- Connection types: support
edges_nullable(false)
andedge_nullable(false)
for non-null fields #3376 - Connections: add
.arguments
reader to newPagination::Connection
classes #3360
Bug fixes
- Relation connection: Remove extra
COUNT
query from some scenarios #3373 - Add a Bootsnap-style parsing cache when Bootsnap is detected #3156
- Fix input validation for input object variables #3370
1.12.5 (18 February 2021)
New features
- Resolvers: support
max_page_size
config #3338 - RangeAdd: call
range_add_edge
(if supported) to improve stable connection support #3341
Bug fixes
- Backtrace: fix new tracer when analyzing multiplex without executing it #3342
- Dataloader: pass along
throw
s #3333 - Skip possible_types filtering for non-interface types #3336
- Improve debugging message for ListResultFailedError #3339
1.12.4 (8 February 2021)
Bug fixes
- Allow prepended modules to add fields #3325
- Fix ConnectionExtension when another extension short-circuits
resolve
#3326 - Backtrace: Fix GraphQL::Backtrace with static validation (used by graphql-client) #3324
- Dataloader: Fix yield from root fiber when accessing arguments from analyzers. Fix arguments sometimes containing unresolved
Execution::Lazy
s #3320 - Dataloader: properly pass raised errors to
handle_error
handlers #3319 - Fix NameError in validation error #3303
- Dataloader: properly batch when parent fields were not batched #3312
1.12.3 (27 January 2021)
Bug fixes
- Fix constant names for legacy scalar types
1.12.2 (26 January 2021)
New features
GraphQL::Deprecation.warn
is used for GraphQL-Ruby 2.0 deprecation warnings (and calls through toActiveSupport::Deprecation.warn
if it's available) #3292
1.12.1 (25 January 2021)
Bug fixes
GraphQL::Dataloader
: properly support selections with multiple fields #3297
1.12.0 (20 January 2021)
Breaking changes
GraphQL::Schema
defaults toGraphQL::Execution::Interpreter
,GraphQL::Analysis::AST
,GraphQL::Pagination::Connections
, andGraphQL::Execution::Errors
. (#3145) To get the previous (deprecated) behaviors:
# Revert to deprecated execution behaviors:
use GraphQL::Execution::Execute
use GraphQL::Analysis
# Disable the new connection implementation:
self.connections = nil
GraphQL::Execution::Interpreter::Arguments
instances are frozen (#3138). (Usually, GraphQL code doesn't interact with these objects, but they're used some places under the hood.)
Deprecations
- Many, many legacy classes and methods were deprecated. #3275 Deprecation errors include links to migration documentation. For a full list, see: https://github.com/rmosolgo/graphql-ruby/issues/3056
New features
- Rails-like argument validations (#3207)
- Fiber-based
GraphQL::Dataloader
for batch-loading data #3264 - Connection and edge behaviors are available as mixins #3071
- Schema definition supports schema directives #3224
Bug fixes
1.11.10 (5 Nov 2021)
Bug fixes
- Properly hook up
Schema.max_validation_errors
at query runtime #3690
1.11.9 (1 Nov 2021)
New Features
Schema.max_validation_errors(val)
limits the number of errors that can be added during static validation #3675
1.11.8 (12 Feb 2021)
Bug fixes
- Improve performance of
Schema.possible_types(t)
for object types #3172
1.11.7 (18 January 2021)
Breaking changes
- Incoming integer values are properly bound (as per the spec) #3206 To continue receiving out-of-bound integer values, add this to your schema's
def self.type_error(err, ctx)
hook:
def self.type_error(err, ctx)
if err.is_a?(GraphQL::IntegerDecodingError)
return err.integer_value # return it anyways, since this is how graphql-ruby used to work
end
# ...
end
New features
- Support Ruby 3.0 #3278
- Add validation timeout option #3234
- Support Prometheus custom_labels in GraphQLCollector #3215
Bug fixes
- Handle
GraphQL::UnauthorizedError
in interpreter in from arguments #3276 - Set description for auto-generated
input:
argument #3141 - Improve performance of fields will merge validation #3228
- Use
Float
graphql type for ActiveRecord decimal columns #3246 - Add some custom methods to ArrayConnection #3238
- Fix generated fields for types ending Connection #3223
- Improve runtime performance #3217
- Improve argument handling when extensions shortcut the defined resolve #3212
- Bind scalar ints as per the spec #3206
- Validate that input object names are unique #3205
1.11.6 (29 October 2020)
Breaking changes
FieldExtension: pass extended values instead of originals to after_resolve
#3168
Deprecations
New features
- Accept additional options in
global_id_field
macro #3196
Bug fixes
- Use
graphql_name
inUnauthorizedError
default message (fixes #3174) #3176 - Improve error handling for base 64 decoding (in
UniqueWithinType
) #3179 - Fix
.valid_isolated_input?
on parsed schemas (fixes #3181) #3182 - Fix fields nullability in subscriptions documentation #3194
- Update
RangeAdd
to use new connections when available #3195
1.11.5 (30 September 2020)
New features
- SanitizedPrinter: accept
inline_variables: false
option and add#redact_argument_value?
and#redacted_argument_value
hooks #3167 - GraphQL::Schema::Timeoout#max_seconds(query) can provide a per-query timeout duration #3167
- Implement Interpreter::Arguments#fetch
- Assign
current_{path,field,arguments,object}
inquery.context
#3139. The values at these keys change while the query is running. - ActionCableSubscriptions: accept
use(..., namespace: "...")
for running multiple schemas in the same application #3076 - Add
deprecation_reason:
to arguments #3015
Bug fixes
- SanitizedPrinter: Fix lists and JSON scalars #3171
- Improve retained memory in Schema.from_definition #3153
- Make it easier to cache schema parsing #3153
- Make sure deprecated arguments aren't required #3137
- Use
.empty?
instead of.length.zero?
in lexer #3134 - Return a proper error when a stack error happens #3129
- Assert valid input types on arguments #3120
- Improve Validator#validate performance #3125
- Don't wrap
RawValue
in ConnectionExtension #3122 - Fix interface possible types visibility #3124
1.11.4 (24 August 2020)
Breaking changes
New features
- Add
node_nullable
option foredge_type
#3083 - Use module namespacing for template generators #3098
Bug fixes
- Rescue
SystemStackError
s during validation #3107 - Add
require 'digest/sha2'
for fingerprint #3103 - Optimize
GraphQL::Query::Context#dig
#3090 - Check if new connections before calling method on it (fixes #3059) #3100
- Thread field owner type through interpreter runtime (fixes #3086) #3099
- Check for visible interfaces on the type in warden #3096
- Update
AppOpticsTracing
with latest changes inPlatformTracing
#3097 - Use throw instead of raise to halt subscriptions early #3084
- Optimize
GraphQL::Query::Context#fetch
#3081
1.11.3 (13 August 2020)
Breaking changes
- Reverted the
required
anddefault_value
argument behaviour change in 1.11.2 since it was not spec compliant #3066
New features
- Improve resolver method conflict warning #3069, #3062
- Store arguments on
Mutation
instances after they're loaded #3073
Bug fixes
- Fix connection wrappers on lazy lists #3070
1.11.2 (1 August 2020)
Breaking changes
- Previously, GraphQL-Ruby allowed both
default_value: ...
andrequired: true
in argument definitions. However, this definition doesn't make sense -- a default value is never used for arequired: true
argument. This configuration now raises an error. Remove thedefault_value:
to get rid of the error. #3011
New features
- Support Date, Time and OpenStruct in Subscription::Serialize #3057
Bug fixes
- Speed up
DELETE_NODE
check #3053 - Reject invalid enum values during definition #3055
- Fix
.trigger
from unsubscribed ActionCable channel #3051 - Fix error message from VariablesAreUsedAndDefined for anonymous queries #3050
- Fix renaming variable identifiers in AST visitor #3045
- Reject
default_value: ...
used withrequired: true
during definition #3011 - Use the configured
edge_class:
with new connections #3036 - Don't call visible for unused arguments #3030, #3031
- Properly load directives from introspection results #3021
- Reject interfaces as members of unions #3024
- Load deprecation reason from introspection results #3014
- Fix arguments caching when extension modify arguments #3009
1.11.1 (17 June 2020)
New Features
- Add
StatsdTracing
#2996
Bug Fixes
- Raise the proper
InvalidNullError
when a mutation field returns an invalidnil
#2997
1.11.0 (13 June 2020)
Breaking changes
- Global tracers are removed (deprecated since 1.7.4) #2936
Fields defined in camel case (
field :doStuff
) will not line up to methods that are underscore case (def do_stuff
). Instead, the given symbol is used verbatim. #2938 To work around this:- Change the name of the method to match the field (eg,
def doStuff
) - Change the name of the field to match the method (eg,
field :do_stuff
, let graphql-ruby camelize it for you) - Or, add
resolver_method: :do_stuff
to explicitly map the field to a method on the object type definition
- Change the name of the method to match the field (eg,
You can probably find instances of this in your application with a regexp like /field :[a-z]+[A-Z]/
, and review them.
New features
extend SubscriptionRoot
is no longer necessary #2770- Add
broadcast: true
option to subscriptions #2959 - Add
Edge#parent
to new connection classes #2961
Bug fixes
- Use the field name as configured for hash key or method name #2906
1.10.12 (13 June 2020)
Bug fixes
- Fix compatibility of
YYYY-mm-dd
withTypes::ISO8601DateTime
#2989 - Remove unused ivar in InputObject #2987
1.9.21 (12 June 2020)
Bug fixes
- Fix
extras:
on subscription fields #2983
1.10.11 (11 June 2020)
New features
- Scout tracer adds transaction name to traces #2969
resolve_type
can optionally return a resolved object #2976- DateTime scalar returns a
Time
for better timezone handling #2973 - Interpreter memory improvements #2980, #2978
- Support lazy values from field-level authorization hooks #2977
- Object generator infers fields from model classes #2954
- Add type-specific runtime errors #2957
Bug fixes
- Fix for error when using
extras:
with subscription fields #2984 - Improve Schema.error_handler inheritance #2975
- Add raw_value to conflict warning list #2958
- Arguments#each_value yields ArgumentValues #2956
1.10.10 (20 May 2020)
Bug Fixes
- Fix lazy
loads:
with list arguments #2949 - Show object fields even when inherited ones are hidden #2950
- Use
reverse_each
in instrumenters #2945 - Fix underscored names in introspection loader #2941
- Fix array input to Date/DateTime types #2927
- Fix method conflict warnings on schema loader #2934
- Fix some Ruby 2.7 warnings #2925
1.9.20 (20 May 2020)
Bug fixes
- Fix
default_value: {}
on Ruby 2.7
1.10.9 (4 May 2020)
New features
- Add
Interpreter::Arguments#dig
#2912
1.10.8 (27 April 2020)
Breaking changes
- With the interpreter,
Query#arguments_for
returnsInterpreter::Arguments
instances instead of plain hashes. (They should work mostly the same, though.) #2881
New features
Schema::Field#introspection?
returns true for built-in introspection-related fields
Bug fixes
- Fix Ruby 2.7 warning on
Schema.to_json
#2905 - Pass
&block
to nested method calls to reduce stack depths #2900 - Fix lazy
loads:
with list arguments #2894 - Fix
loads:
on nested input object #2895 - Rescue base64 encoding errors in the encoder #2896
1.10.7 (16 April 2020)
Breaking changes
Schema.from_introspection(...)
builds class-based schemas #2876
New features
Date
andDateTime
types also accept well-formatted strings #2848Schema.from_introspection(...)
builds class-based schemas #2876Schema#to_definition
now dumps all directives that were part of the original IDL, if the schema was parsed with.from_definition
#2879
Bug fixes
- Fix memory leak in legacy runtime #2884
- Fix interface inheritance in legacy runtime #2882
- Fix description on
List
andNonNull
types (for introspection) #2875 - Fix over-rescue of NoMethodError when building list responses #2887
1.10.6 (6 April 2020)
New features
- Add options to
implements(...)
and inteface type visibility #2791 - Add
Query#fingerprint
for logging #2859 - Add
--playground
option to install generator #2839 - Support lazy-loaded objects from input object
loads:
#2834
Bug fixes
- Fix
Language::Nodes
equality: moveeql?
to==
#2861 - Make rake task properly detect rails
environment
task #2862 - Fix
nil
override formax_page_size
#2843 - Fix
pageInfo
methods when they're called beforenodes
#2845 - Make the default development error match a normal GraphQL error #2825
- Fix
loads:
withrequire: false
#2833 - Fix typeerror for
BigInt
givennil
#2827
1.10.5 (12 March 2020)
New features
- Add
#field_complexity
hook toAST::QueryComplexity
analyzer #2807
Bug fixes
- Pass
nonce: true
when encoding cursors #2821 - Ignore empty-string cursors #2821
- Properly pass along
Analysis::AST
to schema instances #2820 - Support filtering unreachable types in schemas from IDL #2816
- Use
Query#arguments_for
for lookahead arguments #2811 - Fix pagination bug on old connections #2799
- Support new connection system on old runtime #2798
- Add details to raise CoercionErrors #2796
1.10.4 (3 March 2020)
Breaking changes
- When an argument is defined with a symbol (
argument :my_arg, ...
), that symbol is used verbatim to build Ruby keyword arguments. Previously it was converted to underscore-case, but this autotransform was confusing and wrong in some cases. You may have to change the symbol in yourargument(...)
configuration if you were depending on that underscorization. #2792 - Schemas from
.from_definition
previously had half-way connection support. It's now completely removed, so you have to add connection wrappers manually. See #2782 for migration notes.
New features
- Add
Appoptics
tracing #2789 - Add
Query#sanitized_query_string
#2785 - Improved duplicate type error message #2777
Bug fixes
- Fix arguments ending in numbers, so they're injected with the same name that they're configured with #2792
- Improve
Query#arguments_for
with interpreter #2781 - Fix visitor replacement of variable definitions #2752
- Remove half-broken connection handling from
Schema.from_definition
#2782
1.10.3 (17 Feb 2020)
New features
- Support
loads:
with plain field arguments #2720 - Support
raw_value(...)
to halt execution with a certain value #2699 .read_subscription
can returnnil
to bypass executing a subscription #2741
Bug fixes
- Connection wrappers are properly inherited #2750
prepare(...)
is properly applied to default values in subscription fields #2748- Code tidying for RSpec warnings #2741
- Include new analysis module when generating a schema #2734
- Include directive argument types in printed schemas #2733
- Use
module_parent_name
in Rails #2713 - Fix overriding default scalars in build_from_definition #2722
- Fix some non-null errors in lists #2651
1.10.2 (31 Jan 2020)
Bug fixes
- Properly wrap nested input objects in instances #2710
1.10.1 (28 Jan 2020)
Bug fixes
- Include Interface-level
orphan_types
when building a schema #2705 - Properly re-enter selections in complexity analyzer #2595
- Fix input objects with null values #2690
- Fix default values of
{}
in.define
-based schemas #2703 - Fix field extension presence check #2689
- Make new relation connections more efficient #2697
- Don't include fields
@skip(if: true)
or@include(if: false)
in lookahead #2700
1.9.19 (28 Jan 2020)
Bug Fixes
- Fix argument default value of
{}
with Ruby 2.7 argument handling #2704
1.10.0 (20 Jan 2020)
Breaking Changes
- Class-based schemas using the new interpreter will now use definition classes at runtime. #2363 (Previously,
.to_graphql
methods were used to generate singletons which were used at runtime.) This means:- Methods that used to receive types at runtime will now receive classes instead of those singletons.
.name
will now callClass#name
, which will give the class name. Use.graphql_name
to get the name of a GraphQL type. (Fields, arguments and directives have.graphql_name
too, so you can use it everywhere.)- Some methods that return hashes are slow because they merge hashes according to class inheritance, for example
MySchema.types
andMyObjectType.fields
. Instead: - If you only need one item out of the Hash, use
.get_type(type_name)
or.get_field(field_name)
instead. Those methods find a match without performing Hash merges. - If you need the whole Hash, get a cached value from
context.warden
(an instance ofGraphQL::Schema::Warden
) at runtime. Those values reflect the types and fields which are permitted for the current query, and they're cached for life of the query. Check the API docs to see methods on thewarden
.
- Class-based schemas using the interpreter must add
use GraphQL::Analysis::AST
to their schema (and update their custom analyzers, see https://graphql-ruby.org/queries/ast_analysis.html) #2363 - ActiveSupport::Notifications events are correctly named in event.library format #2562
- Field and Argument
#authorized?
methods now accept three arguments (instead of 2). They now accept(obj, args, ctx)
, whereargs
is the arguments (for a field) or the argument value (for an argument). #2520 - Double-null
!!
is disallowed by the parser #2397 - (Non-interpreter only) The return value of subscription fields is passed along to execute the subscription. Return
nil
to get the previous behavior. #2536 Schema.from_definition
builds a class-based schema from the definition string #2178- Only integers are accepted for
Int
type #2404 - Custom scalars now call
.coerce_input
on all input values - previously this call was skipped fornull
values.
Deprecations
.define
is deprecated; class-based schema definitions should be used instead. If you're having trouble or you can't find information about an upgrade path, please open an issue on GitHub!
New Features
- Add tracing events for
.authorized?
and.resolve_type
calls #2660 Schema.from_definition
acceptsusing:
for installing plugins (equivalent touse ...
in class-based schemas) #2307- Add
$
to variable names in error messages #2531 - Add invalid value to argument error message #2531
- Input object arguments with
loads:
get the loaded object in theirauthorized?
hook, asarg
inauthorized?(obj, args, ctx)
. #2536 GraphQL::Pagination
auto-pagination system #2143Schema.from_definition
builds a class-based schema from the definition string #2178
Bug Fixes
- Fix warnings on Ruby 2.7 #2668
- Fix Ruby keyword list to support Ruby 2.7 #2640
- Reduce memory of class-based schema #2636
- Improve runtime performance of interpreter #2630
- Big numbers (ie, greater than Ruby's
Infinity
) no longer :boom: when being reserialized #2320 - Fix
hasNextPage
/hasPrevious
page when max_page_size limits the items returned #2608 - Return parse errors for empty documents and empty argument lists #2344
- Properly serialize
defaultValue
of input objects containing enum values #2439 - Don't crash when a query contains
!!
. #2397 - Resolver
loads:
assign the value to argument@loads
#2364 - Only integers are accepted for
Int
type #2404
1.9.18 (15 Jan 2020)
New features
- Support disabling
__type
or__schema
individually #2657 - Support Ruby 2.7, and turn on CI for it :tada: #2665
Bug fixes
- Fix Ruby 2.7 warnings #2653 #2669
- Properly build camelized names for directive classes #2666
- Use schema-defined context class for SDL generation #2656
- Apply visibility checks when generating SDL #2637
1.9.17 (17 Dec 2019)
New features
- Scoped context for propagating values to child fields #2634
- Add
type_membership_class
with possible_type visibility #2391
Bug fixes
- Don't return unreachable types in introspection response #2596
- Wrap more of execution with error handling #2632
- Fix InputObject
.prepare
for the interpreter #2624 - Fix Ruby keyword list to support Ruby 2.7 #2640
- Fix performance of urlsafe_encode64 backport #2643
1.9.16 (2 Dec 2019)
Breaking changes
GraphQL::Schema::Resolver#initialize
accepts a new keyword argument,field:
. If you have overriden this method, you'll have to add that keyword to your argument list (and pass it along tosuper
.) #2605
Deprecations
SkylightTracing
is disabled; the Skylight agent contains its own GraphQL support. See Skylight's docs for migration. #2601
New features
Bug fixes
- Fix multiplex max_depth calculation #2613
- Use monotonic time in TimeoutMiddleware #2622
- Use underscored names in Mutation generator #2617
- Fix lookahead when added to mutations in their
field(...)
definitions #2605 - Handle returned lists of errors from Mutations #2567
- Fix lexer error on block strings containing only newlines #2598
- Fix mutation generator to reference the new base class #2580
- Use the right camelization configuration when generating subscription topics #2552
1.9.15 (30 Oct 2019)
New features
- Improve parser performance #2572
- Add
def prepare
API for input objects #1869 - Support
extensions
config in Resolver classes #2570 - Support custom
.connection_extension
in field classes #2561 - Warn when a field name is a Ruby keyword #2559
- Improve performance for ActiveRecord connection #2547
Bug fixes
- Fix errantly generated
def resolve_field
method inBaseField
#2578 - Comment out the
null_session
handling in the generated controller, for better compat with Rails API mode #2557 - Fix validation error with duplicate, self-referencing fragment #2577
- Revert the
.authorized?
behavior of InputObjects to handle cyclical references. See 1.10.0.pre1 for a better behavior. #2576 - Replace
NotImplementedError
(which is meant for operating system APIs) withGraphQL::RequiredImplementationMissingError
#2543
1.9.14 (14 Oct 2019)
New features
- Add
null_session
CSRF handing ininstall
generator #2524 - Correctly report InputObjects without arguments and Objects without fields as invalid #2539 #2462
Bug fixes
- Fix argument incompatibility #2541
- Add a
require
forTypes::ISO8691Date
#2528 - Fix errors re-raised after lazy fields #2525
1.9.13 (8 Oct 2019)
Breaking changes
- Enum values were (erroneously) accepted as ID or String values, but they aren't anymore. #2505
New features
- Add
Query#executed?
#2486 - Add
Types::ISO8601Date
#2471
Bug fixes
- Don't accept Enums as IDs or Strings #2505
- Call
.authorized?
hooks on arguments that belong to input objects #2519 - Fix backslash parsing edge case #2510
- Improve performance #2504 #2498
- Properly stringify keys in error extensions #2508
- Fix
extras:
handling in RelayClassicMutation #2484 - Use
Types::BaseField
in scaffold #2470
1.9.12 (9 Sept 2019)
Breaking Changes
- AST Analyzers follow fragments spreads as if they were inline fragments. #2463
New Features
use GraphQL::Execution::Errors
provides error handling for the new interpreter. #2458
Bug Fixes
- Fix false positive on enum value validation #2454
1.9.11 (29 Aug 2019)
Breaking Changes
- Introspection fields are now considered for query depth validations, so you'll need at least
max_depth: 13
to run the introspection query #2437
New features
- Add
extras
setter toGraphQL::Schema::Field
#2450 - Add extensions in
CoercionError
#2431
Bug fixes
- Make
extensions
kwarg on field on more flexible for extensions with options #2443 - Fix list validation error handling #2441
- Include introspective fields in query depth calculations #2437
- Correct the example for using 'a class method to generate fields' #2435
- Enable multiple execution errors for Fields defined to return a list #2433
1.9.10 (20 Aug 2019)
New features
- Support required arguments with default values #2416
Bug fixes
- Properly disable
max_complexity
andmax_depth
whennil
is passed #2409 - Fix printing class-based schemas #2406
- Improve field method naming conflict check #2420
1.9.9 (30 July 2019)
New features
- Memoize generated strings in
.to_query_string
#2400 - Memoize generated strings in platform tracing #2401
Bug fixes
- Support class-based subscription type in
.define
-based schema #2403
1.9.8 (24 July 2019)
New features
- Schema classes pass their configuration to subclasses #2384
- Improve memory consumption of lexer and complexity validator #2389
- The
install
generator creates a BaseArgument #2379 - When a field name conflicts with a built-in method name, give a warning #2376
Bug fixes
- When a resolver argument uses
loads:
, the argument definition will preserve the type in.loads
#2365 - When an required argument is hidden, it won't add a validation error #2393
- Fix handling of invalid UTF-8 #2372, #2377
- Empty block strings are parsed correctly #2381
- For resolvers, only authorize arguments once #2378
1.9.7 (25 June 2019)
Breaking changes
Analysis::AST::Visitor#argument_definition
no longer returns the previous argument definition. Instead, it returns the current argument definition and#previous_argument_definition
returns the previous one. You might have to replace calls to.argument_definition
with.previous_argument_definition
for compatibility. #2226
New features
- Accept a
subscription_scope
configuration in Subscription classes #2297 - Add a
disable_introspection_entry_points
configuration in Schema classes #2327 - Add
Analysis::AST::Visitor#argument_definition
which returns the current argument definition,#previous_argument_definition
returns the previous one #2226 - Run CI on Ruby 2.6 #2328
- Autogenerate base field class #2216
- Add timeout support with interpreter #2220
Bug fixes
- Fix Stack overflow when calling
.to_json
on input objects #2343 - Fix off-by-one error with hasNextPage and ArrayConnections #2349
- Fix GraphQL-Pro operation store compatibility #2350
- Fix class-based transformer when multiple mutations are in one file #2309
- Use
default_graphql_name
for Edge classes #2224 - Support nested
loads:
with input objects #2323 - Support
max_complexity
with multiplex & AST analysis #2306
1.9.6 (23 May 2019)
Bug fixes
- Backport
String#-@
for Ruby 2.2 support #2305
1.9.5 (22 May 2019)
New features
- Support
rescue_from
returningGraphQL::ExecutionError
#2140 - Accept
context:
inSchema.validate
#2256 - Include
query:
in interpreter tracing forexecute_field
andexecute_field_lazy
#2236 - Add
Types::JSON
#2227 - Add
null:
option toBaseEdge.node_type
#2249
Bug fixes
- Fix Ruby 2.2 compatibility #2302
- Distinguish aliased selections in lookahead #2266
- Properly show list enum default values in introspection #2263
- Performance improvements: #2289, #2244, #2258, #2257, #2240
- Don't recursively unwrap inputs for RelayClassicMutation #2236
- Fix
Schema::Field#scoped?
when no return type #2255 - Properly forward more authorization errors #2165
- Raise
ParseError
for.parse(nil)
#2238
1.9.4 (5 Apr 2019)
Breaking Changes
GraphQL::Schema::Resolver::LoadApplicationObjectFailedError
was renamed toGraphQL::LoadApplicationObjectFailedError
. (This will only break if you're referencing the class by name and running Ruby 2.5+) #2080
New features
- Add
Types::BigInt
#2150 - Add auto-loading arguments support in Input Object types #2080
- Add analytics tag to Datadog tracing #2154
Bug fixes
- Fix
Query#execute
when no explicit query string is passed in #2142 - Fix when a root type returns nil because unauthorized #2144
- Fix tracing
node
by threadingowner:
through field tracing #2156 - Fix interpreter handling of exceptions raised during argument preparation #2198
- Fix ActionCableLink when there are errors but no data #2176
- Provide empty hash as default option for field resolvers #2189
- Prevent argument names from overwriting Arguments methods #2171
- Include array indices in error paths #2162
- Handle non-node arrays in AST visitor #2161
1.9.3 (20 Feb 2019)
Bug fixes
- Fix
Schema::Subscription
when it has no arguments #2135 - Don't try to scope
nil
, just skip scoping altogether #2134 - Fix when a root
.authorized?
returnsfalse
and there's noroot_value
#2136 - Fix platform tracing with interpreter & introspection #2137
- Support root Subscription types with name other than
Subscription
#2102 - Fix nested list-type input object nullability validation #2123
1.9.2 (15 Feb 2019)
Bug fixes
- Properly support connection fields with resolve procs #2115
1.9.1 (14 Feb 2019)
Bug fixes
- Properly pass errors to Resolver
load_application_object_failed
methods #2110
1.9.0 (13 Feb 2019)
Breaking Changes
- AST nodes are immutable. To modify a parsed GraphQL query, see
GraphQL::Language::Visitor
for its mutation API, which builds a new AST with the specified mutations applied. #1338, #1740 - Cursors use urlsafe Base64. This won't break your clients (it's backwards-compatible), but it might break your tests, so it's listed here. #1698
- Add
field(..., resolver_method:)
for when GraphQL-Ruby should call a method other than the one whose name matches the field name (#1961). This means that if you're usingmethod:
to call a different method on the Schema::Object subclass, you should update that configuration toresolver_method:
. (method:
is still used to call a different method on the underlying application object.) Int
type now applies boundaries as described in the spec #2101. To preserve the previous, unbounded behavior, handle the error in your schema's.type_error(err, ctx)
hook, for example:
class MySchema < GraphQL::Schema
def self.type_error(err, ctx)
if err.is_a?(GraphQL::IntegerEncodingError)
# Preserve the previous unbounded behavior
# by returning the out-of-bounds value
err.integer_value
else
super
end
end
end
field(...)
configurations don't create implicit method definitions (#1961). If one resolver method depended on the implicitly-created method from another field, you'll have to refactor that call or manually add adef ...
for that field.- Calling
super
in a field method doesn't work anymore (#1961) - Error
"problems"
are now in"extensions" : { "problems": ... }
#2077 - Change schema default to
error_bubbling false
#2069
New Features
- Add class-based subscriptions with
GraphQL::Schema::Subscription
#1930 - Add
GraphQL::Execution::Interpreter
(#1394) andGraphQL::Analysis::AST
(#1824) which together cut GraphQL overhead by half (time and memory) - Add
Schema.unauthorized_field(err)
for whenField#authorized?
checks fail (#1994) - Add class-based custom directives for the interpreter (#2055)
- Add
Schema::FieldExtension
for customizing field execution with class-based fields #1795 - Add
Query#lookahead
for root-level selection info #1931 - Validation errors have
"extensions": { ... }
which includes metadata about that error #1970
Bug fixes
- Fix list-type arguments passed with a single value #2085
- Support
false
as an Enum value #2050 - Support
hash_key:
fields when the key isn't a valid Ruby method name #2016
1.8.15 (13 Feb 2019)
Bug fixes
- Fix unwrapping inputobject types when turning arguments to hashes #2094
- Support lazy objects from
.resolve_type
hooks #2108
1.8.14 (9 Feb 2019)
Bug Fixes
- Fix single-item list inputs that aren't passed as lists #2095
1.8.13 (4 Jan 2019)
Bug fixes
- Fix regression in block string parsing #2032
1.8.12 (3 Jan 2019)
Breaking changes
- When an input object's argument has a validation error, that error is reported on the argument instead of its parent input object. #2013
New features
- Add
error_bubbling false
Schema configuration for nicer validation of compound inputs #2013 - Print descriptions as block strings in SDL #2011
- Improve string-to-constant resolution #1810
- Add
Query::Context#to_hash
for splatting #1955 - Add
#dig
toSchema::InputObject
andQuery::Arguments
#1968 - Add
.*_execution_strategy
methods to class-based schemas #1914 - Accept multiple errors when adding
.rescue_from
handlers #1991
Bug fixes
- Fix scalar tracing in NewRelic and Skylight #1954
- Fix lexer for multiple block strings #1937
- Add
unscope(:order)
when counting relations #1911 - Improve build-from-definition error message #1998
- Fix regression in legacy compat #2000
1.8.11 (16 Oct 2018)
New features
extras: [:lookahead]
injects aGraphQL::Execution::Lookahead
Bug fixes
- Fix type printing in Printer #1902
- Rescue
GraphQL::ExecutionError
in.before_query
hooks #1898 - Properly load default values that are lists of input objects from the IDL #1874
1.8.10 (21 Sep 2018)
Bug fixes
- When using
loads:
with a nullable mutation input field, allownull
values to be provided. #1851 - When an invalid Base64 encoded cursor is provided, raise a
GraphQL::ExecutionError
instead ofArgumentError
. #1855 - Fix an issue with
extras: [:path]
would use the field'spath
instead of thecontext
. #1859
New features
- Add scalar type generator
rails g graphql:scalar
#1847 - Add
#dig
method toQuery::Context
#1861
1.8.9 (13 Sep 2018)
Breaking changes
- When
field ...
is called with a block and the block has one argument, the field is yielded, butself
inside the block is not changed to the field. #1843
New features
extras: [...]
can inject values from the field instance #1808- Add
ISO8601DateTime.time_precision
for customization #1845 - Fix input objects with default values of enum #1827
Schema.sync_lazy(value)
hook for intercepting lazy-resolved objects #1784
Bug fixes
- When a field block is provided with an arity of
1
, yield the field #1843
1.8.8 (27 Aug 2018)
Bug fixes
- When using
RelayClassicMutation
,client_mutation_id
will no longer be passed toauthorized?
method #1771 - Fix issue in schema upgrader script which would cause
.to_non_null_type
calls in type definition to be ignored #1783 - Ensure enum values respond to
graphql_name
#1792 - Fix infinite resolution bug that could occur when an exception not inheriting from
StandardError
is thrown #1804
New features
- Add
#path
method to schema members #1766 - Add
as:
argument to allow overriding the name of the argument when usingloads:
#1773 - Add support for list of IDs when using
loads:
in an argument definition #1797
1.8.7 (9 Aug 2018)
Breaking changes
Some mutation authorization hooks added in 1.8.5 were changed, see #1736 and #1737. Roughly:
before_prepare
was changed to#ready?
validate_*
hooks were replaced with a single#authorized?
method
Bug fixes
- Argument default values include nested default values #1728
- Clean up duplciate method defs #1739
New features
- Built-in support for Mongoid 5, 6, 7 #1754
- Mutation
#ready?
and#authorized?
may halt flow and/or return data #1736, #1737 - Add
.scope_items(items, ctx)
hook for filtering lists - Add
#default_graphql_name
for overriding default logic #1729 - Add
#add_argument
for building schemas #1732 - Cursors are decoded using
urlsafe_decode64
to future-proof for urlsafe cursors #1748
1.8.6 (31 July 2018)
Breaking changes
- Only allow Objects to implement actual Interfaces #1715. Use
include
instead for plain Ruby modules. - Revert extending interface methods onto Objects #1716. If you were taking advantage of this feature, you can create a plain Ruby module with the functionality and include it in both the interface and object.
Deprecations
New features
- Support string descriptions (from June 2018 GraphQL spec) #1725
- Add some accessors to Schema members #1722
- Yield argument for definition block with arity of one #1714
- Yield field for definition blocks with arity of one #1712
- Support grouping by "endpoint" with skylight instrumentation #1663
- Validation: Don't traverse irep if no handlers are registered #1696
- Add
nodes_field
option toedge_type
to hide nodes field #1693 - Add
GraphQL::Types::ISO8601DateTime
to documentation #1694 - Conditional Analyzers #1690
- Improve error messages in
ActionCableSubscriptions
#1675 - Add Prometheus tracing #1672
- Add
map
toInputObject
#1669
Bug fixes
- Improve the mutation generator #1718
- Fix method inheritance for interfaces #1709
- Fix Interface inheritance chain #1686
- Fix require in
tracing.rb
#1685 - Remove delegate for
FieldResolutionContext#schema
#1682 - Remove duplicated
object_class
method #1667
1.8.5 (10 July 2018)
Breaking changes
- GraphQL validation errors now include
"filename"
if the parsed document had afilename
#1618
Deprecations
TypeKind#resolves?
is deprecated in favor ofTypeKind#abstract?
#1619
New features
- Add Mutation loading/authorization system #1609
- Interface
definition_methods
are inherited by object type classes #1635 - include
"filename"
in GraphQL errors if the parsed document has a filename #1618 - Add
Schema::InputObject#empty?
#1651 - require
ISO8601DateTime
by default #1660 - Support
extend
in the parser #1620 - Improve generator to have nicer error handling in development
Bug fixes
- Fix
@skip
/@include
with default value offalse
#1617 - Fix lists of abstract types with promises #1613
- Don't check the type of
nil
when it's in a list #1610 - Fix NoMethodError when
variables: nil
is passed toexecute(...)
#1661 - Objects returned from
Schema.unauthorized_objects
are properly wrapped by their type proxies #1662
1.8.4 (21 June 2018)
New features
- Add class-based definitions for Relay types #1568
- Add a built-in auth system #1494
Bug fixes
- Properly rescue coercion errors in variable values #1602
1.8.3 (14 June 2018)
New features
- Add an ISO 8601 DateTime scalar:
Types::ISO8601DateTime
. #1566 - Use classes under the hood for built-in scalars. These are now accessible via
Types::
namespace. #1565 - Add
possible_types
helpers to abstract types #1580
Bug fixes
- Fix
Language::Visitor
when visitingInputObjectTypeDefinition
nodes to include childDirective
nodes. #1584 - Fix an issue preventing proper subclassing of
TimeoutMiddleware
. #1579 - Fix
graphql:interface
generator such that it generates working code. #1577 - Update the description of auto-generated
before
andafter
arguments to better describe their input type. #1572 - Add
Language::Nodes::DirectiveLocation
AST node to represent directive locations in directive definitions. #1564
1.8.2 (6 June 2018)
Breaking changes
Schema::InputObject#to_h
recursively transforms hashes to underscorized, symbolized keys. #1555
New features
- Generators create class-based types #1562
Schema::InputObject#to_h
returns a underscorized, symbolized hash #1555
Bug fixes
- Support
default_mask
in class-based schemas #1563 - Fix null propagation for list types #1558
- Validate unique arguments in queries #1557
- Fix
RelayClassicMutation
s with no arguments #1543
1.8.1 (1 June 2018)
Breaking changes
- When filtering items out of a schema, Unions will now be hidden if their possible types are all hidden or if all fields returning it are hidden. #1515
New features
GraphQL::ExecutionError.new
accepts anextensions:
option which will be merged into the"extensions"
key in that error's JSON #1552
Bug fixes
- When filtering items out of a schema, Unions will now be hidden if their possible types are all hidden or if all fields returning it are hidden. #1515
- Require that fields returning interfaces have selections made on them #1551
- Correctly mark introspection types and fields as
introspection?
#1535 - Remove unused introspection objects #1534
- use
object
/context
in the upgrader instead of@object
/@context
#1529 - (Development) Don't require mongodb for non-mongo tests #1548
- Track position of union member nodes in the parser #1541
1.8.0 (17 May 2018)
1.8.0
has been in prerelease for 6 months. See the prerelease changelog for change-by-change details. Here's a high-level changelog, followed by a detailed list of changes since the last prerelease.
High-level changes
Breaking Changes
- GraphQL-Ruby is not tested on Ruby 2.1. #1070 Because Ruby 2.1 doesn't garbage collect Symbols, it's possible that GraphQL-Ruby will introduce a OOM vulnerability where unique symbols are dynamically created, for example, turning user input into Symbols. No instances of this are known in GraphQL-Ruby ... yet!
GraphQL::Delegate
, a duplicate of Ruby'sForwardable
, was removed. UseForwardable
instead, and update your Ruby if you're on2.4.0
, due to a performance regression inForwardable
in that version.MySchema.subscriptions.trigger
asserts that its inputs are valid arguments #1400. So if you were previously passing invalid options there, you'll get an error. Remove those options.
New Features
- A new class-based API for schema definition. The old API is completely supported, but the new one is much nicer to use. If you migrate, some schema extensions may require a bit of extra work.
- Built-in support for Mongoid-backed Relay connections
.execute(variables: ...)
andsubscriptions.trigger
both accept Symbol-keyed hashes- Lots of other small things around SDL parsing, tracing, runtime ... everything. Read the details below for a full list.
Bug Fixes
- Many, many bug fixes. See the detailed list if you're curious about specific bugs.
Changes since 1.8.0.pre11
:
Breaking Changes
GraphQL::Schema::Field#initialize
's signature changed to accept keywords and a block only.type:
,description:
andname:
were moved to keywords. SeeField.from_options
for how thefield(...)
helper's arguments are merged to go toField.new
. #1508
New Features
Schema::Resolver
is a replacement forGraphQL::Function
#1472- Fix subscriptions with class-based schema #1478
Tracing::NewRelicTracing
acceptsset_transaction_name:
to use the GraphQL operation name as the NewRelic transaction name #1430
Bug fixes
- Backported
accepts_definition
s are inherited #1514 - Fix Schema generator's
resolve_type
method #1481 - Fix constant assignment warnings with interfaces including multiple other interfaces #1465
- InputObject types loaded from SDL have the proper AST node assigned to them #1512
1.8.0.pre11 (3 May 2018)
Breaking changes
Schema::Mutation.resolve_mutation
was moved to an instance method; see changes toSchema::RelayClassicMutation
in #1469 for an example refactorGraphQL::Delegate
was removed, use Ruby'sForwardable
instead (warning: bad performance on Ruby 2.4.0)GraphQL::Schema::Interface
is a module, not a class #1372. To refactor, use a base module instead of a base class:
module BaseInterface
include GraphQL::Schema::Interface
end
And include that in your interface types:
module Reservable
include BaseInterface
field :reservations, ...
end
In object types, no change is required; use implements
as before:
class EventVenue < BaseObject
implements Reservable
end
New features
GraphQL::Schema::Interface
is a module- Support
prepare:
andas:
argument options #1469 - First-class support for Mongoid connections #1452
- More type inspection helpers for class-based types #1446
- Field methods may call
super
to get the default behavior #1437 variables:
accepts symbol keys #1401- Reprint any directives which were parsed from SDL #1417
- Support custom JSON scalars #1398
- Subscription
trigger
accepts symbol, underscored arguments and validates their presence #1400 - Mutations accept a
null(true | false)
setting to affect field nullability #1406 RescueMiddleware
uses inheritance to match errors #1393- Resolvers may return a list of errors #1231
Bug fixes
- Better error for anonymous class names #1459
- Input Objects correctly inherit arguments #1432
- Fix
.subscriptions
for class-based Schemas #1391
1.8.0.pre10 (4 Apr 2018)
New features
- Add
Schema::Mutation
andSchema::RelayClassicMutation
base classes #1360
Bug fixes
- Fix using anonymous classes for field types #1358
1.8.0.pre9 (19 Mar 2018)
- New version number. (I needed this because I messed up build tooling for 1.8.0.pre8).
1.8.0.pre8 (19 Mar 2018)
New Features
- Backport
accepts_definition
for configurations #1357 - Add
#owner
method to Schema objects - Add
Interface.orphan_types
config for orphan types #1346 - Add
extras: :execution_errors
foradd_error
#1313 - Accept a block to
Schema::Argument#initialize
#1356
Bug Fixes
- Support
cursor_encoder
#1357 - Don't double-count lazy/eager field time in Tracing #1321
- Fix camelization to support single leading underscore #1315
- Fix
.resolve_type
for Union and Interface classes #1342 - Apply kwargs before block in
Argument.from_dsl
#1350
1.8.0.pre7 (27 Feb 2018)
New features
- Upgrader improvements #1305
- Support
global_id_field
for interfaces #1299 - Add
camelize: false
#1300 - Add readers for
context
,object
andarguments
#1283 - Replace
Schema.method_missing
with explicit whitelist #1265
1.8.0.pre6 (1 Feb 2018)
New features
- Custom enum value classes #1264
Bug fixes
- Properly print SDL type directives #1255
1.8.0.pre5 (1 Feb 2018)
New features
- Upgrade argument access with the upgrader #1251
- Add
Schema#find(str)
for finding schema members by name #1232
Bug fixes
- Fix
Schema.max_complexity
#1246 - Support cyclical connections/edges #1253
1.8.0.pre4 (18 Jan 2018)
Breaking changes
Type.fields
,Field.arguments
,Enum.values
andInputObject.arguments
return a Hash instead of an Array #1222
New features
- By default, fields try hash keys which match their name, as either a symbol or a string #1225
field do ... end
instance_evals on the Field instance, not a FieldProxy #1227[T, null: true]
creates lists with nullable items #1229- Upgrader improvements #1223
Bug fixes
- Don't require
parser
unless the upgrader is run #1218
1.8.0.pre3 (12 Jan 2018)
New Features
- Custom
Context
classes for class-based schemas #1161 - Custom introspection for class-based schemas #1170
- Improvements to upgrader tasks and internals #1151, #1178, #1212
- Allow description inside field blocks #1175
1.8.0.pre2 (29 Nov 2017)
New Features
- Add
rake graphql:upgrade[app/graphql]
for automatic upgrade #1110 - Automatically camelize field names and argument names #1143, #1126
- Improved error message when defining
name
instead ofgraphql_name
#1104
Bug fixes
- Fix list wrapping when value is
nil
#1117 - Fix ArgumentError typo #1098
1.8.0.pre1 (14 Nov 2017)
Breaking changes
- Stop official support for Ruby 2.1 #1070
New features
- Add class-based schema definition API #1037
1.7.14 (4 Apr 2018)
New features
- Support new IDL spec for
&
for interfaces #1304 - Schema members built from IDL have an
#ast_node
#1367
Bug fixes
- Fix paging backwards with
hasNextPage
#1319 - Add hint for
orphan_types
in error message #1380 - Use an empty hash for
result
when a query has unhandled errors #1382
1.7.13 (28 Feb 2018)
Bug fixes
Schema#as_json
returns a hash, not aGraphQL::Query::Result
#1288
1.7.12 (13 Feb 2018)
Bug fixes
typed_children
should always return a Hash #1278
1.7.11 (13 Feb 2018)
Bug fixes
- Fix compatibility of
irep_node.typed_children
on leaf nodes #1277
1.7.10 (13 Feb 2018)
Breaking Changes
- Empty selections (
{ }
) are invalid in the GraphQL spec, but were previously allowed by graphql-ruby. They now return a parse error. #1268
Bug fixes
- Fix error when inline fragments are spread on scalars #1268
- Fix printing SDL when types have interfaces and directives #1255
1.7.9 (1 Feb 2018)
New Features
- Support block string inputs #1219
Bug fixes
- Fix deprecation regression in schema printer #1250
- Fix resource names in DataDog tracing #1208
- Fix passing
context
to multiplex inQuery#result
#1200
1.7.8 (11 Jan 2018)
New features
- Refactor
Schema::Printer
to useLanguage::Printer
#1159 - Add
ArgumentValue#default_used?
andArguments#default_used?
#1152
Bug fixes
- Fix Scout Tracing #1187
- Call
#inspect
forEnumType::UnresolvedValueError
#1179 - Parse empty field sets in IDL parser #1145
1.7.7 (29 Nov 2017)
New features
Schema#to_document
returns aLanguage::Nodes::Document
#1134- Add
trace_scalars
andtrace: true|false
to monitoring #1103 - Add
Tracing::DataDogPlatform
monitoring #1129 - Support namespaces in
rails g graphql:function
and:loader
#1127 - Support
serializer:
option forActionCableSubscriptions
#1085
Bug fixes
- Properly count the column after a closing quote #1136
- Fix default value input objects in
Schema.from_definition
#1135 - Fix
rails destroy graphql:mutation
#1119 - Avoid unneeded query in RelationConnection with Sequel #1101
- Improve & document instrumentation stack behavior #1101
1.7.6 (13 Nov 2017)
Bug fixes
- Serialize symbols in with
GraphQL::Subscriptions::Serialize
#1084
1.7.5 (7 Nov 2017)
Breaking changes
- Rename
Backtrace::InspectResult#inspect
to#inspect_result
#1022
New features
- Improved website search with Algolia #934
- Support customized generator directory #1047
- Recursively serialize
GlobalID
-compliant objects in Arrays and hashes #1030 - Add
Subscriptions#build_id
helper #1046 - Add
#non_null?
and#list?
helper methods to type objects #1054
Bug fixes
- Fix infinite loop in query instrumentation when error is raised #1074
- Don't try to trace error when it's not raised during execution
- Improve validation of query variable definitions #1073
- Fix Scout tracing module load order #1064
1.7.4 (9 Oct 2017)
Deprecations
GraphQL::Tracing.install
is deprecated, use schema-local or query-local tracers instead #996
New features
- Add monitoring plugins for AppSignal, New Relic, Scout and Skylight #994, #1013
- Custom coercion errors for custom scalars #988
- Extra
options
forGraphQL::ExecutionError
#1002 - Use
GlobalID
for subscription serialization when available #1004 - Schema- and query-local, threadsafe tracers #996
Bug fixes
- Accept symbol-keyed arguments to
.trigger
#1009
1.7.3 (20 Sept 2017)
Bug fixes
- Fix arguments on
Query.__type
field #978 - Fix
Relay::Edge
objects inBacktrace
tables #975
1.7.2 (20 Sept 2017)
Bug fixes
- Correctly skip connections that return
ctx.skip
#972
1.7.1 (18 Sept 2017)
Bug fixes
- Properly release changes from 1.7.0
1.7.0 (18 Sept 2017)
Breaking changes
GraphQL::Result
is the returned from GraphQL execution. #898Schema#execute
andQuery#result
both return aGraphQL::Result
. It implements Hash-like methods to preserve compatibility.
New features
puts ctx.backtrace
prints out a GraphQL backtrace table #946GraphQL::Backtrace.enable
wraps unhandled errors with GraphQL backtraces #946GraphQL::Relay::ConnectionType.bidrectional_pagination = true
turns on true bi-directional pagination checks forhasNextPage
/hasPreviousPage
fields. This will become the default behavior in a future version. #960- Field arguments may be accessed as methods on the
args
object. This is an alternative to#[]
syntax which provides did-you-mean behavior instead of returningnil
on a typo. #924 For example:
# using hash syntax:
args[:limit] # => 10
args[:limittt] # => nil
# using method syntax:
args.limit # => 10
args.limittt # => NoMethodError
The old syntax is not deprecated.
Improvements to schema filters #919
- If a type is not referenced by anything, it's hidden
- If a type is an abstract type, but has no visible members, it's hidden
GraphQL::Argument.define
builds re-usable arguments #948GraphQL::Subscriptions
provides hooks for subscription platforms #672GraphQL::Subscriptions::ActionCableSubscriptions
implements subscriptions over ActionCable #672More runtime values are accessble from a
ctx
object #923 :ctx.parent
returns thectx
from the parent fieldctx.object
returns the currentobj
for that fieldctx.value
returns the resolved GraphQL value for that field
These can be used together, for example, ctx.parent.object
to get the parent object.
GraphQL::Tracing
provides more hooks into gem internals for performance monitoring #917GraphQL::Result
provides access to the originalquery
andcontext
after executing a query #898
Bug fixes
- Prevent passing both query string and parsed document to
Schema#execute
#957 - Prevent invalid names for types #947
1.6.8 (8 Sept 2017)
Breaking changes
- Validate against EnumType value names to match
/^[_a-zA-Z][_a-zA-Z0-9]*$/
#915
New features
- Use stdlib
forwardable
when it's not Ruby 2.4.0 #926 - Improve
UnresolvedTypeError
message #928 - Add a default field to the Rails generated mutation type #922
Bug fixes
- Find types via directive arguments when traversing the schema #944
- Assign
#connection?
when building a schema from IDL #941 - Initialize
@edge_class
tonil
#942 - Disallow invalid enum values #915
- Disallow doubly-nested non-null types #916
- Fix
Query#selected_operation_name
when no selections are present #899 - Fix needless
COUNT
query forhasNextPage
#906 - Fix negative offset with
last
argument #907 - Fix line/col for
ArgumentsAreDefined
validation #890 - Fix Sequel error when limit is
0
#892
1.6.7 (11 Aug 2017)
New features
- Add
GraphQL.parse_file
andAbstractNode#filename
#873 - Support
.graphql
filepaths withSchema.from_definition
#872
Bug fixes
- Fix variable usage inside non-null list #888
- Fix unqualified usage of ActiveRecord::Relation #885
- Fix
FieldsWillMerge
handling of equivalent input objects - Fix to call
prepare:
on nested input types
1.6.6 (14 Jul 2017)
New features
- Validate
graphql-pro
downloads withrake graphql:pro:validate[$VERSION]
#846
Bug fixes
- Remove usage of Rails-only
Array.wrap
#840 - Fix
RelationConnection
to count properly when relation contains an alias #838 - Print name of Enum type when a duplicate value is added #843
1.6.5 (13 Jul 2017)
Breaking changes
Schema#types[](type_name)
returnsnil
when there's no type namedtype_name
(it used to raiseRuntimeError
). To get an error for missing types, use.fetch
instead, for example:
# Old way:
MySchema.types[type_name] # => may raise RuntimeError
# New way:
MySchema.types.fetch(type_name) # => may raise KeyError
- Schema build steps happen in one pass instead of two passes #819 . This means that
instrument(:field)
hooks may not accessSchema#types
,Schema#possible_types
orSchema#get_field
, since the underlying data hasn't been prepared yet. There's not really a clear upgrade path here. It's a bit of a mess. If you're affected by this, feel free to open an issue and we'll try to find something that works!
Deprecations
Schema#resolve_type
is now called with(abstract_type, obj, ctx)
instead of(obj, ctx)
#834 . To update, add an unused parameter to the beginning of yourresolve_type
hook:
MySchema = GraphQL::Schema.define do
# Old way:
resolve_type ->(obj, ctx) { ... }
# New way:
resolve_type ->(type, obj, ctx) { ... }
end
New features
rails g graphql:mutation
will add Mutation boilerplate if it wasn't added already #812InterfaceType
andUnionType
both acceptresolve_type ->(obj, ctx) { ... }
functions for type-specific resolution. This function takes precedence overSchema#resolve_type
#829 #834Schema#resolve_type
is called with three arguments,(abstract_type, obj, ctx)
, so you can distinguish object type based on interface or union.Query#operation_name=
may be assigned during query instrumentation #833query.context.add_error(err)
may be used to add query-level errors #833
Bug fixes
argument(...)
DSL accepts custom keywords #809- Use single-query
max_complexity
overrides #812 - Return a client error when
InputObjectType
receives an array as input #803 - Properly handle raised errors in
prepare
functions #805 - Fix using
as
andprepare
inargument do ... end
blocks #817 - When types are added to the schema with
instrument(:field, ...)
, make sure they're inSchema#types
#819 - Raise an error when duplicate
EnumValue
is created #831 - Properly resolve all query levels breadth-first when using
lazy_resolve
#835 - Fix tests to run on PostgresQL; Run CI on PostgresQL #814
- When no query string is present, return a client error instead of raising
ArgumentError
#833 - Properly validate lists containing variables #824
1.6.4 (20 Jun 2017)
New features
Schema.to_definition
sorts fields and arguments alphabetically #775validate: false
skips static validations in query execution #790
Bug fixes
graphql:install
addsoperation_name: params[:operationName]
#786graphql:install
skipsgraphiql-rails
for API-only apps #772SerialExecution
calls.is_a?(Skip)
to avoid user-defined#==
methods #794prepare:
functions which returnExecutionError
are properly handled when default values are present #801
1.6.3 (7 Jun 2017)
Bug fixes
- Run multiplex instrumentation when running a single query with a legacy execution strategy #766
- Check each strategy when looking for overridden execution strategy #765
- Correctly wrap
Method
s with BackwardsCompatibility #763 - Various performance improvements #764
- Don't call
#==(other)
on user-provided objects (use.is_a?
instead) #761 - Support lazy object from custom connection
#edge_nodes
#762 - If a lazy field returns an invalid null, stop evaluating its siblings #767
1.6.2 (2 Jun 2017)
New features
Schema.define { default_max_page_size(...) }
provides a Connectionmax_page_size
when no other is provided #752Schema#get_field(type, field)
accepts a string type name #756Schema.define { rescue_from(...) }
accepts multiple error classes for the handler #758
Bug fixes
- Use
*_execution_strategy
when executing a single query (doesn't supportSchema#multiplex
) #755 - Fix NameError when
ActiveRecord
isn't loaded #747 - Fix
Query#mutation?
etc to support lazily-loaded AST #754
1.6.1 (28 May 2017)
New Features
Query#selected_operation_name
returns the operation to execute, even if it was inferred (not provided asoperation_name:
) #746
Bug fixes
- Return
nil
fromQuery#operation_name
if nooperation_name:
was provided #746
1.6.0 (27 May 2017)
Breaking changes
InternalRepresentation::Node#return_type
will now return the wrapping type. Usereturn_type.unwrap
to access the old value #704instrument(:query, ...)
instrumenters are applied as a stack instead of a queue #735. If you depend on queue-based behavior, move yourbefore_query
andafter_query
hooks to separate instrumenters.- In a
Relay::Mutation
, Raising or returning aGraphQL::Execution
will nullify the mutation field, not the field's children. #731 args.to_h
returns a slightly different hash #714- keys are always
String
s - if an argument is aliased with
as:
, the alias is used as the key
- keys are always
InternalRepresentation::Node#return_type
includes the original "wrapper" types (non-null or list types), call.unwrap
to get the inner type #20
# before
irep_node.return_type
# after
irep_node.return_type.unwrap
Deprecations
- Argument
prepare
functions which take one argument are deprecated #730
# before
argument :id, !types.ID, prepare: ->(val) { ... }
# after
argument :id, !types.ID, prepare: ->(val, ctx) { ... }
New features
Schema#multiplex(queries)
runs multiple queries concurrently #691GraphQL::RakeTask
supports dumping the schema to IDL or JSON #687- Improved support for
Schema.from_definition
#699 :- Custom scalars are supported with
coerce_input
andcoerce_result
functions resolve_type
function will be used for abstract types- Default resolve behavior is to check
obj
for a method and call it with 0, 1, or 2 arguments.
- Custom scalars are supported with
ctx.skip
may be returned from field resolve functions to exclude the field from the response entirely #688instrument(:field, ..., after_built_ins: true)
to apply field instrumentation after Relay wrappers #740- Argument
prepare
functions are invoked with(val, ctx)
(previously, it was only(val)
) #730 args.to_h
returns stringified, aliased arguments #714ctx.namespace(:my_namespace)
provides namespaced key-value storage #689GraphQL::Query
can be initialized without a query_string; it can be added after initialization #710- Improved filter support #713
Schema.execute(only:, except:)
accept a callable or an array of callables (multiple filters)- Filters can be added to a query via
Query#merge_filters(only:, except:)
. You can add a filter to every query by merging it in during query instrumentation.
Bug fixes
- Correctly apply cursors and
max_page_size
inRelay::RelationConnection
andRelay::ArrayConnection
#728 - Nullify a mutation field when it raises or returns an error #731
1.5.14 (27 May 2017)
New features
UniqueWithinType
Relay ID generator supports-
in the ID #742assign_metadata_key
assignstrue
when the definition method is called without arguments #724- Improved lexer performance #737
Bug fixes
- Assign proper
parent
when aconnection
resolve returns a promise #736
1.5.13 (11 May 2017)
- Fix raising
ExecutionError
inside mutation resolve functions (it nullifies the field) #722
1.5.12 (9 May 2017)
- Fix returning
nil
from connection resolve functions (now they becomenull
) #719 - Fix duplicate AST nodes when merging fragments #721
1.5.11 (8 May 2017)
New features
Schema.from_definition
accepts aparser:
option (to work around lack of schema parser ingraphql-libgraphqlparser
) #712Query#internal_representation
exposes anInternalRepresentation::Document
#701- Update generator usage of
graphql-batch
#697
Bug fixes
- Handle fragments with the same name as operations #706
- Fix type generator: ensure type name is camelized #718
- Fix
Query#operation_name
to return the operation name #707 - Fix pretty-print of non-null & list types #705
- Fix single input objects passed to list-type arguments #716
1.5.10 (25 Apr 2017)
New features
- Support Rails 5.1 #693
- Fall back to
String#encode
for non-UTF-8/non-ASCII strings #676
Bug Fixes
- Correctly apply
Relay::Mutation
'sreturn_field ... property:
argument #692 - Handle Rails 5.1's
ActionController::Parameters
#693
1.5.9 (19 Apr 2017)
Bug Fixes
- Include instrumentation-related changes in introspection result #681
1.5.8 (18 Apr 2017)
New features
- Use Relay PageInfo descriptions from graphql-js #673
Bug Fixes
- Allow fields with different arguments when fragments are included within inline fragments of non-overlapping types #680
- Run
lazy_resolve
instrumentation forconnection
fields #679
1.5.7 (14 Apr 2017)
Bug fixes
InternalRepresentation::Node#definition
returnsnil
instead of raising NoMethodError for operation fields #675Field#function
is properly populated for fields derived fromGraphQL::Function
s #674
1.5.6 (9 Apr 2017)
Breaking Changes
- Returned strings which aren't encoded as UTF-8 or ASCII will raise
GraphQL::StringEncodingError
instead of becomingnil
#661
To preserve the previous behavior, Implement Schema#type_error
to return nil
for this error, eg:
GraphQL::Schema.define do
type_error ->(err, ctx) {
case err
# ...
when GraphQL::StringEncodingError
nil
end
}
coerce_non_null_input
andvalidate_non_null_input
are private #667
Deprecations
- One-argument
coerce_input
andcoerce_result
functions for custom scalars are deprecated. #667 Those functions now accept a second argument,ctx
.
# From
->(val) { val.to_i }
# To:
->(val, ctx) { val.to_i }
- Calling
coerce_result
,coerce_input
,valid_input?
orvalidate_input
without actx
is deprecated. #667 Usecoerce_isolated_result
coerce_isolated_input
,valid_isolated_input?
,validate_input
to explicitly bypassctx
.
New Features
- Include
#types
inGraphQL::Function
#654 - Accept
prepare:
function for arguments #646 - Scalar coerce functions receive
ctx
#667
Bug Fixes
- Properly apply default values of
false
#658 - Fix application of argument options in
GraphQL::Relay::Mutation
#660 - Support concurrent-ruby
>1.0.0
#663 - Only raise schema validation errors on
#execute
to avoid messing with Rails constant loading #665
1.5.5 (31 Mar 2017)
Bug Fixes
- Improve threadsafety of
lazy_resolve
cache, useConcurrent::Map
if it's available #631 - Properly handle unexpeced input objects #638
- Handle errors during definition by preseriving the definition #632
- Fix
nil
input for nullable list types #637, #639 - Handle invalid schema IDL with a validation error #647
- Properly serialize input object default values #635
- Fix
as:
on mutationinput_field
#650 - Fix null propagation for
nil
members of non-null list types #649
1.5.4 (22 Mar 2017)
Breaking Changes
- Stop supporting deprecated one-argument schema masks #616
Bug Fixes
- Return a client error for unknown variable types when default value is provided or when directives are present #627
- Fix validation performance regression on nested abstract fragment conditions #622, #624
- Put back
InternalRepresentation::Node#parent
and fix it for fragment fields #621 - Ensure enum names are strings #619
1.5.3 (20 Mar 2017)
Bug Fixes
- Fix infinite loop triggered by user input. #620 This query would cause an infinite loop:
query { ...frag }
fragment frag on Query { __typename }
fragment frag on Query { ...frag }
- Validate fragment name uniqueness #618
1.5.2 (16 Mar 2017)
Breaking Changes
- Parse errors are no longer raised to the application. #607 Instead, they're returned to the client in the
"errors"
key. To preserve the previous behavior, you can implementSchema#parse_error
to raise the error:
MySchema = GraphQL::Schema.define do
# ...
parse_error ->(err, ctx) { raise(err) }
end
New Features
- Add
graphq:enum
generator #611 - Parse errors are returned to the client instead of raised #607
Bug Fixes
- Handle negative cursor pagination args as
0
#612 - Properly handle returned
GraphQL::ExecutionError
s from connection resolves #610 - Properly handle invalid nulls in lazy scalar fields #609
- Properly handle invalid input objects passed to enum arguments #604
- Fix introspection response of enum default values #605
- Allow
Schema.from_definition
default resolver hashes to have defaults #608
1.5.1 (12 Mar 2017)
Bug fixes
- Fix rewrite performance regressions from 1.5.0 #599
- Remove unused
GraphQL::Execution::Lazy
initialization API #597
1.5.0 (10 Mar 2017), yanked
Breaking changes
- Only UTF-8-encoded strings will be returned by
String
fields. Strings with other encodings (or objects whose#to_s
method returns a string with a different encoding) will returnnil
instead of that string. #517
To opt into the previous behavior, you can modify GraphQL::STRING_TYPE
:
# app/graphql/my_schema.rb
# Restore previous string behavior:
GraphQL::STRING_TYPE.coerce_result = ->(value) { value.to_s }
MySchema = GraphQL::Schema.define { ... }
- Substantial changes to the internal query representation (#512, #536). Query analyzers may notice some changes:
- Nodes skipped by directives are not visited
- Nodes are always on object types, so
Node#owner_type
always returns an object type. (Interfaces and Unions are replaced with concrete object types which are valid in the current scope.)
See changes to Analysis::QueryComplexity
for an example migration. Here are some other specific changes:
- Nodes are tracked on object types only, not interface or union types
- Deprecated, buggy
Node#children
andNode#path
were removed - Buggy
#included
was removed - Nodes excluded by directives are entirely absent from the rewritten tree
- Internal
InternalRepresentation::Selection
was removed (no longer needed) Node#spreads
was replaced byNode#ast_spreads
which returns a Set
New features
Schema#validate
returns a list of errors for a query string #513implements ...
adds interfaces to object types without inherit-by-default #548, #574GraphQL::Relay::RangeAdd
for implementingRANGE_ADD
mutations #587use ...
definition method for plugins #565- Rails generators #521, #580
GraphQL::Function
for reusable resolve behavior with arguments & return type #545- Support for Ruby 2.4 #475
- Relay
node
&nodes
field can be extended with a custom block #552 - Performance improvements:
- Resolve fragments only once when validating #504
- Reuse
Arguments
objects #500 - Skip needless
FieldResult
s #482 - Remove overhead from
ensure_defined
#483 - Benchmark & Profile tasks for gem maintenance #520, #579
- Fetch
has_next_page
while fetching items inRelationConnection
#556 - Merge selections on concrete object types ahead of time #512
- Support runnable schemas with
Schema.from_definition
#567, #584
Bug fixes
- Support different arguments on non-overlapping typed fragments #512
- Don't include children of
@skip
ped nodes when parallel branches are not skipped #536 - Fix offset in ArrayConnection when it's larger than the array #571
- Add missing
frozen_string_literal
comments #589
1.4.5 (6 Mar 2017)
Bug Fixes
- When an operation name is provided but no such operation is present, return an error (instead of executing the first operation) #563
- Require unique operation names #563
- Require selections on root type #563
- If a non-null field returns
null
, don't resolve any more sibling fields. #575
1.4.4 (17 Feb 2017)
New features
Relay::Node.field
andRelay::Node.plural_field
accept a customresolve:
argument #550Relay::BaseConnection#context
provides access to the query context #537- Allow re-assigning
Field#name
#541 - Support
return_interfaces
onRelay::Mutation
s #533 BaseType#to_definition
stringifies the type to IDL #539argument ... as:
can be used to alias an argument inside the resolve function #542
Bug fixes
- Fix negative offset from cursors on PostgresQL #510
- Fix circular dependency issue on
.connection_type
s #535 - Better error when
Relay::Mutation.resolve
doesn't return a Hash
1.4.3 (8 Feb 2017)
New features
GraphQL::Relay::Node.plural_field
finds multiple nodes by UUID #525
Bug fixes
- Properly handle errors from lazy mutation results #528
- Encode all parsed strings as UTF-8 #516
- Improve error messages #501 #519
1.4.2 (23 Jan 2017)
Bug fixes
- Absent variables aren't present in
args
(again!) #494 - Ensure definitions were executed when accessing
Field#resolve_proc
#502 (This could have caused errors when multiple instrumenters modified the same field in the schema.)
1.4.1 (16 Jan 2017)
Bug fixes
- Absent variables aren't present in
args
#479 - Fix grouped ActiveRecord relation with
last
only #476 Schema#default_mask
& queryonly:
/except:
are combined, not overriden #485- Root types can be hidden with dynamic filters #480
1.4.0 (8 Jan 2017)
Breaking changes
Deprecations
- One-argument schema filters are deprecated. Schema filters are now called with two arguments,
(member, ctx)
. #463 To update, add a second argument to your schema filter. - The arity of middleware
#call
methods has changed. Instead ofnext_middleware
being the last argument, it is passed as a block. To update, callyield
to continue the middleware chain or use&next_middleware
to capturenext_middleware
into a local variable.
# Previous:
def call(*args, next_middleware)
next_middleware.call
end
# Current
def call(*args)
yield
end
# Or
def call(*args, &next_middleware)
next_middleware.call
end
New features
- You can add a
nodes
field directly to a connection. #451 That way you can say{ friends { nodes } }
instead of{ freinds { edges { node } } }
. Either passnodes_field: true
when defining a custom connection type, for example:
FriendsConnectionType = FriendType.define_connection(nodes_field: true)
Or, set GraphQL::Relay::ConnectionType.default_nodes_field = true
before defining your schema, for example:
GraphQL::Relay::ConnectionType.default_nodes_field = true
MySchema = GraphQL::Schema.define { ... }
- Middleware performance was dramatically improved by reducing object allocations. #462
next_middleware
is now passed as a block. In general,yield
is faster than calling a captured block. - Improve error messages for wrongly-typed variable values #423
- Cache the value of
resolve_type
per object per query #462 - Pass
ctx
to schema filters #463 - Accept whitelist schema filters as
only:
#463 - Add
Schema#to_definition
which acceptsonly:/except:
to filter the schema when printing #463 - Add
Schema#default_mask
as a defaultexcept:
filter #463 - Add reflection methods to types #473
#introspection?
marks built-in introspection types#default_scalar?
marks built-in scalars#default_relay?
marks built-in Relay types#default_directive?
marks built-in directives
Bug fixes
- Fix ArrayConnection: gracefully handle out-of-bounds cursors #452
- Fix ArrayConnection & RelationConnection: properly handle
last
withoutbefore
#362
1.3.0 (8 Dec 2016)
Deprecations
- As per the spec,
__
prefix is reserved for built-in names only. This is currently deprecated and will be invalid in a future version. #427, #450
New features
Schema#lazy_resolve
allows you to define handlers for a second pass of resolution #386Field#lazy_resolve
can be instrumented to track lazy resolution #429Schema#type_error
allows you to handleInvalidNullError
s andUnresolvedTypeErrors
in your own way #416Schema#cursor_encoder
can be specified for transforming cursors from built-in Connection implementations #345- Schema members
#dup
correctly: they shallowly copy their state into new instances #444 Query#provided_variables
is now public #430
Bug fixes
- Schemas created from JSON or strings with custom scalars can validate queries (although they still can't check if inputs are valid for those custom scalars) #445
- Always use
quirks_mode: true
when serializing values (to support non-stdlibJSON
s) #449 - Calling
#redefine
on a Schema member copies state outside of previous#define
blocks (uses#dup
) #444
1.2.6 (1 Dec 2016)
Bug fixes
- Preserve connection behaviors after
redefine
#421 - Implement
respond_to_missing?
onDefinedObjectProxy
(which isself
inside.define { ... }
) #414
1.2.5 (22 Nov 2016)
Breaking changes
Visitor
received some breaking changes, though these are largely-private APIs (#401):- Global visitor hooks (
Visitor#enter
andVisitor#leave
) have been removed - Returning
SKIP
from a visitor hook no longer skips sibling nodes
- Global visitor hooks (
New features
Schema#instrument
may be called outside ofSchema.define
#399- Validation: assert that directives on a node are unique #409
instrument(:query)
hooks are executed even if the query raises an error #412
Bug fixes
Mutation#input_fields
should trigger lazy definition #392ObjectType#connection
doesn't modify the providedGraphQL::Field
#411Mutation#resolve
may return aGraphQL::ExecutionError
#405Arguments
can handle nullable arguments passed asnil
#410
1.2.4 (14 Nov 2016)
Bug fixes
- For invalid enum values, print the enum name in the error message (not a Ruby object dump) #403
- Improve detection of invalid UTF-8 escapes #394
1.2.3 (14 Nov 2016)
Bug fixes
Lexer
previous token should be a local variable, not a method attribute #396Arguments
should wrap values according to their type, not their value #398
1.2.2 (7 Nov 2016)
New features
Schema.execute
raises an error ifvariables:
is a string
Bug fixes
- Dynamic fields
__schema
,__type
and__typename
are properly validated #391
1.2.1 (7 Nov 2016)
Bug fixes
- Implement
Query::Context#strategy
andFieldResolutionContext#strategy
to support GraphQL::Batch #382
1.2.0 (7 Nov 2016)
Breaking changes
A breaking change from 1.1.0 was reverted: two-character
"\\u"
is longer treated as the Unicode escape character #372Due to the execution bug described below, the internal representation of a query has changed. Although
Node
responds to the same methods, tree is built differently and query analyzers visit it differently. #373, #379
The difference is in cases like this:
outer {
... on A { inner1 { inner2 } }
... on B { inner1 { inner3 } }
}
Previously, visits would be:
outer
, which has one child:inner1
, which has two definitions (one onA
, another onB
), then visit its twochildren
:inner2
which has one definition (on the return type ofinner1
)inner3
which has one definition (on the return type ofinner1
)
This can be wrong for some cases. For example, if A
and B
are mutually exclusive (both object types, or union types with no shared members), then inner2
and inner3
will never be executed together.
Now, the visit goes like this:
outer
which has two entries intyped_children
, one onA
and another onB
. Visit eachtyped_chidren
branch:inner1
, then its onetyped_children
branch:inner2
inner1
, then its onetyped_children
branch:inner3
As you can see, we visit inner1
twice, once for each type condition. inner2
and inner3
are no longer visited as siblings. Instead they're visited as ... cousins? (They share a grandparent, not a parent.)
Although Node#children
is still present, it may not contain all children actually resolved at runtime, since multiple typed_children
branches could apply to the same runtime type (eg, two branches on interface types can apply to the same object type). To track all children, you have to do some bookkeeping during visitation, see QueryComplexity
for an example.
You can see PR #373 for how built-in analyzers were changed to reflect this.
Deprecations
InternalRepresentation::Node#children
andInternalRepresentation::Node#definitions
are deprecated due to the bug described below and the breaking change described above. Instead, useInternalRepresentation::Node#typed_children
andInternalRepresentation::Node#defininition
. #373
New features
null
support for the whole library: as a query literal, variable value, and argument default value. To check for the presence of a nullable, useArguments#key?
#369GraphQL::Schema::UniqueWithinType.default_id_separator
may be assigned to a custom value #381Context#add_error(err)
may be used to add aGraphQL::ExecutionError
to the response's"errors"
key (and the resolve function can still return a value) #367The third argument of
resolve
is now aFieldResolutionContext
, which behaves just like aQuery::Context
, except that it is not modified during query execution. This means you can capture a reference to that context and access some field-level details after the fact:#path
,#ast_node
,#irep_node
. (Other methods are delegated to the underlyingQuery::Context
) #379TimeoutMiddleware
's second argument is a proxied query object: it's#context
method returns theFieldResolutionContext
(see above) for the timed-out field. Other methods are delegated to the underlyingQuery
#379
Bug fixes
- Fix deep selection merging on divergently-typed fragments. #370, #373, #379 Previously, nested selections on different fragments were not distinguished. Consider a case like this:
... on A { inner1 { inner2 } }
... on B { inner1 { inner3 } }
Previously, an object of type A
would resolve inner1
, then the result would receive both inner2
and inner3
. The same was true for an object of type B
.
Now, those are properly distinguished. An object of type A
resolves inner1
, then its result receives inner2
. An object of type B
receives inner1
, then inner3
.
1.1.0 (1 Nov 2016)
Breaking changes
- Two-character
"\\u"
is no longer treated as the Unicode escape character, only the Unicode escape character"\u"
is treated that way. (This behavior was a bug, the migration path is to use the Unicode escape character.) #366 GraphQL::Language::ParserTests
was removed, useGraphQL::Compatibility
instead. #366- Non-null arguments can't be defined with default values, because those values would never be used #361
New features
Schema.from_definition(definition_string)
builds aGraphQL::Schema
out of a schema definition. #346- Schema members (types, fields, arguments, enum values) can be hidden on a per-query basis with the
except:
option #300 GraphQL::Compatibility
contains.build_suite
functions for testing user-provided parsers and execution strategies with GraphQL internals. #366- Schema members respond to
#redefine { ... }
for making shallow copies with extended definitions. #357 Schema#instrument
provides an avenue for observing query and field resolution with no overhead.- Some
SerialExecution
objects were converted to functions, resulting in a modest performance improvement for query resolution.
Bug fixes
NonNullType
andListType
have no name (nil
), as per the spec #355- Non-null arguments can't be defined with default values, because those values would never be used #361
1.0.0 (25 Oct 2016)
Breaking changes
validate: false
option removed fromSchema.execute
(it didn't work anyways) #338- Some deprecated methods were removed: #349
BaseConnection#object
was removed, useBaseConnection#nodes
BaseConnection.connection_for_items
was removed, useBaseConnection#connection_for_nodes
- Two-argument resolve functions for
Relay::Mutation
s are not supported, use three arguments instead:(root_obj, input, ctx)
Schema.new
no longer accepts initialization options, useSchema.define
insteadGraphQL::ObjectType::UnresolvedTypeError
was removed, useGraphQL::UnresolvedTypeError
instead
- Fragment type conditions should be parsed as
TypeName
nodes, not strings. (Users ofgraphql-libgraphqlparser
should update to1.0.0
of that gem.) #342
New Features
- Set
ast_node
andirep_node
on query context before sending it to middleware #348 - Enum values can be extended with
.define
#341
Bug Fixes
- Use
RelationConnection
for Rails 3 relations (which also extendArray
) #343 - Fix schema printout when arguments have comments #335
0.19.4 (18 Oct 2016)
Breaking changes
Relay::BaseConnection#order
was removed (it always returnednil
) #313- In the IDL, Interface names & Union members are parsed as
TypeName
nodes instead of Strings #322
New features
- Print and parse descriptions in the IDL #305
- Schema roots from IDL are omitted when their names match convention #320
- Don't add
rescue_middleware
to a schema if it's not usingrescue_from
#328 Query::Arguments#each_value
yieldsQuery::Argument::ArgumentValue
instances which contain key, value and argument definition #331
Bug fixes
- Use
JSON.generate(val, quirks_mode: true)
for compatibility with other JSON implementations #316 - Improvements for compatibility with 1.9.3 branch #315 #314 #313
- Raise a descriptive error when calculating a
cursor
for a node which isn't present in the connection's members #327
0.19.3 (13 Oct 2016)
Breaking Changes
GraphQL::Query::Arguments.new
requiresargument_definitions:
of type{String => GraphQL::Argument }
#304
Deprecations
Relay::Mutation#resolve
has a new signature. #301
Previously, it was called with two arguments:
resolve ->(inputs, ctx) { ... }
Now, it's called with three inputs:
resolve ->(obj, inputs, ctx) { ... }
obj
is the value of root_value:
given to Schema#execute
, as with other root-level fields.
Two-argument resolvers are still supported, but they are deprecated and will be removed in a future version.
New features
Relay::Mutation
accepts a user-definedreturn_type
#310Relay::Mutation#resolve
receives theroot_value
passed toSchema#execute
#301- Derived
Relay
objects have descriptions #303
Bug fixes
- Introspection query is 7 levels deep instead of 3 #308
- Unknown variable types cause validation errors, not runtime errors #310
Query::Arguments
doesn't wrap hashes from parsed scalars (fix for user-defined "JSONScalar") #304
0.19.2 (6 Oct 2016)
New features
- If a list entry has a
GraphQL::ExecutionError
, replace the entry withnil
and return the error #295
Bug fixes
- Support graphql-batch rescuing
InvalidNullError
s #296 - Schema printer prints Enum names, not Ruby values for enums #297
0.19.1 (4 Oct 2016)
Breaking changes
- Previously-deprecated
InterfaceType#resolve_type
hook has been removed, useSchema#resolve_type
instead #290
New features
- Eager-load schemas at definition time, validating types & schema-level hooks #289
InvalidNullError
s contain the type & field name that returned null #293- If an object is resolved with
Schema#resolve_type
and the resulting type is not a member of the expected possible types, raise an error #291
Bug fixes
- Allow
directive
as field or argument name #288
0.19.0 (30 Sep 2016)
Breaking changes
GraphQL::Relay::GlobalNodeIdentification
was removed. Its features were moved toGraphQL::Schema
orGraphQL::Relay::Node
. The new hooks support more robust & flexible global IDs. #243- Relay's
"Node"
interface andnode(id: "...")
field were both moved toGraphQL::Relay::Node
. To use them in your schema, call.field
and.interface
. For example:
# Adding a Relay-compliant `node` field: field :node, GraphQL::Relay::Node.field
# This object type implements Relay's `Node` interface: interfaces [GraphQL::Relay::Node.interface]
- UUID hooks were renamed and moved to
GraphQL::Schema
. You should defineid_from_object
andobject_from_id
in yourSchema.define { ... }
block. For example:
MySchema = GraphQL::Schema.define do # Fetch an object by UUID object_from_id ->(id, ctx) { MyApp::RelayLookup.find(id) } # Generate a UUID for this object id_from_object ->(obj, type_defn, ctx) { MyApp::RelayLookup.to_id(obj) } end
- The new hooks have no default implementation. To use the previous default, use
GraphQL::Schema::UniqueWithinType
, for example:
MySchema = GraphQL::Schema.define do object_from_id ->(id, ctx) { # Break the id into its parts: type_name, object_id = GraphQL::Schema::UniqueWithinType.decode(id) # Fetch the identified object # ... } id_from_object ->(obj, type_defn, ctx) { # Provide the type name & the object's `id`: GraphQL::Schema::UniqueWithinType.encode(type_defn.name, obj.id) } end
If you were using a custom
id_separator
, it's now accepted as an input toUniqueWithinType
's methods, asseparator:
. For example:# use "---" as a ID separator GraphQL::Schema::UniqueWithinType.encode(type_name, object_id, separator: "---") GraphQL::Schema::UniqueWithinType.decode(relay_id, separator: "---")
type_from_object
was previously deprecated and has been replaced bySchema#resolve_type
. You should define this hook in your schema to return a type definition for a given object:
MySchema = GraphQL::Schema.define do # ... resolve_type ->(obj, ctx) { # based on `obj` and `ctx`, # figure out which GraphQL type to use # and return the type } end
Schema#node_identification
has been removed.
- Relay's
Argument
default values have been changed to be consistent withInputObjectType
default values. #267
Previously, arguments expected GraphQL values as default_value
s. Now, they expect application values. (InputObjectType
s always worked this way.)
Consider an enum like this one, where custom values are provided:
PowerStateEnum = GraphQL::EnumType.define do
name "PowerState"
value("ON", value: 1)
value("OFF", value: 0)
end
Previously, enum names were provided as default values, for example:
field :setPowerState, PowerStateEnum do
# Previously, the string name went here:
argument :newValue, default_value: "ON"
end
Now, enum values are provided as default values, for example:
field :setPowerState, PowerStateEnum do
# Now, use the application value as `default_value`:
argument :newValue, default_value: 1
end
Note that if you don't have custom values, then there's no change, because the name and value are the same.
Here are types that are affected by this change:
- Custom scalars (previously, the
default_value
was a string, now it should be the application value, egDate
orBigDecimal
) - Enums with custom
value:
s (previously, thedefault_value
was the name, now it's the value)
If you can't replace default_value
s, you can also use a type's #coerce_input
method to translate a GraphQL value into an application value. For example:
# Using a custom scalar, "Date"
# PREVIOUSLY, provide a string:
argument :starts_on, DateType, default_value: "2016-01-01"
# NOW, transform the string into a Date:
argument :starts_on, DateType, default_value: DateType.coerce_input("2016-01-01")
New features
- Support
@deprecated
in the Schema language #275 - Support
directive
definitions in the Schema language #280 - Use the same introspection field descriptions as
graphql-js
#284
Bug fixes
- Operation name is no longer present in execution error
"path"
values #276 - Default values are correctly dumped & reloaded in the Schema language #267
0.18.15 (20 Sep 2016)
Breaking changes
- Validation errors no longer have a
"path"
key in their JSON. It was renamed to"fields"
#264 @skip
and@include
over multiple selections are handled according to the spec: if the same field is selected multiple times and one or more of them would be included, the field will be present in the response. Previously, if one or more of them would be skipped, it was absent from the response. #256
New features
- Execution errors include a
"path"
key which points to the field in the response where the error occurred. #259 - Parsing directives from the Schema language is now supported #273
Bug fixes
@skip
and@include
over multiple selections are now handled according to the spec #256
0.18.14 (20 Sep 2016)
Breaking changes
- Directives are no longer considered as "conflicts" in query validation. This is in conformity with the spec, but a change for graphql-ruby #263
Features
- Query analyzers may emit errors by raising
GraphQL::AnalysisError
s during#call
or returning a single error or an array of errors from#final_value
#262
Bug fixes
- Merge fields even when
@skip
/@include
are not identical #263 - Fix possible infinite loop in
FieldsWillMerge
validation #261
0.18.13 (19 Sep 2016)
Bug fixes
- Find infinite loops in nested contexts, too #258
0.18.12 (19 Sep 2016)
New features
GraphQL::Analysis::FieldUsage
can be used to check for deprecated fields in the query analysis phase #245
Bug fixes
- If a schema receives a query on
mutation
orsubscription
but that root doesn't exist, return a validation error #254 Query::Arguments#to_h
only includes keys that were provided in the query or have a default value #251
0.18.11 (11 Sep 2016)
New features
GraphQL::Language::Nodes::Document#slice(operation_name)
finds that operation and its dependencies and puts them in a newDocument
#241
Bug fixes
- Validation errors for non-existent fields have the location of the field usage, not the parent field #247
- Properly
require "forwardable"
#242 - Remove
ALLOWED_CONSTANTS
for boolean input, use a plain comparison #240
0.18.10 (9 Sep 2016)
New features
- Assign
#mutation
on objects which are derived from aRelay::Mutation
#239
0.18.9 (6 Sep 2016)
Bug fixes
- fix backward compatibility for
type_from_object
#238
0.18.8 (6 Sep 2016)
New features
- AST nodes now respond to
#eql?(other)
to test value equality #231
Bug fixes
- The
connection
helper no longer adds a duplicate field #235
0.18.7 (6 Sep 2016)
New features
- Support parsing nameless fragments (but not executing them) #232
Bug fixes
- Allow
__type(name: "Whatever")
to return null, as per the spec #233 - Include a Relay mutation's description with a mutation field #225
0.18.6 (29 Aug 2016)
New features
GraphQL::Schema::Loader.load(schema_json)
turns an introspection result into aGraphQL::Schema
#207.define
accepts plural definitions for: object fields, interface fields field arguments, enum values #222
0.18.5 (27 Aug 2016)
Deprecations
Schema.new
is deprecated; useSchema.define
instead.
Before:
schema = GraphQL::Schema.new(
query: QueryType,
mutation: MutationType,
max_complexity: 100,
types: [ExtraType, OtherType]
)
schema.node_identification = MyGlobalID
schema.rescue_from(ActiveRecord::RecordNotFound) { |err| "..." }
After:
schema = GraphQL::Schema.define do
query QueryType
mutation MutationType
max_complexity 100
node_identification MyGlobalID
rescue_from(ActiveRecord::RecordNotFound) { |err| "..." }
# Types was renamed to `orphan_types` to avoid conflict with the `types` helper
orphan_types [ExtraType, OtherType]
end
This unifies the disparate methods of configuring a schema and provides new, more flexible design space. It also adds #metadata
to schemas for user-defined storage.
UnionType#resolve_type
,InterfaceType#resolve_type
, andGlobalNodeIdentification#type_from_object
are deprecated, unify them intoSchema#resolve_type
instead.
Before:
GraphQL::Relay::GlobalNodeIdentification.define do
type_from_object ->(obj) { ... }
end
GraphQL::InterfaceType.define do
resolve_type ->(obj, ctx) { ... }
end
After:
GraphQL::Schema.define do
resolve_type ->(obj, ctx) { ... }
end
This simplifies type inference and prevents unexpected behavior when different parts of the schema resolve types differently.
New features
- Include expected type in Argument errors #221
- Define schemas with
Schema.define
#208 - Define a global object-to-type function with
Schema#resolve_type
#216
Bug fixes
0.18.4 (25 Aug 2016)
New features
InvalidNullError
s expose a proper#message
#217
Bug fixes
- Return an empty result for queries with no operations #219
0.18.3 (22 Aug 2016)
Bug fixes
Connection.new(:field)
is optional, not required #215- 0.18.2 introduced a more restrictive approach to resolving interfaces & unions; revert that approach #212
0.18.2 (17 Aug 2016)
New features
- Connection objects expose the
GraphQL::Field
that created them viaConnection#field
#206
0.18.1 (7 Aug 2016)
Deprecations
- Unify
Relay
naming aroundnodes
as the items of a connection:Relay::BaseConnection.connection_for_nodes
replacesRelay::BaseConnection.connection_for_items
Relay::BaseConnection#nodes
replacesRelay::BaseConnection#object
New features
- Connection fields'
.resolve_proc
is an instance ofRelay::ConnectionResolve
#204 - Types, fields and arguments can store arbitrary values in their
metadata
hashes #203
0.18.0 (4 Aug 2016)
Breaking changes
graphql-relay
has been merged withgraphql
, you should removegraphql-relay
from your gemfile. #195
Deprecations
New features
GraphQL.parse
can turn schema definitions into aGraphQL::Language::Nodes::Document
. The document can be stringified again withDocument#to_query_string
#191- Validation errors include a
path
to the part of the query where the error was found #198 .define
also accepts keywords for each helper method, egGraphQL::ObjectType.define(name: "PostType", ...)
Bug fixes
global_id_field
s have default complexity of 1, notnil
- Relay
pageInfo
is correct for connections limited bymax_page_size
- Rescue invalid variable errors & missing operation name errors during query analysis
0.17.2 (26 Jul 2016)
Bug fixes
- Correctly spread fragments when nested inside other fragments #194
0.17.1 (26 Jul 2016)
Bug fixes
- Fix
InternalRepresentation::Node#inspect
0.17.0 (21 Jul 2016)
Breaking changes
InternalRepresentation::Node
API changes:#definition_name
returns the field name on field nodes (while#name
may have an alias)#definitions
returns{type => field}
pairs for possible fields on this node#definition
is gone, it is equivalent tonode.definitions.values.first
#on_types
is gone, it is equivalent tonode.definitions.keys
New features
- Accept
hash_key:
field option - Call
.define { }
block lazily, so-> { }
is not needed for circular references #182
Bug fixes
- Support
on
as an Enum value - If the same field is requested on multiple types, choose the maximum complexity among them (not the first)
0.16.1 (20 Jul 2016)
Bug fixes
- Fix merging fragments on Union types (see #190, broken from #180)
0.16.0 (14 Jul 2016)
Breaking changes & deprecations
- I don't know that this breaks anything, but
GraphQL::Query::SerialExecution
now iterates over a tree ofGraphQL::InternalRepresentation::Node
s instead of an AST (GraphQL::Language::Nodes::Document
).
New features
- Query context keys can be assigned with
Context#[]=
#178 - Cancel further field resolution with
TimeoutMiddleware
#179 - Add
GraphQL::InternalRepresentation
for normalizing queries from AST #180 - Analyze the query before running it #180
- Assign complexity cost to fields, enforce max complexity before running it #180
- Log max complexity or max depth with
MaxComplexity
orMaxDepth
analyzers #180 - Query context exposes
#irep_node
, the internal representation of the current node #180
Bug fixes
- Non-null errors are propagated to the next nullable field, all the way up to
data
#174
0.15.3 (28 Jun 2016)
New features
EnumValue
s can receive their properties after instantiation #171
0.15.2 (16 Jun 2016)
New features
- Support lazy type arguments in Object's
interfaces
and Union'spossible_types
#169
Bug fixes
- Support single-member Unions, as per the spec #170
0.15.1 (15 Jun 2016)
Bug fixes
- Whitelist operation types in
lexer.rb
0.15.0 (11 Jun 2016)
Breaking changes & deprecations
- Remove
debug:
option, propagate all errors. #161
0.14.1 (11 Jun 2016)
Breaking changes & deprecations
debug:
is deprecated (#165). Propagating errors (debug: true
) will become the default behavior. You can get a similar implementation of error gobbling withCatchallMiddleware
. Add it to your schema:MySchema.middleware << GraphQL::Schema::CatchallMiddleware
New features
Bug fixes
- Restore previous introspection fields on DirectiveType as deprecated #164
- Apply coercion to input default values #162
- Proper Enum behavior when a value isn't found
0.14.0 (31 May 2016)
Breaking changes & deprecations
New features
GraphQL::Language::Nodes::Document#to_query_string
will re-serialize a query AST #151- Accept
root_value:
when running a query #157 - Accept a
GraphQL::Language::Nodes::Document
toQuery.new
(this allows you to cache parsed queries on the server) #152
Bug fixes
- Improved parse error messages #149
- Improved build-time validation #150
- Raise a meaningful error when a Union or Interface can't be resolved during query execution #155
0.13.0 (29 Apr 2016)
Breaking changes & deprecations
- "Dangling" object types are not loaded into the schema. The must be passed in
GraphQL::Schema.new(types: [...])
. (This was deprecated in 0.12.1)
New features
- Update directive introspection to new spec #121
- Improved schema validation errors #113
- 20x faster parsing #119
- Support inline fragments without type condition #123
- Support multiple schemas composed of the same types #142
- Accept argument
description
anddefault_value
in the block #138 - Middlewares can send new arguments to subsequent middlewares #129
Bug fixes
- Don't leak details of internal errors #120
- Default query
context
to{}
#133 - Fixed list nullability validation #131
- Ensure field names are strings #128
- Fix
@skip
and@include
implementation #124 - Interface membership is not shared between schemas #142
0.12.1 (26 Apr 2016)
Breaking changes & deprecations
- Connecting object types to the schema only via interfaces is deprecated. It will be unsupported in the next version of
graphql
.
Sometimes, object type is only connected to the Query (or Mutation) root by being a member of an interface. In these cases, bugs happen, especially with Rails development mode. (And sometimes, the bugs don't appear until you deploy to a production environment!)
So, in a case like this:
HatInterface = GraphQL::ObjectType.define do
# ...
end
FezType = GraphQL::ObjectType.define do
# ...
interfaces [HatInterface]
end
QueryType = GraphQL::ObjectType.define do
field :randomHat, HatInterface # ...
end
FezType
can only be discovered by QueryType
through HatInterface
. If fez_type.rb
hasn't been loaded by Rails, HatInterface.possible_types
will be empty!
Now, FezType
must be passed to the schema explicitly:
Schema.new(
# ...
types: [FezType]
)
Since the type is passed directly to the schema, it will be loaded right away!
New features
Bug fixes
0.12.0 (20 Mar 2016)
Breaking changes & deprecations
GraphQL::DefinitionConfig
was replaced byGraphQL::Define
#116- Many scalar types are more picky about which inputs they allow (#115). To get the previous behavior, add this to your program:
# Previous coerce behavior for scalars:
GraphQL::BOOLEAN_TYPE.coerce = ->(value) { !!value }
GraphQL::ID_TYPE.coerce = ->(value) { value.to_s }
GraphQL::STRING_TYPE.coerce = ->(value) { value.to_s }
# INT_TYPE and FLOAT_TYPE were unchanged
GraphQL::Field
s can't be renamed because#resolve
may depend on that name. (This was only a problem if you pass the sameGraphQL::Field
instance tofield ... field:
definitions.)GraphQL::Query::DEFAULT_RESOLVE
was removed.GraphQL::Field#resolve
handles that behavior.
New features
- Can override
max_depth:
fromSchema#execute
- Base
GraphQL::Error
for all graphql-related errors
Bug fixes
- Include
""
for String default values (so it's encoded as a GraphQL string literal)
0.11.1 (6 Mar 2016)
New features
- Schema
max_depth:
option #110 - Improved validation errors for input objects #104
- Interfaces provide field implementations to object types #108
0.11.0 (28 Feb 2016)
Breaking changes & deprecations
GraphQL::Query::BaseExecution
was removed, you should probably extendSerialExecution
instead #96GraphQL::Language::Nodes
members no longer raise if they don't get inputs duringinitialize
#92GraphQL.parse
no longer acceptsas:
for parsing partial queries. #92
New features
Field#property
&Field#property=
can be used to access & modify the method that will be sent to the underlying object when resolving a field #88- When defining a field, you can pass a string for as
type
. It will be looked up in the global namespace. Query::Arguments#to_h
unwrapsArguments
objects recursively- If you raise
GraphQL::ExecutionError
during field resolution, it will be rescued and the message will be added to the response'serrors
key. #93 - Raise an error when non-null fields are
nil
#94
Bug fixes
- Accept Rails params as input objects
- Don't get a runtime error when input contains unknown key #100
0.10.9 (15 Jan 2016)
Bug fixes
- Handle re-assignment of
ObjectType#interfaces
#84 - Fix merging queries on interface-typed fields #85
0.10.8 (14 Jan 2016)
Bug fixes
- Fix transform of nested lists #79
- Fix parse & transform of escaped characters #83
0.10.7 (22 Dec 2015)
New features
- Support Rubinius
Bug fixes
- Coerce values into one-item lists for ListTypes
0.10.6 (20 Dec 2015)
Bug fixes
- Remove leftover
puts
es
0.10.5 (19 Dec 2015)
Bug fixes
- Accept enum value description in definition #71
- Correctly parse empty input objects #75
- Correctly parse arguments preceded by newline
- Find undefined input object keys during static validation
0.10.4 (24 Nov 2015)
New features
- Add
Arguments#to_h
#66
Bug fixes
- Accept argument description in definition
- Correctly parse empty lists
0.10.3 (11 Nov 2015)
New features
- Support root-level
subscription
type
Bug fixes
- Require Set for Schema::Printer
0.10.2 (10 Nov 2015)
Bug fixes
- Handle blank strings in queries
- Raise if a field is configured without a proper type #61
0.10.1 (22 Oct 2015)
Bug fixes
- Properly merge fields on fragments within fragments
- Properly delegate enumerable-ish methods on
Arguments
#56 - Fix & refactor literal coersion & validation #53
0.10.0 (17 Oct 2015)
New features
- Scalars can have distinct
coerce_input
andcoerce_result
methods #48 - Operations don't require a name #54
Bug fixes
- Big refactors and fixes to variables and arguments:
- Correctly apply argument default values
- Correctly apply variable default values
- Raise at execution-time if non-null variables are missing
- Incoming values are coerced to their proper types before execution
0.9.5 (1 Oct 2015)
New features
- Add
Schema#middleware
to wrap field access - Add
RescueMiddleware
to handle errors during field execution - Add
Schema::Printer
for printing the schema definition #45
Bug fixes
0.9.4 (22 Sept 2015)
New features
- Fields can return
GraphQL::ExecutionError
s to add errors to the response
Bug fixes
- Fix resolution of union types in some queries #41
0.9.3 (15 Sept 2015)
New features
- Add
Schema#execute
shorthand for running queries - Merge identical fields in fragments so they're only resolved once #34
- An error during parsing raises
GraphQL::ParseError
#33
Bug fixes
- Find nested input types in
TypeReducer
#35 - Find variable usages inside fragments during static validation
0.9.2, 0.9.1 (10 Sept 2015)
Bug fixes
- remove Celluloid dependency
0.9.0 (10 Sept 2015)
Breaking changes & deprecations
- remove
GraphQL::Query::ParallelExecution
(usegraphql-parallel
)
0.8.1 (10 Sept 2015)
Breaking changes & deprecations
GraphQL::Query::ParallelExecution
has been extracted tographql-parallel
0.8.0 (4 Sept 2015)
New features
- Async field resolution with
context.async { ... }
- Access AST node during resolve with
context.ast_node
Bug fixes
- Fix for validating arguments returning up too soon
- Raise if you try to define 2 types with the same name
- Raise if you try to get a type by name but it doesn't exist
0.7.1 (27 Aug 2015)
Bug fixes
- Merge nested results from different fragments instead of using the latest one only
0.7.0 (26 Aug 2015)
Breaking changes & deprecations
- Query keyword argument
params:
was removed, usevariables:
instead.
Bug fixes
@skip
has precedence over@include
- Handle when
DEFAULT_RESOVE
returns nil
0.6.2 (20 Aug 2015)
Bug fixes
- Fix whitespace parsing in input objects
0.6.1 (16 Aug 2015)
New features
- Parse UTF-8 characters & escaped characters
Bug fixes
- Properly parse empty strings
- Fix argument / variable compatibility validation
0.6.0 (14 Aug 2015)
Breaking changes & deprecations
- Deprecate
params
option toQuery#new
in favor ofvariables
- Deprecated
.new { |obj, types, fields, args| }
API was removed (use.define
)
New features
Query#new
acceptsoperation_name
argumentInterfaceType
andUnionType
acceptresolve_type
configs
Bug fixes
- Gracefully handle blank-string & whitespace-only queries
- Handle lists in variable definitions and arguments
- Handle non-null input types
0.5.0 (12 Aug 2015)
Breaking changes & deprecations
- Deprecate definition API that yielded a bunch of helpers #18
New features
- Add new definition API #18