WebProfiler debugging integration

.travis.yml

@@ -52,7 +52,10 @@ before_script:
 
   # Reference and enable rules in build site.
   - ln -s $TESTDIR modules/rules
+  - drush --yes dl webprofiler
   - drush --yes pm-enable simpletest rules
+  - drush cr
+  - drush --yes pm-enable webprofiler
 
   # Start a web server on port 8080, run in the background; wait for
   # initialization. This is temporarly disabled since there are no web tests

config/install/rules.settings.yml

@@ -1,4 +1,3 @@
 log_errors: warning
 debug_log: false
-debug: false
 log_level: info

config/schema/rules.schema.yml

@@ -125,14 +125,11 @@ rules.settings:
   label: 'Rules settings'
   mapping:
     log_errors:
-      type: integer
+      type: string
       label: 'Logging of Rules evaluation errors'
     debug_log:
       type: boolean
       label: 'Log debug information to the available loggers'
-    debug:
-      type: boolean
-      label: 'Show debug information'
     log_level:
-      type: integer
+      type: string
       label: 'Log level'

rules.info.yml

@@ -3,3 +3,5 @@ type: module
 description: 'React on events and conditionally evaluate actions.'
 package: Rules
 core: 8.x
+test_dependencies:
+  - webprofiler

src/Logger/RulesLoggerChannel.php

@@ -25,13 +25,6 @@ class RulesLoggerChannel extends LoggerChannel {
    */
   protected $config;
 
-  /**
-   * Static storage of log entries.
-   *
-   * @var array
-   */
-  protected $logs = [];
-
   /**
    * Creates RulesLoggerChannel object.
    *
@@ -47,12 +40,6 @@ public function __construct(ConfigFactoryInterface $config_factory) {
    * {@inheritdoc}
    */
   public function log($level, $message, array $context = []) {
-    $this->logs[] = [
-      'level' => $level,
-      'message' => $message,
-      'context' => $context,
-    ];
-
     // Log message only if rules logging setting is enabled.
     if ($this->config->get('debug_log')) {
       if ($this->levelTranslation[$this->config->get('log_errors')] >= $this->levelTranslation[$level]) {
@@ -61,21 +48,4 @@ public function log($level, $message, array $context = []) {
     }
   }
 
-  /**
-   * Returns the structured array of entries.
-   *
-   * @return array
-   *   Array of stored log entries.
-   */
-  public function getLogs() {
-    return $this->logs;
-  }
-
-  /**
-   * Clears the static logs entries cache.
-   */
-  public function clearLogs() {
-    $this->logs = [];
-  }
-
 }

src/Logger/RulesStubLogger.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\rules\Logger\RulesStubLogger.
+ */
+
+namespace Drupal\rules\Logger;
+
+use Drupal\Core\Logger\RfcLoggerTrait;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Logs events into the memory with ability check it afterwards.
+ */
+class RulesStubLogger implements LoggerInterface {
+  use RfcLoggerTrait;
+
+  /**
+   * The database connection object.
+   *
+   * @var array
+   */
+  protected $logs;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function log($level, $message, array $context = array()) {
+    $this->logs[] = [
+      'level' => $level,
+      'message' => $message,
+      'context' => $context,
+    ];
+  }
+
+  /**
+   * Clears static logs storage.
+   */
+  public function cleanLogs() {
+    $this->logs = array();
+  }
+
+  /**
+   * Returns statically saved logs.
+   *
+   * @return array
+   *   Array of logs.
+   */
+  public function getLogs() {
+    return $this->logs;
+  }
+
+}

src/RulesServiceProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\rules\RulesServiceProvider.
+ */
+
+namespace Drupal\rules;
+
+use Drupal\Core\Config\BootstrapConfigStorageFactory;
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\Core\DependencyInjection\ServiceProviderBase;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Defines a service profiler for the WebProfiler module.
+ */
+class RulesServiceProvider extends ServiceProviderBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function register(ContainerBuilder $container) {
+    if (FALSE !== $container->hasDefinition('logger.channel.rules') && $container->hasDefinition('webprofiler.drupal')) {
+      $container->register('webprofiler.rules', 'Drupal\rules\WebProfiler\DataCollector\RulesDataCollector')
+        ->addArgument(new Reference('logger.channel.rules'))
+        ->addTag('data_collector', array(
+          'template' => '@rules/Collector/rules.html.twig',
+          'id' => 'rules',
+          'title' => 'Rules',
+          'priority' => 200,
+        ));
+      // Replace the regular logger.channel.rules service with a traceable one.
+      $definition = $container->findDefinition('logger.channel.rules');
+      $definition->setClass('Drupal\rules\WebProfiler\RulesChannelLoggerWrapper');
+    }
+  }
+
+}

src/Tests/ConfigEntityTest.php

@@ -89,7 +89,6 @@ public function testConfigRule() {
     // Create the Rules expression object from the configuration.
     $expression = $loaded_entity->getExpression();
     $expression->execute();
-
     // Test that the action logged something.
     $this->assertRulesLogEntryExists('action called');
   }

src/Tests/RulesDrupalTestBase.php

@@ -7,6 +7,7 @@
 
 namespace Drupal\rules\Tests;
 
+use Drupal\rules\Logger\RulesStubLogger;
 use Drupal\simpletest\KernelTestBase;
 
 /**
@@ -35,14 +36,6 @@ abstract class RulesDrupalTestBase extends KernelTestBase {
    */
   protected $typedDataManager;
 
-
-  /**
-   * Rules logger.
-   *
-   * @var \Drupal\rules\Logger\RulesLoggerChannel
-   */
-  protected $logger;
-
   /**
    * Modules to enable.
    *
@@ -56,10 +49,15 @@ abstract class RulesDrupalTestBase extends KernelTestBase {
   public function setUp() {
     parent::setUp();
 
-    $this->logger = $this->container->get('logger.channel.rules');
-    // Clear the log from any stale entries that are bleeding over from previous
-    // tests.
-    $this->logger->clearLogs();
+    // Prepare Rules logging for testing.
+    $this->installConfig(array('rules'));
+    $logger = new RulesStubLogger();
+    $this->container->get('config.factory')
+      ->getEditable('rules.settings')
+      ->set('debug_log', 1)
+      ->save();
+    $this->container->set('logger', $logger);
+    $this->container->get('logger')->cleanLogs();
 
     $this->expressionManager = $this->container->get('plugin.manager.rules_expression');
     $this->conditionManager = $this->container->get('plugin.manager.condition');
@@ -92,7 +90,7 @@ protected function createCondition($id) {
    */
   protected function assertRulesLogEntryExists($message, $log_item_index = 0) {
     // Test that the action has logged something.
-    $logs = $this->logger->getLogs();
+    $logs = $this->container->get('logger')->getLogs();
     $this->assertEqual($logs[$log_item_index]['message'], $message);
   }
 

src/Tests/RulesDrupalWebTestBase.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\rules\Tests\RulesDrupalWebTestBase
+ */
+
+namespace Drupal\rules\Tests;
+
+use Drupal\simpletest\WebTestBase;
+
+/**
+ * Rules base web test.
+ *
+ * @group rules
+ */
+abstract class RulesDrupalWebTestBase extends WebTestBase {
+
+  /**
+   * Modules to install.
+   *
+   * @var array
+   */
+  public static $modules = ['rules'];
+
+  /**
+   * Authenticated user.
+   *
+   * @var \Drupal\user\Entity\User
+   */
+  protected $user;
+
+  /**
+   * User with administer rules permissions.
+   *
+   * @var \Drupal\user\Entity\User
+   */
+  protected $adminUser;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $permissions = array('create page content', 'administer rules');
+    $this->user = $this->drupalCreateUser();
+    // @todo uncomment it when patch with permission comes.
+    // $this->adminUser = $this->drupalCreateUser($permissions);
+  }
+
+}

