Add rules logger channel and get rid of custom logger and debugger

Author: Artyom Miroshnik

config/install/rules.settings.yml

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

config/schema/rules.schema.yml

@@ -118,4 +118,21 @@ rules.context.definition:
       label: 'Type'
     label:
       type: string
-      label: 'Label'
+      label: 'Label'
+
+rules.settings:
+  type: config_object
+  label: 'Rules settings'
+  mapping:
+    log_errors:
+      type: integer
+      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
+      label: 'Log level'

rules.services.yml

@@ -5,3 +5,6 @@ services:
   plugin.manager.rules_data_processor:
     class: Drupal\rules\Context\DataProcessorManager
     arguments: ['@container.namespaces', '@module_handler']
+  logger.channel.rules:
+    class: Drupal\rules\Logger\RulesLoggerChannel
+    arguments: ['@config.factory']

src/Engine/RulesLog.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\rules\Logger\RulesLoggerChannel.
+ */
+
+namespace Drupal\rules\Logger;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Config\ImmutableConfig;
+use Drupal\Core\Logger\LoggerChannel;
+use Psr\Log\LoggerTrait;
+
+/**
+ * Logs rules log entries in the available loggers.
+ */
+class RulesLoggerChannel extends LoggerChannel {
+  use LoggerTrait;
+
+  /**
+   * A configuration object with rules settings.
+   *
+   * @var ImmutableConfig
+   */
+  protected $config;
+
+  /**
+   * Static storage of log entries.
+   *
+   * @var array
+   */
+  protected $logs = [];
+
+  /**
+   * Creates RulesLoggerChannel object.
+   *
+   * @param ConfigFactoryInterface $config_factory
+   *   Config factory instance.
+   */
+  public function __construct(ConfigFactoryInterface $config_factory) {
+    parent::__construct('rules');
+    $this->config = $config_factory->get('rules.settings');
+  }
+
+  /**
+   * {@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]) {
+        parent::log($level, $message, $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/RulesLoggerChannel.php

@@ -7,8 +7,6 @@
 
 namespace Drupal\rules\Tests;
 
-use Drupal\rules\Engine\RulesLog;
-
 /**
  * Tests storage and loading of Rules config entities.
  *
@@ -30,11 +28,6 @@ public function setUp() {
     parent::setUp();
 
     $this->storage = $this->container->get('entity.manager')->getStorage('rules_component');
-
-    // Clear the log from any stale entries that are bleeding over from previous
-    // tests.
-    $logger = RulesLog::logger();
-    $logger->clear();
   }
 
   /**
@@ -72,8 +65,7 @@ public function testConfigAction() {
     $expression->execute();
 
     // Test that the action logged something.
-    $log = RulesLog::logger()->get();
-    $this->assertEqual($log[0][0], 'action called');
+    $this->assertRulesLogEntryExists('action called');
   }
 
   /**
@@ -99,8 +91,7 @@ public function testConfigRule() {
     $expression->execute();
 
     // Test that the action logged something.
-    $log = RulesLog::logger()->get();
-    $this->assertEqual($log[0][0], 'action called');
+    $this->assertRulesLogEntryExists('action called');
   }
 
   /**

src/Tests/ConfigEntityTest.php

@@ -30,11 +30,6 @@ class NodeIntegrationTest extends RulesDrupalTestBase {
   public function setUp() {
     parent::setUp();
 
-    // Clear the log from any stale entries that are bleeding over from previous
-    // tests.
-    $logger = RulesLog::logger();
-    $logger->clear();
-
     $this->installSchema('system', ['sequences']);
     $this->installEntitySchema('user');
     $this->installEntitySchema('node');
@@ -85,10 +80,6 @@ public function testNodeDataSelector() {
     $rule->addAction('rules_test_log');
     $rule->setContextValue('node', $node);
     $rule->execute();
-
-    // Test that the action logged something.
-    $log = RulesLog::logger()->get();
-    $this->assertEqual($log[0][0], 'action called');
   }
 
   /**

src/Tests/NodeIntegrationTest.php

@@ -35,6 +35,14 @@ abstract class RulesDrupalTestBase extends KernelTestBase {
    */
   protected $typedDataManager;
 
+
+  /**
+   * Rules logger.
+   *
+   * @var \Drupal\rules\Logger\RulesLoggerChannel
+   */
+  protected $logger;
+
   /**
    * Modules to enable.
    *
@@ -47,6 +55,12 @@ 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();
+
     $this->expressionManager = $this->container->get('plugin.manager.rules_expression');
     $this->conditionManager = $this->container->get('plugin.manager.condition');
     $this->typedDataManager = $this->container->get('typed_data_manager');
@@ -68,4 +82,18 @@ protected function createCondition($id) {
     return $condition;
   }
 
+  /**
+   * Checks if particular message is in the log with given delta.
+   *
+   * @param string $message
+   *   Log message.
+   * @param int $log_item_index
+   *   Log item's index in log entries stack.
+   */
+  protected function assertRulesLogEntryExists($message, $log_item_index = 0) {
+    // Test that the action has logged something.
+    $logs = $this->logger->getLogs();
+    $this->assertEqual($logs[$log_item_index]['message'], $message);
+  }
+
 }