Skip to content

Latest commit

 

History

History
658 lines (536 loc) · 32.8 KB

CHANGELOG.md

File metadata and controls

658 lines (536 loc) · 32.8 KB
Raw

CHANGELOG

Next release

2024-03-06, 9.5.0

Changed

  • Relax PaginationType/SimplePaginationType getPaginationFields typehint #1132 / jasonvarga

2024-03-04, 9.4.0

Added

  • Possibility to add resolver middleware at runtime using GraphQL::appendGlobalResolverMiddleware(YourMiddleware::class) or GraphQL::appendGlobalResolverMiddleware(new YourMiddleware(...))

2024-02-18, 9.3.0

Removed

  • Support for Laravel 9 & PHP 8.0 have been removed #1123 / mfn

2024-02-18, 9.2.0

Added

2023-08-06, 9.1.0

Fixed

  • fix schema validation - resolve not allowed in input fields #1078 / crissi

2023-06-25, 9.0.0

Breaking changes

Added

  • Upgrade to graphql-php 15 #953 / mfn
    This includes possible breaking changes also outside of this package, see also https://github.com/webonyx/graphql-php/releases/tag/v15.0.0
    Known breaking changes:

    • non-standard error related data keys are not included directly in errors.*.<non-standard error key> any more, but have been moved to errors.*.extensions.<non-standard error key>.
      Also new keys may appear here from upstream.
    • The errors.*.extensions.category has been removed upstream, but we try to keep it alive with the interface \Rebing\GraphQL\Error\ProvidesErrorCategory as it can be a useful discriminator on the client side in certain cases. But only the cases from this library are preserved, e.g. categories like request, graphql or internal are gone.
    • The \Rebing\GraphQL\Support\OperationParams has added required types due to its base class changes:
      • Old: public function getOriginalInput($key)
        new: public function getOriginalInput(string $key)
      • Old: public function isReadOnly()
        new: public function isReadOnly(): bool

    Some BC may happen also if you extended code originating in graphql-php, some examples:

    • if you implement custom types, you now have to use property types for e.g. $name or $description
    • If you used any \GraphQL\Validator\DocumentValidator in your code directly, you now need use FQCN to reference them and not the shortened string names.
    • ->getWrappedType(true) was replaced with ->getInnermostType()
    • the class \GraphQL\Type\Definition\FieldArgument has been renamed to \GraphQL\Type\Definition\Argument

Removed

  • Remove support for eager loading (=non-lazy loading) of types
    Lazy loading has been introduced in 2.0.0 (2019-08) and has been made the default since 8.0.0 (2021-11).
    The practical impact is that types are always going to be resolved using a type loader and therefore cannot use aliases anymore. Types and their type name have to match.
  • Remove integrated GraphiQL support in favour of https://github.com/mll-lab/laravel-graphiql #986 / mfn
  • Laravel 6 is no longer supported #967 / mfn
  • Laravel 8 is no longer supported #1049 / mfn

Changed

  • The type resolver is now able to resolve the top level types 'Query', 'Mutation' and 'Subscription'
    If you have an existing query/mutation/type named like this, you need to rename it.
  • Return types were added to all methods of the commands #1005 / sforward
  • Upgrade to laragraph/utils v2 #1032 / mfn
  • The Pagination and SimplePagination helper types now enforce nonNull on their data types
  • The test suite now also runs with --prefer-lowest #1055 / mfn
    This uncovered a few issues with laragraph/utils and webonyx/graphql-php and thus their minimum version had to be slightly bumped to 2.0.1 and 15.0.3 respectively.

Removed

  • Remove unused publish command #1004 / sforward A leftover from the Lumen removal yers ago (#772)

2023-02-18, 8.6.0

Added

2023-01-13, 8.5.0

Added

2023-01-06, 8.4.0

Added

2022-06-11, 8.3.0

Added

Fixed

Removed

  • Support for PHP 7.2, PHP 7.3 and Laravel 7.0 (all EOL) #914 / mfn

2022-01-30, 8.2.1

Fixed

  • Fix schema parsing issue when route prefix is empty string #890 / hello-liang-shan
    Note: this is a follow-up fix to #888

2022-01-27, 8.2.0

Fixed

2022-01-15, 8.1.0

Added

2021-11-15, 8.0.0