src/Tests/RulesEngineTest.php

@@ -79,7 +79,6 @@ public function testContextPassing() {
     $rule->addAction('rules_test_log');
     $rule->setContextValue('test', 'test value');
     $rule->execute();
-
     // Test that the action logged something.
     $this->assertRulesLogEntryExists('action called');
   }
@@ -99,7 +98,6 @@ public function testProvidedVariables() {
 
     $rule->addAction('rules_test_log');
     $rule->execute();
-
     // Test that the action logged something.
     $this->assertRulesLogEntryExists('action called');
   }

src/Tests/RulesWebProfilerTest.php

@@ -0,0 +1,76 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\rules\Tests\RulesWebProfilerTest
+ */
+
+namespace Drupal\rules\Tests;
+
+/**
+ * Class RulesWebProfilerTest
+ *
+ * Tests integration Rules logging with WebProfiler module.
+ *
+ * @group rules
+ */
+class RulesWebProfilerTest extends RulesDrupalWebTestBase {
+
+  /**
+   * Authenticated user with access to WebProfiler.
+   *
+   * @var \Drupal\user\Entity\User
+   */
+  protected $webProfilerUser;
+
+  public static $modules = ['rules', 'webprofiler', 'block'];
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp() {
+    parent::setup();
+
+    // Enable rules logging.
+    $this->container->get('config.factory')
+      ->getEditable('rules.settings')
+      ->set('debug_log', 1)
+      ->set('log_errors', 'debug')
+      ->save();
+
+    $this->webProfilerUser = $this->drupalCreateUser(array(
+      'access webprofiler',
+      'view webprofiler toolbar',
+    ));
+
+    // Enables rules web debugging with WebProfiler.
+    $this->container->get('config.factory')
+      ->getEditable('webprofiler.config')
+      ->set('active_toolbar_items.rules', 'rules')
+      ->save();
+
+    $this->drupalLogin($this->webProfilerUser);
+  }
+
+  /**
+   * Goes to WebProfiler page using link from toolbar and check entries there.
+   */
+  public function testWebProfilerPage() {
+    $this->drupalGet('404', [
+      'query' => [
+        'log' => '1',
+        'log-level' => 'critical',
+        'log-message' => 'critical message',
+        'log-amount' => 5,
+      ],
+    ]);
+
+    $this->drupalGet('admin/reports/profiler/list');
+    $links = $this->xpath('//main//table[1]//a');
+    $url = $this->getAbsoluteUrl($links[0]['href']);
+    $this->drupalGet($url);
+    $this->assertText('Rules logs', 'Rules logs table exists');
+    $this->assertText('critical message', 'Rules log entry exists');
+  }
+
+}