Converting schemas to plugins. (#365)

Author: fubhy

graphql.links.menu.yml

@@ -1,5 +1,11 @@
 graphql.config_page:
   title: 'GraphQL'
   description: 'GraphQL settings and extensions.'
-  parent: 'system.admin_config_services'
+  parent: system.admin_config_services
   route_name: graphql.config_page
+
+graphq.schema_overview:
+  title: 'Schemas'
+  description: 'Birds-eye overview of your available schemas.'
+  parent: graphql.config_page
+  route_name: graphql.schema_overview

graphql.routing.yml

@@ -1,16 +1,15 @@
-graphql.request:
-  path: '/graphql'
-  defaults:
-    _graphql:
-      single: '\Drupal\graphql\Controller\RequestController::handleRequest'
-      multiple: '\Drupal\graphql\Controller\RequestController::handleBatchRequest'
-  requirements:
-    _graphql_query_access: 'TRUE'
-
 graphql.config_page:
   path: '/admin/config/graphql'
   defaults:
     _controller: '\Drupal\system\Controller\SystemController::systemAdminMenuBlockPage'
     _title: 'GraphQL'
   requirements:
     _permission: 'administer site configuration'
+
+graphql.schema_overview:
+  path: '/admin/config/graphql/schemas'
+  defaults:
+    _controller: '\Drupal\graphql\Controller\SchemaOverviewController::listSchemas'
+    _title: 'Schemas'
+  requirements:
+    _permission: 'administer site configuration'

graphql.services.yml

@@ -21,13 +21,6 @@ parameters:
     # @default false
     development: false
 
-    # GraphQL schema class to be used:
-    #
-    # By default, this uses the GraphQL schema provided by the module.
-    #
-    # @default \Drupal\graphql\GraphQL\Schema\Schema
-    schema_class: Drupal\graphql\GraphQL\Schema\Schema
-
 services:
   # Logger channel for graphql related log entries.
   logger.channel.graphql:
@@ -80,44 +73,22 @@ services:
   graphql.query_processor:
     class: Drupal\graphql\GraphQL\Execution\QueryProcessor
     arguments:
-    - '@service_container'
-    - '@graphql.schema'
-    - '@graphql.reducer_manager'
-    - '@current_user'
-    - '%graphql.config%'
-  graphql.schema:
-    class: Drupal\graphql\GraphQL\Schema\Schema
-    factory: ['@graphql.schema_factory', getSchema]
-    tags:
-      - { name: graphql_extra_cache_metadata }
-  graphql.schema_factory:
-    class: Drupal\graphql\GraphQL\Schema\SchemaFactory
+      - '@service_container'
+      - '@graphql.reducer_manager'
+      - '@graphql.schema_loader'
+      - '@current_user'
+      - '%graphql.config%'
+  graphql.schema_loader:
+    class: Drupal\graphql\GraphQL\Schema\SchemaLoader
     arguments:
-    - '@cache_contexts_manager'
-    - '@request_stack'
-    - '@graphql.schema_provider'
-    - '@cache.graphql_schema'
-    - '@cache.graphql_schema_metadata'
-    - '%graphql.config%'
-    tags:
-      - { name: service_collector, tag: graphql_extra_schema_cache_metadata, call: addExtraCacheMetadata }
+      - '@cache_contexts_manager'
+      - '@request_stack'
+      - '@plugin.manager.graphql.schema'
+      - '@cache.graphql_schema'
+      - '@cache.graphql_schema_metadata'
+      - '%graphql.config%'
 
-  # Global cache metadata to add to every graphql schema.
-  # TODO: This needs to be refactored.
-  graphql.extra_schema_cache_metadata:
-    class: Drupal\Core\Cache\CacheableMetadata
-    calls:
-      - { method: addCacheContexts, arguments: [['languages:language_interface']] }
-      - { method: addCacheTags, arguments: [['graphql_schema']] }
-    tags:
-      - { name: graphql_extra_schema_cache_metadata }
-
-  # Composite service for gathering schemas.
-  graphql.schema_provider:
-    class: Drupal\graphql\SchemaProvider\SchemaProvider
-    arguments: ['%graphql.config%']
-    tags:
-        - { name: service_collector, tag: graphql_schema_provider, call: addSchemaProvider }
+  # Query map provider using the composite pattern.
   graphql.query_map_provider:
     class: Drupal\graphql\QueryMapProvider\QueryMapProvider
     tags:
@@ -131,20 +102,24 @@ services:
   # Service for graphql request caching.
   graphql.cache_subscriber:
     class: Drupal\graphql\EventSubscriber\CacheSubscriber
-    arguments: ['@graphql.request_policy', '@graphql.response_policy', '@current_route_match', '@request_stack', '@cache.graphql_response', '@cache.graphql_response_metadata', '@cache_contexts_manager', '%graphql.config%']
+    arguments:
+      - '@graphql.request_policy'
+      - '@graphql.response_policy'
+      - '@current_route_match'
+      - '@request_stack'
+      - '@cache.graphql_response'
+      - '@cache.graphql_response_metadata'
+      - '@cache_contexts_manager'
+      - '@graphql.schema_loader'
+      - '%graphql.config%'
     tags:
-      - { name: service_collector, tag: graphql_extra_cache_metadata, call: addExtraCacheMetadata }
       - { name: event_subscriber }
 
-  # Global cache metadata to add to every graphql request.
-  # TODO: This needs to be refactored.
-  graphql.extra_cache_metadata:
-    class: Drupal\Core\Cache\CacheableMetadata
-    calls:
-      - { method: addCacheContexts, arguments: [['gql', 'user']] }
-      - { method: addCacheTags, arguments: [['graphql_response']] }
+  graphql.query_routes:
+    class: Drupal\graphql\Routing\QueryRoutes
+    arguments: ['@plugin.manager.graphql.schema']
     tags:
-      - { name: graphql_extra_cache_metadata }
+      - { name: 'event_subscriber' }
 
   # Cache request and response policies for graphql requests.
   graphql.request_policy:
@@ -181,7 +156,7 @@ services:
   # Schema introspection service.
   graphql.introspection:
     class: Drupal\graphql\GraphQL\Utility\Introspection
-    arguments: ['@service_container', '@graphql.reducer_manager', '@graphql.schema']
+    arguments: ['@graphql.query_processor']
 
   # Support for subrequests.
   graphql.subrequest_subscriber:
@@ -197,20 +172,23 @@ services:
   graphql.batched_resolver:
     class: Drupal\graphql\GraphQL\Batching\BatchedFieldResolver
 
-  # Schema provider based on plugin system.
-  graphql.schema_provider.pluggable:
-    class: Drupal\graphql\SchemaProvider\PluggableSchemaProvider
-    arguments:
-      - '@graphql.pluggable_schema_manager'
-    tags:
-      - { name: graphql_schema_provider }
-
   # Plugin system based schema manager.
   graphql.pluggable_schema_manager:
     class: Drupal\graphql\Plugin\GraphQL\PluggableSchemaManager
     tags:
       - { name: service_collector, tag: graphql_plugin_manager, call: addPluginManager }
 
+  # Plugin manager for schemas
+  plugin.manager.graphql.schema:
+    class: Drupal\graphql\Plugin\GraphQL\SchemaPluginManager
+    arguments:
+      - 'Plugin/GraphQL/Schemas'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Schemas\SchemaPluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLSchema'
+      - 'graphql_schemas'
+
   # Plugin manager implementations for schema types.
   plugin.manager.graphql.union_type:
     class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager

modules/graphql_core/src/Plugin/GraphQL/Schemas/DefaultSchema.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\GraphQL\Schemas;
+
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\graphql\Plugin\GraphQL\SchemaPluginInterface;
+use Drupal\graphql\Plugin\GraphQL\Schemas\SchemaPluginBase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Youshido\GraphQL\Config\Schema\SchemaConfig;
+use Youshido\GraphQL\Schema\InternalSchemaMutationObject;
+use Youshido\GraphQL\Schema\InternalSchemaQueryObject;
+
+/**
+ * Default generated schema.
+ *
+ * @GraphQLSchema(
+ *   id = "default",
+ *   name = "Default",
+ *   path = "/graphql"
+ * )
+ */
+class DefaultSchema extends SchemaPluginBase implements SchemaPluginInterface, ContainerFactoryPluginInterface {
+
+  /**
+   * The pluggable schema manager service.
+   *
+   * @var \Drupal\graphql\Plugin\GraphQL\PluggableSchemaManagerInterface
+   */
+  protected $schemaManager;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    /** @var \Drupal\graphql\Plugin\GraphQL\PluggableSchemaManagerInterface $schemaManager */
+    $schemaManager = $container->get('graphql.pluggable_schema_manager');
+
+    $query = new InternalSchemaQueryObject(['name' => 'RootQuery']);
+    $query->addFields($schemaManager->getRootFields());
+
+    $mutation = new InternalSchemaMutationObject(['name' => 'RootMutation']);
+    $mutation->addFields($schemaManager->getMutations());
+
+    $types = $schemaManager->find(function() {
+      return TRUE;
+    }, [
+      GRAPHQL_UNION_TYPE_PLUGIN,
+      GRAPHQL_TYPE_PLUGIN,
+      GRAPHQL_INPUT_TYPE_PLUGIN,
+    ]);
+
+    return new static($configuration + ['schema' => [
+      'query' => $query,
+      'mutation' => $mutation,
+      'types' => $types,
+    ]], $plugin_id, $plugin_definition);
+  }
+}

