Merge pull request #27 from moufmouf/inject_request

Adding the ability to type-hint on a Symfony request

Author: moufmouf

Context/SymfonyGraphQLContext.php

@@ -0,0 +1,28 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Context;
+
+
+use Symfony\Component\HttpFoundation\Request;
+
+class SymfonyGraphQLContext implements SymfonyRequestContextInterface
+{
+    /**
+     * @var Request
+     */
+    private $request;
+
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * @return Request
+     */
+    public function getRequest(): Request
+    {
+        return $this->request;
+    }
+}

Context/SymfonyRequestContextInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace TheCodingMachine\Graphqlite\Bundle\Context;
+
+use Symfony\Component\HttpFoundation\Request;
+
+interface SymfonyRequestContextInterface
+{
+    /**
+     * @return Request
+     */
+    public function getRequest(): Request;
+}

Controller/GraphQL/InvalidUserPasswordException.php

@@ -0,0 +1,10 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Controller\GraphQL;
+
+
+class InvalidUserPasswordException
+{
+
+}

Controller/GraphQL/LoginController.php

@@ -0,0 +1,10 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Controller\GraphQL;
+
+
+class LoginController
+{
+
+}

Controller/GraphqliteController.php

@@ -10,6 +10,7 @@
 use GraphQL\Error\Error;
 use GraphQL\Executor\ExecutionResult;
 use GraphQL\Executor\Promise\Promise;
+use GraphQL\Server\ServerConfig;
 use GraphQL\Server\StandardServer;
 use GraphQL\Upload\UploadMiddleware;
 use function in_array;
@@ -27,6 +28,7 @@
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
+use TheCodingMachine\Graphqlite\Bundle\Context\SymfonyGraphQLContext;
 
 /**
  * Listens to every single request and forward Graphql requests to Graphql Webonix standardServer.
@@ -37,14 +39,16 @@ class GraphqliteController
      * @var HttpMessageFactoryInterface
      */
     private $httpMessageFactory;
-    /** @var StandardServer */
-    private $standardServer;
     /** @var bool|int */
     private $debug;
+    /**
+     * @var ServerConfig
+     */
+    private $serverConfig;
 
-    public function __construct(StandardServer $standardServer, HttpMessageFactoryInterface $httpMessageFactory = null, ?int $debug = Debug::RETHROW_UNSAFE_EXCEPTIONS)
+    public function __construct(ServerConfig $serverConfig, HttpMessageFactoryInterface $httpMessageFactory = null, ?int $debug = Debug::RETHROW_UNSAFE_EXCEPTIONS)
     {
-        $this->standardServer = $standardServer;
+        $this->serverConfig = $serverConfig;
         $this->httpMessageFactory = $httpMessageFactory ?: new DiactorosFactory();
         $this->debug = $debug ?? false;
     }
@@ -84,12 +88,17 @@ public function handleRequest(Request $request): Response
         $uploadMiddleware = new UploadMiddleware();
         $psr7Request = $uploadMiddleware->processRequest($psr7Request);
 
-        return $this->handlePsr7Request($psr7Request);
+        return $this->handlePsr7Request($psr7Request, $request);
     }
 
