Merge branch 'master' into make_it_easier_to_extend_select_fields

Author: mfn

.gitattributes

@@ -4,10 +4,17 @@
 .gitignore export-ignore
 /.github export-ignore
 /.php_cs.dist export-ignore
-/docker export-ignore
+/docker-compose-dev.yml export-ignore
+/Dockerfile.dev export-ignore
 /example export-ignore
+/Makefile export-ignore
 /phpstan-baseline.neon export-ignore
 /phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
+/README-docker.md export-ignore
 /tests export-ignore
 /tmp export-ignore
+
+# Github specific: force syntax highlighting to be PHP for stubs
+# See https://github.com/github/linguist/blob/master/docs/overrides.md
+*.stub linguist-language=PHP

.gitignore

@@ -3,5 +3,5 @@
 /phpunit.xml
 /composer.lock
 .phpunit.result.cache
-.php_cs.cache
+.php-cs-fixer.cache
 /tmp

.php_cs.dist .php-cs-fixer.dist.php

@@ -64,8 +64,8 @@ CHANGELOG
     - 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)
-    - This also means that the per schema config key `method` (aka HTTP method)
-      is not supported anymore
+    - 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

CHANGELOG.md

@@ -0,0 +1,13 @@
+FROM php:8.0.10-cli-alpine
+
+COPY --from=mlocati/php-extension-installer:1.2.60 /usr/bin/install-php-extensions /usr/local/bin/
+
+RUN install-php-extensions \
+      xdebug && \
+      rm /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
+
+COPY --from=composer:2.1.8 /usr/bin/composer /usr/local/bin/
+
+COPY ./ /app
+
+WORKDIR /app

Dockerfile.dev

@@ -0,0 +1,6 @@
+docker-phpstan:
+	docker-compose -f docker-compose-dev.yml run --rm php sh -c "php -v ; composer phpstan"
+docker-phpstan-baseline:
+	docker-compose -f docker-compose-dev.yml run --rm php sh -c "php -v ; composer phpstan-baseline"
+docker-rebuild:
+	docker-compose -f docker-compose-dev.yml build php

Makefile

@@ -289,6 +289,8 @@ them, in addition to the global middleware. For example:
 
         ],
         'middleware' => ['auth'],
+        // Which HTTP methods to support; must be given in UPPERCASE!
+        'method' => ['GET', 'POST'], 
         'execution_middleware' => [
             \Rebing\GraphQL\Support\ExecutionMiddleware\UnusedVariablesMiddleware::class,
         ],
@@ -2520,7 +2522,7 @@ The `macro` function accepts a name as its first argument, and a `Closure` as it
 
 Automatic Persisted Queries (APQ) improve network performance by sending smaller requests, with zero build-time configuration.
 
-APQ is disabled by default and can be enabled in the config via `apc.enabled=true` or by setting the environment variable `GRAPHQL_APQ_ENABLE=true`.
+APQ is disabled by default and can be enabled in the config via `apq.enabled=true` or by setting the environment variable `GRAPHQL_APQ_ENABLE=true`.
 
 A persisted query is an ID or hash that can be generated on the client sent to the server instead of the entire GraphQL query string. 
 This smaller signature reduces bandwidth utilization and speeds up client loading times.

docker/README.md README-docker.md

@@ -44,12 +44,12 @@
     "require-dev": {
         "orchestra/testbench": "4.0.*|5.0.*|^6.0",
         "phpunit/phpunit": "~7.0|~8.0|^9",
-        "nunomaduro/larastan": "0.7.5",
+        "nunomaduro/larastan": "^0",
         "mockery/mockery": "^1.2",
-        "friendsofphp/php-cs-fixer": "^2.15",
+        "friendsofphp/php-cs-fixer": "^3",
         "ext-pdo_sqlite": "*",
         "laravel/legacy-factories": "^1.0",
-        "mfn/php-cs-fixer-config": "^1"
+        "mfn/php-cs-fixer-config": "^2"
     },
     "autoload": {
         "psr-4": {
@@ -64,7 +64,7 @@
     "scripts": {
         "phpstan": "phpstan analyse --memory-limit=512M",
         "phpstan-baseline": "phpstan analyse --memory-limit=512M --generate-baseline",
-        "lint": "php-cs-fixer fix --diff --diff-format=udiff --dry-run",
+        "lint": "php-cs-fixer fix --diff --dry-run",
         "fix-style": "php-cs-fixer fix",
         "tests": "phpunit --colors=always --verbose",
         "tests-all": [
@@ -86,5 +86,9 @@
         }
     },
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
+    }
 }

README.md

