8.0.0-rc1 / Breaking Changes incoming!

[mfn]

Due to some longer standing cleanups and embracing of a more standardized approach how to process the GraphQL request using https://github.com/laragraph/utils , a few breaking changes were made for this next major version.

To be clear (see below for details): you will need to adapt your configuration file

Breaking changes

• 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.middlware => 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)
  • 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 not possible to register schemas with a - in their name

• 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

  • batched queries will only work with POST requests
    This is due to RequestParser using \GraphQL\Server\Helper::parseRequestParams which includes this check
  • 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
  • Signature changes In \Rebing\GraphQL\GraphQLController:
    • old: protected function executeQuery(string $schema, array $input): array
      new: protected function executeQuery(string $schema, OperationParams $params): array
    • old: protected function queryContext(string $query, ?array $params, string $schema)
      new: protected function queryContext(string $query, ?array $variables, string $schema)
    • old: protected function handleAutomaticPersistQueries(string $schemaName, array $input): string
      new: protected function handleAutomaticPersistQueries(string $schemaName, OperationParams $operation): string

• In \Rebing\GraphQL\GraphQLController, renamed all occurrences of $schema to $schemaName
  This is to reduce the confusion as the code in some other places uses $schema
  for the actual schema itself (either as an object or array form).
  This changes the signature on the following methods:

  • old: protected function executeQuery(string $schema, OperationParams $params): array
    new: protected function executeQuery(string $schemaName, OperationParams $params): array
  • old: protected function queryContext(string $query, ?array $variables, string $schema)
    new: protected function queryContext(string $query, ?array $variables, string $schemaName)

• 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

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

• As part of APQ parsed query support #740 / mfn:

  • In \Rebing\GraphQL\GraphQLController, the following signature changed:
    • old: protected function handleAutomaticPersistQueries(string $schemaName, OperationParams $operation): string
      new: protected function handleAutomaticPersistQueries(string $schemaName, OperationParams $operation): array
  • In \Rebing\GraphQL\GraphQL, the following signature changed:
    • old: public function query(string $query, ?array $variables = [], array $opts = []): array
      new: public function query($query, ?array $variables = [], array $opts = []): array
    • old: public function queryAndReturnResult(string $query, ?array $variables = [], array $opts = []): ExecutionResult
      new: public function queryAndReturnResult($query, ?array $variables = [], array $opts = []): ExecutionResult

Added

• 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
• Laravels ValidationException is now formatted the same way as a ValidationError #748 / mfn

Changed

• Lazy loading types has been enabled by default #758 / mfn

---

This discussion was created from the release 8.0.0-rc1 / Breaking Changes incoming!.

[mfn]

heads up: thanks to @crissi we're likely to add a "execution middleware" which will bring even more (also breaking) changes but OTOH might obsolete some of these documented here, see #762

[mfn]

RC2 has been release, see the new discussion at #770