Merge pull request #997 from rebing/mfn-integration-v9

Author: mfn

.github/workflows/integration_tests.yml

@@ -34,16 +34,10 @@ jobs:
       fail-fast: false
       matrix:
         php: ${{ fromJson(needs.supported-versions-matrix.outputs.version) }}
-        laravel: [^6.0, ^8.0, ^9.0, ^10.0]
+        laravel: [^8.0, ^9.0, ^10.0]
         exclude:
           - php: 7.4
             laravel: ^9.0
-          - php: 8.0
-            laravel: ^6.0
-          - php: 8.1
-            laravel: ^6.0
-          - php: 8.2
-            laravel: ^6.0
           - php: 8.0
             laravel: ^10.0
           - php: 7.4

.github/workflows/tests.yml

@@ -34,22 +34,15 @@ jobs:
       fail-fast: false
       matrix:
         php: ${{ fromJson(needs.supported-versions-matrix.outputs.version) }}
-        laravel: [^6.0, ^8.0, ^9.0, ^10.0]
-        lazy_types: ['false', 'true']
+        laravel: [^8.0, ^9.0, ^10.0]
         exclude:
           - php: 7.4
             laravel: ^9.0
-          - php: 8.0
-            laravel: ^6.0
-          - php: 8.1
-            laravel: ^6.0
-          - php: 8.2
-            laravel: ^6.0
           - php: 8.0
             laravel: ^10.0
           - php: 7.4
             laravel: ^10.0
-    name: P=${{ matrix.php }} L=${{ matrix.laravel }} Lazy types=${{ matrix.lazy_types }}
+    name: P=${{ matrix.php }} L=${{ matrix.laravel }}
     runs-on: ubuntu-latest
     env:
       COMPOSER_NO_INTERACTION: 1
@@ -83,9 +76,5 @@ jobs:
 
       - run: composer update --prefer-dist --no-progress
 
-      - name: Enable lazy types conditionally
-        run: echo "TESTS_ENABLE_LAZYLOAD_TYPES=1" >> $GITHUB_ENV
-        if: matrix.lazy_types == 'true'
-
       - name: Run tests
         run: composer tests

CHANGELOG.md

