All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
You can find and compare releases at the GitHub release page.
- PHP version required: 7.4+
- Propagate error message and stack trace for why leaf value serialization failed
- Do not throw client safe
Error
when failing to serialize an Enum type - Use native PHP types for properties of
Type
and its subclasses - Throw
SerializationError
over client safeError
when failing to serialize leaf types - Move debug entries in errors under
extensions
key - Use native PHP types wherever possible
- Always throw
RequestError
with useful message when clients provide an invalid JSON body - Move class
BlockString
from namespaceGraphQL\Utils
toGraphQL\Language
- Return string-keyed arrays from
GraphQL::getStandardDirectives()
,GraphQL::getStandardTypes()
andGraphQL::getStandardValidationRules()
- Move complexity related code from
FieldDefinition
toQueryComplexity
- Exclude unused standard types from the schema
- Require lazy type loader to return
Type
directly without an intermediary callable - Allow lazy type loader to return
null
- Rename
ServerConfig
optionpersistentQueryLoader
topersistedQueryLoader
- Call previously unused methods
EnumType::parseValue()
andEnumType::parseLiteral()
- Strongly type
PromiseAdapter::createRejected()
to require\Throwable
- Move members specific to
NamedType
out ofType
:$name
,$description
,$config
,isBuiltInType()
,assertValid()
- Always convert recursively when calling
Node::toArray()
- Make
Directive::$config['args']
use the same definition style asFieldDefinition::$config['args']
- Rename
FieldArgument
toArgument
- Make errors when parsing scalar literals more precise
- Change expected
QueryPlan
options from['group-implementor-fields']
to['groupImplementorFields' => true]
inResolveInfo::lookAhead()
- Always convert promises through
PromiseAdapter::convertThenable()
before calling->then()
on them - Use
JSON_THROW_ON_ERROR
injson_encode()
- Validate some internal invariants through
assert()
- Improve extendability of validator rules
- Add tests for errors that occur when undeclared fields are passed in input
- Warn about orphaned object types
- Expose structured enumeration of directive locations
- Add
AST::concatAST()
utility - Allow lazy input object fields
- Add validation rule
UniqueEnumValueNames
- Add SDL validation rule
UniqueOperationTypes
(#995) - Add ability to remove custom validation rules after adding them via
DocumentValidator::removeRule()
- Allow lazy enum values
- Make
Node
implementJsonSerializable
- Use recursive algorithm for printer and improve its performance
- Use
foreach
over slower functionsarray_map()
andUtils::map()
- Avoid QueryPlan crash when multiple $fieldNodes are present
- Clarify error when attempting to coerce anything but
array
orstdClass
to an input object - Allow directives on variable definitions
- Handle
null
parent of list inValuesOfCorrectType::getVisitor
- Allow sending both
query
andqueryId
, ignorequeryId
in that case - Fix
extend()
to preserverepeatable
(#931) - Preserve extended methods from class-based types in
SchemaExtender::extend()
- Fix printing of empty types (#940)
- Clone
NodeList
inNode::cloneDeep()
- Remove deprecated
Type::getInternalTypes()
- Remove deprecated
GraphQL::execute()
- Remove deprecated
GraphQL::executeAndReturnResult()
- Remove deprecated experimental CoroutineExecutor
- Remove deprecated
FormattedError::create()
andFormattedError::createFromPHPError()
- Remove deprecated
GraphQL::setPromiseAdapter()
- Remove deprecated
AST::getOperation()
- Remove deprecated constants from
BreakingChangesFinder
- Remove deprecated
DocumentValidator::isValidLiteralValue()
- Remove deprecated
Error::formatError()
andError::toSerializableArray()
- Remove deprecated
GraphQL::getInternalDirectives()
- Remove deprecated
Schema::isPossibleType()
- Remove deprecated methods from
TypeInfo
- Remove deprecated
Values::valueFromAST()
andValues::isValidPHPValue()
- Remove deprecated public property access to
InputObjectField::$type
- Remove deprecated public property access to
FieldDefinition::$type
- Remove alias
GraphQL\Validator\Rules\AbstractQuerySecurity
, useGraphQL\Validator\Rules\QuerySecurityRule
- Remove alias
GraphQL\Validator\Rules\AbstractValidationRule
, useGraphQL\Validator\Rules\ValidationRule
- Remove
OperationParams
methodgetOriginalInput()
in favor of public property$originalInput
- Remove
OperationParams
methodisReadOnly()
in favor of public property$readOnly
- Remove
Utils::withErrorHandling()
- Remove
TypeComparators::doTypesOverlap()
- Remove
DocumentValidator::isError()
- Remove
DocumentValidator::append()
- Remove
Utils::getVariableType()
in favor ofUtils::printSafe()
- Remove warning for passing
isDeprecated
in field definition config - Remove
WrappingType::getWrappedType()
argument$recurse
in favor ofWrappingType::getInnermostType()
- Remove
Type::assertType()
- Remove
ListOfType::$ofType
,ListOfType::getOfType()
andNonNull::getOfType()
- Remove option
commentDescriptions
fromBuildSchema::buildAST()
,BuildSchema::build()
andPrinter::doPrint()
- Remove parameter
$options
fromASTDefinitionBuilder
- Remove
FieldDefinition::create()
in favor ofnew FieldDefinition()
- Fix compatibility of more methods with native return type in PHP 8.1
- Support non-JSON
ServerRequestInterface
- Fix compatibility of methods with native return type in PHP 8.1
- Allow field definitions to be defined as any
iterable
, not justarray
- Make
IntType
constantsMAX_INT
andMIN_INT
public
- Add support for type config decorator in
SchemaExtender
- Implement
GraphQL\Utils\AST::getOperationAST()
- Allow providing field definitions as a callable and resolve them lazily
- Avoid crashing in
QueryPlan
when__typename
is used in the query
Refactoring:
- Improve performance of subtype checks
- Fix overly eager validation of repeatable directive usage
- Add fallback for
directive.isRepeatable
inBuildClientSchema
- Open ReferenceExecutor for extending
- Ensure properties annotated to hold NodeList are not null
- Validate that directive argument names do not use reserved or duplicate names
- Fix Input Object field shortcut definition with callable (#773)
- Implement support for interfaces implementing interfaces (#740), huge kudos to @Kingdutch
Deprecates:
-
Constant
BreakingChangeFinder::BREAKING_CHANGE_INTERFACE_REMOVED_FROM_OBJECT
. UseBreakingChangeFinder::BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED
instead. Constant value also changed fromINTERFACE_REMOVED_FROM_OBJECT
toIMPLEMENTED_INTERFACE_REMOVED
. -
Constant
BreakingChangeFinder::DANGEROUS_CHANGE_INTERFACE_ADDED_TO_OBJECT
UseDANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED
instead. Constant value also changed fromINTERFACE_ADDED_TO_OBJECT
toIMPLEMENTED_INTERFACE_ADDED
.
Refactoring:
- Reify AST node types and remove unneeded nullability (#751)
- Allow pushing nodes to
NodeList
via[]=
(#767) - Fix signature of
Error\FormattedError::prepareFormatter()
to address PHP8 deprecation (#742) - Do not add errors key to result when errors discarded by custom error handler (#766)
- Fixed
SchemaPrinter
so that it uses late static bindings when extended - Parse
DirectiveDefinitionNode->locations
asNodeList<NamedNode>
(fixes AST::fromArray conversion) (#723) - Parse
Parser::implementsInterfaces
asNodeList<NamedTypeNode>
(fixes AST::fromArray conversion) - Fix signature of
Parser::unionMemberTypes
to match actualNodeList<NamedTypeNode>
- Allow
typeLoader
to return a type thunk (#687)
- Read getParsedBody() instead of getBody() when Request is ServerRequest (#715)
- Fix default get/set behavior on InputObjectField and FieldDefinition (#716)
Deprecates:
- Public access to
FieldDefinition::$type
property (#702)
Fixes:
- Fix validation for input field definition directives (#714)
- Handle nullable
DirectiveNode#astNode
inSchemaValidationContext
(#708)
- Add partial parse functions for const variants (#693)
- Differentiate between client-safe and non-client-safe errors in scalar validation (#706)
- Proper type hints for
IntValueNode
(#691) - Fix "only booleans are allowed" errors (#659)
- Ensure NamedTypeNode::$name is always a NameNode (#695)
- Visitor: simplify getVisitFn (#694)
- Replace function calls with type casts (#692)
- Optimize lazy types (#684)
- Fix for: Argument defaults with integer/float values crashes introspection query (#679)
- Fix for "Invalid AST Node: false" error (#685)
- Fix double Error wrapping when parsing variables (#688)
- Do not use call_user_func or call_user_func_array (#676)
- Codestyle and static analysis improvements (#648, #690)
This release brings several breaking changes. Please refer to UPGRADE document for details.
- BREAKING/BUGFIX: Strict coercion of scalar types (#278)
- BREAKING/BUGFIX: Spec-compliance: Fixed ambiguity with null variable values and default values (#274)
- BREAKING: Removed deprecated directive introspection fields (onOperation, onFragment, onField)
- BREAKING:
GraphQL\Deferred
now extendsGraphQL\Executor\Promise\Adapter\SyncPromise
- BREAKING: renamed several types of dangerous/breaking changes (returned by
BreakingChangesFinder
) - BREAKING: Renamed
GraphQL\Error\Debug
toGraphQL\Error\DebugFlag
. - BREAKING: Debug flags in
GraphQL\Executor\ExecutionResult
,GraphQL\Error\FormattedError
andGraphQL\Server\ServerConfig
do not acceptboolean
value anymore butint
only. - BREAKING:
$positions
inGraphQL\Error\Error
constructor are not nullable anymore. Same can be expressed by passing an empty array.
- Support repeatable directives (#643)
- Support SDL Validation and other schema validation improvements (e.g. #492)
- Added promise adapter for Amp (#551)
- Query plan utility improvements (#513, #632)
- Allow retrieving query complexity once query has been completed (#316)
- Allow input types to be passed in from variables using \stdClass instead of associative arrays (#535)
- Support UTF-16 surrogate pairs within string literals (#554, #556)
- Compliant with the GraphQL specification June 2018 Edition
- Having an empty string in
deprecationReason
will now print the@deprecated
directive (only anull
deprecationReason
won't print the@deprecated
directive).
- Perf: support lazy type definitions (#557)
- Simplified Deferred implementation (now allows chaining like promises, #573)
- Deprecated Experimental executor (#397)
- Some bugs
- Improve accuracy of type hints with PHPStan
Special thanks to @simPod, @spawnia and @shmax for their major contributions!
- Fix double Error wrapping when parsing variables (#689)
- Don't call global field resolver on introspection fields (#481)
- Added retrieving query complexity once query has been completed (#316)
- Allow input types to be passed in from variables using \stdClass instead of associative arrays (#535)
- QueryPlan can now be used on interfaces not only objects. (#495)
- Array in variables in place of object shouldn't cause fatal error (fixes #467)
- Scalar type ResolverInfo::getFieldSelection support (#529)
- Fix coroutine executor when using with promise (#486)
- Force int when setting max query depth (#477)
- Reverted minor possible breaking change (#476)
- Added QueryPlan support (#436)
- Fixed an issue with NodeList iteration over missing keys (#475)
- Better validation of field/directive arguments
- Support for apollo client/server persisted queries
- Minor tweaks and fixes
This release brings several breaking changes. Please refer to UPGRADE document for details.
New features and notable changes:
- PHP version required: 7.1+
- Spec compliance: error
category
and extensions are displayed underextensions
key when using default formatting (#389) - New experimental executor with improved performance (#314).
It is a one-line switch:GraphQL::useExperimentalExecutor()
.
Please try it and post your feedback at webonyx#397 (as it may become the default one in future)
- Ported
extendSchema
from the reference implementation underGraphQL\Utils\SchemaExtender
(#362) - Added ability to override standard types via
GraphQL::overrideStandardTypes(array $types)
(#401) - Added flag
Debug::RETHROW_UNSAFE_EXCEPTIONS
which would only rethrow app-specific exceptions (#337) - Several classes were renamed (see UPGRADE.md)
- Schema Validation improvements
- Bugfix: Call to a member function getLocation() on null (#336)
- Fixed several errors discovered by static analysis (#329)
- Execution performance optimization for lists
- Allow stringeable objects to be serialized by StringType (#303)
- StandardServer: add support for the multipart/form-data content type (#300)
- SchemaPrinter: Use multi-line block for trailing quote (#294)
- Fixed bug in validation rule OverlappingFieldsCanBeMerged (#292)
- Added one more breaking change note in UPGRADE.md (#291)
- Spec compliance: remove
data
entry from response on top-level error (#281)
- RFC: Block String (multi-line strings via triple-quote """string""")
- GraphQL Schema SDL: Descriptions as strings (including multi-line)
- Changed minimum required PHP version to 5.6
Improvements:
- Allow extending GraphQL errors with additional properties
- Fixed parsing of default values in Schema SDL
- Handling several more cases in findBreakingChanges
- StandardServer: expect
operationName
(instead ofoperation
) in input
- Allow objects with __toString in IDType
- findBreakingChanges utility (see #199)
- StandardServer: Support non pre-parsed PSR-7 request body (see #202)
- Bugfix: provide descriptions to custom scalars (see #181)
- Ability to override internal types via
types
option of the schema (see #174).
This release brings little changes but there are two reasons why it is released as major version:
- To follow reference implementation versions (it matches 0.11.x series of graphql-js)
- It may break existing applications because scalar input coercion rules are stricter now:
In previous versions sloppy client input could leak through with unexpected results. For example string"false"
accidentally sent in variables was converted to booleantrue
and passed to field arguments. In the new version, such input will produce an error (which is a spec-compliant behavior).
Improvements:
- Stricter input coercion (see #171)
- Types built with
BuildSchema
now have reference to AST node with corresponding AST definition (in $astNode property) - Account for query offset for error locations (e.g. when query is stored in
.graphql
file)
- StandardServer improvement: do not raise an error when variables are passed as empty string (see #156)
- Fixed infinite loop in the server (see #153)
This release brings several breaking changes. Please refer to UPGRADE document for details.
New features and notable changes:
- Changed minimum PHP version from 5.4 to 5.5
- Lazy loading of types without separate build step (see #69, see docs)
- PSR-7 compliant Standard Server (see docs)
- New default error formatting, which does not expose sensitive data (see docs)
- Ability to define custom error handler to filter/log/re-throw exceptions after execution (see docs)
- Allow defining schema configuration using objects with fluent setters vs array (see docs)
- Allow serializing AST to array and re-creating AST from array lazily (see docs)
- Apollo-style query batching support via server (see docs)
- Schema validation, including validation of interface implementations (see docs)
- Ability to pass custom config formatter when defining schema using GraphQL type language (see docs)
Improvements:
- Significantly improved parser performance (see #137 and #128)
- Support for PHP7 exceptions everywhere (see #127)
- Improved documentation and docblock comments
Deprecations and breaking changes - see UPGRADE document.
- Minor change to assist DataLoader project in fixing #150
- Fixed PHP notice and invalid conversion when non-scalar value is passed as ID or String type (see #121)
- Fixed bug occurring when enum
value
is bool, null or float (see #141)
- Ability to disable introspection (see #131)
- Fixed issue with query complexity throwing on invalid queries (see #125)
- Fixed "Out of memory" error when
resolveType
returns unexpected result (see #119)
- Bugfix: throw UserError vs InvariantViolationError for errors caused by client (see #123)
- Bugfix: use directives when calculating query complexity (see #113)
- Bugfix:
AST\Node::__toString()
will convert node to array recursively to encode to json without errors
- Bugfix:
ResolveInfo::getFieldSelection()
now correctly merges fragment selections (see #98)
- Bugfix:
ResolveInfo::getFieldSelection()
now respects inline fragments
- Fixed SyncPromiseAdapter::all() to not change the order of arrays (see #92)
- Tools to help building schema out of Schema definition language as well as printing existing schema in Schema definition language (see #91)
- Fixed Utils::assign() bug related to detecting missing required keys (see #89)
- Schema Definition Language: element descriptions can be set through comments (see #88)
- Fixed:
GraphQL\Server
now properly sets promise adapter before executing query
- Deferred resolvers (see #66, see docs)
- New Facade class with fluid interface:
GraphQL\Server
(see #82) - Experimental: ability to load types in Schema lazily via custom
TypeResolutionStrategy
(see #69)
This release brings several minor breaking changes. Please refer to UPGRADE document for details.
New features:
- Support for
null
value (as required by latest GraphQL spec) - Shorthand definitions for field and argument types (see #47)
path
entry in errors produced by resolvers for better debuggingresolveType
for interface/union is now allowed to return string name of type- Ability to omit name when extending type class (vs defining inline)
Improvements:
- Spec compliance improvements
- New docs and examples
Look at GitHub Releases Page.