Add GraphQL Playground and bump dependencies (#2961)

Author: alanpoulain

src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php

@@ -55,8 +55,9 @@ final class SwaggerUiAction
     private $reDocEnabled;
     private $graphqlEnabled;
     private $graphiQlEnabled;
+    private $graphQlPlaygroundEnabled;
 
-    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false)
+    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, NormalizerInterface $normalizer, TwigEnvironment $twig, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '', string $version = '', $formats = [], $oauthEnabled = false, $oauthClientId = '', $oauthClientSecret = '', $oauthType = '', $oauthFlow = '', $oauthTokenUrl = '', $oauthAuthorizationUrl = '', $oauthScopes = [], bool $showWebby = true, bool $swaggerUiEnabled = false, bool $reDocEnabled = false, bool $graphqlEnabled = false, bool $graphiQlEnabled = false, bool $graphQlPlaygroundEnabled = false)
     {
         $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
         $this->resourceMetadataFactory = $resourceMetadataFactory;
@@ -79,6 +80,7 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName
         $this->reDocEnabled = $reDocEnabled;
         $this->graphqlEnabled = $graphqlEnabled;
         $this->graphiQlEnabled = $graphiQlEnabled;
+        $this->graphQlPlaygroundEnabled = $graphQlPlaygroundEnabled;
 
         if (\is_array($formats)) {
             $this->formats = $formats;
@@ -122,6 +124,7 @@ private function getContext(Request $request, Documentation $documentation): arr
             'reDocEnabled' => $this->reDocEnabled,
             'graphqlEnabled' => $this->graphqlEnabled,
             'graphiQlEnabled' => $this->graphiQlEnabled,
+            'graphQlPlaygroundEnabled' => $this->graphQlPlaygroundEnabled,
         ];
 
         $swaggerContext = ['spec_version' => $request->query->getInt('spec_version', 2)];

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -370,6 +370,7 @@ private function registerGraphQlConfiguration(ContainerBuilder $container, array
 
         $container->setParameter('api_platform.graphql.enabled', $enabled);
         $container->setParameter('api_platform.graphql.graphiql.enabled', $enabled && $this->isConfigEnabled($container, $config['graphql']['graphiql']));
+        $container->setParameter('api_platform.graphql.graphql_playground.enabled', $enabled && $this->isConfigEnabled($container, $config['graphql']['graphql_playground']));
 
         if (!$enabled) {
             return;

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -226,6 +226,9 @@ private function addGraphQlSection(ArrayNodeDefinition $rootNode): void
                         ->arrayNode('graphiql')
                             ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
                         ->end()
+                        ->arrayNode('graphql_playground')
+                            ->{class_exists(GraphQL::class) && class_exists(TwigBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
+                        ->end()
                     ->end()
                 ->end()
             ->end();

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -43,6 +43,7 @@
             <argument>%api_platform.enable_entrypoint%</argument>
             <argument>%api_platform.enable_docs%</argument>
             <argument>%api_platform.graphql.graphiql.enabled%</argument>
+            <argument>%api_platform.graphql.graphql_playground.enabled%</argument>
 
             <tag name="routing.loader" />
         </service>

src/Bridge/Symfony/Bundle/Resources/config/graphql.xml

@@ -113,8 +113,10 @@
             <argument type="service" id="api_platform.graphql.schema_builder" />
             <argument type="service" id="api_platform.graphql.executor" />
             <argument type="service" id="api_platform.graphql.action.graphiql" />
+            <argument type="service" id="api_platform.graphql.action.graphql_playground" />
             <argument>%kernel.debug%</argument>
             <argument>%api_platform.graphql.graphiql.enabled%</argument>
+            <argument>%api_platform.graphql.graphql_playground.enabled%</argument>
             <argument>%api_platform.graphql.default_ide%</argument>
         </service>
 
@@ -125,6 +127,13 @@
             <argument>%api_platform.title%</argument>
         </service>
 
+        <service id="api_platform.graphql.action.graphql_playground" class="ApiPlatform\Core\GraphQl\Action\GraphQlPlaygroundAction" public="true">
+            <argument type="service" id="twig" />
+            <argument type="service" id="api_platform.router" />
+            <argument>%api_platform.graphql.graphql_playground.enabled%</argument>
+            <argument>%api_platform.title%</argument>
+        </service>
+
         <!-- Serializer -->
 
         <service id="api_platform.graphql.normalizer.item" class="ApiPlatform\Core\GraphQl\Serializer\ItemNormalizer" public="false">

src/Bridge/Symfony/Bundle/Resources/config/routing/graphql/graphql_playground.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <route id="api_graphql_graphql_playground" path="/graphql/graphql_playground">
+        <default key="_controller">api_platform.graphql.action.graphql_playground</default>
+    </route>
+
+</routes>

src/Bridge/Symfony/Bundle/Resources/config/swagger-ui.xml

@@ -33,6 +33,7 @@
             <argument>%api_platform.enable_re_doc%</argument>
             <argument>%api_platform.graphql.enabled%</argument>
             <argument>%api_platform.graphql.graphiql.enabled%</argument>
+            <argument>%api_platform.graphql.graphql_playground.enabled%</argument>
         </service>
 
     </services>