Breaking changes

  • Rewrite and simplify how schemas are handled

    • \Rebing\GraphQL\GraphQL::$schemas now only holds Schemas and not a mixture of strings or arrays
    • \Rebing\GraphQL\GraphQL::schema() now only accepts a "schema name", but no ad hoc Schema or "schema configs". To use ad hoc schemas, use \Rebing\GraphQL\GraphQL::buildSchemaFromConfig() and \Rebing\GraphQL\GraphQL::addSchema()
    • \Rebing\GraphQL\GraphQL::queryAndReturnResult() (and thus also \Rebing\GraphQL\GraphQL::query()) does not accept ad hoc schemas via $opts['schema'] anymore; it now only can reference a schema via its name.
    • \Rebing\GraphQL\GraphQL::addSchema() now only accept Schema objects, where before it would support ad hoc schemas via array configuration. Use \Rebing\GraphQL\GraphQL::buildSchemaFromConfig() for that now.
    • \Rebing\GraphQL\GraphQL::getSchemaConfiguration() has been removed due to the simplifications.
    • \Rebing\GraphQL\GraphQL::getNormalizedSchemaConfiguration() does not support ad hoc schemas anymore and only accepts the schema name.
    • \Rebing\GraphQL\GraphQLServiceProvider::bootSchemas() has been removed due to the simplifications.

  • The following methods now take a \Illuminate\Contracts\Config\Repository as second argument:

    • \Rebing\GraphQL\GraphQL::__construct
    • \Rebing\GraphQL\GraphQLServiceProvider::applySecurityRules

  • As part of moving the architecture to an execution based middleware approach, the following methods have been removed:

    • \Rebing\GraphQL\GraphQLController::handleAutomaticPersistQueries has been replaced by the AutomaticPersistedQueriesMiddleware middleware
    • \Rebing\GraphQL\GraphQLController::queryContext has been replaced by the AddAuthUserContextValueMiddleware middleware
      If you relied on overriding queryContext to inject a custom context, you now need to create your own execution middleware and add to your configuration
    • \Rebing\GraphQL\GraphQLController::executeQuery has become obsolete, no direct replacement.

  • Routing has been rewritten and simplified #757 / mfn

    • All routing related configuration is now within the top level route configuration key
    • The following configuration options have been removed:
      • graphql.routes
        It's therefore also not possible anymore to register different routes for queries and mutations within a schema. Each schema gets only one route (except for the default schema, which is registered for the global prefix route as well as under its name).
        If necessary, this can be emulated with different schemas and multi-level paths
    • The following configuration options have been moved/renamed:
      • graphql.prefix => graphql.route.prefix
      • graphql.controllers => graphql.route.controller
        Further, providing a controller action for query or mutation is not supported anymore.
      • graphql.middleware => graphql.route.middleware
      • graphql.route_group_attributes => graphql.route.group_attributes
    • The actual routes defined have changed:
      • No more separate routes for the HTTP methods
      • 1 route for each schema + 1 route for the group prefix (default schema)
      • If GraphiQL is enabled: 1 route graphiql route for each schema + 1 for the graphiql group prefix (default schema)
      • If provided, the 'method' argument must provide the HTTP method verbs in uppercase like POST or GET, post or get will not work.
    • It's now possible to prevent the registering of any routes by making the top level route an empty array or null
    • \Rebing\GraphQL\GraphQL::routeNameTransformer has been removed
    • It's now possible to register schemas with a - in their name
    • Routes are now properly cacheable

  • Remove the \Rebing\GraphQL\GraphQLController::$app property #755 / mfn
    Injecting the application container early is incompatible when running within an application server like laravel/octane, as it's not guaranteed that the container received contains all the bindings. If you relied on this property when extending the classes, invoke the container directly via Container::getInstance().

  • Remove deprecated \Rebing\GraphQL\Support\Type::$inputObject and \Rebing\GraphQL\Support\Type::$enumObject properties #752 / mfn
    Instead in your code, extend \Rebing\GraphQL\Support\InputType and \Rebing\GraphQL\Support\EnumType directly

  • Support for Lumen has been removed

  • Integrate laragraph/utils RequestParser #739 / mfn
    The parsing of GraphQL requests is now more strict:

    • if you send a GET request, the GraphQL query has to be in the query parameters
    • if you send a POST request, the GraphQL query needs to be in the body
      Mixing of either isn't possible anymore
    • batched queries will only work with POST requests This is due to RequestParser using \GraphQL\Server\Helper::parseRequestParams which includes this check Further:
    • Drop support for configuration the name of the variable for the variables (params_key)
    • GraphQLUploadMiddleware has been removed (RequestParser includes this functionality)
    • Empty GraphQL queries now return a proper validated GraphQL error

  • In \Rebing\GraphQL\GraphQL, renamed remaining instances of $params to $variables
    After switching to RequestParser, the support for changing the variable name what was supposed to params_key has gone and thus the name isn't fitting anymore. Also, the default value for $variables has been changed to null to better fit the how OperationParams works:

    • old: public function query(string $query, ?array $params = [], array $opts = []): array new: public function query(string $query, ?array $variables = null, array $opts = []): array

    • old: public function queryAndReturnResult(string $query, ?array $params = [], array $opts = []): ExecutionResult new: public function queryAndReturnResult(string $query, ?array $variables = null, array $opts = []): ExecutionResult

    • \Rebing\GraphQL\Support\ResolveInfoFieldsAndArguments has been removed

    • $getSelectFields closure no longer takes a depth parameter

  • The $args argument, of the handle method of the execution middlewares requires array as type.

