Merge pull request #73 from mcg-web/promise

Promise

Author: mcg-web

.travis.yml

@@ -19,9 +19,10 @@ matrix:
         - php: 7.1
           env: SYMFONY_VERSION=3.2.*
         - php: hhvm
-        - php: nightly
-    allow_failures:
-        - php: nightly
+# TODO(mcg-web): uncomment after fixing this bug https://github.com/travis-ci/travis-ci/issues/7124
+#        - php: nightly
+#    allow_failures:
+#        - php: nightly
 
 cache:
     directories:
@@ -35,8 +36,9 @@ before_install:
 install: composer update --prefer-dist --no-interaction
 
 script:
-    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then bin/phpunit -d xdebug.max_nesting_level=1000 --debug --coverage-clover=coverage.clover; else bin/phpunit --debug; fi
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then bin/phpunit -d xdebug.max_nesting_level=1000 --debug --coverage-clover=build/logs/clover.xml; else bin/phpunit --debug; fi
     - if [ "$TRAVIS_PHP_VERSION" == "7.0" ]; then bin/php-cs-fixer fix --diff --dry-run -v; fi;
 
 after_script:
-    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml; fi
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php bin/coveralls -v; fi

DependencyInjection/Configuration.php

@@ -142,6 +142,12 @@ public function getConfigTreeBuilder()
                 ->arrayNode('services')
                     ->addDefaultsIfNotSet()
                     ->children()
+                        ->scalarNode('executor')
+                            ->defaultValue('overblog_graphql.executor.default')
+                        ->end()
+                        ->scalarNode('promise_adapter')
+                            ->defaultValue('overblog_graphql.promise_adapter.default')
+                        ->end()
                         ->scalarNode('expression_language')
                             ->defaultValue('overblog_graphql.expression_language.default')
                         ->end()

DependencyInjection/OverblogGraphQLExtension.php

@@ -39,8 +39,8 @@ public function load(array $configs, ContainerBuilder $container)
         $this->setSecurity($config, $container);
         $this->setConfigBuilders($config);
         $this->setVersions($config, $container);
+        $this->setShowDebug($config, $container);
 
-        $container->getDefinition('overblog_graphql.request_executor')->replaceArgument(3, $config['definitions']['show_debug_info']);
         $container->setParameter($this->getAlias().'.resources_dir', realpath(__DIR__.'/../Resources'));
     }
 
@@ -55,6 +55,11 @@ public function prepend(ContainerBuilder $container)
         $typesExtension->containerPrependExtensionConfig($config, $container);
     }
 
+    private function setShowDebug(array $config, ContainerBuilder $container)
+    {
+        $container->getDefinition($this->getAlias().'.request_executor')->replaceArgument(4, $config['definitions']['show_debug_info']);
+    }
+
     private function setVersions(array $config, ContainerBuilder $container)
     {
         $container->setParameter($this->getAlias().'.versions.graphiql', $config['versions']['graphiql']);

Error/ErrorHandler.php

@@ -11,7 +11,7 @@
 
 namespace Overblog\GraphQLBundle\Error;
 
-use GraphQL\Error;
+use GraphQL\Error\Error as GraphQLError;
 use GraphQL\Executor\ExecutionResult;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
@@ -63,8 +63,8 @@ public function setUserErrorClass($userErrorClass)
     }
 
     /**
-     * @param Error[] $errors
-     * @param bool    $throwRawException
+     * @param GraphQLError[] $errors
+     * @param bool           $throwRawException
      *
      * @return array
      *
@@ -79,7 +79,7 @@ protected function treatExceptions(array $errors, $throwRawException)
             ],
         ];
 
-        /** @var Error $error */
+        /** @var GraphQLError $error */
         foreach ($errors as $error) {
             $rawException = $this->convertException($error->getPrevious());
 
@@ -111,7 +111,7 @@ protected function treatExceptions(array $errors, $throwRawException)
             if ($rawException instanceof UserErrors) {
                 $rawExceptions = $rawException;
                 foreach ($rawExceptions->getErrors() as $rawException) {
-                    $treatedExceptions['errors'][] = Error::createLocatedError($rawException, $error->nodes);
+                    $treatedExceptions['errors'][] = GraphQLError::createLocatedError($rawException, $error->nodes);
                 }
                 continue;
             }
@@ -123,19 +123,24 @@ protected function treatExceptions(array $errors, $throwRawException)
 
             $this->logException($rawException, LogLevel::CRITICAL);
 
-            $treatedExceptions['errors'][] = new Error(
+            $treatedExceptions['errors'][] = new GraphQLError(
                 $this->internalErrorMessage,
                 $error->nodes,
-                $rawException,
                 $error->getSource(),
-                $error->getPositions()
+                $error->getPositions(),
+                $error->path,
+                $rawException
             );
         }
 
         return $treatedExceptions;
     }
 
