Optimize Deferred execution

CHANGELOG.md

@@ -9,6 +9,16 @@ You can find and compare releases at the [GitHub release page](https://github.co
 
 ## Unreleased
 
+## v15.29.0
+
+### Changed
+
+- Optimize `Deferred` execution https://github.com/webonyx/graphql-php/pull/1805
+
+### Deprecated
+
+- Deprecate `GraphQL\Deferred::create()` in favor of constructor https://github.com/webonyx/graphql-php/pull/1805
+
 ## v15.28.0
 
 ### Changed

benchmarks/DeferredBench.php

@@ -0,0 +1,80 @@
+<?php declare(strict_types=1);
+
+namespace GraphQL\Benchmarks;
+
+use GraphQL\Deferred;
+use GraphQL\Executor\Promise\Adapter\SyncPromiseQueue;
+
+/**
+ * @OutputTimeUnit("microseconds", precision=3)
+ *
+ * @Warmup(5)
+ *
+ * @Revs(200)
+ *
+ * @Iterations(10)
+ */
+class DeferredBench
+{
+    public function benchSingleDeferred(): void
+    {
+        new Deferred(static fn () => 'value');
+        SyncPromiseQueue::run();
+    }
+
+    public function benchNestedDeferred(): void
+    {
+        new Deferred(static fn () => new Deferred(static fn () => null));
+        SyncPromiseQueue::run();
+    }
+
+    public function benchChain5(): void
+    {
+        $deferred = new Deferred(static fn () => 'value');
+        $deferred->then(static fn ($v) => $v)
+            ->then(static fn ($v) => $v)
+            ->then(static fn ($v) => $v)
+            ->then(static fn ($v) => $v)
+            ->then(static fn ($v) => $v);
+        SyncPromiseQueue::run();
+    }
+
+    public function benchChain100(): void
+    {
+        $deferred = new Deferred(static fn () => 'value');
+        $promise = $deferred;
+        for ($i = 0; $i < 100; ++$i) {
+            $promise = $promise->then(static fn ($v) => $v);
+        }
+        SyncPromiseQueue::run();
+    }
+
+    public function benchManyDeferreds(): void
+    {
+        $fn = static fn () => null;
+        for ($i = 0; $i < 1000; ++$i) {
+            new Deferred($fn);
+        }
+        SyncPromiseQueue::run();
+    }
+
+    public function benchManyNestedDeferreds(): void
+    {
+        for ($i = 0; $i < 5000; ++$i) {
+            new Deferred(static fn () => new Deferred(static fn () => null));
+        }
+        SyncPromiseQueue::run();
+    }
+
+    public function bench1000Chains(): void
+    {
+        $promises = [];
+        for ($i = 0; $i < 1000; ++$i) {
+            $d = new Deferred(static fn () => $i);
+            $promises[] = $d->then(static fn ($v) => $v)
+                ->then(static fn ($v) => $v)
+                ->then(static fn ($v) => $v);
+        }
+        SyncPromiseQueue::run();
+    }
+}

benchmarks/HugeSchemaBench.php

@@ -14,11 +14,11 @@
  *
  * @OutputTimeUnit("milliseconds", precision=3)
  *
- * @Warmup(1)
+ * @Warmup(2)
  *
- * @Revs(5)
+ * @Revs(10)
  *
- * @Iterations(1)
+ * @Iterations(3)
  */
 class HugeSchemaBench
 {
@@ -50,6 +50,7 @@ public function benchSchema(): void
             ->getTypeMap();
     }
 
+    /** @Revs(1000) */
     public function benchSchemaLazy(): void
     {
         $this->createLazySchema();

benchmarks/StarWarsBench.php

@@ -11,11 +11,11 @@
  *
  * @OutputTimeUnit("milliseconds", precision=3)
  *
- * @Warmup(2)
+ * @Warmup(5)
  *
- * @Revs(10)
+ * @Revs(100)
  *
- * @Iterations(2)
+ * @Iterations(10)
  */
 class StarWarsBench
 {

composer.json

@@ -64,7 +64,7 @@
   },
   "scripts": {
     "baseline": "phpstan --generate-baseline",
-    "bench": "phpbench run",
+    "bench": "php -d zend.assertions=-1 vendor/bin/phpbench run --report=default",
     "check": [
       "@fix",
       "@stan",
@@ -78,6 +78,6 @@
     "php-cs-fixer": "make php-cs-fixer",
     "rector": "rector process",
     "stan": "phpstan --verbose",
-    "test": "php -d zend.exception_ignore_args=Off -d zend.assertions=On -d assert.active=On -d assert.exception=On vendor/bin/phpunit"
+    "test": "php -d zend.exception_ignore_args=0 -d zend.assertions=1 -d assert.active=1 -d assert.exception=1 vendor/bin/phpunit"
   }
 }

docs/class-reference.md

@@ -1778,6 +1778,25 @@ function createRejected(Throwable $reason): GraphQL\Executor\Promise\Promise
 function all(iterable $promisesOrValues): GraphQL\Executor\Promise\Promise
 ```
 
+## GraphQL\Deferred
+
+User-facing promise class for deferred field resolution.
+
+@phpstan-type Executor callable(): mixed
+
+### GraphQL\Deferred Methods
+
+```php
+/**
+ * Create a new Deferred promise and enqueue its execution.
+ *
+ * @api
+ *
+ * @param Executor $executor
+ */
+function __construct(callable $executor)
+```
+
 ## GraphQL\Validator\DocumentValidator
 
 Implements the "Validation" section of the spec.

generate-class-reference.php

@@ -23,6 +23,7 @@
     GraphQL\Executor\ScopedContext::class => [],
     GraphQL\Executor\ExecutionResult::class => [],
     GraphQL\Executor\Promise\PromiseAdapter::class => [],
+    GraphQL\Deferred::class => [],
     GraphQL\Validator\DocumentValidator::class => [],
     GraphQL\Error\Error::class => ['constants' => true],
     GraphQL\Error\Warning::class => ['constants' => true],

phpbench.json

@@ -3,5 +3,11 @@
   "runner.path": "benchmarks",
   "runner.file_pattern": "*Bench.php",
   "runner.retry_threshold": 5,
-  "runner.time_unit": "milliseconds"
+  "runner.time_unit": "milliseconds",
+  "runner.progress": "plain",
+  "report.generators": {
+    "default": {
+      "extends": "aggregate"
+    }
+  }
 }

src/Deferred.php

@@ -3,21 +3,55 @@
 namespace GraphQL;
 
 use GraphQL\Executor\Promise\Adapter\SyncPromise;
+use GraphQL\Executor\Promise\Adapter\SyncPromiseQueue;
 
 /**
- * @phpstan-import-type Executor from SyncPromise
+ * User-facing promise class for deferred field resolution.
+ *
+ * @phpstan-type Executor callable(): mixed
  */
 class Deferred extends SyncPromise
 {
-    /** @param Executor $executor */
-    public static function create(callable $executor): self
+    /**
+     * Executor for deferred promises.
+     *
+     * @var (callable(): mixed)|null
+     */
+    protected $executor;
+
+    /**
+     * Create a new Deferred promise and enqueue its execution.
+     *
+     * @api
+     *
+     * @param Executor $executor
+     */
+    public function __construct(callable $executor)
     {
-        return new self($executor);
+        $this->executor = $executor;
+
+        SyncPromiseQueue::enqueue(function (): void {
+            $executor = $this->executor;
+            assert($executor !== null, 'Always set in constructor, this callback runs only once.');
+            $this->executor = null;
+
+            try {
+                $this->resolve($executor());
+            } catch (\Throwable $e) {
+                $this->reject($e);
+            }
+        });
     }
 
-    /** @param Executor $executor */
-    public function __construct(callable $executor)
+    /**
+     * Alias for __construct.
+     *
+     * @param Executor $executor
+     *
+     * @deprecated TODO remove in next major version, use new Deferred() instead
+     */
+    public static function create(callable $executor): self
     {
-        parent::__construct($executor);
+        return new self($executor);
     }
 }

src/Executor/Promise/Adapter/AmpPromiseAdapter.php

@@ -41,10 +41,9 @@ public function then(Promise $promise, ?callable $onFulfilled = null, ?callable
             }
         };
 
-        $adoptedPromise = $promise->adoptedPromise;
-        assert($adoptedPromise instanceof AmpPromise);
-
-        $adoptedPromise->onResolve($onResolve);
+        $ampPromise = $promise->adoptedPromise;
+        assert($ampPromise instanceof AmpPromise);
+        $ampPromise->onResolve($onResolve);
 
         return new Promise($deferred->promise(), $this);
     }

src/Executor/Promise/Adapter/ReactPromiseAdapter.php

@@ -28,34 +28,34 @@ public function convertThenable($thenable): Promise
     /** @throws InvariantViolation */
     public function then(Promise $promise, ?callable $onFulfilled = null, ?callable $onRejected = null): Promise
     {
-        $adoptedPromise = $promise->adoptedPromise;
-        assert($adoptedPromise instanceof ReactPromiseInterface);
+        $reactPromise = $promise->adoptedPromise;
+        assert($reactPromise instanceof ReactPromiseInterface);
 
-        return new Promise($adoptedPromise->then($onFulfilled, $onRejected), $this);
+        return new Promise($reactPromise->then($onFulfilled, $onRejected), $this);
     }
 
     /** @throws InvariantViolation */
     public function create(callable $resolver): Promise
     {
-        $promise = new ReactPromise($resolver);
+        $reactPromise = new ReactPromise($resolver);
 
-        return new Promise($promise, $this);
+        return new Promise($reactPromise, $this);
     }
 
     /** @throws InvariantViolation */
     public function createFulfilled($value = null): Promise
     {
-        $promise = resolve($value);
+        $reactPromise = resolve($value);
 
-        return new Promise($promise, $this);
+        return new Promise($reactPromise, $this);
     }
 
     /** @throws InvariantViolation */
     public function createRejected(\Throwable $reason): Promise
     {
-        $promise = reject($reason);
+        $reactPromise = reject($reason);
 
-        return new Promise($promise, $this);
+        return new Promise($reactPromise, $this);
     }
 
     /** @throws InvariantViolation */
@@ -70,11 +70,11 @@ public function all(iterable $promisesOrValues): Promise
         $promisesOrValuesArray = is_array($promisesOrValues)
             ? $promisesOrValues
             : iterator_to_array($promisesOrValues);
-        $promise = all($promisesOrValuesArray)->then(static fn ($values): array => array_map(
+        $reactPromise = all($promisesOrValuesArray)->then(static fn (array $values): array => array_map(
             static fn ($key) => $values[$key],
             array_keys($promisesOrValuesArray),
         ));
 
-        return new Promise($promise, $this);
+        return new Promise($reactPromise, $this);
     }
 }