drupal-graphql /
graphql
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like SchemaPluginBase often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SchemaPluginBase, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | abstract class SchemaPluginBase extends PluginBase implements SchemaPluginInterface, SchemaBuilderInterface, ContainerFactoryPluginInterface, CacheableDependencyInterface { |
||
| 30 | |||
| 31 | /** |
||
| 32 | * The field plugin manager. |
||
| 33 | * |
||
| 34 | * @var \Drupal\graphql\Plugin\FieldPluginManager |
||
| 35 | */ |
||
| 36 | protected $fieldManager; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The mutation plugin manager. |
||
| 40 | * |
||
| 41 | * @var \Drupal\graphql\Plugin\MutationPluginManager |
||
| 42 | */ |
||
| 43 | protected $mutationManager; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * The subscription plugin manager. |
||
| 47 | * |
||
| 48 | * @var \Drupal\graphql\Plugin\SubscriptionPluginManager |
||
| 49 | */ |
||
| 50 | protected $subscriptionManager; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * The type manager aggregator service. |
||
| 54 | * |
||
| 55 | * @var \Drupal\graphql\Plugin\TypePluginManagerAggregator |
||
| 56 | */ |
||
| 57 | protected $typeManagers; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * Static cache of field definitions. |
||
| 61 | * |
||
| 62 | * @var array |
||
| 63 | */ |
||
| 64 | protected $fields = []; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Static cache of mutation definitions. |
||
| 68 | * |
||
| 69 | * @var array |
||
| 70 | */ |
||
| 71 | protected $mutations = []; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Static cache of subscription definitions. |
||
| 75 | * |
||
| 76 | * @var array |
||
| 77 | */ |
||
| 78 | protected $subscriptions = []; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Static cache of type instances. |
||
| 82 | * |
||
| 83 | * @var array |
||
| 84 | */ |
||
| 85 | protected $types = []; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * The service parameters |
||
| 89 | * |
||
| 90 | * @var array |
||
| 91 | */ |
||
| 92 | protected $parameters; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * The query provider service. |
||
| 96 | * |
||
| 97 | * @var \Drupal\graphql\GraphQL\QueryProvider\QueryProviderInterface |
||
| 98 | */ |
||
| 99 | protected $queryProvider; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * The current user. |
||
| 103 | * |
||
| 104 | * @var \Drupal\Core\Session\AccountProxyInterface |
||
| 105 | */ |
||
| 106 | protected $currentUser; |
||
| 107 | |||
| 108 | /** |
||
| 109 | * The logger service. |
||
| 110 | * |
||
| 111 | * @var \Psr\Log\LoggerInterface |
||
| 112 | */ |
||
| 113 | protected $logger; |
||
| 114 | |||
| 115 | /** |
||
| 116 | * @var \Drupal\Core\Language\LanguageManagerInterface |
||
| 117 | */ |
||
| 118 | protected $languageManager; |
||
| 119 | |||
| 120 | /** |
||
| 121 | * {@inheritdoc} |
||
| 122 | */ |
||
| 123 | public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { |
||
| 139 | |||
| 140 | /** |
||
| 141 | * SchemaPluginBase constructor. |
||
| 142 | * |
||
| 143 | * @param array $configuration |
||
| 144 | * The plugin configuration array. |
||
| 145 | * @param string $pluginId |
||
| 146 | * The plugin id. |
||
| 147 | * @param array $pluginDefinition |
||
| 148 | * The plugin definition array. |
||
| 149 | * @param \Drupal\graphql\Plugin\FieldPluginManager $fieldManager |
||
| 150 | * The field plugin manager. |
||
| 151 | * @param \Drupal\graphql\Plugin\MutationPluginManager $mutationManager |
||
| 152 | * The mutation plugin manager. |
||
| 153 | * @param \Drupal\graphql\Plugin\SubscriptionPluginManager $subscriptionManager |
||
| 154 | * The subscription plugin manager. |
||
| 155 | * @param \Drupal\graphql\Plugin\TypePluginManagerAggregator $typeManagers |
||
| 156 | * The type manager aggregator service. |
||
| 157 | * @param \Drupal\graphql\GraphQL\QueryProvider\QueryProviderInterface $queryProvider |
||
| 158 | * The query provider service. |
||
| 159 | * @param \Drupal\Core\Session\AccountProxyInterface $currentUser |
||
| 160 | * The current user. |
||
| 161 | * @param \Psr\Log\LoggerInterface $logger |
||
| 162 | * The logger service. |
||
| 163 | * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager |
||
| 164 | * The language manager service. |
||
| 165 | * @param array $parameters |
||
| 166 | * The service parameters. |
||
| 167 | */ |
||
| 168 | public function __construct( |
||
| 169 | $configuration, |
||
| 170 | $pluginId, |
||
| 171 | $pluginDefinition, |
||
| 172 | FieldPluginManager $fieldManager, |
||
| 173 | MutationPluginManager $mutationManager, |
||
| 174 | SubscriptionPluginManager $subscriptionManager, |
||
| 175 | TypePluginManagerAggregator $typeManagers, |
||
| 176 | QueryProviderInterface $queryProvider, |
||
| 177 | AccountProxyInterface $currentUser, |
||
| 178 | LoggerInterface $logger, |
||
| 179 | LanguageManagerInterface $languageManager, |
||
| 180 | array $parameters |
||
| 181 | ) { |
||
| 182 | parent::__construct($configuration, $pluginId, $pluginDefinition); |
||
| 183 | $this->fieldManager = $fieldManager; |
||
| 184 | $this->mutationManager = $mutationManager; |
||
| 185 | $this->subscriptionManager = $subscriptionManager; |
||
| 186 | $this->typeManagers = $typeManagers; |
||
| 187 | $this->queryProvider = $queryProvider; |
||
| 188 | $this->currentUser = $currentUser; |
||
| 189 | $this->parameters = $parameters; |
||
| 190 | $this->logger = $logger; |
||
| 191 | $this->languageManager = $languageManager; |
||
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * {@inheritdoc} |
||
| 196 | */ |
||
| 197 | public function getSchema() { |
||
| 198 | $config = new SchemaConfig(); |
||
| 199 | |||
| 200 | if ($this->hasMutations()) { |
||
| 201 | $config->setMutation(new ObjectType([ |
||
| 202 | 'name' => 'Mutation', |
||
| 203 | 'fields' => function () { |
||
| 204 | return $this->getMutations(); |
||
| 205 | }, |
||
| 206 | ])); |
||
| 207 | } |
||
| 208 | |||
| 209 | if ($this->hasSubscriptions()) { |
||
| 210 | $config->setSubscription(new ObjectType([ |
||
| 211 | 'name' => 'Subscription', |
||
| 212 | 'fields' => function () { |
||
| 213 | return $this->getSubscriptions(); |
||
| 214 | }, |
||
| 215 | ])); |
||
| 216 | } |
||
| 217 | |||
| 218 | $config->setQuery(new ObjectType([ |
||
| 219 | 'name' => 'Query', |
||
| 220 | 'fields' => function () { |
||
| 221 | return $this->getFields('Root'); |
||
| 222 | }, |
||
| 223 | ])); |
||
| 224 | |||
| 225 | $config->setTypes(function () { |
||
| 226 | return $this->getTypes(); |
||
| 227 | }); |
||
| 228 | |||
| 229 | $config->setTypeLoader(function ($name) { |
||
| 230 | return $this->getType($name); |
||
| 231 | }); |
||
| 232 | |||
| 233 | return new Schema($config); |
||
| 234 | } |
||
| 235 | |||
| 236 | /** |
||
| 237 | * {@inheritdoc} |
||
| 238 | */ |
||
| 239 | public function validateSchema() { |
||
| 240 | return NULL; |
||
| 241 | } |
||
| 242 | |||
| 243 | /** |
||
| 244 | * {@inheritdoc} |
||
| 245 | */ |
||
| 246 | public function getServer() { |
||
| 247 | // If the current user has appropriate permissions, allow to bypass |
||
| 248 | // the secure fields restriction. |
||
| 249 | $globals['bypass field security'] = $this->currentUser->hasPermission('bypass graphql field security'); |
||
|
|
|||
| 250 | |||
| 251 | // Create the server config. |
||
| 252 | $config = ServerConfig::create(); |
||
| 253 | |||
| 254 | // Each document (e.g. in a batch query) gets its own resolve context. This |
||
| 255 | // allows us to collect the cache metadata and contextual values (e.g. |
||
| 256 | // inheritance for language) for each query separately. |
||
| 257 | $config->setContext(function ($params, $document, $operation) use ($globals) { |
||
| 258 | // Each document (e.g. in a batch query) gets its own resolve context. This |
||
| 259 | // allows us to collect the cache metadata and contextual values (e.g. |
||
| 260 | // inheritance for language) for each query separately. |
||
| 261 | $context = new ResolveContext($globals, [ |
||
| 262 | 'language' => $this->languageManager->getCurrentLanguage()->getId(), |
||
| 263 | ]); |
||
| 264 | |||
| 265 | $context->addCacheTags(['graphql']); |
||
| 266 | |||
| 267 | // Always add the language_url cache context. |
||
| 268 | $context->addCacheContexts([ |
||
| 269 | 'languages:language_url', |
||
| 270 | 'languages:language_interface', |
||
| 271 | 'languages:language_content', |
||
| 272 | 'user.permissions', |
||
| 273 | ]); |
||
| 274 | |||
| 275 | return $context; |
||
| 276 | }); |
||
| 277 | |||
| 278 | $config->setValidationRules(function (OperationParams $params, DocumentNode $document, $operation) { |
||
| 279 | if (isset($params->queryId) && empty($params->getOriginalInput('query'))) { |
||
| 280 | // Assume that pre-parsed documents are already validated. This allows |
||
| 281 | // us to store pre-validated query documents e.g. for persisted queries |
||
| 282 | // effectively improving performance by skipping run-time validation. |
||
| 283 | return []; |
||
| 284 | } |
||
| 285 | |||
| 286 | return array_values(DocumentValidator::defaultRules()); |
||
| 287 | }); |
||
| 288 | |||
| 289 | $config->setPersistentQueryLoader([$this->queryProvider, 'getQuery']); |
||
| 290 | $config->setQueryBatching(TRUE); |
||
| 291 | $config->setDebug(!!$this->parameters['development']); |
||
| 292 | $config->setSchema($this->getSchema()); |
||
| 293 | |||
| 294 | // Always log the errors. |
||
| 295 | $config->setErrorsHandler(function (array $errors, callable $formatter) { |
||
| 296 | /** @var \GraphQL\Error\Error $error */ |
||
| 297 | foreach ($errors as $error) { |
||
| 298 | $this->logger->error($error->getMessage()); |
||
| 299 | } |
||
| 300 | |||
| 301 | return array_map($formatter, $errors); |
||
| 302 | }); |
||
| 303 | |||
| 304 | return $config; |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | /** |
||
| 309 | * {@inheritdoc} |
||
| 310 | */ |
||
| 311 | public function hasFields($type) { |
||
| 314 | |||
| 315 | /** |
||
| 316 | * {@inheritdoc} |
||
| 317 | */ |
||
| 318 | public function hasMutations() { |
||
| 321 | |||
| 322 | /** |
||
| 323 | * {@inheritdoc} |
||
| 324 | */ |
||
| 325 | public function hasSubscriptions() { |
||
| 328 | |||
| 329 | /** |
||
| 330 | * {@inheritdoc} |
||
| 331 | */ |
||
| 332 | public function hasType($name) { |
||
| 335 | |||
| 336 | /** |
||
| 337 | * {@inheritdoc} |
||
| 338 | */ |
||
| 339 | public function getFields($type) { |
||
| 351 | |||
| 352 | /** |
||
| 353 | * {@inheritdoc} |
||
| 354 | */ |
||
| 355 | public function getMutations() { |
||
| 358 | |||
| 359 | /** |
||
| 360 | * {@inheritdoc} |
||
| 361 | */ |
||
| 362 | public function getSubscriptions() { |
||
| 365 | |||
| 366 | /** |
||
| 367 | * {@inheritdoc} |
||
| 368 | */ |
||
| 369 | public function getTypes() { |
||
| 374 | |||
| 375 | /** |
||
| 376 | * {@inheritdoc} |
||
| 377 | */ |
||
| 378 | public function getSubTypes($name) { |
||
| 382 | |||
| 383 | /** |
||
| 384 | * {@inheritdoc} |
||
| 385 | */ |
||
| 386 | public function resolveType($name, $value, ResolveContext $context, ResolveInfo $info) { |
||
| 404 | |||
| 405 | /** |
||
| 406 | * {@inheritdoc} |
||
| 407 | */ |
||
| 408 | public function getType($name) { |
||
| 423 | |||
| 424 | /** |
||
| 425 | * {@inheritdoc} |
||
| 426 | */ |
||
| 427 | public function processMutations(array $mutations) { |
||
| 430 | |||
| 431 | /** |
||
| 432 | * {@inheritdoc} |
||
| 433 | */ |
||
| 434 | public function processSubscriptions(array $subscriptions) { |
||
| 437 | |||
| 438 | /** |
||
| 439 | * {@inheritdoc} |
||
| 440 | */ |
||
| 441 | public function processFields(array $fields) { |
||
| 444 | |||
| 445 | /** |
||
| 446 | * {@inheritdoc} |
||
| 447 | */ |
||
| 448 | public function processArguments(array $args) { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * {@inheritdoc} |
||
| 471 | */ |
||
| 472 | public function processType(array $type) { |
||
| 479 | |||
| 480 | /** |
||
| 481 | * Retrieves the type instance for the given reference. |
||
| 482 | * |
||
| 483 | * @param array $type |
||
| 484 | * The type reference. |
||
| 485 | * |
||
| 486 | * @return \GraphQL\Type\Definition\Type |
||
| 487 | * The type instance. |
||
| 488 | */ |
||
| 489 | protected function buildType($type) { |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Retrieves the field definition for a given field reference. |
||
| 501 | * |
||
| 502 | * @param array $field |
||
| 503 | * The type reference. |
||
| 504 | * |
||
| 505 | * @return array |
||
| 506 | * The field definition. |
||
| 507 | */ |
||
| 508 | View Code Duplication | protected function buildField($field) { |
|
| 516 | |||
| 517 | /** |
||
| 518 | * Retrieves the mutation definition for a given field reference. |
||
| 519 | * |
||
| 520 | * @param array $mutation |
||
| 521 | * The mutation reference. |
||
| 522 | * |
||
| 523 | * @return array |
||
| 524 | * The mutation definition. |
||
| 525 | */ |
||
| 526 | View Code Duplication | protected function buildMutation($mutation) { |
|
| 534 | |||
| 535 | /** |
||
| 536 | * Retrieves the subscription definition for a given field reference. |
||
| 537 | * |
||
| 538 | * @param array $mutation |
||
| 539 | * The subscription reference. |
||
| 540 | * |
||
| 541 | * @return array |
||
| 542 | * The subscription definition. |
||
| 543 | */ |
||
| 544 | View Code Duplication | protected function buildSubscription($subscription) { |
|
| 552 | |||
| 553 | /** |
||
| 554 | * {@inheritdoc} |
||
| 555 | */ |
||
| 556 | public function getCacheContexts() { |
||
| 559 | |||
| 560 | /** |
||
| 561 | * {@inheritdoc} |
||
| 562 | */ |
||
| 563 | public function getCacheTags() { |
||
| 566 | |||
| 567 | /** |
||
| 568 | * {@inheritdoc} |
||
| 569 | */ |
||
| 570 | public function getCacheMaxAge() { |
||
| 573 | } |
||
| 574 |
Loading history...
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.