FieldPluginBase::resolve() - Code Metrics - Inspection of "Contextual language handling." - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-3.x (#550)

by Philipp

created 2018-03-17 13:05 UTC

FieldPluginBase::resolve() C

↳ Parent: FieldPluginBase

Complexity

Conditions	7
Paths	7

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	14
nc	7
nop	4
dl	0
loc	24
rs	6.7272
c	0
b	0
f	0

<?php

namespace Drupal\graphql\Plugin\GraphQL\Fields;

use Drupal\Component\Plugin\PluginBase;
use Drupal\Component\Render\MarkupInterface;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\graphql\GraphQL\Execution\ResolveContext;
use Drupal\graphql\GraphQL\ValueWrapperInterface;
use Drupal\graphql\Plugin\FieldPluginInterface;
use Drupal\graphql\Plugin\FieldPluginManager;
use Drupal\graphql\Plugin\GraphQL\Traits\ArgumentAwarePluginTrait;
use Drupal\graphql\Plugin\GraphQL\Traits\CacheablePluginTrait;
use Drupal\graphql\Plugin\GraphQL\Traits\DeprecatablePluginTrait;
use Drupal\graphql\Plugin\GraphQL\Traits\DescribablePluginTrait;
use Drupal\graphql\Plugin\GraphQL\Traits\TypedPluginTrait;
use Drupal\graphql\Plugin\LanguageNegotiation\LanguageNegotiationGraphQL;
use Drupal\graphql\Plugin\SchemaBuilderInterface;
use GraphQL\Deferred;
use GraphQL\Type\Definition\ListOfType;
use GraphQL\Type\Definition\NonNull;
use GraphQL\Type\Definition\ResolveInfo;

abstract class FieldPluginBase extends PluginBase implements FieldPluginInterface {
  use CacheablePluginTrait;
  use DescribablePluginTrait;
  use TypedPluginTrait;
  use ArgumentAwarePluginTrait;
  use DeprecatablePluginTrait;

  /**
   * The language context service.
   *
   * @var \Drupal\graphql\GraphQLLanguageContext
   */
  protected $languageContext;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(SchemaBuilderInterface $builder, FieldPluginManager $manager, $definition, $id) {
    return [
      'description' => $definition['description'],
      'contexts' => $definition['contexts'],
      'deprecationReason' => $definition['deprecationReason'],
      'type' => $builder->processType($definition['type']),
      'args' => $builder->processArguments($definition['args']),
      'resolve' => function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($manager, $id) {
        $instance = $manager->getInstance(['id' => $id]);
        return $instance->resolve($value, $args, $context, $info);
      },
    ];
  }

  /**
   * Get the language context instance.
   *
   * @return \Drupal\graphql\GraphQLLanguageContext
   *   The language context service.
   */
  protected function getLanguageContext() {
    if (!isset($this->languageContext)) {
      $this->languageContext = \Drupal::service('graphql.language_context');
    }
    return $this->languageContext;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition() {

    $definition = $this->getPluginDefinition();

    return [
      'type' => $this->buildType($definition),
      'description' => $this->buildDescription($definition),
      'args' => $this->buildArguments($definition),
      'deprecationReason' => $this->buildDeprecationReason($definition),
      'contexts' => $this->buildCacheContexts($definition),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function resolve($value, array $args, ResolveContext $context, ResolveInfo $info) {
    $definition = $this->getPluginDefinition();

    // If not resolving in a trusted environment, check if the field is secure.
    if (!$context->getGlobal('development', FALSE) && !$context->getGlobal('bypass field security', FALSE)) {
      if (empty($definition['secure'])) {
        throw new \Exception(sprintf("Unable to resolve insecure field '%s'.", $info->fieldName));
      }
    }

    foreach ($definition['contextual_arguments'] as $argument) {
      if (array_key_exists($argument, $args) && !is_null($args[$argument])) {
        $context->setContext($argument, $args[$argument], $info);
      }
      else {
        $args[$argument] = $context->getContext($argument, $info);
      }
    }

    return \Drupal::service('graphql.language_context')
      ->executeInLanguageContext(function () use ($value, $args, $context, $info) {
        return $this->resolveDeferred([$this, 'resolveValues'], $value, $args, $context, $info);
      }, $context->getContext('language', $info));
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveDeferred(callable $callback, $value, array $args, ResolveContext $context, ResolveInfo $info) {
    $result = $callback($value, $args, $context, $info);

    if (is_callable($result)) {
      return new Deferred(function () use ($result, $value, $args, $context, $info) {
        return $this->resolveDeferred($result, $value, $args, $context, $info);
      });
    }

    $result = iterator_to_array($result);

    // Only collect cache metadata if this is a query. All other operation types
    // are not cacheable anyways.
    if ($info->operation->operation === 'query') {
      $dependencies = $this->getCacheDependencies($result, $value, $args, $context, $info);
      foreach ($dependencies as $dependency) {
        $context->addCacheableDependency($dependency);
      }
    }

    return $this->unwrapResult($result, $info);
  }

  /**
   * Unwrap the resolved values.
   *
   * @param array $result
   *   The resolved values.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return mixed
   *   The extracted values (an array of values in case this is a list, an
   *   arbitrary value if it isn't).
   */
  protected function unwrapResult($result, ResolveInfo $info) {
    $result = array_map(function ($item) {
      return $item instanceof ValueWrapperInterface ? $item->getValue() : $item;
    }, $result);

    $result = array_map(function ($item) {
      return $item instanceof MarkupInterface ? $item->__toString() : $item;
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }, $result);

    // If this is a list, return the result as an array.
    $type = $info->returnType;
    if ($type instanceof ListOfType || ($type instanceof NonNull && $type->getWrappedType() instanceof ListOfType)) {
      return $result;
    }

    return !empty($result) ? reset($result) : NULL;
  }

  /**
   * Retrieve the list of cache dependencies for a given value and arguments.
   *
   * @param array $result
   *   The result of the field.
   * @param mixed $parent
   *   The parent value.
   * @param array $args
   *   The arguments passed to the field.
   * @param \Drupal\graphql\GraphQL\Execution\ResolveContext $context
   *   The resolve context.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return array
   *   A list of cacheable dependencies.
   */
  protected function getCacheDependencies(array $result, $parent, array $args, ResolveContext $context, ResolveInfo $info) {
    $self = new CacheableMetadata();
    $definition = $this->getPluginDefinition();
    if (!empty($definition['response_cache_contexts'])) {
      $self->addCacheContexts($definition['response_cache_contexts']);
    }

    if (!empty($definition['response_cache_tags'])) {
      $self->addCacheTags($definition['response_cache_tags']);
    }

    if (isset($definition['response_cache_max_age'])) {
      $self->mergeCacheMaxAge($definition['response_cache_max_age']);
    }

    return array_merge([$self], array_filter($result, function ($item) {
      return $item instanceof CacheableDependencyInterface;
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }));
  }

  /**
   * Retrieve the list of field values.
   *
   * Always returns a list of field values. Even for single value fields.
   * Single/multi field handling is responsibility of the base class.
   *
   * @param mixed $value
   *   The current object value.
   * @param array $args
   *   Field arguments.
   * @param $context
   *   The resolve context.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   *   The value generator.
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    // Allow overriding this class without having to declare this method.
    yield NULL;
  }

}


Pull Request — 8.x-3.x (#550)

FieldPluginBase::resolve() C

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php
2
3		namespace Drupal\graphql\Plugin\GraphQL\Fields;
4
5		use Drupal\Component\Plugin\PluginBase;
6		use Drupal\Component\Render\MarkupInterface;
7		use Drupal\Core\Cache\CacheableDependencyInterface;
8		use Drupal\Core\Cache\CacheableMetadata;
9		use Drupal\graphql\GraphQL\Execution\ResolveContext;
10		use Drupal\graphql\GraphQL\ValueWrapperInterface;
11		use Drupal\graphql\Plugin\FieldPluginInterface;
12		use Drupal\graphql\Plugin\FieldPluginManager;
13		use Drupal\graphql\Plugin\GraphQL\Traits\ArgumentAwarePluginTrait;
14		use Drupal\graphql\Plugin\GraphQL\Traits\CacheablePluginTrait;
15		use Drupal\graphql\Plugin\GraphQL\Traits\DeprecatablePluginTrait;
16		use Drupal\graphql\Plugin\GraphQL\Traits\DescribablePluginTrait;
17		use Drupal\graphql\Plugin\GraphQL\Traits\TypedPluginTrait;
18		use Drupal\graphql\Plugin\LanguageNegotiation\LanguageNegotiationGraphQL;
19		use Drupal\graphql\Plugin\SchemaBuilderInterface;
20		use GraphQL\Deferred;
21		use GraphQL\Type\Definition\ListOfType;
22		use GraphQL\Type\Definition\NonNull;
23		use GraphQL\Type\Definition\ResolveInfo;
24
25		abstract class FieldPluginBase extends PluginBase implements FieldPluginInterface {
26		use CacheablePluginTrait;
27		use DescribablePluginTrait;
28		use TypedPluginTrait;
29		use ArgumentAwarePluginTrait;
30		use DeprecatablePluginTrait;
31
32		/**
33		* The language context service.
34		*
35		* @var \Drupal\graphql\GraphQLLanguageContext
36		*/
37		protected $languageContext;
38
39		/**
40		* {@inheritdoc}
41		*/
42		public static function createInstance(SchemaBuilderInterface $builder, FieldPluginManager $manager, $definition, $id) {
43		return [
44		'description' => $definition['description'],
45		'contexts' => $definition['contexts'],
46		'deprecationReason' => $definition['deprecationReason'],
47		'type' => $builder->processType($definition['type']),
48		'args' => $builder->processArguments($definition['args']),
49		'resolve' => function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($manager, $id) {
50		$instance = $manager->getInstance(['id' => $id]);
51		return $instance->resolve($value, $args, $context, $info);
52		},
53		];
54		}
55
56		/**
57		* Get the language context instance.
58		*
59		* @return \Drupal\graphql\GraphQLLanguageContext
60		* The language context service.
61		*/
62		protected function getLanguageContext() {
63		if (!isset($this->languageContext)) {
64		$this->languageContext = \Drupal::service('graphql.language_context');
65		}
66		return $this->languageContext;
67		}
68
69		/**
70		* {@inheritdoc}
71		*/
72	View Code Duplication	public function getDefinition() {
		0 ignored issues – show Duplication introduced 2018-02-16 13:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
73		$definition = $this->getPluginDefinition();
74
75		return [
76		'type' => $this->buildType($definition),
77		'description' => $this->buildDescription($definition),
78		'args' => $this->buildArguments($definition),
79		'deprecationReason' => $this->buildDeprecationReason($definition),
80		'contexts' => $this->buildCacheContexts($definition),
81		];
82		}
83
84		/**
85		* {@inheritdoc}
86		*/
87		public function resolve($value, array $args, ResolveContext $context, ResolveInfo $info) {
88		$definition = $this->getPluginDefinition();
89
90		// If not resolving in a trusted environment, check if the field is secure.
91		if (!$context->getGlobal('development', FALSE) && !$context->getGlobal('bypass field security', FALSE)) {
92		if (empty($definition['secure'])) {
93		throw new \Exception(sprintf("Unable to resolve insecure field '%s'.", $info->fieldName));
94		}
95		}
96
97		foreach ($definition['contextual_arguments'] as $argument) {
98		if (array_key_exists($argument, $args) && !is_null($args[$argument])) {
99		$context->setContext($argument, $args[$argument], $info);
100		}
101		else {
102		$args[$argument] = $context->getContext($argument, $info);
103		}
104		}
105
106		return \Drupal::service('graphql.language_context')
107		->executeInLanguageContext(function () use ($value, $args, $context, $info) {
108		return $this->resolveDeferred([$this, 'resolveValues'], $value, $args, $context, $info);
109		}, $context->getContext('language', $info));
110		}
111
112		/**
113		* {@inheritdoc}
114		*/
115		protected function resolveDeferred(callable $callback, $value, array $args, ResolveContext $context, ResolveInfo $info) {
116		$result = $callback($value, $args, $context, $info);
117
118		if (is_callable($result)) {
119		return new Deferred(function () use ($result, $value, $args, $context, $info) {
120		return $this->resolveDeferred($result, $value, $args, $context, $info);
121		});
122		}
123
124		$result = iterator_to_array($result);
125
126		// Only collect cache metadata if this is a query. All other operation types
127		// are not cacheable anyways.
128		if ($info->operation->operation === 'query') {
129		$dependencies = $this->getCacheDependencies($result, $value, $args, $context, $info);
130		foreach ($dependencies as $dependency) {
131		$context->addCacheableDependency($dependency);
132		}
133		}
134
135		return $this->unwrapResult($result, $info);
136		}
137
138		/**
139		* Unwrap the resolved values.
140		*
141		* @param array $result
142		* The resolved values.
143		* @param \GraphQL\Type\Definition\ResolveInfo $info
144		* The resolve info object.
145		*
146		* @return mixed
147		* The extracted values (an array of values in case this is a list, an
148		* arbitrary value if it isn't).
149		*/
150		protected function unwrapResult($result, ResolveInfo $info) {
151		$result = array_map(function ($item) {
152		return $item instanceof ValueWrapperInterface ? $item->getValue() : $item;
153		}, $result);
154
155		$result = array_map(function ($item) {
156		return $item instanceof MarkupInterface ? $item->__toString() : $item;
		0 ignored issues – show Bug introduced 2018-02-22 17:22 UTC by Report Bug Copy Issue Report The class `Drupal\Component\Render\MarkupInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
157		}, $result);
158
159		// If this is a list, return the result as an array.
160		$type = $info->returnType;
161		if ($type instanceof ListOfType \|\| ($type instanceof NonNull && $type->getWrappedType() instanceof ListOfType)) {
162		return $result;
163		}
164
165		return !empty($result) ? reset($result) : NULL;
166		}
167
168		/**
169		* Retrieve the list of cache dependencies for a given value and arguments.
170		*
171		* @param array $result
172		* The result of the field.
173		* @param mixed $parent
174		* The parent value.
175		* @param array $args
176		* The arguments passed to the field.
177		* @param \Drupal\graphql\GraphQL\Execution\ResolveContext $context
178		* The resolve context.
179		* @param \GraphQL\Type\Definition\ResolveInfo $info
180		* The resolve info object.
181		*
182		* @return array
183		* A list of cacheable dependencies.
184		*/
185		protected function getCacheDependencies(array $result, $parent, array $args, ResolveContext $context, ResolveInfo $info) {
186		$self = new CacheableMetadata();
187		$definition = $this->getPluginDefinition();
188		if (!empty($definition['response_cache_contexts'])) {
189		$self->addCacheContexts($definition['response_cache_contexts']);
190		}
191
192		if (!empty($definition['response_cache_tags'])) {
193		$self->addCacheTags($definition['response_cache_tags']);
194		}
195
196		if (isset($definition['response_cache_max_age'])) {
197		$self->mergeCacheMaxAge($definition['response_cache_max_age']);
198		}
199
200		return array_merge([$self], array_filter($result, function ($item) {
201		return $item instanceof CacheableDependencyInterface;
		0 ignored issues – show Bug introduced 2018-02-07 13:56 UTC by Report Bug Copy Issue Report The class `Drupal\Core\Cache\CacheableDependencyInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
202		}));
203		}
204
205		/**
206		* Retrieve the list of field values.
207		*
208		* Always returns a list of field values. Even for single value fields.
209		* Single/multi field handling is responsibility of the base class.
210		*
211		* @param mixed $value
212		* The current object value.
213		* @param array $args
214		* Field arguments.
215		* @param $context
216		* The resolve context.
217		* @param \GraphQL\Type\Definition\ResolveInfo $info
218		* The resolve info object.
219		*
220		* @return \Generator
221		* The value generator.
222		*/
223		protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
224		// Allow overriding this class without having to declare this method.
225		yield NULL;
226		}
227
228		}
229

drupal-graphql / graphql

Pull Request — 8.x-3.x (#550)

FieldPluginBase::resolve() C

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like