[1.0.x] Entity Usage Explorer

Thank you for applying!

Please read Review process for security advisory coverage: What to expect for more details and Security advisory coverage application checklist to understand what reviewers look for. Tips for ensuring a smooth review gives some hints for a smoother review.

The important notes are the following.

• If you have not done it yet, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
• For the time this application is open, only your commits are allowed.
• The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
• We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications, Application workflow, What to cover in an application review, and Tools to use for reviews.

The important notes are the following.

• It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
• Reviewers should show the output of a CLI tool only once per application.
• It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues.

1. FILE: README.md

The README file is missing the required sections including Requirements.

2. FILE: entity_usage_explorer.module

/**
 * @file
 * The module file.
 */

The usual description for a .module file is “Hook implementations for the [module name] module”, where [module name] is the module name given in the .info.yml file.

3. FILE: templates/entity-usage-overview-page.html.twig

Twig code needs to be correctly indented. Drupal uses two spaces for indentation, not four spaces or tabs.

Strings shown in the user interface must be translatable. That holds true also for strings used in template files.

Rest looks fine to me.

Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/UsageService.php

  /**
   * Summary of loadContentEntityTypes.
   */
  public function loadContentEntityTypes() : array {
    $entity_definitions = $this->entityTypeManager->getDefinitions();

    $content_entity_types = [];

    foreach ($entity_definitions as $entity_type_id => $definition) {
      if ($definition->entityClassImplements(ContentEntityInterface::class)) {
        $content_entity_types[] = $entity_type_id;
      }
    }

    return $content_entity_types;
  }

  /**
   * Implements getEntityReferences().
   */
  public function getEntityReferences($entity_type, $bundle_to_query) {
    $target_type = '';
    $entity_tables = $this->database->query("SHOW TABLES LIKE '%{$entity_type}__%'")->fetchAllKeyed(0, 0);
    $matches = [];

    foreach ($entity_tables as $table) {
      $prefix_key = str_replace("{$entity_type}__", '', $table);
      $column = $this->database->query("SHOW COLUMNS FROM `$table` LIKE '%target_id%'")->fetch();

      if ($column) {
        $column_name = $column->Field;
        if (str_ends_with($column_name, '_target_id')) {
          $suffix_key = str_replace('_target_id', '', $column_name);

          if ($prefix_key === $suffix_key) {
            $field_name = $prefix_key;
            $storage = $this->entityTypeManager->getStorage('field_storage_config')->load("{$entity_type}." . $field_name);
            if ($storage && in_array($storage->getType(), ['entity_reference', 'entity_reference_revisions', 'file'])) {
              $target_type = $storage->getSettings()['target_type'];
            }
            if ($bundle_to_query == $target_type) {
              $matches[] = [
                'table' => $table,
                'column' => $column_name,
                'field_name' => $field_name,
                'key' => $prefix_key,
                'target_type' => $target_type ?? 'Not an entity reference field',
              ];
            }
          }
        }
      }
    }

    return $matches;
  }

  /**
   * Implements getEntityUsage().
   */
  public function getEntityUsage(string $target_entity, int $entity_id): array {
    $data = [];
    $entity_types = $this->loadContentEntityTypes();
    foreach ($entity_types as $entity_type) {
      if ($entity_type == 'menu_link_content') {
        $menu_record = $this->getEntityUsageInMenu($target_entity, $entity_id);
        if (!empty($menu_record)) {
          $data[$entity_type] = $menu_record;
        }
      }

      $matches = $this->getEntityReferences($entity_type, $target_entity);
      if (!empty($matches)) {
        $data[$entity_type] = [];
        foreach ($matches as $match) {
          $query = $this->database->select($match['table'], 't')
            ->fields('t')
            ->condition($match['column'], $entity_id)
            ->execute();

          $result = $query->fetchAll();
          if (!empty($result)) {
            $data[$entity_type] = array_merge($data[$entity_type], $result);
          }
        }
      }
    }

    return $data;
  }

None of those documentation comments are correct. A short description starting with Implements is for hook implementations. For other functions and methods, a documentation comment needs to contain at least a short description, a description of the parameters (if they are used), and a description of the returned value (if it is not void).

    $target_type = '';
    $entity_tables = $this->database->query("SHOW TABLES LIKE '%{$entity_type}__%'")->fetchAllKeyed(0, 0);
    $matches = [];

    foreach ($entity_tables as $table) {
      $prefix_key = str_replace("{$entity_type}__", '', $table);
      $column = $this->database->query("SHOW COLUMNS FROM `$table` LIKE '%target_id%'")->fetch();

Drupal core does not query entity tables in that way, which is not necessary to verify a specific database table exists to then query it.

src/Controller/UsageOverviewController.php

Since that class does not use any method from the parent class, it does not need to use ControllerBase as parent class. Controllers do not need to have a parent class; as long as they implement \Drupal\Core\DependencyInjection\ContainerInjectionInterface, they are fine.

I will review the project tomorrow.

Thank you for your contribution and for your patience with the review process!

I am going to update your account so you can opt into security advisory coverage any project you create, including the projects you already created.

These are some recommended readings to help you with maintainership:

• Dries' post on Responsible maintainers
• Maintainership
• Git version control system
• Issue procedures and etiquette
• Maintaining and responding to issues for a project
• Release naming conventions.

You can find more contributors chatting on Slack or IRC in #drupal-contribute. So, come hang out and stay involved!
Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

I thank the dedicated reviewers as well.