Added

  • Command to make an execution middleware #772 / mfn
  • Command to make a schema configuration #830 / matsn0w
  • The primary execution of the GraphQL request is now piped through middlewares #762 / crissi and mfn
    This allows greater flexibility for enabling/disabling certain functionality as well as bringing in new features without having to open up the library.
  • Primarily register \Rebing\GraphQL\GraphQL as service and keep 'graphql' as alias #768 / mfn
  • Automatic Persisted Queries (APQ) now cache the parsed query #740 / mfn
    This avoids having to re-parse the same queries over and over again.
  • Add ability to detect unused GraphQL variables #660 / mfn
  • Laravel's ValidationException is now formatted the same way as a ValidationError #748 / mfn
  • A few missing typehints (mostly array related) #849 / mfn

Changed

  • Internally webonyx query plan feature is now used for retrieving information about a query #793 / crissi)
  • Rewrite and simplify how schemas are handled #779 / mfn
  • Internally stop using the global config() function and preferable use the repository or the Facade otherwise #774 / mfn
  • Don't silence broken schemas when normalizing them for generating routes #766 / mfn
  • Lazy loading types has been enabled by default #758 / mfn
  • Make it easier to extend select fields #799 / crissi
  • The $args argument, of the handle method of the execution middlewares requires array as type #843 / sforward
  • Embrace thecodingmachine/safe and use thecodingmachine/phpstan-safe-rule to enforce it #851 / mfn
  • Don't require a return value for the query option of fields #856 / sforward

Fixed

