FGM / mongodb

modules/mongodb_watchdog/src/Controller/RequestController.php

<?php

namespace Drupal\mongodb_watchdog\Controller;

use Drupal\Component\Utility\Unicode;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Link;
use Drupal\Core\Logger\RfcLogLevel;
use Drupal\mongodb_watchdog\Logger;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Implements the controller for the request events page.
 */
class RequestController implements ContainerInjectionInterface {

  /**
   * The core date.formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The items_per_page configuration value.
   *
   * @var int
   */
  protected $itemsPerPage;

  /**
   * The length of the absolute path to the site root, in runes.
   *
   * @var int
   */
  protected $rootLength;

  /**
   * The mongodb_watchdog logger, to access events.
   *
   * @var \Drupal\mongodb_watchdog\Logger
   */
  protected $watchdog;

  /**
   * RequestController constructor.
   *
   * @param \Drupal\mongodb_watchdog\Logger $watchdog
   *   The MongoDB logger service, to load event data.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The core date.formatter service.
   * @param int $items_per_page
   *   The items_per_page configuration value.
   */
  public function __construct(Logger $watchdog, DateFormatterInterface $date_formatter, $items_per_page) {
    $this->dateFormatter = $date_formatter;
    $this->itemsPerPage = $items_per_page;
    $this->watchdog = $watchdog;

    // Add terminal "/".
    $this->rootLength = Unicode::strlen(DRUPAL_ROOT) + 1;
  }

  /**
   * Build the top part of the page, about the request.
   *
   * @param string $unique_id
   *   The unique request id.
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array
   *   A render array for a table.
   */
  public function buildTrackRequest($unique_id, array $events) {
    if ($events) {
      $row = array_slice($events, 0, 1);
      /** @var \Drupal\mongodb_watchdog\Event $first */
      list($template, $first) = reset($row);

The assignment to $template is unused. Consider omitting it like so list($first,,$third).

Unused variable $template.

      $location = $first->location;
      $timestamp = isset($first->timestamp)
        ? $this->dateFormatter->format($first->timestamp, 'long')
        : t('No information');
    }
    else {
      $location = $timestamp = t('No information');
    }

    $rows = [
      [t('Request ID'), $unique_id],
      [t('Location'), $location],
      [t('Date/time'), $timestamp],
    ];

    foreach ($rows as &$row) {
      $row[0] = [
        'data' => $row[0],
        'header' => TRUE,
      ];
    }

    $ret = [
      '#type' => 'table',
      '#rows' => $rows,
    ];
    return $ret;
  }

  /**
   * Build the bottom part of the page, about the events during the request.
   *
   * @param array<\Drupal\mongodb_watchdog\EventTemplate\Drupal\mongodb_watchdog\Event[]> $events
   *   A fully loaded array of events and their templates.
   *
   * @return array
   *   A render array for a table.
   */
  public function buildTrackRows(array $events) {
    $header = [
      t('Sequence'),
      t('Type'),
      t('Severity'),
      t('Event'),
      t('File'),
      t('Line'),
    ];
    $rows = [];
    $levels = RfcLogLevel::getLevels();

    /** @var \Drupal\mongodb_watchdog\EventTemplate $template */
    /** @var \Drupal\mongodb_watchdog\Event $event */
    foreach ($events as list($template, $event)) {
      $row = [
        ['data' => $event->requestTracking_sequence],
        $template->type,
        [
          'data' => $levels[$template->severity],
          'class' => OverviewController::SEVERITY_CLASSES[$template->severity],
        ],
        [
          'data' => Link::createFromRoute($template->asString($event->variables), 'mongodb_watchdog.reports.detail', [
            'event_template' => $template->_id,
          ]),
        ],
        $this->simplifyPath($event->variables['%file']),
        $event->variables['%line'],
      ];
      $rows[] = $row;
    }

    $ret = [
      '#type' => 'table',
      '#rows' => $rows,
      '#header' => $header,
    ];
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

This method seems to be duplicated in your project.

    /** @var \Drupal\mongodb_watchdog\Logger $watchdog */
    $watchdog = $container->get('mongodb.logger');

    /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
    $date_formatter = $container->get('date.formatter');

    /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
    $config_factory = $container->get('config.factory');
    $items_per_page = $config_factory->get('mongodb_watchdog.settings')->get('items_per_page');
    return new static($watchdog, $date_formatter, $items_per_page);
  }

  /**
   * Set up the templates pager.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param int $uniqueId
   *   The uniqueId of the current request.
   *
   * @return int
   *   The number of the page to display, starting at 0.
   */
  public function setupPager(Request $request, $uniqueId) {

This method seems to be duplicated in your project.

    $count = $this->watchdog->requestEventsCount($uniqueId);
    $height = $this->itemsPerPage;
    pager_default_initialize($count, $height);

    $page = intval($request->query->get('page'));
    if ($page < 0) {
      $page = 0;
    }
    else {
      $page_max = intval(min(ceil($count / $height), PHP_INT_MAX) - 1);
      if ($page > $page_max) {
        $page = $page_max;
      }
    }

    return $page;
  }

  /**
   * Convert an absolute path to a relative one if below the site root.
   *
   * @param string $path
   *   An absolute path on the filesystem.
   *
   * @return string
   *   A relative path if possible, otherwise the input path.
   */
  public function simplifyPath($path) {
    $ret = (Unicode::strpos($path, DRUPAL_ROOT) === 0)
      ? Unicode::substr($path, $this->rootLength)
      : $path;
    return $ret;
  }

  /**
   * Controller.
   *
   * @param string $uniqueId
   *   The unique request id from mod_unique_id. Unsafe.
   *
   * @return array

Consider making the return type a bit more specific; maybe use array<string,string|array>.

   *   A render array.
   */
  public function track(Request $request, $uniqueId) {
    if (!preg_match('/[\w-]+/', $uniqueId)) {
      return ['#markup' => ''];
    }

    $page = $this->setupPager($request, $uniqueId);
    $skip = $page * $this->itemsPerPage;
    $height = $this->itemsPerPage;

    $events = $this->watchdog->requestEvents($uniqueId, $skip, $height);
    $ret = [
      '#attached' => [
        'library' => ['mongodb_watchdog/styling'],
      ],
      'request' => $this->buildTrackRequest($uniqueId, $events),
      'events' => $this->buildTrackRows($events),
      'pager' => [
        '#type' => 'pager',
      ],
    ];
    return $ret;
  }

}