class Validator in GraphQL 8.4

GraphQL validation service.

Hierarchy

• class \Drupal\graphql\GraphQL\Validator implements ValidatorInterface

1 file declares its use of Validator

ValidatorTest.php in tests/src/Kernel/ValidatorTest.php

1 string reference to 'Validator'

graphql.services.yml in ./graphql.services.yml

graphql.services.yml

1 service uses Validator

graphql.validator in ./graphql.services.yml

Drupal\graphql\GraphQL\Validator

File

src/GraphQL/Validator.php, line 18

Namespace

Drupal\graphql\GraphQL

class Validator implements ValidatorInterface {

  /**
   * The schema plugin manager.
   *
   * @var \Drupal\graphql\Plugin\SchemaPluginManager
   */
  protected $pluginManager;

  /**
   * GraphQL logger channel.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $logger;

  /**
   * ValidateResolverController constructor.
   *
   * @param \Drupal\graphql\Plugin\SchemaPluginManager $pluginManager
   *   The schema plugin manager.
   */
  public function __construct(SchemaPluginManager $pluginManager) {
    $this->pluginManager = $pluginManager;
  }

  /**
   * {@inheritdoc}
   */
  public function validateSchema(ServerInterface $server) : array {
    $plugin = $this
      ->getSchemaPlugin($server);
    try {
      return $plugin
        ->getSchema($plugin
        ->getResolverRegistry())
        ->validate();
    } catch (Error $e) {
      return [
        $e,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getMissingResolvers(ServerInterface $server, array $ignore_types = []) : array {
    $plugin = $this
      ->getSchemaPlugin($server);
    $resolver_registry = $plugin
      ->getResolverRegistry();
    if (!method_exists($resolver_registry, "getFieldResolverWithInheritance")) {
      $this->logger
        ->warning("Could not get missing resolvers for @server_name as its registry class (@klass) does not implement getFieldResolverWithInheritance.", [
        '@server_name' => $server
          ->id(),
        '@klass' => get_class($resolver_registry),
      ]);
      return [];
    }
    try {
      $schema = $plugin
        ->getSchema($resolver_registry);
    } catch (Error $e) {
      return [];
    }
    $missing_resolvers = [];
    foreach ($schema
      ->getTypeMap() as $type) {

      // We only care about concrete fieldable types. Resolvers may be defined
      // for interfaces to be available for all implementing types, but only the
      // actual resolved types need resolvers for their fields.
      if (!$type instanceof ObjectType) {
        continue;
      }

      // Skip hidden/internal/introspection types since they're handled by
      // GraphQL itself.
      if (strpos($type->name, "__") === 0) {
        continue;
      }
      if (in_array($type->name, $ignore_types, TRUE)) {
        continue;
      }
      foreach ($type
        ->getFields() as $field) {
        if ($resolver_registry
          ->getFieldResolverWithInheritance($type, $field->name) === NULL) {
          if (!isset($missing_resolvers[$type->name])) {
            $missing_resolvers[$type->name] = [];
          }
          $missing_resolvers[$type->name][] = $field->name;
        }
      }
    }
    return $missing_resolvers;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrphanedResolvers(ServerInterface $server, array $ignore_types = []) : array {
    $plugin = $this
      ->getSchemaPlugin($server);
    $resolver_registry = $plugin
      ->getResolverRegistry();
    try {
      $schema = $plugin
        ->getSchema($resolver_registry);
    } catch (Error $e) {
      return [];
    }
    if (!method_exists($resolver_registry, "getAllFieldResolvers")) {
      $this->logger
        ->warning("Could not get orphaned resolvers for @server_name as its registry class (@klass) does not implement getAllFieldResolvers.", [
        '@server_name' => $server
          ->id(),
        '@klass' => get_class($resolver_registry),
      ]);
      return [];
    }
    $orphaned_resolvers = [];

    /**
     * @var string $type_name
     * @var array $fields
     */
    foreach ($resolver_registry
      ->getAllFieldResolvers() as $type_name => $fields) {
      if (in_array($type_name, $ignore_types, TRUE)) {
        continue;
      }
      try {
        $type = $schema
          ->getType($type_name);
      } catch (Error $_) {
        $type = NULL;
      }

      // If the type can't have any fields then our resolvers don't make sense.
      if (!$type instanceof InterfaceType && !$type instanceof ObjectType && !$type instanceof InputObjectType) {
        $orphaned_resolvers[$type_name] = array_keys($fields);
        continue;
      }
      foreach ($fields as $field_name => $resolver) {
        try {
          $type
            ->getField($field_name);
        } catch (InvariantViolation $_) {
          if (!isset($orphaned_resolvers[$type_name])) {
            $orphaned_resolvers[$type_name] = [];
          }
          $orphaned_resolvers[$type_name][] = $field_name;
        }
      }
    }
    return $orphaned_resolvers;
  }

  /**
   * Get the schema plugin for a GraphQL server.
   *
   * @param \Drupal\graphql\Entity\ServerInterface $server
   *   The GraphQL server.
   *
   * @return \Drupal\graphql\Plugin\SchemaPluginInterface
   *   A schema plugin interface.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   Thrown when no schema plugin is defined for the server.
   */
  private function getSchemaPlugin(ServerInterface $server) : SchemaPluginInterface {
    $schema_name = $server
      ->get('schema');

    /** @var \Drupal\graphql\Plugin\SchemaPluginInterface $plugin */
    $plugin = $this->pluginManager
      ->createInstance($schema_name);
    if ($plugin instanceof ConfigurableInterface && ($config = $server
      ->get('schema_configuration'))) {
      $plugin
        ->setConfiguration($config[$schema_name] ?? []);
    }
    return $plugin;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Validator::$logger	protected	property	GraphQL logger channel.
Validator::$pluginManager	protected	property	The schema plugin manager.
Validator::getMissingResolvers	public	function	Get a list of missing resolvers. Overrides ValidatorInterface::getMissingResolvers
Validator::getOrphanedResolvers	public	function	Get a list of orphaned resolvers. Overrides ValidatorInterface::getOrphanedResolvers
Validator::getSchemaPlugin	private	function	Get the schema plugin for a GraphQL server.
Validator::validateSchema	public	function	Validates the schema of the server. Overrides ValidatorInterface::validateSchema
Validator::__construct	public	function	ValidateResolverController constructor.