[1.0.x] Content Insights Report

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. main is a wrong name for a branch. Release branch names always end with the literal .x as described in Release branches → . The only exception is for the main branch, which is actually not fully supported on drupal.org and should be avoided.

main will be a supported branch in future, but for the moment it is better not to use it. It is not wrong, but it is not completely supported on drupal.org.

2. Fix phpcs issues.

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml content_insights_report/

FILE: content_insights_report/src/Controller/ContentInsightsReportController.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 361 | ERROR | The array declaration extends to column 85 (the limit is 80). The array content should be split up over multiple lines
 375 | ERROR | The array declaration extends to column 85 (the limit is 80). The array content should be split up over multiple lines
--------------------------------------------------------------------------------

3. FILE: README.md

The README file is missing the required sections → , including Project name, Requirements, and Configuration.

4. FILE: content_insights_report.info.yml

core_version_requirement: ^8 || ^9 || ^10 || ^11

The Drupal Core versions before 8.7.7 do not recognize the core_version_requirement → key.

5. FILE: content_insights_report.module

/**
 * @file
 * Contains content_insights_report.module.
 */

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.

6. FILE: templates/content-insights-report.html.twig

      {% if show_created_by_and_date == 'yes' %}
          {% set today = date() %}
          <p id="created-by-and-date" class="text-right">{{ 'Created by'|trans }} <i>{{ user.displayname }}</i> on {{ today|date('Y/m/d H:i') }}</p>
      {% endif %}

        <tbody>
            <tr>
              <td><a href="/admin/content?type={{ data.content_type_id }}" class="btn btn-primary btn-lg square" role="button">{{ data.total_count }}</a></td>
              <td><a href="/admin/content?status=1&type={{ data.content_type_id }}" class="btn btn-primary btn-lg square" role="button">{{ data.published_count }}</a></td>
              <td><a href="/admin/content?status=2&type={{ data.content_type_id }}" class="btn btn-primary btn-lg square" role="button">{{ data.unpublished_count }}</a></td>
            </tr>
        </tbody>

                <thead>
                  <th>{{ 'Nodes'|trans }}</th>
                    {% for ms_stage in ms.status['1'].stage %}
                      <th>{{ ms_stage.name }}</th>
                    {% endfor %}
                </thead>

    {% if show_created_by_and_date == 'yes' %}
        {% set today = date() %}
        <p id="created-by-and-date" class="text-right">{{ 'Created by'|trans }} <i>{{ user.displayname }}</i> on {{ today|date('Y/m/d H:i') }}</p>
    {% endif %}

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

7. FILE: src/Controller/ContentInsightsReportController.php

  /**
   * Constructs a content_insights_report object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler) {

FILE: src/Form/ContentInsightsReportConfigForm.php

  /**
   * Constructs a content_insights_report object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

Thanks Vishal for your detailed feedback.

I have fixed all 7 issues reported and created a new release 1.0.5
Ready for your review.

1. Main branch
- Main branch is now delete.

2. Fix phpcs issues.
- 2 errors are now resolved.

3. FILE: README.md
- File has been updated with all required fields.

4. FILE: content_insights_report.info.yml
- Version has ben updated accordingly

5. FILE: content_insights_report.module
- Description has been updated.
- Help text also updated

6. FILE: templates/content-insights-report.html.twig
- indent issue fixed

7. __construct
- FILE: src/Controller/ContentInsightsReportController.php - documentation comment remove.
- FILE: src/Form/ContentInsightsReportConfigForm.php - documentation comment remove.

These applications do not require that new releases are created after reviews.

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.

FILE: src/Controller/ContentInsightsReportController.php

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

The parent class already has properties and methods for the entity type manager, and the configuration object. There is no need to redefine properties for the same purpose; instead, the parent class methods should be used.

Thanks Vishal for your detailed feedback.

I have fixed all 2 issues reported and pushed the code to 1.0.x

FILE: src/Controller/ContentInsightsReportController.php
- Remove the 2 properties

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.

Hi vishal.kadam
Just an update:
I have now added in Submodule to connect with Group module to provide the same report based on a group.
Could you please run the checks again just to make sure i have covered everything needed for security advisory coverage.

Code of sub-module looks fine to me.

• 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/Controller/ContentInsightsReportController.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.

$connection = Database::getConnection();

The code needs to inject the database service. Since services can be overwritten by modules, the database service is not necessarily an instance of that class.

src/Form/ContentInsightsReportConfigForm.php

The parent class already have a property for the configuration factory. There is no need to define that property for the child class.

$config = $this->configFactory->get('content_insights_report.settings');

$this->config() needs to be used to get a configuration object.

content_insights_report.module

      $output .= '<p>' . t('This module generates a Content Insights Report that provides valuable data and analysis about the content in your system. The report is based on various parameters, including content type, status, and workflows, giving you insights into the overall performance and status of the content within your system.') . '</p>';
      $output .= '<p>' . t('For a full description of the module on drupal.org, visit the <a href="https://www.drupal.org/project/content_insights_report" title="Content Insights Report">Content Insights Report Project Page</a>.') . '</p>';
      $output .= '<p>' . t('Submit bug reports and feature suggestions, or track changes in the <a href="https://www.drupal.org/project/issues/search/content_insights_report" title="Content Insights Report Issues">Content Insights Report Issues</a>.') . '</p>';

Drupal core's code uses placeholders even when the link is for a drupal.org page. The reason for that is that translator people do not need to translate the URL used for the <a> tag.

The module has tests. 👍