-    private function handlePsr7Request(ServerRequestInterface $request): JsonResponse
+    private function handlePsr7Request(ServerRequestInterface $request, Request $symfonyRequest): JsonResponse
     {
-        $result = $this->standardServer->executePsrRequest($request);
+        // Let's put the request in the context.
+        $serverConfig = clone $this->serverConfig;
+        $serverConfig->setContext(new SymfonyGraphQLContext($symfonyRequest));
+
+        $standardService = new StandardServer($serverConfig);
+        $result = $standardService->executePsrRequest($request);
 
         if ($result instanceof ExecutionResult) {
             return new JsonResponse($result->toArray($this->debug), $this->decideHttpStatusCode($result));

Mappers/RequestParameter.php

@@ -0,0 +1,28 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Mappers;
+
+
+use GraphQL\Type\Definition\ResolveInfo;
+use TheCodingMachine\Graphqlite\Bundle\Context\SymfonyRequestContextInterface;
+use TheCodingMachine\GraphQLite\GraphQLException;
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
+
+class RequestParameter implements ParameterInterface
+{
+
+    /**
+     * @param array<string, mixed> $args
+     * @param mixed $context
+     *
+     * @return mixed
+     */
+    public function resolve(?object $source, array $args, $context, ResolveInfo $info)
+    {
+        if (!$context instanceof SymfonyRequestContextInterface) {
+            throw new GraphQLException('Cannot type-hint on a Symfony Request object in your query/mutation/field. The request context must implement SymfonyRequestContextInterface.');
+        }
+        return $context->getRequest();
+    }
+}

Mappers/RequestParameterMapper.php

@@ -0,0 +1,25 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Mappers;
+
+
+use phpDocumentor\Reflection\DocBlock;
+use phpDocumentor\Reflection\Type;
+use ReflectionParameter;
+use Symfony\Component\HttpFoundation\Request;
+use TheCodingMachine\GraphQLite\Annotations\ParameterAnnotations;
+use TheCodingMachine\GraphQLite\Mappers\Parameters\ParameterMapperInterface;
+use TheCodingMachine\GraphQLite\Parameters\ParameterInterface;
+
+class RequestParameterMapper implements ParameterMapperInterface
+{
+
+    public function mapParameter(ReflectionParameter $parameter, DocBlock $docBlock, ?Type $paramTagType, ParameterAnnotations $parameterAnnotations): ?ParameterInterface
+    {
+        if ($parameter->getType()->getName() === Request::class) {
+            return new RequestParameter();
+        }
+        return null;
+    }
+}

Resources/config/container/graphqlite.xml

@@ -47,10 +47,6 @@
 
         <service id="TheCodingMachine\GraphQLite\Security\AuthorizationServiceInterface" alias="TheCodingMachine\Graphqlite\Bundle\Security\AuthorizationService" />
 
-        <service id="GraphQL\Server\StandardServer">
-            <argument type="service" id="GraphQL\Server\ServerConfig" />
-        </service>
-
         <service id="GraphQL\Server\ServerConfig">
             <call method="setSchema">
                 <argument type="service" id="TheCodingMachine\GraphQLite\Schema"/>
@@ -62,6 +58,10 @@
         </service>
 
         <service id="TheCodingMachine\Graphqlite\Bundle\Controller\GraphqliteController" public="true" />
+
+        <service id="TheCodingMachine\Graphqlite\Bundle\Mappers\RequestParameterMapper">
+            <tag name="graphql.parameter_mapper"/>
+        </service>
     </services>
 
 </container>

Tests/Fixtures/Controller/TestGraphqlController.php

@@ -6,6 +6,7 @@
 
 use GraphQL\Error\Error;
 use Porpaginas\Arrays\ArrayResult;
+use Symfony\Component\HttpFoundation\Request;
 use TheCodingMachine\GraphQLite\Annotations\FailWith;
 use TheCodingMachine\GraphQLite\Annotations\Logged;
 use TheCodingMachine\GraphQLite\Annotations\Right;
@@ -102,4 +103,13 @@ public function withUserRight(): string
     {
         return 'foo';
     }
+
+    /**
+     * @Query()
+     * @return string
+     */
+    public function getUri(Request $request): string
+    {
+        return $request->getPathInfo();
+    }
 }

Tests/FunctionalTest.php

@@ -17,7 +17,7 @@
 
 class FunctionalTest extends TestCase
 {
-    public function testServiceWiring()
+    public function testServiceWiring(): void
     {
         $kernel = new GraphqliteTestingKernel('test', true);
         $kernel->boot();
@@ -68,7 +68,7 @@ public function testServiceWiring()
         ], $result);
     }
 
-    public function testServiceAutowiring()
+    public function testServiceAutowiring(): void
     {
         $kernel = new GraphqliteTestingKernel('test', true);
         $kernel->boot();
@@ -98,7 +98,7 @@ public function testServiceAutowiring()
         ], $result);
     }
 
-    public function testErrors()
+    public function testErrors(): void
     {
         $kernel = new GraphqliteTestingKernel('test', true);
         $kernel->boot();
@@ -134,7 +134,7 @@ public function testErrors()
         $this->assertSame(404, $response->getStatusCode(), $response->getContent());
     }
 
-    public function testLoggedMiddleware()
+    public function testLoggedMiddleware(): void
     {
         $kernel = new GraphqliteTestingKernel('test', true);
         $kernel->boot();
@@ -155,7 +155,7 @@ public function testLoggedMiddleware()
         ], $result);
     }
 
-    public function testLoggedMiddleware2()
+    public function testLoggedMiddleware2(): void
     {
         $kernel = new GraphqliteTestingKernel('test', true);
         $kernel->boot();
@@ -185,6 +185,27 @@ public function testLoggedMiddleware2()
 
     }
 
+    public function testInjectQuery(): void
+    {
+        $kernel = new GraphqliteTestingKernel('test', true);
+        $kernel->boot();
+
+        $request = Request::create('/graphql', 'GET', ['query' => '
+        { 
+          uri
+        }']);
+
+        $response = $kernel->handle($request);
+
+        $result = json_decode($response->getContent(), true);
+
+        $this->assertSame([
+            'data' => [
+                'uri' => '/graphql'
+            ]
+        ], $result);
+    }
+
     private function logIn(ContainerInterface $container)
     {
         // put a token into the storage so the final calls can function