-    public function logException(\Exception $exception, $errorLevel = LogLevel::ERROR)
+    /**
+     * @param \Exception|\Error $exception
+     * @param string            $errorLevel
+     */
+    public function logException($exception, $errorLevel = LogLevel::ERROR)
     {
         $message = sprintf(
             '%s: %s[%d] (caught exception) at %s line %s.',
@@ -154,15 +159,15 @@ public function handleErrors(ExecutionResult $executionResult, $throwRawExceptio
         $exceptions = $this->treatExceptions($executionResult->errors, $throwRawException);
         $executionResult->errors = $exceptions['errors'];
         if (!empty($exceptions['extensions']['warnings'])) {
-            $executionResult->extensions['warnings'] = array_map(['GraphQL\Error', 'formatError'], $exceptions['extensions']['warnings']);
+            $executionResult->extensions['warnings'] = array_map(['GraphQL\Error\Error', 'formatError'], $exceptions['extensions']['warnings']);
         }
     }
 
     /**
      * Tries to convert a raw exception into a user warning or error
      * that is displayed to the user.
      *
-     * @param \Exception $rawException
+     * @param \Exception|\Error $rawException
      *
      * @return \Exception|\Error
      */
@@ -172,8 +177,9 @@ protected function convertException($rawException = null)
             return;
         }
 
-        if (!empty($this->exceptionMap[get_class($rawException)])) {
-            $errorClass = $this->exceptionMap[get_class($rawException)];
+        $rawExceptionClass = get_class($rawException);
+        if (isset($this->exceptionMap[$rawExceptionClass])) {
+            $errorClass = $this->exceptionMap[$rawExceptionClass];
 
             return new $errorClass($rawException->getMessage(), $rawException->getCode(), $rawException);
         }

Executor/Executor.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Executor;
+
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Executor\Promise\Promise;
+use GraphQL\Schema;
+use Overblog\GraphQLBundle\Executor\Promise\PromiseAdapterInterface;
+
+class Executor implements ExecutorInterface
+{
+    /**
+     * @param Schema      $schema
+     * @param string      $requestString
+     * @param null|array  $rootValue
+     * @param null|array  $contextValue
+     * @param null|array  $variableValues
+     * @param null|string $operationName
+     *
+     * @return ExecutionResult|Promise
+     */
+    public function execute(Schema $schema, $requestString, $rootValue = null, $contextValue = null, $variableValues = null, $operationName = null)
+    {
+        return call_user_func_array('GraphQL\GraphQL::executeAndReturnResult', func_get_args());
+    }
+
+    /**
+     * @param PromiseAdapterInterface|null $promiseAdapter
+     */
+    public function setPromiseAdapter(PromiseAdapterInterface $promiseAdapter = null)
+    {
+        call_user_func_array('GraphQL\GraphQL::setPromiseAdapter', func_get_args());
+    }
+}

Executor/ExecutorInterface.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Executor;
+
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Executor\Promise\Promise;
+use GraphQL\Schema;
+use Overblog\GraphQLBundle\Executor\Promise\PromiseAdapterInterface;
+
+interface ExecutorInterface
+{
+    /**
+     * @param Schema      $schema
+     * @param string      $requestString
+     * @param null|array  $rootValue
+     * @param null|array  $contextValue
+     * @param null|array  $variableValues
+     * @param null|string $operationName
+     *
+     * @return ExecutionResult|Promise
+     */
+    public function execute(Schema $schema, $requestString, $rootValue = null, $contextValue = null, $variableValues = null, $operationName = null);
+
+    /**
+     * @param PromiseAdapterInterface|null $promiseAdapter
+     */
+    public function setPromiseAdapter(PromiseAdapterInterface $promiseAdapter = null);
+}

Executor/Promise/Adapter/GraphQLPromiseAdapter.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Executor\Promise\Adapter;
+
+use GraphQL\Executor\Promise\Adapter\SyncPromise;
+use GraphQL\Executor\Promise\Adapter\SyncPromiseAdapter as BaseSyncPromiseAdapter;
+use GraphQL\Executor\Promise\Promise;
+use Overblog\GraphQLBundle\Executor\Promise\PromiseAdapterInterface;
+
+class GraphQLPromiseAdapter extends BaseSyncPromiseAdapter implements PromiseAdapterInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function isThenable($value)
+    {
+        $valueOrPromise = $value instanceof Promise ? $value->adoptedPromise : $value;
+
+        return parent::isThenable($valueOrPromise) || $valueOrPromise instanceof SyncPromise;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function convertThenable($thenable)
+    {
+        if ($thenable instanceof Promise) {
+            return $thenable;
+        }
+
+        return parent::convertThenable($thenable);
+    }
+}

Executor/Promise/Adapter/ReactPromiseAdapter.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Executor\Promise\Adapter;
+
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Executor\Promise\Adapter\ReactPromiseAdapter as BaseReactPromiseAdapter;
+use GraphQL\Executor\Promise\Promise;
+use Overblog\GraphQLBundle\Executor\Promise\PromiseAdapterInterface;
+
+class ReactPromiseAdapter extends BaseReactPromiseAdapter implements PromiseAdapterInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function isThenable($value)
+    {
+        return parent::isThenable($value instanceof Promise ? $value->adoptedPromise : $value);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function convertThenable($thenable)
+    {
+        if ($thenable instanceof Promise) {
+            return $thenable;
+        }
+
+        return parent::convertThenable($thenable);
+    }
+
+    /**
+     * Synchronously wait when promise completes.
+     *
+     * @param Promise $promise
+     *
+     * @return ExecutionResult
+     *
+     * @throws \Exception
+     */
+    public function wait(Promise $promise)
+    {
+        if (!$this->isThenable($promise)) {
+            return;
+        }
+        $wait = true;
+        $resolvedValue = null;
+        $exception = null;
+        /** @var \React\Promise\PromiseInterface $reactPromise */
+        $reactPromise = $promise->adoptedPromise;
+
+        while ($wait) {
+            $reactPromise->then(function ($values) use (&$resolvedValue, &$wait) {
+                $resolvedValue = $values;
+                $wait = false;
+            }, function ($reason) use (&$exception, &$wait) {
+                $exception = $reason;
+                $wait = false;
+            });
+        }
+
+        if ($exception instanceof \Exception) {
+            throw $exception;
+        }
+
+        return $resolvedValue;
+    }
+}

Executor/Promise/PromiseAdapterInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the OverblogGraphQLBundle package.
+ *
+ * (c) Overblog <http://github.com/overblog/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Overblog\GraphQLBundle\Executor\Promise;
+
+use GraphQL\Executor\ExecutionResult;
+use GraphQL\Executor\Promise\Promise;
+use GraphQL\Executor\Promise\PromiseAdapter;
+
+interface PromiseAdapterInterface extends PromiseAdapter
+{
+    /**
+     * Synchronously wait when promise completes.
+     *
+     * @param Promise $promise
+     *
+     * @return ExecutionResult
+     */
+    public function wait(Promise $promise);
+}