Merge 5db0c3f into 4b752f1

Author: mcg-web

README.md

@@ -3,7 +3,10 @@ OverblogGraphQLBundle
 
 This Symfony bundle provides integration of [GraphQL](https://facebook.github.io/graphql/) using [webonyx/graphql-php](https://github.com/webonyx/graphql-php)
 and [GraphQL Relay](https://facebook.github.io/relay/docs/graphql-relay-specification.html).
-It also supports batching using libs like [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer) or [Apollo GraphQL](http://dev.apollodata.com/core/network.html#query-batching).
+It also supports:
+* batching with [ReactRelayNetworkLayer](https://github.com/nodkz/react-relay-network-layer)
+* batching with [Apollo GraphQL](http://dev.apollodata.com/core/network.html#query-batching).
+* upload and batching upload with [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client)
 
 [![Build Status](https://travis-ci.org/overblog/GraphQLBundle.svg?branch=master)](https://travis-ci.org/overblog/GraphQLBundle)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/overblog/GraphQLBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/overblog/GraphQLBundle/?branch=master)

Request/BatchParser.php

@@ -7,6 +7,8 @@
 
 class BatchParser implements ParserInterface
 {
+    use UploadParserTrait;
+
     const PARAM_ID = 'id';
 
     private static $queriesDefaultValue = [
@@ -49,17 +51,29 @@ public function parse(Request $request)
      */
     private function getParsedBody(Request $request)
     {
-        $type = explode(';', $request->headers->get('content-type'))[0];
+        $contentType = explode(';', $request->headers->get('content-type'))[0];
 
         // JSON object
-        if ($type !== static::CONTENT_TYPE_JSON) {
-            throw new BadRequestHttpException(sprintf('Only request with content type "%s" is accepted.', static::CONTENT_TYPE_JSON));
-        }
+        switch ($contentType) {
+            case static::CONTENT_TYPE_JSON:
+                $parsedBody = json_decode($request->getContent(), true);
+
+                if (JSON_ERROR_NONE !== json_last_error()) {
+                    throw new BadRequestHttpException('POST body sent invalid JSON');
+                }
+                break;
 
-        $parsedBody = json_decode($request->getContent(), true);
+            case static::CONTENT_TYPE_FORM_DATA:
+                $parsedBody = $this->treatUploadFiles($request->request->all(), $request->files->all());
+                break;
 
-        if (JSON_ERROR_NONE !== json_last_error()) {
-            throw new BadRequestHttpException('POST body sent invalid JSON');
+            default:
+                throw new BadRequestHttpException(sprintf(
+                    'Batching parser only accepts "%s" or "%s" content-type but got %s.',
+                    static::CONTENT_TYPE_JSON,
+                    static::CONTENT_TYPE_FORM_DATA,
+                    json_encode($contentType)
+                ));
         }
 
         return $parsedBody;

Request/Parser.php

@@ -7,6 +7,8 @@
 
 class Parser implements ParserInterface
 {
+    use UploadParserTrait;
+
     /**
      * @param Request $request
      *
@@ -55,7 +57,7 @@ private function getParsedBody(Request $request)
             // URL-encoded query-string
             case static::CONTENT_TYPE_FORM:
             case static::CONTENT_TYPE_FORM_DATA:
-                $parsedBody = $request->request->all();
+                $parsedBody = $this->treatUploadFiles($request->request->all(), $request->files->all());
                 break;
 
             default:

Request/UploadParserTrait.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Overblog\GraphQLBundle\Request;
+
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+
+trait UploadParserTrait
+{
+    /**
+     * @param array $operations
+     * @param array $map
+     * @param array $files
+     *
+     * @return array
+     */
+    protected function mappingUploadFiles(array $operations, array $map, array $files)
+    {
+        $accessor = PropertyAccess::createPropertyAccessorBuilder()
+            ->enableExceptionOnInvalidIndex()
+            ->getPropertyAccessor();
+
+        foreach ($map as $fileName => $locations) {
+            foreach ($locations as $location) {
+                $fileKey = sprintf('[%s]', $fileName);
+                if (!$accessor->isReadable($files, $fileKey)) {
+                    throw new BadRequestHttpException(sprintf('File %s is missing in the request.', json_encode($fileName)));
+                }
+                $file = $accessor->getValue($files, $fileKey);
+                $locationKey = $this->locationToPropertyAccessPath($location);
+                if (!$accessor->isReadable($operations, $locationKey)) {
+                    throw new BadRequestHttpException(sprintf('Map entry %s could not be localized in operations.', json_encode($location)));
+                }
+                $accessor->setValue($operations, $locationKey, $file);
+            }
+        }
+
+        return $operations;
+    }
+
+    protected function locationToPropertyAccessPath($location)
+    {
+        return array_reduce(
+            explode('.', $location),
+            function ($carry, $item) {
+                return sprintf('%s[%s]', $carry, $item);
+            }
+        );
+    }
+
+    protected function isUploadPayload(array $payload)
+    {
+        return isset($payload['operations']) && isset($payload['map']) && is_array($payload['operations']) && is_array($payload['map']);
+    }
+
+    protected function treatUploadFiles(array $parsedBody, array $files)
+    {
+        if ($this->isUploadPayload($parsedBody)) {
+            return $this->mappingUploadFiles($parsedBody['operations'], $parsedBody['map'], $files);
+        } else {
+            return $parsedBody;
+        }
+    }
+}

Resources/doc/definitions/upload-files.md

@@ -1,5 +1,53 @@
 ### Upload files
 
+Using apollo-upload-client
+--------------------------
+
+The bundle comes of the box with a server compatible with
+[apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client).
+
+1. Register upload scalar type to enabled it
+
+```yaml
+# config/services.yaml
+services
+    Overblog\GraphQLBundle\Upload\Type\GraphQLUploadType:
+        class: Overblog\GraphQLBundle\Upload\Type\GraphQLUploadType
+        arguments:
+            - MyUpload
+        tags:
+            - { name: overblog_graphql.type, alias: MyUpload }
+```
+You can name as you want just replace `MyUpload` in above example.
+
+2. Use it in your Schema
+
+Here an example:
+
+```yaml
+Mutation:
+    type: object
+    config:
+        fields:
+            singleUpload:
+                type: String!
+                resolve: '@=args["file"].getBasename()'
+                args:
+                    file: MyUpload!
+            multipleUpload:
+                type: '[String!]'
+                resolve: '@=[args["files"][0].getBasename(), args["files"][1].getBasename()]'
+                args:
+                    files: '[MyUpload!]!'
+```
+
+**Notes:**
+- Files args are of type `Symfony\Component\HttpFoundation\File\UploadedFile`
+- Upload scalar type can be use only on inputs fields (args or InputObject)
+
+The classic way
+---------------
+
 here an example of how uploading can be done using this bundle
 
 * First define schema

Tests/Functional/App/config/upload/config.yml

@@ -0,0 +1,24 @@
+imports:
+    - { resource: ../config.yml }
+
+overblog_graphql:
+    errors_handler:
+        rethrow_internal_exceptions: true
+    definitions:
+        class_namespace: "Overblog\\GraphQLBundle\\Upload\\__DEFINITIONS__"
+        schema:
+            query: Query
+            mutation: Mutation
+        mappings:
+            types:
+                -
+                    type: yaml
+                    dir: "%kernel.root_dir%/config/upload/mapping"
+
+services:
+    Overblog\GraphQLBundle\Upload\Type\GraphQLUploadType:
+        class: Overblog\GraphQLBundle\Upload\Type\GraphQLUploadType
+        arguments:
+            - Upload
+        tags:
+            - { name: overblog_graphql.type, alias: Upload }

Tests/Functional/App/config/upload/mapping/schema.types.yaml

@@ -0,0 +1,30 @@
+Query:
+    type: object
+    config:
+        fields:
+            foo: {type: String!}
+
+Mutation:
+    type: object
+    config:
+        fields:
+            singleUpload:
+                type: String!
+                resolve: '@=args["file"].getBasename()'
+                args:
+                    file: Upload!
+            multipleUpload:
+                type: '[String!]'
+                resolve: '@=[args["files"][0].getBasename(), args["files"][1].getBasename()]'
+                args:
+                    files: '[Upload!]!'
+            serializationIsUnsupported:
+                type: Upload!
+                resolve: '@=args["file"]'
+                args:
+                    file: Upload!
+            oldUpload:
+                type: String!
+                resolve: '@=args["file"]'
+                args:
+                    file: String!

Tests/Functional/Controller/GraphControllerTest.php

@@ -230,7 +230,7 @@ public function testBatchEndpointWithEmptyQuery()
 
     /**
      * @expectedException \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
-     * @expectedExceptionMessage Only request with content type "application/json" is accepted.
+     * @expectedExceptionMessage Batching parser only accepts "application/json" or "multipart/form-data" content-type but got "".
      */
     public function testBatchEndpointWrongContentType()
     {