Merge branch 'master' of github.com:grynchuk/graphqlite into fix-prefetch-in-batch-requests

Author: grynchuk

.github/workflows/continuous_integration.yml

@@ -18,18 +18,18 @@ jobs:
     strategy:
       matrix:
         install-args: ['', '--prefer-lowest']
-        php-version: ['8.1', '8.2']
+        php-version: ['8.1', '8.2', '8.3']
       fail-fast: false
 
     steps:
       # Cancel previous runs of the same branch
       - name: cancel
-        uses: styfle/cancel-workflow-action@0.10.1
+        uses: styfle/cancel-workflow-action@0.12.1
         with:
           access_token: ${{ github.token }}
 
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Install PHP with extensions"
         uses: "shivammathur/setup-php@v2"
@@ -44,7 +44,7 @@ jobs:
           echo "::set-output name=dir::$(composer config cache-files-dir)"
 
       - name: composer-cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composercache.outputs.dir }}
           key: composer-${{ hashFiles('**/composer.json') }}-${{ matrix.install-args }}
@@ -61,7 +61,7 @@ jobs:
         run: "vendor/bin/phpunit"
 
       - name: phpstan-cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           key: phpstan-${{ matrix.php-version }}-${{ matrix.install-args }}-${{ github.ref }}-${{ github.sha }}
           path: .phpstan-cache
@@ -76,16 +76,16 @@ jobs:
 
       - name: "Run coding standard checks with squizlabs/php_codesniffer"
         run: "composer cs-check"
-        if: ${{ matrix.php-version == '7.2' }} # Do not suggest using features after 7.2
 
       - name: "Archive code coverage results"
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "codeCoverage"
           path: "build"
+          overwrite: true
 
-      - uses: codecov/codecov-action@v3.1.4 # upload the coverage to codecov
+      - uses: codecov/codecov-action@v4.0.1 # upload the coverage to codecov
         with:
-          fail_ci_if_error: true # optional (default = false)
-        # Do not upload in forks, and only on php8, latest deps
-        if: ${{ github.repository == 'thecodingmachine/graphqlite' && matrix.php-version == '8.0' && matrix.install-args == '' }}
+          fail_ci_if_error: false # optional (default = false) - Need CODECOV_TOKEN
+        # Do not upload in forks, and only on php8.3, latest deps
+        if: ${{ github.repository == 'thecodingmachine/graphqlite' && matrix.php-version == '8.3' && matrix.install-args == '' }}

.github/workflows/doc_generation.yml

@@ -19,10 +19,10 @@ jobs:
     steps:
 
       - name: "Checkout"
-        uses: "actions/checkout@v3"
+        uses: "actions/checkout@v4"
 
       - name: "Setup NodeJS"
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '16.x'
 
@@ -36,7 +36,7 @@ jobs:
 
       - name: "Deploy website"
         if: "${{ github.event_name == 'push' || github.event_name == 'release' }}"
-        uses: JamesIves/github-pages-deploy-action@v4.4.2
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages # The branch the action should deploy to.

composer.json

@@ -16,14 +16,14 @@
         "composer/package-versions-deprecated": "^1.8",
         "phpdocumentor/reflection-docblock": "^4.3 || ^5.0",
         "phpdocumentor/type-resolver": "^1.4",
-        "psr/container": "^2",
+        "psr/container": "^1.1 || ^2",
         "psr/http-factory": "^1",
-        "psr/http-message": "^1.0.1",
+        "psr/http-message": "^1.0.1 || ^2.0",
         "psr/http-server-handler": "^1",
         "psr/http-server-middleware": "^1",
-        "psr/simple-cache": "^1.0.1",
-        "symfony/cache": "^4.3 || ^5 || ^6",
-        "symfony/expression-language": "^4 || ^5 || ^6",
+        "psr/simple-cache": "^1.0.1 || ^2 || ^3",
+        "symfony/cache": "^4.3 || ^5 || ^6 || ^7",
+        "symfony/expression-language": "^4 || ^5 || ^6 || ^7",
         "thecodingmachine/cache-utils": "^1",
         "thecodingmachine/class-explorer": "^1.1.0",
         "webonyx/graphql-php": "^v15.0"
@@ -38,7 +38,7 @@
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan": "^1.9",
         "phpunit/phpunit": "^8.5.19 || ^9.5.8",
