Integrity::checkForward() - Code Metrics - Inspection of "Merge pull request #12 from OSInet/3-err" - OSInet/qa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( 58d359...626d2d )

by Frédéric G.

created 2020-08-14 17:16 UTC

Integrity::checkForward() C

↳ Parent: Integrity

Complexity

Conditions	16
Paths	95

Size

Total Lines	63
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	37
c	1
b	0
f	0
dl	0
loc	63
rs	5.5666
cc	16
nc	95
nop	1

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace Drupal\qa\Plugin\QaCheck\References;

use Drupal\Core\Config\ConfigFactoryInterface;
filter:
    dependency_paths: ["lib/*"]
use Drupal\Core\Entity\EntityTypeManagerInterface;
filter:
    dependency_paths: ["lib/*"]
use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
filter:
    dependency_paths: ["lib/*"]
use Drupal\qa\Pass;
use Drupal\qa\Plugin\QaCheckBase;
use Drupal\qa\Plugin\QaCheckInterface;
use Drupal\qa\Result;
use Symfony\Component\DependencyInjection\ContainerInterface;
filter:
    dependency_paths: ["lib/*"]

/**
 * Integrity checks for broken entity references.
 *
 * It covers core entity_reference only.
 *
 * Future versions are expected to cover
 * - core: file
 * - core: image
 * - contrib: entity_reference_revisions, notably used by paragraphs.
 * - contrib: dynamic_entity_reference
 *
 * For entity_reference_revisions, it will check references both up and down
 * the
 * parent/child chain.
 *
 * @QaCheck(
 *   id = "references.integrity",
 *   label=@Translation("Referential integrity"),
 *   details=@Translation("This check finds broken entity references. Missing
 *   nodes or references mean broken links and a bad user experience. These
 *   should usually be edited."), usesBatch=true, steps=3,
 * )
 */
class Integrity extends QaCheckBase implements QaCheckInterface {

  const NAME = 'references.integrity';

  const STEP_ER = 'entity_reference';

  const STEP_FILE = 'file';

  const STEP_IMAGE = 'image';

  const STEP_ERR = 'entity_reference_revisions';

  const STEP_DER = 'dynamic_entity_reference';

  /**
   * The config.factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * The entity_type.manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $etm;

  /**
   * A map of storage handler by entity_type ID.
   *
   * @var array
   */
  protected $storages;

