Move plugin system to graphql base module. (#364)

Author: fubhy

graphql.module

@@ -6,6 +6,15 @@
  */
 use Drupal\graphql\Utility\StringHelper;
 
+define('GRAPHQL_SCALAR_PLUGIN', 'scalar');
+define('GRAPHQL_FIELD_PLUGIN', 'field');
+define('GRAPHQL_MUTATION_PLUGIN', 'mutation');
+define('GRAPHQL_INTERFACE_PLUGIN', 'interface');
+define('GRAPHQL_UNION_TYPE_PLUGIN', 'union');
+define('GRAPHQL_INPUT_TYPE_PLUGIN', 'input');
+define('GRAPHQL_TYPE_PLUGIN', 'type');
+define('GRAPHQL_ENUM_PLUGIN', 'enum');
+
 /**
  * Implements hook_help().
  */
@@ -48,4 +57,74 @@ function graphql_camelcase($components) {
  */
 function graphql_propcase($components) {
   return StringHelper::propCase($components);
-}
+}
+
+/**
+ * Implements hook_graphql_interfaces_alter().
+ *
+ * Flatten the interface inheritance tree.
+ */
+function graphql_graphql_interfaces_alter(&$definitions) {
+  $interfaces = array_map(function($definition) use ($definitions) {
+    return graphql_list_interfaces($definitions, $definition);
+  }, $definitions);
+
+  foreach ($interfaces as $index => $list) {
+    $definition['interfaces'] = $list;
+  }
+}
+
+/**
+ * Implements hook_graphql_types_alter().
+ *
+ * Flatten the interface inheritance tree.
+ */
+function graphql_graphql_types_alter(&$definitions) {
+  $interfaceDefinitions = \Drupal::service('plugin.manager.graphql.interface')->getDefinitions();
+
+  $interfaces = array_map(function($definition) use ($interfaceDefinitions) {
+    return graphql_list_interfaces($interfaceDefinitions, $definition);
+  }, $definitions);
+
+  foreach ($interfaces as $index => $list) {
+    $definitions[$index]['interfaces'] = $list;
+  }
+}
+
+/**
+ * Get a flattened list of a plugins interface inheritance tree.
+ *
+ * @param array $definitions
+ *   The list of interface definitions.
+ * @param mixed $definition
+ *   A plugin definition.
+ *
+ * @return string[]
+ *   A list of interface names.
+ */
+function graphql_list_interfaces(array &$definitions, $definition) {
+  $parents = array_filter($definitions, function($parent) use ($definition) {
+    return in_array($parent['name'], $definition['interfaces']);
+  });
+
+  $interfaces = array_reduce(array_map(function($parent) use ($definitions) {
+    return graphql_list_interfaces($definitions, $parent);
+  }, $parents), 'array_merge', $definition['interfaces']);
+
+  return $interfaces;
+}
+
+/**
+ * Alter the subrequest payload and add contextual data.
+ */
+function graphql_graphql_subrequest_alter(&$data, $requirements) {
+  /** @var \Drupal\Core\Plugin\Context\ContextRepositoryInterface $repository */
+  $repository = \Drupal::service('graphql.context_repository');
+  $requiredContexts = array_intersect(array_keys($repository->getAvailableContexts()), $requirements);
+  $runtimeContexts = $repository->getRuntimeContexts($requiredContexts);
+  foreach ($requiredContexts as $contextId) {
+    if (array_key_exists($contextId, $runtimeContexts)) {
+      $data[$contextId] = $runtimeContexts[$contextId]->getContextValue();
+    }
+  }
+}

graphql.services.yml

@@ -25,15 +25,23 @@ parameters:
     #
     # By default, this uses the GraphQL schema provided by the module.
     #
-    # @default \Drupal\graphql\Schema
-    schema_class: Drupal\graphql\GraphQL\Schema
+    # @default \Drupal\graphql\GraphQL\Schema\Schema
+    schema_class: Drupal\graphql\GraphQL\Schema\Schema
 
 services:
+  # Logger channel for graphql related log entries.
+  logger.channel.graphql:
+    parent: logger.channel_base
+    arguments: ['graphql']
+
+  # Check access for executing graphql queries.
   access_check.graphql.query:
     class: Drupal\graphql\Access\QueryAccessCheck
     arguments: ['@request_stack']
     tags:
       - { name: access_check, applies_to: _graphql_query_access }
+
+  # Schema and schema metadata cache bin.
   cache.graphql_schema:
     class: Drupal\Core\Cache\CacheBackendInterface
     tags:
@@ -46,6 +54,8 @@ services:
       - { name: cache.bin }
     factory: cache_factory:get
     arguments: [graphql_schema_metadata]
+
+  # Response and response metadata cache bin.
   cache.graphql_response:
     class: Drupal\Core\Cache\CacheBackendInterface
     tags:
@@ -58,18 +68,30 @@ services:
       - { name: cache.bin }
     factory: cache_factory:get
     arguments: [graphql_response_metadata]
+
+  # Cache context for graphql request parameters.
   cache_context.gql:
     class: Drupal\graphql\Cache\Context\QueryCacheContext
     arguments: ['@request_stack']
     tags:
       - { name: cache.context }
+
+  # Schema and processor factory.
+  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
+    class: Drupal\graphql\GraphQL\Schema\Schema
     factory: ['@graphql.schema_factory', getSchema]
     tags:
       - { name: graphql_extra_cache_metadata }
   graphql.schema_factory:
-    class: Drupal\graphql\SchemaFactory
+    class: Drupal\graphql\GraphQL\Schema\SchemaFactory
     arguments:
     - '@cache_contexts_manager'
     - '@request_stack'
@@ -78,22 +100,19 @@ services:
     - '@cache.graphql_schema_metadata'
     - '%graphql.config%'
     tags:
-        - { name: service_collector, tag: graphql_extra_schema_cache_metadata, call: addExtraCacheMetadata }
-  graphql.query_processor:
-    class: Drupal\graphql\QueryProcessor
-    arguments:
-    - '@service_container'
-    - '@graphql.schema'
-    - '@graphql.reducer_manager'
-    - '@current_user'
-    - '%graphql.config%'
+      - { name: service_collector, tag: graphql_extra_schema_cache_metadata, call: addExtraCacheMetadata }
+
+  # 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%']
@@ -103,22 +122,31 @@ services:
     class: Drupal\graphql\QueryMapProvider\QueryMapProvider
     tags:
         - { name: service_collector, tag: graphql_query_map_provider, call: addQueryMapProvider }
+
+  # Manager for schema reducers. Uses a compiler pass to gather reducers.
   graphql.reducer_manager:
-    class: Drupal\graphql\Reducers\ReducerManager
+    class: Drupal\graphql\GraphQL\Reducers\ReducerManager
     arguments: ['@service_container', '%graphql.reducers%']
+
+  # 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%']
     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']] }
     tags:
       - { name: graphql_extra_cache_metadata }
+
+  # Cache request and response policies for graphql requests.
   graphql.request_policy:
     class: Drupal\Core\PageCache\ChainRequestPolicy
     tags:
@@ -142,12 +170,157 @@ services:
     arguments: ['@path_processor_manager']
     tags:
       - { name: graphql_request_policy }
+
+  # Upcasting for graphql query request parameters.
   graphql.route_enhancer.query:
     class: Drupal\graphql\Routing\QueryRouteEnhancer
     arguments: ['@graphql.query_map_provider']
     tags:
       - { name: route_enhancer }
+
+  # Schema introspection service.
   graphql.introspection:
-    class: Drupal\graphql\Introspection
+    class: Drupal\graphql\GraphQL\Utility\Introspection
     arguments: ['@service_container', '@graphql.reducer_manager', '@graphql.schema']
 
+  # Support for subrequests.
+  graphql.subrequest_subscriber:
+    class: Drupal\graphql\EventSubscriber\SubrequestSubscriber
+    tags:
+      - { name: event_subscriber }
+  graphql.context_repository:
+    class: Drupal\graphql\GraphQL\Context\ContextRepository
+    tags:
+      - { name: service_collector, tag: context_provider, call: addContextProvider }
+
+  # Support for deferred / batched field resolvers.
+  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 implementations for schema types.
+  plugin.manager.graphql.union_type:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/UnionTypes'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Unions\UnionTypePluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLUnionType'
+      - 'graphql_union_types'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.interface:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Interfaces'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Interfaces\InterfacePluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLInterface'
+      - 'graphql_interfaces'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.type:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Types'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Types\TypePluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLType'
+      - 'graphql_types'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.input_type:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/InputTypes'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\InputTypes\InputTypePluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLInputType'
+      - 'graphql_input_types'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.field:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Fields'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLField'
+      - 'graphql_fields'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.mutation:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Mutations'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Mutations\MutationPluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLMutation'
+      - 'graphql_mutations'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.scalar:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Scalars'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Youshido\GraphQL\Type\TypeInterface'
+      - '\Drupal\graphql\Annotation\GraphQLScalar'
+      - 'graphql_scalars'
+      - '@logger.channel.graphql'
+  plugin.manager.graphql.enum:
+    class: Drupal\graphql\Plugin\GraphQL\TypeSystemPluginManager
+    tags:
+      - { name: graphql_plugin_manager }
+    calls:
+      - [setSchemaManager, ['@graphql.pluggable_schema_manager']]
+    arguments:
+      - 'Plugin/GraphQL/Enums'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\graphql\Plugin\GraphQL\Enums\EnumPluginBase'
+      - '\Drupal\graphql\Annotation\GraphQLEnum'
+      - 'graphql_enums'
+      - '@logger.channel.graphql'