-        "symfony/var-dumper": "^5.4 || ^6.0",
+        "symfony/var-dumper": "^5.4 || ^6.0 || ^7",
         "thecodingmachine/phpstan-strict-rules": "^1.0"
     },
     "suggest": {

phpstan.neon

@@ -17,6 +17,7 @@ parameters:
         - "#Parameter .* of class ReflectionMethod constructor expects string(\\|null)?, object\\|string given.#"
         - "#PHPDoc tag @throws with type Psr\\\\SimpleCache\\\\InvalidArgumentException is not subtype of Throwable#"
         - '#Variable \$context might not be defined.#'
+        - '#Parameter \#1 \$callable of class TheCodingMachine\\GraphQLite\\Middlewares\\ServiceResolver constructor expects array{object, string}&callable\(\): mixed, array{object, non-empty-string} given.#'
         -
            message: '#Parameter .* of class GraphQL\\Error\\Error constructor expects#'
            path: src/Exceptions/WebonyxErrorHandler.php

src/AggregateControllerQueryProvider.php

@@ -29,8 +29,11 @@ class AggregateControllerQueryProvider implements QueryProviderInterface
      * @param iterable<string>   $controllers          A list of controllers name in the container.
      * @param ContainerInterface $controllersContainer The container we will fetch controllers from.
      */
-    public function __construct(private readonly iterable $controllers, private readonly FieldsBuilder $fieldsBuilder, private readonly ContainerInterface $controllersContainer)
-    {
+    public function __construct(
+        private readonly iterable $controllers,
+        private readonly FieldsBuilder $fieldsBuilder,
+        private readonly ContainerInterface $controllersContainer,
+    ) {
     }
 
     /** @return array<string,FieldDefinition> */
@@ -52,13 +55,26 @@ public function getMutations(): array
         $mutationList = [];
 
         foreach ($this->controllers as $controllerName) {
-            $controller   = $this->controllersContainer->get($controllerName);
+            $controller = $this->controllersContainer->get($controllerName);
             $mutationList[$controllerName] = $this->fieldsBuilder->getMutations($controller);
         }
 
         return $this->flattenList($mutationList);
     }
 
+    /** @return array<string, FieldDefinition> */
+    public function getSubscriptions(): array
+    {
+        $subscriptionList = [];
+
+        foreach ($this->controllers as $controllerName) {
+            $controller = $this->controllersContainer->get($controllerName);
+            $subscriptionList[$controllerName] = $this->fieldsBuilder->getSubscriptions($controller);
+        }
+
+        return $this->flattenList($subscriptionList);
+    }
+
     /**
      * @param array<string, array<string, FieldDefinition>> $list
      *

src/AggregateControllerQueryProviderFactory.php

@@ -15,12 +15,18 @@ class AggregateControllerQueryProviderFactory implements QueryProviderFactoryInt
      * @param iterable<string> $controllers A list of controllers name in the container.
      * @param ContainerInterface $controllersContainer The container we will fetch controllers from.
      */
-    public function __construct(private readonly iterable $controllers, private readonly ContainerInterface $controllersContainer)
-    {
+    public function __construct(
+        private readonly iterable $controllers,
+        private readonly ContainerInterface $controllersContainer,
+    ) {
     }
 
     public function create(FactoryContext $context): QueryProviderInterface
     {
-        return new AggregateControllerQueryProvider($this->controllers, $context->getFieldsBuilder(), $this->controllersContainer);
+        return new AggregateControllerQueryProvider(
+            $this->controllers,
+            $context->getFieldsBuilder(),
+            $this->controllersContainer,
+        );
     }
 }

src/AggregateQueryProvider.php

@@ -20,7 +20,9 @@ class AggregateQueryProvider implements QueryProviderInterface
     /** @param QueryProviderInterface[] $queryProviders */
     public function __construct(iterable $queryProviders)
     {
-        $this->queryProviders = is_array($queryProviders) ? $queryProviders : iterator_to_array($queryProviders);
+        $this->queryProviders = is_array($queryProviders)
+            ? $queryProviders
+            : iterator_to_array($queryProviders);
     }
 
     /** @return QueryField[] */
@@ -48,4 +50,17 @@ public function getMutations(): array
 
         return array_merge(...$mutationsArray);
     }
+
+    /** @return QueryField[] */
+    public function getSubscriptions(): array
+    {
+        $subscriptionsArray = array_map(static function (QueryProviderInterface $queryProvider) {
+            return $queryProvider->getSubscriptions();
+        }, $this->queryProviders);
+        if ($subscriptionsArray === []) {
+            return [];
+        }
+
+        return array_merge(...$subscriptionsArray);
+    }
 }

src/Annotations/Cost.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\GraphQLite\Annotations;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_METHOD)]
+class Cost implements MiddlewareAnnotationInterface
+{
+    /**
+     * @param int $complexity Complexity for that field
+     * @param string[] $multipliers Names of fields by value of which complexity will be multiplied
+     * @param ?int $defaultMultiplier Default multiplier value if all multipliers are missing/null
+     */
+    public function __construct(
+        public readonly int $complexity = 1,
+        public readonly array $multipliers = [],
+        public readonly int|null $defaultMultiplier = null,
+    ) {
+    }
+}

src/Annotations/Field.php

@@ -6,6 +6,10 @@
 
 use Attribute;
 