@@ -4,10 +4,57 @@ CHANGELOG
 [Next release](https://github.com/rebing/graphql-laravel/compare/8.6.0...master)
 --------------
 
+## Breaking changes
+### Added
+- Upgrade to graphql-php 15 [\#953 / mfn](https://github.com/rebing/graphql-laravel/pull/953)\
+  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](https://github.com/rebing/graphql-laravel/pull/986)
+- Laravel 6 is no longer supported [\#967 / mfn](https://github.com/rebing/graphql-laravel/pull/967)
+
+## Changed
+- The type resolver is now able to resolve the top level types 'Query',
+  'Mutation' and 'Subscription'
+
 2023-02-18, 8.6.0
 -----------------
 ### Added
-- Add Laravl 10 support [\#983 / jasonvarga](https://github.com/rebing/graphql-laravel/pull/983)
+- Add Laravel 10 support [\#983 / jasonvarga](https://github.com/rebing/graphql-laravel/pull/983)
 
 2023-01-13, 8.5.0
 -----------------

README.md

@@ -6,7 +6,7 @@
 [![Downloads](https://img.shields.io/packagist/dt/rebing/graphql-laravel.svg?style=flat-square)](https://packagist.org/packages/rebing/graphql-laravel)
 [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://join.slack.com/t/rebing-graphql/shared_invite/enQtNTE5NjQzNDI5MzQ4LTdhNjk0ZGY1N2U1YjE4MGVlYmM2YTc2YjQ0MmIwODY5MWMwZWIwYmY1MWY4NTZjY2Q5MzdmM2Q3NTEyNDYzZjc)
 
-Use Facebook's GraphQL with PHP 7.4+ on Laravel 6.0 & 8.0+. It is based on the [PHP port of GraphQL reference implementation](https://github.com/webonyx/graphql-php). You can find more information about GraphQL in the [GraphQL Introduction](https://reactjs.org/blog/2015/05/01/graphql-introduction.html) on the [React](https://reactjs.org/) blog or you can read the [GraphQL specifications](https://spec.graphql.org/).
+Use Facebook's GraphQL with PHP 7.4+ on Laravel 8.0+. It is based on the [PHP port of GraphQL reference implementation](https://github.com/webonyx/graphql-php). You can find more information about GraphQL in the [GraphQL Introduction](https://reactjs.org/blog/2015/05/01/graphql-introduction.html) on the [React](https://reactjs.org/) blog or you can read the [GraphQL specifications](https://spec.graphql.org/).
 
 * Allows creating **queries** and **mutations** as request endpoints
 * Supports multiple schemas
@@ -56,8 +56,6 @@ Review the configuration file:
 config/graphql.php
 ```
 
-The default GraphiQL view makes use of the global `csrf_token()` helper function.
-
 ## Usage
 
 - [Laravel GraphQL](#laravel-graphql)
@@ -69,7 +67,6 @@ The default GraphiQL view makes use of the global `csrf_token()` helper function
     - [Concepts](#concepts)
       - [A word on declaring a field `nonNull`](#a-word-on-declaring-a-field-nonnull)
     - [Data loading](#data-loading)
-    - [GraphiQL](#graphiql)
     - [Middleware Overview](#middleware-overview)
       - [HTTP middleware](#http-middleware)
       - [GraphQL execution middleware](#graphql-execution-middleware)
@@ -126,8 +123,6 @@ The default GraphiQL view makes use of the global `csrf_token()` helper function
     - [Upgrading from v1 to v2](#upgrading-from-v1-to-v2)
     - [Migrating from Folklore](#migrating-from-folklore)
   - [Performance considerations](#performance-considerations)
-    - [Lazy loading of types](#lazy-loading-of-types)
-      - [Example of aliasing **not** supported by lazy loading](#example-of-aliasing-not-supported-by-lazy-loading)
     - [Wrap Types](#wrap-types)
   - [GraphQL testing clients](#graphql-testing-clients)
 
@@ -204,20 +199,6 @@ static data, ElasticSearch results, caching, etc.) in your resolvers but you've
 to be mindful of the execution model to avoid repetitive fetches and perform
 smart pre-fetching of your data.
 
-### GraphiQL
-
-GraphiQL is lightweight "GraphQL IDE" in your browser. It takes advantage of the
-GraphQL type system and allows autocompletion of all queries/mutations/types and
-fields.
-
-GraphiQL in the meantime evolved in terms of features and complexity, thus for
-convenience an older version is directly included with this library.
-
-As enabled by the default configuration, it's available under the `/graphiql`
-route.
-
-If you are using multiple schemas, you can access them via `/graphiql/<schema name>`.
-
 ### Middleware Overview
 
 The following middleware concepts are supported:
@@ -278,12 +259,6 @@ them, in addition to the global middleware. For example:
     'default' => [
         'query' => [
             ExampleQuery::class,
-            // It's possible to specify a name/alias with the key
-            // but this is discouraged as it prevents things
-            // like improving performance with e.g. `lazyload_types=true`
-            // It's recommended to specify just the class here and
-            // rely on the `'name'` attribute in the query / type.
-            'someQuery' => AnotherExampleQuery::class,
         ],
         'mutation' => [
             ExampleMutation::class,
@@ -447,18 +422,6 @@ Alternatively you can:
   GraphQL::addType(\App\GraphQL\Types\UserType::class);
   ```
 
-As with queries/mutations, you can use an alias name (though again this prevents
-it from taking advantage of lazy type loading):
-```php
-'schemas' => [
-    'default' => [
-        // ...
-        
-        'types' => [
-            'Useralias' => App\GraphQL\Types\UserType::class,
-        ],
-```
-
 Then you need to define a query that returns this type (or a list). You can also specify arguments that you can use in the resolve method.
 ```php
 namespace App\GraphQL\Queries;
@@ -2696,9 +2659,6 @@ To prevent such scenarios, you can add the `UnusedVariablesMiddleware` to your
 - `batching`\
   - 'enable'\
     Whether to support GraphQL batching or not
-- `lazyload_types`\
-  The types will be loaded on demand. Enabled by default as it improves
-  performance. Cannot be used with type aliasing.
 - `error_formatter`\
   This callable will be passed the Error object for each errors GraphQL catch.
   The method should return an array representing the error.
@@ -2715,19 +2675,6 @@ To prevent such scenarios, you can add the `UnusedVariablesMiddleware` to your
   You can define your own pagination type.
 - `simple_pagination_type`\
   You can define your own simple pagination type.
-- `graphiql`\
-  Config for GraphiQL (see (https://github.com/graphql/graphiql)
-  - `prefix`\
-    The route prefix
-  - `controller`\
-    The controller / method to handle the route
-  - `middleware`\
-    Any middleware to be run before invoking the controller
-  - `view`\
-    Which view to use
-  - `display`\
-    Whether to enable it or not.\
-    **Note:** it's recommended to disable this in production!
 - `defaultFieldResolver`\
   Overrides the default field resolver, see http://webonyx.github.io/graphql-php/data-fetching/#default-field-resolver
 - `headers`\
@@ -2809,7 +2756,7 @@ The following is not a bullet-proof list but should serve as a guide. It's not a
 - `composer remove folklore/graphql`
 - if you've a custom ServiceProvider or did include it manually, remove it. The point is that the existing GraphQL code should not be triggered to run.
 - `composer require rebing/graphql-laravel`
-- Publish `config/graphql.php` and adapt it (prefix, middleware, schemas, types, mutations, queries, security settings, graphiql)
+- Publish `config/graphql.php` and adapt it (prefix, middleware, schemas, types, mutations, queries, security settings)
   - Removed settings
     - `domain`
     - `resolvers`
@@ -2824,24 +2771,6 @@ The following is not a bullet-proof list but should serve as a guide. It's not a
 
 ## Performance considerations
 
-### Lazy loading of types
-
-Lazy loading of types is a way of improving the start up performance.
-
-If you are declaring types using aliases, this is not supported and you need to
-set `lazyload_types` set to `false`.
-
-#### Example of aliasing **not** supported by lazy loading
-
-I.e. you cannot have a query class `ExampleQuery` with the `$name` property
-`example` but register it with a different one; this will **not** work:
-
-```php
-'query' => [
-    'aliasedExample' => ExampleQuery::class,
-],
-```
-
 ### Wrap Types
 
 You can wrap types to add more information to the queries and mutations. Similar as the pagination is working you can do the same with your extra data that you want to inject ([see test examples](https://github.com/rebing/graphql-laravel/tree/master/tests/Unit/WithTypeTests)). For instance, in your query:
@@ -2870,4 +2799,4 @@ public function resolve($root, array $args)
 
 ## GraphQL testing clients
  - [Firecamp](https://firecamp.io/graphql)
- - [GraphiQL](https://github.com/graphql/graphiql)
+ - [GraphiQL](https://github.com/graphql/graphiql) [integration via laravel-graphiql](https://github.com/mll-lab/laravel-graphiql)

composer.json

@@ -36,11 +36,11 @@
     "require": {
         "php": ">= 7.4",
         "ext-json": "*",
-        "illuminate/contracts": "^6.0|^8.0|^9.0|^10.0",
-        "illuminate/support": "^6.0|^8.0|^9.0|^10.0",
-        "laragraph/utils": "^1",
+        "illuminate/contracts": "^8.0|^9.0|^10.0",
+        "illuminate/support": "^8.0|^9.0|^10.0",
+        "laragraph/utils": "^1.5",
         "thecodingmachine/safe": "^1.1|^2.4",
-        "webonyx/graphql-php": "^14.6.4"
+        "webonyx/graphql-php": "^15"
     },
     "require-dev": {
         "ext-pdo_sqlite": "*",
@@ -50,8 +50,8 @@
         "mockery/mockery": "^1.2",
         "phpstan/phpstan": "1.10.3",
         "nunomaduro/larastan": "2.4.1",
-        "orchestra/testbench": "4.0.*|5.0.*|^6.0|^7.0|^8.0",
-        "phpunit/phpunit": "~7.0|~8.0|^9",
+        "orchestra/testbench": "^6.0|^7.0|^8.0",
+        "phpunit/phpunit": "~8.0|^9",
         "thecodingmachine/phpstan-safe-rule": "^1"
     },
     "autoload": {
@@ -69,11 +69,7 @@
         "phpstan-baseline": "phpstan analyse --memory-limit=512M --generate-baseline",
         "lint": "php-cs-fixer fix --diff --dry-run",
         "fix-style": "php-cs-fixer fix",
-        "tests": "phpunit --colors=always --verbose",
-        "tests-all": [
-            "TESTS_ENABLE_LAZYLOAD_TYPES=0 phpunit --colors=always --verbose",
-            "TESTS_ENABLE_LAZYLOAD_TYPES=1 phpunit --colors=always --verbose"
-        ]
+        "tests": "phpunit --colors=always --verbose"
     },
     "extra": {
         "branch-alias": {
@@ -93,5 +89,8 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true
+    },
+    "suggest": {
+        "mll-lab/laravel-graphiql": "Easily integrate GraphiQL into your Laravel projects. "
     }
 }

config/config.php

@@ -111,11 +111,6 @@
         // \Rebing\GraphQL\Support\UploadType::class,
     ],
 
-    // The types will be loaded on demand. Default is to load all types on each request
-    // Can increase performance on schemes with many types
-    // Presupposes the config type key to match the type class name property
-    'lazyload_types' => true,
-
     // This callable will be passed the Error object for each errors GraphQL catch.
     // The method should return an array representing the error.
     // Typically:
@@ -157,17 +152,6 @@
      */
     'simple_pagination_type' => \Rebing\GraphQL\Support\SimplePaginationType::class,
 
-    /*
-     * Config for GraphiQL (see (https://github.com/graphql/graphiql).
-     */
-    'graphiql' => [
-        'prefix' => 'graphiql', // Do NOT use a leading slash
-        'controller' => \Rebing\GraphQL\GraphQLController::class . '@graphiql',
-        'middleware' => [],
-        'view' => 'graphql::graphiql',
-        'display' => env('ENABLE_GRAPHIQL', true),
-    ],
-
     /*
      * Overrides the default field resolver
      * See http://webonyx.github.io/graphql-php/data-fetching/#default-field-resolver