  /**
   * SystemUnusedExtensions constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $id
   *   The plugin ID.
   * @param array $definition
   *   The plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $etm
   *   The entity_type.manager service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *   The config.factory service.
   */
  public function __construct(
    array $configuration,
    string $id,
    array $definition,
    EntityTypeManagerInterface $etm,
    ConfigFactoryInterface $config
  ) {
    parent::__construct($configuration, $id, $definition);
    $this->config = $config;
    $this->etm = $etm;

    $this->cacheStorages();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(
    ContainerInterface $container,
    array $configuration,
    $id,
    $definition
  ) {
    $etm = $container->get('entity_type.manager');
    $config = $container->get('config.factory');
    return new static($configuration, $id, $definition, $etm, $config);
  }

  /**
   * Fetch and cache the storage handlers per entity type for repeated use.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function cacheStorages(): void {
    $ets = array_keys($this->etm->getDefinitions());
    $handlers = [];
    foreach ($ets as $et) {
      $handlers[$et] = $this->etm->getStorage($et);
    }
    $this->storages = $handlers;
  }

  /**
   * @param array $fieldMap
   *
   * @return array
   * @throws \Drupal\Core\TypedData\Exception\MissingDataException
   */
  protected function checkForward(array $fieldMap): array {
    $checks = [];
    foreach ($fieldMap as $et => $fields) {
      $checks[$et] = [
        // Eventual result of a broken reference:
        // <id> => [ <field_name> => <target_id> ].
      ];
      $entities = $this->storages[$et]->loadMultiple();
      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
      foreach ($entities as $entity) {
        $checks[$et][$entity->id()] = [];
        foreach ($fields as $name => $targetET) {
          if (!$entity->hasField($name)) {
            continue;
          }
          $target = $entity->get($name);
          if ($target->isEmpty()) {
            continue;
          }
          $checks[$et][$entity->id()][$name] = [];
          /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $value */
          foreach ($target as $delta => $value) {
            // Happens with DER.
            if (is_array($targetET)) {
              $targetType = $value->toArray()['target_type'];
              // A fail here would be a severe case where content was not migrated after a schema change.
              $deltaTargetET = in_array($targetType,
                $targetET) ? $targetType : '';
            }
            else {
              $deltaTargetET = $targetET;
            }

            $targetID = $value->toArray()[EntityReferenceItem::mainPropertyName()];
            if (!empty($deltaTargetET)) {
              foreach ($entity->referencedEntities() as $targetEntity) {
                $x = $targetEntity->getEntityTypeId();
                if ($x != $deltaTargetET) {
                  continue;
                }
                // Target found, next delta.
                $x = $targetEntity->id();
                if ($x === $targetID) {
                  continue 2;
                }
              }
            }
            // Target not found: broken reference.
            $checks[$et][$entity->id()][$name][$delta] = $targetID;
          }
          if (empty($checks[$et][$entity->id()][$name])) {
            unset($checks[$et][$entity->id()][$name]);
          }
        }
        if (empty($checks[$et][$entity->id()])) {
          unset($checks[$et][$entity->id()]);
        }
      }
      if (empty($checks[$et])) {
        unset($checks[$et]);
      }
    }
    return $checks;
  }

  public function checkReferenceType(string $step): Result {
    $fieldMap = $this->getFields($step);
    $checks = $this->checkForward($fieldMap);
    return new Result($step, empty($checks), $checks);
  }

  /**
   * Get reference fields of the selected type.
   *
   * @param string $refType
   *   The field type.
   *
   * @return array
   *   A field by entity type map.
   */
  protected function getFields(string $refType): array {
    $fscStorage = $this->storages['field_storage_config'];
    $defs = $fscStorage->loadMultiple();
    $fields = [];
    /** @var \Drupal\field\FieldStorageConfigInterface $fsc */
    foreach ($defs as $fsc) {
      if ($fsc->getType() !== $refType) {
        continue;
      }
      $et = $fsc->getTargetEntityTypeId();
      $name = $fsc->getName();
      $target = $fsc->getSetting('target_type');
      if (empty($target)) {
        // Dynamic Entity Reference allows multiple target entity types.
        $target = array_values($fsc->getSetting('entity_type_ids'));
      }
      // XXX hard-coded knowledge. Maybe refactor once multiple types are used.
      // $prop = $fsc->getMainPropertyName();
      if (!isset($fields[$et])) {
        $fields[$et] = [];
      }
      $fields[$et][$name] = $target;
    }
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function run(): Pass {
    $pass = parent::run();

    $steps = [
      self::STEP_ER,
      self::STEP_ERR,
      self::STEP_DER,
      self::STEP_FILE,
      self::STEP_IMAGE,
    ];
    foreach ($steps as $step) {
      $pass->record($this->checkReferenceType($step));
      $pass->life->modify();
    }
    $pass->life->end();
    return $pass;
  }

}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Drupal\qa\Plugin\QaCheck\References;
6
7			use Drupal\Core\Config\ConfigFactoryInterface;
			0 ignored issues – show Bug introduced 2020-08-14 12:32 UTC by Report Bug Copy Issue Report The type `Drupal\Core\Config\ConfigFactoryInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Drupal\Core\Entity\EntityTypeManagerInterface;
			0 ignored issues – show Bug introduced 2020-08-14 12:32 UTC by Report Bug Copy Issue Report The type `Drupal\Core\Entity\EntityTypeManagerInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
			0 ignored issues – show Bug introduced 2020-08-14 12:32 UTC by Report Bug Copy Issue Report The type `Drupal\Core\Field\Plugin...ype\EntityReferenceItem` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use Drupal\qa\Pass;
11			use Drupal\qa\Plugin\QaCheckBase;
12			use Drupal\qa\Plugin\QaCheckInterface;
13			use Drupal\qa\Result;
14			use Symfony\Component\DependencyInjection\ContainerInterface;
			0 ignored issues – show Bug introduced 2020-08-14 12:32 UTC by Report Bug Copy Issue Report The type `Symfony\Component\Depend...tion\ContainerInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15
16			/**
17			* Integrity checks for broken entity references.
18			*
19			* It covers core entity_reference only.
20			*
21			* Future versions are expected to cover
22			* - core: file
23			* - core: image
24			* - contrib: entity_reference_revisions, notably used by paragraphs.
25			* - contrib: dynamic_entity_reference
26			*
27			* For entity_reference_revisions, it will check references both up and down
28			* the
29			* parent/child chain.
30			*
31			* @QaCheck(
32			* id = "references.integrity",
33			* label=@Translation("Referential integrity"),
34			* details=@Translation("This check finds broken entity references. Missing
35			* nodes or references mean broken links and a bad user experience. These
36			* should usually be edited."), usesBatch=true, steps=3,
37			* )
38			*/
39			class Integrity extends QaCheckBase implements QaCheckInterface {
40
41			const NAME = 'references.integrity';
42
43			const STEP_ER = 'entity_reference';
44
45			const STEP_FILE = 'file';
46
47			const STEP_IMAGE = 'image';
48
49			const STEP_ERR = 'entity_reference_revisions';
50
51			const STEP_DER = 'dynamic_entity_reference';
52
53			/**
54			* The config.factory service.
55			*
56			* @var \Drupal\Core\Config\ConfigFactoryInterface
57			*/
58			protected $config;
59
60			/**
61			* The entity_type.manager service.
62			*
63			* @var \Drupal\Core\Entity\EntityTypeManagerInterface
64			*/
65			protected $etm;
66
67			/**
68			* A map of storage handler by entity_type ID.
69			*
70			* @var array
71			*/
72			protected $storages;
73
74			/**
75			* SystemUnusedExtensions constructor.
76			*
77			* @param array $configuration
78			* The plugin configuration.
79			* @param string $id
80			* The plugin ID.
81			* @param array $definition
82			* The plugin definition.
83			* @param \Drupal\Core\Entity\EntityTypeManagerInterface $etm
84			* The entity_type.manager service.
85			* @param \Drupal\Core\Config\ConfigFactoryInterface $config
86			* The config.factory service.
87			*/
88			public function __construct(
89			array $configuration,
90			string $id,
91			array $definition,
92			EntityTypeManagerInterface $etm,
93			ConfigFactoryInterface $config
94			) {
95			parent::__construct($configuration, $id, $definition);
96			$this->config = $config;
97			$this->etm = $etm;
98
99			$this->cacheStorages();
100			}
101
102			/**
103			* {@inheritdoc}
104			*/
105			public static function create(
106			ContainerInterface $container,
107			array $configuration,
108			$id,
109			$definition
110			) {
111			$etm = $container->get('entity_type.manager');
112			$config = $container->get('config.factory');
113			return new static($configuration, $id, $definition, $etm, $config);
114			}
115
116			/**
117			* Fetch and cache the storage handlers per entity type for repeated use.
118			*
119			* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
120			* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
121			*/
122			protected function cacheStorages(): void {
123			$ets = array_keys($this->etm->getDefinitions());
124			$handlers = [];
125			foreach ($ets as $et) {
126			$handlers[$et] = $this->etm->getStorage($et);
127			}
128			$this->storages = $handlers;
129			}
130
131			/**
132			* @param array $fieldMap
133			*
134			* @return array
135			* @throws \Drupal\Core\TypedData\Exception\MissingDataException
136			*/
137			protected function checkForward(array $fieldMap): array {
138			$checks = [];
139			foreach ($fieldMap as $et => $fields) {
140			$checks[$et] = [
141			// Eventual result of a broken reference:
142			// <id> => [ <field_name> => <target_id> ].
143			];
144			$entities = $this->storages[$et]->loadMultiple();
145			/** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
146			foreach ($entities as $entity) {
147			$checks[$et][$entity->id()] = [];
148			foreach ($fields as $name => $targetET) {
149			if (!$entity->hasField($name)) {
150			continue;
151			}
152			$target = $entity->get($name);
153			if ($target->isEmpty()) {
154			continue;
155			}
156			$checks[$et][$entity->id()][$name] = [];
157			/** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $value */
158			foreach ($target as $delta => $value) {
159			// Happens with DER.
160			if (is_array($targetET)) {
161			$targetType = $value->toArray()['target_type'];
162			// A fail here would be a severe case where content was not migrated after a schema change.
163			$deltaTargetET = in_array($targetType,
164			$targetET) ? $targetType : '';
165			}
166			else {
167			$deltaTargetET = $targetET;
168			}
169
170			$targetID = $value->toArray()[EntityReferenceItem::mainPropertyName()];
171			if (!empty($deltaTargetET)) {
172			foreach ($entity->referencedEntities() as $targetEntity) {
173			$x = $targetEntity->getEntityTypeId();
174			if ($x != $deltaTargetET) {
175			continue;
176			}
177			// Target found, next delta.
178			$x = $targetEntity->id();
179			if ($x === $targetID) {
180			continue 2;
181			}
182			}
183			}
184			// Target not found: broken reference.
185			$checks[$et][$entity->id()][$name][$delta] = $targetID;
186			}
187			if (empty($checks[$et][$entity->id()][$name])) {
188			unset($checks[$et][$entity->id()][$name]);
189			}
190			}
191			if (empty($checks[$et][$entity->id()])) {
192			unset($checks[$et][$entity->id()]);
193			}
194			}
195			if (empty($checks[$et])) {
196			unset($checks[$et]);
197			}
198			}
199			return $checks;
200			}
201
202			public function checkReferenceType(string $step): Result {
203			$fieldMap = $this->getFields($step);
204			$checks = $this->checkForward($fieldMap);
205			return new Result($step, empty($checks), $checks);
206			}
207
208			/**
209			* Get reference fields of the selected type.
210			*
211			* @param string $refType
212			* The field type.
213			*
214			* @return array
215			* A field by entity type map.
216			*/
217			protected function getFields(string $refType): array {
218			$fscStorage = $this->storages['field_storage_config'];
219			$defs = $fscStorage->loadMultiple();
220			$fields = [];
221			/** @var \Drupal\field\FieldStorageConfigInterface $fsc */
222			foreach ($defs as $fsc) {
223			if ($fsc->getType() !== $refType) {
224			continue;
225			}
226			$et = $fsc->getTargetEntityTypeId();
227			$name = $fsc->getName();
228			$target = $fsc->getSetting('target_type');
229			if (empty($target)) {
230			// Dynamic Entity Reference allows multiple target entity types.
231			$target = array_values($fsc->getSetting('entity_type_ids'));
232			}
233			// XXX hard-coded knowledge. Maybe refactor once multiple types are used.
234			// $prop = $fsc->getMainPropertyName();
235			if (!isset($fields[$et])) {
236			$fields[$et] = [];
237			}
238			$fields[$et][$name] = $target;
239			}
240			return $fields;
241			}
242
243			/**
244			* {@inheritdoc}
245			*/
246			public function run(): Pass {
247			$pass = parent::run();
248
249			$steps = [
250			self::STEP_ER,
251			self::STEP_ERR,
252			self::STEP_DER,
253			self::STEP_FILE,
254			self::STEP_IMAGE,
255			];
256			foreach ($steps as $step) {
257			$pass->record($this->checkReferenceType($step));
258			$pass->life->modify();
259			}
260			$pass->life->end();
261			return $pass;
262			}
263
264			}
265

OSInet / qa

Push — 8.x-1.x ( 58d359...626d2d )

Integrity::checkForward() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like