+use function trigger_error;
+
+use const E_USER_DEPRECATED;
+
 /**
  * @Annotation
  * @Target({"PROPERTY", "METHOD"})
@@ -44,6 +48,7 @@ class Field extends AbstractRequest
     public function __construct(array $attributes = [], string|null $name = null, string|null $outputType = null, string|null $prefetchMethod = null, string|array|null $for = null, string|null $description = null, string|null $inputType = null)
     {
         parent::__construct($attributes, $name, $outputType);
+
         $this->prefetchMethod = $prefetchMethod ?? $attributes['prefetchMethod'] ?? null;
         $this->description = $description ?? $attributes['description'] ?? null;
         $this->inputType = $inputType ?? $attributes['inputType'] ?? null;
@@ -54,6 +59,16 @@ public function __construct(array $attributes = [], string|null $name = null, st
         }
 
         $this->for = (array) $forValue;
+
+        if (! $this->prefetchMethod) {
+            return;
+        }
+
+        trigger_error(
+            "Using #[Field(prefetchMethod='" . $this->prefetchMethod . "')] on fields is deprecated in favor " .
+            "of #[Prefetch('" . $this->prefetchMethod . "')] \$data attribute on the parameter itself.",
+            E_USER_DEPRECATED,
+        );
     }
 
     /**

src/Annotations/MiddlewareAnnotations.php

@@ -21,7 +21,11 @@ public function __construct(private array $annotations)
     /**
      * Return annotations of the $className type
      *
-     * @return array<int, MiddlewareAnnotationInterface>
+     * @param class-string<TAnnotation> $className
+     *
+     * @return array<int, TAnnotation>
+     *
+     * @template TAnnotation of MiddlewareAnnotationInterface
      */
     public function getAnnotationsByType(string $className): array
     {
@@ -32,6 +36,12 @@ public function getAnnotationsByType(string $className): array
 
     /**
      * Returns at most 1 annotation of the $className type.
+     *
+     * @param class-string<TAnnotation> $className
+     *
+     * @return TAnnotation|null
+     *
+     * @template TAnnotation of MiddlewareAnnotationInterface
      */
     public function getAnnotationByType(string $className): MiddlewareAnnotationInterface|null
     {

src/Annotations/Prefetch.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\GraphQLite\Annotations;
+
+use Attribute;
+use TheCodingMachine\GraphQLite\GraphQLRuntimeException;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+class Prefetch implements ParameterAnnotationInterface
+{
+    /** @param string|(callable&array{class-string, string}) $callable */
+    public function __construct(public readonly string|array $callable)
+    {
+    }
+
+    public function getTarget(): string
+    {
+        // This is only needed for using #[Prefetch] as a Doctrine attribute, which it doesn't support.
+        throw new GraphQLRuntimeException();
+    }
+}

src/Annotations/Subscription.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\GraphQLite\Annotations;
+
+use Attribute;
+
+/**
+ * @Annotation
+ * @Target({"METHOD"})
+ * @Attributes({
+ *   @Attribute("outputType", type = "string"),
+ * })
+ */
+#[Attribute(Attribute::TARGET_METHOD)]
+class Subscription extends AbstractRequest
+{
+}

src/Context/Context.php

@@ -5,8 +5,8 @@
 namespace TheCodingMachine\GraphQLite\Context;
 
 use SplObjectStorage;
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
 use TheCodingMachine\GraphQLite\PrefetchBuffer;
-use TheCodingMachine\GraphQLite\QueryField;
 
 /**
  * A context class that should be passed to the Webonyx executor.
@@ -24,7 +24,7 @@ public function __construct()
      * Returns the prefetch buffer associated to the field $field.
      * (the buffer is created on the fly if it does not exist yet).
      */
-    public function getPrefetchBuffer(QueryField $field): PrefetchBuffer
+    public function getPrefetchBuffer(ParameterInterface $field): PrefetchBuffer
     {
         if ($this->prefetchBuffers->offsetExists($field)) {
             $prefetchBuffer = $this->prefetchBuffers->offsetGet($field);

src/Context/ContextInterface.php

@@ -4,8 +4,8 @@
 
 namespace TheCodingMachine\GraphQLite\Context;
 
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
 use TheCodingMachine\GraphQLite\PrefetchBuffer;
-use TheCodingMachine\GraphQLite\QueryField;
 
 /**
  * A context class that should be passed to the Webonyx executor.
@@ -18,5 +18,5 @@ interface ContextInterface
      * Returns the prefetch buffer associated to the field $field.
      * (the buffer is created on the fly if it does not exist yet).
      */
-    public function getPrefetchBuffer(QueryField $field): PrefetchBuffer;
+    public function getPrefetchBuffer(ParameterInterface $field): PrefetchBuffer;
 }

src/Exceptions/GraphQLAggregateException.php

@@ -23,6 +23,7 @@ class GraphQLAggregateException extends Exception implements GraphQLAggregateExc
     public function __construct(iterable $exceptions = [])
     {
         parent::__construct('Many exceptions have be thrown:');
+
         foreach ($exceptions as $exception) {
             $this->add($exception);
         }