modules/graphql_core/tests/modules/graphql_cache_test/src/Counter.php

@@ -11,7 +11,7 @@ class Counter {
    *
    * @var int
    */
-  private $count = 0;
+  protected static $count = 0;
 
   /**
    * Increase the counter and return it.
@@ -23,8 +23,8 @@ class Counter {
    *   The current count value.
    */
   public function count($amount = 1) {
-    $this->count += $amount;
-    return $this->count;
+    static::$count += $amount;
+    return static::$count;
   }
 
 }

modules/graphql_core/tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/A.php

@@ -17,8 +17,8 @@
  *   secure = true,
  *   type = "Int",
  *   types = {"Root", "Object"},
- *   cache_tags = {"a"},
- *   cache_contexts = {"graphql_test"}
+ *   response_cache_tags = {"a"},
+ *   response_cache_contexts = {"graphql_test"}
  * )
  */
 class A extends FieldPluginBase implements ContainerFactoryPluginInterface {

modules/graphql_core/tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/B.php

@@ -11,8 +11,8 @@
  *   name = "b",
  *   type = "Int",
  *   types = {"Root", "Object"},
- *   cache_tags = {"b"},
- *   cache_contexts = {"graphql_test"}
+ *   response_cache_tags = {"b"},
+ *   response_cache_contexts = {"graphql_test"}
  * )
  */
 class B extends A {

modules/graphql_core/tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/C.php

@@ -11,8 +11,8 @@
  *   name = "c",
  *   type = "Int",
  *   types = {"Root"},
- *   cache_tags = {"c"},
- *   cache_contexts = {"graphql_test_root_field"}
+ *   response_cache_tags = {"c"},
+ *   response_cache_contexts = {"graphql_test_root_field"}
  * )
  */
 class C extends A {

modules/graphql_core/tests/src/Kernel/EnumTest.php

@@ -49,7 +49,7 @@ public function testEnumAnnotations() {
    */
   public function testEnumTypeNames() {
     /** @var \Youshido\GraphQL\Schema\AbstractSchema $schema */
-    $schema = \Drupal::service('graphql.schema');
+    $schema = \Drupal::service('plugin.manager.graphql.schema')->createInstance('default');
     $types = TypeCollector::collectTypes($schema);
     foreach ($types as $type) {
       if ($type instanceof EnumType && $type->getName() === NULL) {

modules/graphql_core/tests/src/Kernel/LanguageTest.php

@@ -3,6 +3,7 @@
 namespace Drupal\Tests\graphql_core\Kernel;
 
 use Drupal\language\Entity\ConfigurableLanguage;
+use Drupal\Tests\graphql\Traits\ByPassAccessTrait;
 use Drupal\Tests\graphql_core\Traits\GraphQLFileTestTrait;
 use Drupal\Tests\language\Kernel\LanguageTestBase;
 
@@ -13,6 +14,7 @@
  */
 class LanguageTest extends LanguageTestBase {
   use GraphQLFileTestTrait;
+  use ByPassAccessTrait;
 
   /**
    * {@inheritdoc}