@@ -87,6 +87,9 @@
             // Laravel HTTP middleware
             'middleware' => null,
 
+            // Which HTTP methods to support; must be given in UPPERCASE!
+            'method' => ['GET', 'POST'],
+
             // An array of middlewares, overrides the global ones
             'execution_middleware' => null,
         ],

composer.json

@@ -0,0 +1,10 @@
+version: '3'
+
+services:
+    php:
+        build:
+            context: .
+            dockerfile: Dockerfile.dev
+        volumes:
+            - ./:/app
+        working_dir: '/app'

config/config.php

@@ -236,7 +236,7 @@ parameters:
 			path: src/Support/Rules.php
 
 		-
-			message: "#^Binary operation \"\\.\" between string and array\\|string\\|null results in an error\\.$#"
+			message: "#^Binary operation \"\\.\" between non\\-empty\\-string and array\\|string\\|null results in an error\\.$#"
 			count: 1
 			path: src/Support/SelectFields.php
 
@@ -391,7 +391,7 @@ parameters:
 			path: src/Support/Type.php
 
 		-
-			message: "#^Parameter \\#1 \\$callback of function call_user_func_array expects callable\\(\\)\\: mixed, array\\(\\$this\\(Rebing\\\\GraphQL\\\\Support\\\\Type\\), string\\) given\\.$#"
+			message: "#^Parameter \\#1 \\$callback of function call_user_func_array expects callable\\(\\)\\: mixed, array\\(\\$this\\(Rebing\\\\GraphQL\\\\Support\\\\Type\\), non\\-empty\\-string\\) given\\.$#"
 			count: 1
 			path: src/Support/Type.php
 
@@ -425,11 +425,6 @@ parameters:
 			count: 1
 			path: tests/Database/AuthorizeArgsTests/TestAuthorizationArgsQuery.php
 
-		-
-			message: "#^Method Rebing\\\\GraphQL\\\\Tests\\\\Database\\\\AuthorizeArgsTests\\\\TestAuthorizationArgsQuery\\:\\:authorize\\(\\) should return bool but return statement is missing\\.$#"
-			count: 1
-			path: tests/Database/AuthorizeArgsTests/TestAuthorizationArgsQuery.php
-
 		-
 			message: "#^Property Rebing\\\\GraphQL\\\\Tests\\\\Database\\\\AuthorizeArgsTests\\\\TestAuthorizationArgsQuery\\:\\:\\$attributes has no typehint specified\\.$#"
 			count: 1
@@ -1220,6 +1215,11 @@ parameters:
 			count: 1
 			path: tests/Support/Objects/ExampleNestedValidationInputObject.php
 
+		-
+			message: "#^Method Rebing\\\\GraphQL\\\\Tests\\\\Support\\\\Objects\\\\ExampleSchemaWithMethod\\:\\:toConfig\\(\\) should return array\\(\\?'execution_middleware' \\=\\> array\\<class\\-string\\<Rebing\\\\GraphQL\\\\Support\\\\ExecutionMiddleware\\\\AbstractExecutionMiddleware\\>\\>, \\?'method' \\=\\> array\\<string\\>\\|string, \\?'middleware' \\=\\> array\\<string\\>, \\?'mutation' \\=\\> array\\<class\\-string\\>, 'query' \\=\\> array\\<class\\-string\\>, \\?'types' \\=\\> array\\<class\\-string\\>\\) but returns array\\<literal\\-string&non\\-empty\\-string, array\\<string\\>\\|string\\>&nonEmpty\\.$#"
+			count: 1
+			path: tests/Support/Objects/ExampleSchemaWithMethod.php
+
 		-
 			message: "#^Property Rebing\\\\GraphQL\\\\Tests\\\\Support\\\\Objects\\\\ExampleType\\:\\:\\$attributes has no typehint specified\\.$#"
 			count: 1

docker-compose-dev.yml