Removed

  • The method \Rebing\GraphQL\GraphQLServiceProvider::provides was removed #769 / mfn
    It's only relevant for deferred providers which ours however isn't (and can't be made into with the current Laravel architecture).

2021-04-10, 7.2.0

Added

2021-04-08, 7.1.0

Added

2021-04-03, 7.0.1

Added

2021-04-03, 7.0.0

Breaking changes

  • Signature of \Rebing\GraphQL\Support\Privacy::validate changed, now it accepts both query/mutation arguments and the query/mutation context. Update your existing privacy policies this way: 
    -public function validate(array $queryArgs): bool
+public function validate(array $queryArgs, $queryContext = null): bool

Added

  • Ability to pass query/mutation context to the field privacy handler (both closure and class) #727 / torunar

2021-04-03, 6.5.0

Fixed

2021-03-31, 6.4.0

Added

2021-03-12, 6.3.0

Added

2021-03-12, 6.2.0

Fixed

2020-11-30, 6.1.0

Same as 6.1.0-rc1!

Added

2020-11-27, 6.1.0-rc1

Added

2020-11-26, 6.0.0

Fixed

  • Implemented generation of a SyntaxError instead of a hard Exception for empty single/batch queries #685 / plivius

2020-11-13, 6.0.0-rc1

Breaking changes

Added

2020-11-26, 5.1.5

Fixed

  • Implemented generation of a SyntaxError instead of a hard Exception for empty single/batch queries #685 / plivius

2020-11-16, 5.1.5-rc1

Added

2020-09-03, 5.1.4

Hotfix release to replace 5.1.3

Apologies for the rushed 5.1.3 release causing trouble, it was in fact cut from the wrong branch and it was current state for the upcoming 6.x series 😬

5.1.4 intends to correct this.

Added

2020-09-02, 5.1.3

Added

2020-07-02, 5.1.2

Added

  • Re-added support for validation in field arguments (with breaking change fix) #630 / crissi

2020-04-23, 5.1.1

Fixed

2020-04-22, 5.1.0

Added

2020-04-03, 5.0.0

Added

Fixed

  • Fix the infinite loop as well as sending the correct matching input data to the rule-callback #579 / crissi
  • Fix selecting not the correct columns for interface fields #607 / illambo

Changed

  • Refactor route files with the goal of making adding subscription support easier #575 / crissi

Removed

  • Official support for Laravel 5.8 has been removed #596 / mfn

2019-12-09, 4.0.0

Added

  • Allow passing through an instance of a Field #521 / georgeboot
  • Add the ability to alias query and mutations arguments as well as input objects #517 / crissi
  • Classes can now be injected in the Resolve method from the query/mutation similarly to Laravel controller methods #520 / crissi

Fixed

  • Fix validation rules for non-null list of non-null objects #511 / crissi
  • Add morph type to returned models #503 / crissi
  • Querying same field multiple times causes an error (e.g. via fragments) #537 / edgarsn
  • Fixed the custom query not being handled by interface's relations #486 / EdwinDayot

Changed

2019-10-23, 3.1.0

Added

2019-10-20, 3.0.0

Added

  • Add wrapType(), allowing to add more information for queries/mutations #496 / albertcito

Changed

  • The signature of authorize changed, receiving not the exact same argumenst the resolver would #489 / mfn
    • before: public function authorize(array $args)
    • after: public function authorize($root, array $args, $ctx, ResolveInfo $resolveInfo = null, Closure $getSelectFields = null): bool
  • Forward PHP engine errors to the application error handler #487 / mfn

2019-08-27, 2.1.0

Added

  • The custom 'query' now receives the GraphQL context as the 3rd arg (same as any resolver) #464 / mfn
  • Allow to load deeper nested queries by allowing to change the depth when calling $getSelectFields(int $depth) #472 / mfn

2019-08-18, 2.0.1

Added

Changed

Fixed

  • Support adding Schema objects directly #449 / mfn
  • Input arguments are properly parsed when objects or lists are passed #419 / sowork

2019-08-05, 2.0.0

Breaking changes

  • The UploadType now has to be added manually to the types in your schema if you want to use it
    • The ::getInstance() method is gone
  • The order and arguments/types for resolvers has changed:
    • before: resolve($root, $array, SelectFields $selectFields, ResolveInfo $info)
    • after: resolve($root, $array, $context, ResolveInfo $info, Closure $getSelectFields)
  • Added PHP types / phpdoc to all methods / properties #331
    • Changes in method signatures will require small adaptions.
  • Validation errors are moved from error.validation to error.extensions.validation as per GraphQL spec recommendation #294
  • SelectFields on interface types now only selects specific fields instead of all #294
    • Although this could be considered a bug fix, it changes what columns are selected and if your code as a side effect dependent on all columns being selected, it will break

Added

  • Added support for lazy loading types (config lazyload_types), improve performance on large type systems #405 but doesn't work together with type aliases or paginate().
  • A migration guide for the Folklore library as part of the readme
  • New make:graphql:input command
  • New make:graphql:union command
  • New make:graphql:interface command
  • New make:graphql:field command
  • New make:graphql:enum command and dedicated EnumType, deprecating $enumObject=true in the Type class
  • New make:graphql:scalar command and add more information regarding scalars to the readme
  • TypeConvertible interface requiring to implement toType(): \GraphQL\Type\Definition\Type Existing types are not affected because they already made use of the same method/signature, but custom Scalar GraphQL types work differently and benefit from the interface
  • alias is now also supported for relationships #367
  • InputType support class which eventually replace $inputObject=true #363
  • Support DB::raw() in alias fields
  • GraphiQL: use regenerated CSRF from server if present #332
  • Internal
    • Added declare(strict_types=1) directive to all files
    • Test suite has been refactored and now features Database (SQLite) tests too

Changed

  • Types and Schemas are now only booted when the graphql service is requested, improving performance when having this library installed but not using it in certain workloads (pure artisan commands, non-GraphQL web requests, etc.) #427
  • Follow Laravel convention and use plural for namespaces (e.g. new queries are placed in App\GraphQL\Queries, not App\GraphQL\Query anymore); make commands have been adjusted
  • Made the following classes abstract: Support\Field, Support\InterfaceType, Support\Mutation, Support\Query, Support\Type, Support\UnionType #357
  • Updated GraphiQL to 0.13.0 #335
    • If you're using CSP, be sure to allow cdn.jsdelivr.net and cdnjs.cloudflare.com
  • ValidatorError: remove setter and make it a constructor arg, add getter and rely on contracts
  • Replace global helper is_lumen with static class call \Rebing\GraphQL\Helpers::isLumen

Fixed

  • The Paginator correctly inherits the types model so it can be used with SelectFields and still generates correct SQL queries #415
  • Arguments are now validated before they're passed to authorize() #413
  • File uploads now correctly work with batched requests #397
  • Path multi-level support for Schemas works again #358
  • SelectFields correctly passes field arguments to the custom query #327
    • This also applies to privacy checks on fields, the callback now receives the field arguments too
    • Previously the initial query arguments would be used everywhere

Removed

  • Removed \Fluent dependency on \Rebing\GraphQL\Support\Field #431
  • Removed \Fluent dependency on \Rebing\GraphQL\Support\Type #389
  • Unused static field \Rebing\GraphQL\Support\Type::$instances
  • Unused field \Rebing\GraphQL\Support\Type::$unionType

2019-06-10, v1.24.0

Changed

  • Prefix named GraphiQL routes with graphql. for compatibility with Folklore #360

2019-06-10, v1.23.0

Added

  • New config options headers to send custom HTTP headers and json_encoding_options for encoding the JSON response #293

Fixed

  • SelectFields now works with wrapped types (nonNull, listOf) #315

2019-05-31, v1.22.0

Added

  • Auto-resolve aliased fields #283
  • This project has a changelog \o/

2019-03-07, v1.21.2

  • Allow configuring a custom default field resolver #266
  • Routes have now given names, so they can be referenced #264
  • Expose more fields on the default pagination type #262
  • Mongodb support #257
  • Add support for MorphOne relationships #238
  • Checks for lumen when determining schema #247
  • Internal changes:
    • Replace deprecated global array_* and str_* helpers with direct Arr::* and Str::* calls
    • Code style now enforced via StyleCI

2019-03-07, v1.20.2

  • Fixed infinite recursion for InputTypeObject self reference #230

2019-03-03, v1.20.1

  • Laravel 5.8 support

2019-02-04, v1.19.1

  • Don't report certain GraphQL Errors

2019-02-03, v1.18.1

  • Mutation routes fix

2019-01-29, v1.18.0

  • Fix to allow recursive input objects #158

2019-01-24, v1.17.6

  • Fixed default error handler

2018-12-17, v1.17.3

  • Bump webonxy/graphql-php version requirement
  • Add support for custom error handler config handle_errors

2018-12-17, v1.16.0

  • Fixed validation

2018-07-20, v1.14.2

  • Validation error messages Can now add custom validation error messages to Queries and Mutations

2018-05-16, v1.13.0

  • Added support for query complexity and depth (more details)
  • Also added support for InputObjectType rules validation.

2018-04-20, v1.12.0

2018-04-10, v1.11.0

  • Rules supported for all Fields Added rules support for Query fields

2018-02-28, v1.9.5

  • Allow subscription types to be added Supports creating the schema, but the underlying PHP functionality does not do anything.

2018-01-05, v1.8.2

  • Updating route and controller to give us the ability to create multilevel URI names #69

2017-10-31, v1.7.3

  • Composer fix

2017-10-04, v1.7.1

  • SelectFields fix

2017-09-23, v1.6.1

  • GET routes

2017-08-27, v1.5.0

  • Enum types

2017-08-20, v1.4.9

  • Privacy validation optimized

2017-03-27, v1.4

  • Initial release