Merge pull request #1577 from tripal/tv4g0-issue1576-TripalLogger

Tripal 4 tripal logger string substitution not done in some cases
tripal · Jul 18, 2023 · 2647edb · 2647edb
2 parents 5170c01 + 7d62356
commit 2647edb
Showing 1 changed file with 29 additions and 15 deletions.
diff --git a/tripal/src/Services/TripalLogger.php b/tripal/src/Services/TripalLogger.php
@@ -143,15 +143,15 @@ protected function log2Server($message, $context, $options) {
    */
   protected function log2Message($level, $message, $context = []) {
 
-    if (in_array($level, ['info', 'notice'])) {
-      $status = \Drupal\Core\Messenger\MessengerInterface::TYPE_STATUS;
-    }
-    else if (in_array($level, ['critical', 'error', 'emergency'])) {
+    if (in_array($level, ['emergency', 'alert', 'critical', 'error'])) {
       $status = \Drupal\Core\Messenger\MessengerInterface::TYPE_ERROR;
     }
-    else if (in_array($level, ['alert', 'warning'])) {
+    else if (in_array($level, ['warning'])) {
       $status = \Drupal\Core\Messenger\MessengerInterface::TYPE_WARNING;
     }
+    else if (in_array($level, ['notice', 'info', 'debug'])) {
+      $status = \Drupal\Core\Messenger\MessengerInterface::TYPE_STATUS;
+    }
     else {
       // Any other type of status we just won't handle.
       return;
@@ -216,7 +216,8 @@ public function notice($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->notice($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->notice($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -253,7 +254,8 @@ public function info($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->info($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->info($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -299,7 +301,8 @@ public function error($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->error($message);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->error($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -347,7 +350,8 @@ public function warning($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->warning($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->warning($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -395,7 +399,8 @@ public function emergency($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->emergency($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->emergency($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -443,7 +448,8 @@ public function alert($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->alert($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->alert($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -491,7 +497,8 @@ public function critical($message, $context = [], $options=[]) {
     $this->log2Job($message, $context);
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->critical($message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->critical($message_str);
     }
 
     if (isset($options['drupal_set_message'])) {
@@ -538,8 +545,11 @@ public function critical($message, $context = [], $options=[]) {
   public function debug($message, $context = [], $options=[]) {
     if ($this->isSuppressed()) return;
 
+    // If we are not set to return debugging information and the severity level
+    // is debug then don't report the error.
     // Get the backtrace and include in the error message, but only if the
     // TRIPAL_DEBUG environment variable is set.
+    // (In Tripal 3 this was added to all levels)
     if (getenv('TRIPAL_DEBUG') == 1) {
       $backtrace = debug_backtrace();
       $message .= "\nBacktrace:\n";
@@ -548,9 +558,11 @@ public function debug($message, $context = [], $options=[]) {
         $function = $backtrace[$i];
         $message .= "  $i) " . $function['function'] . "\n";
       }
+
       $this->log2job('DEBUG: ' . $message, $context);
       if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-        $this->logger->debug($message, $context);
+        $message_str = $this->messageString($message, $context);
+        $this->logger->debug($message_str);
       }
 
       $this->log2Server('DEBUG: ' . $message, $context, $options);
@@ -595,15 +607,17 @@ public function debug($message, $context = [], $options=[]) {
   public function log($level, $message, $context = [], $options=[]) {
     if ($this->isSuppressed()) return;
 
-    if ($level != 'INFO' and $level != 'NOTICE') {
+    $level = strtolower($level);
+    if ($level != 'info' and $level != 'notice') {
       $this->log2Job(ucwords($level) . ': ' . $message, $context);
     }
     else {
       $this->log2Job($message, $context);
     }
 
     if (!array_key_exists('logger', $options) or $options['logger'] !== FALSE) {
-      $this->logger->log($level, $message, $context);
+      $message_str = $this->messageString($message, $context);
+      $this->logger->log($level, $message_str);
     }
 
     if (isset($options['drupal_set_message'])) {