@@ -9,11 +9,12 @@ interface ConfigConvertible
 {
     /**
      * @return array{
-     *                query:array<string,class-string>|array<class-string>,
-     *                mutation?:array<string,class-string>|array<class-string>,
-     *                types?:array<string,class-string>|array<class-string>,
+     *                execution_middleware?:array<class-string<AbstractExecutionMiddleware>>,
+     *                method?:string|string[],
      *                middleware?:array<string|class-string>,
-     *                execution_middleware?:array<class-string<AbstractExecutionMiddleware>>
+     *                mutation?:array<string,class-string>|array<class-string>,
+     *                query:array<string,class-string>|array<class-string>,
+     *                types?:array<string,class-string>|array<class-string>
      *                }
      */
     public function toConfig(): array;

docker/Dockerfile

@@ -32,22 +32,23 @@ function (Router $router) use ($config, $routeConfig): void {
             $defaultSchema = $config->get('graphql.default_schema', 'default');
 
             foreach ($schemas as $schemaName => $schemaConfig) {
+                $method = $schemaConfig['method'] ?? ['GET', 'POST'];
                 $actions = array_filter([
                     'uses' => $schemaConfig['controller'] ?? $routeConfig['controller'] ?? GraphQLController::class . '@query',
                     'middleware' => $schemaConfig['middleware'] ?? $routeConfig['middleware'] ?? null,
                 ]);
 
                 // Add route for each schema…
                 $router->addRoute(
-                    ['GET', 'POST'],
+                    $method,
                     $schemaName,
                     $actions + ['as' => "graphql.$schemaName"]
                 );
 
                 // … and the default schema against the group itself
                 if ($schemaName === $defaultSchema) {
                     $router->addRoute(
-                        ['GET', 'POST'],
+                        $method,
                         '',
                         $actions + ['as' => 'graphql']
                     );

docker/Makefile

@@ -50,6 +50,8 @@ public function authorize(
 
         $selectFields = $getSelectFields();
         Assert::assertInstanceOf(SelectFields::class, $selectFields);
+
+        return true;
     }
 
     public function resolve(): void

docker/docker-compose.yml

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types = 1);
+namespace Rebing\GraphQL\Tests\Support\Objects;
+
+class ExampleSchemaWithMethod extends ExampleSchema
+{
+    public function toConfig(): array
+    {
+        return array_merge(parent::toConfig(), ['method' => ['POST']]);
+    }
+}

phpstan-baseline.neon

@@ -371,7 +371,8 @@ public function testGetTypes(): void
 
     public function testAddSchema(): void
     {
-        $schema = GraphQL::buildSchemaFromConfig([
+        $schema = GraphQL::buildSchemaFromConfig(
+            [
                 'query' => [
                     'examplesCustom' => ExamplesQuery::class,
                 ],

src/Support/Contracts/ConfigConvertible.php

@@ -7,6 +7,7 @@
 use Illuminate\Routing\Router;
 use Rebing\GraphQL\Tests\Support\Objects\ExampleMiddleware;
 use Rebing\GraphQL\Tests\Support\Objects\ExampleSchema;
+use Rebing\GraphQL\Tests\Support\Objects\ExampleSchemaWithMethod;
 use Rebing\GraphQL\Tests\TestCase;
 
 class NoRoutesRegisteredTest extends TestCase
@@ -27,9 +28,11 @@ protected function getEnvironmentSetUp($app): void
                     'middleware' => [ExampleMiddleware::class],
                 ],
                 'with_methods' => [
+                    'method' => ['POST'],
                     'middleware' => [ExampleMiddleware::class],
                 ],
                 'class_based' => ExampleSchema::class,
+                'class_based_with_methods' => ExampleSchemaWithMethod::class,
                 'shorthand' => BuildSchema::build('
                     schema {
                         query: ShorthandExample

src/routes.php

@@ -7,6 +7,7 @@
 use Illuminate\Support\Collection;
 use Rebing\GraphQL\Tests\Support\Objects\ExampleMiddleware;
 use Rebing\GraphQL\Tests\Support\Objects\ExampleSchema;
+use Rebing\GraphQL\Tests\Support\Objects\ExampleSchemaWithMethod;
 use Rebing\GraphQL\Tests\TestCase;
 
 class RoutesTest extends TestCase
@@ -30,9 +31,11 @@ protected function getEnvironmentSetUp($app): void
                     'middleware' => [ExampleMiddleware::class],
                 ],
                 'with_methods' => [
+                    'method' => ['POST'],
                     'middleware' => [ExampleMiddleware::class],
                 ],
                 'class_based' => ExampleSchema::class,
+                'class_based_with_methods' => ExampleSchemaWithMethod::class,
             ],
         ]);
     }
@@ -75,9 +78,7 @@ public function testRoutes(): void
             ],
             'graphql.with_methods' => [
                 'methods' => [
-                    'GET',
                     'POST',
-                    'HEAD',
                 ],
                 'uri' => 'graphql_test/with_methods',
                 'middleware' => [
@@ -95,6 +96,15 @@ public function testRoutes(): void
                     ExampleMiddleware::class,
                 ],
             ],
+            'graphql.class_based_with_methods' => [
+                'methods' => [
+                    'POST',
+                ],
+                'uri' => 'graphql_test/class_based_with_methods',
+                'middleware' => [
+                    ExampleMiddleware::class,
+                ],
+            ],
         ];
 
         $actual = Collection::make(