feature(Sentry): add more data (user locale, request + transaction id)

also fix some Log/Formatter phpstan issues
tine20 · Sep 6, 2021 · 57ef516 · 57ef516
1 parent 2d4ee90
commit 57ef516
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 36 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -9879,26 +9879,6 @@ parameters:
 			count: 1
 			path: tine20/Tinebase/Log.php
 
-		-
-			message: "#^Method Tinebase_Log_Formatter\\:\\:reset\\(\\) should return string but return statement is missing\\.$#"
-			count: 1
-			path: tine20/Tinebase/Log/Formatter.php
-
-		-
-			message: "#^Method Tinebase_Log_Formatter\\:\\:resetUsername\\(\\) should return string but return statement is missing\\.$#"
-			count: 1
-			path: tine20/Tinebase/Log/Formatter.php
-
-		-
-			message: "#^PHPDoc tag @param has invalid value \\(\\$logPrio\\)\\: Unexpected token \"\\$logPrio\", expected type at offset 18$#"
-			count: 1
-			path: tine20/Tinebase/Log/Formatter.php
-
-		-
-			message: "#^PHPDoc tag @param has invalid value \\(\\$output\\)\\: Unexpected token \"\\$output\", expected type at offset 18$#"
-			count: 1
-			path: tine20/Tinebase/Log/Formatter.php
-
 		-
 			message: "#^Access to an undefined property Zend_Mail_Message\\:\\:\\$contentType\\.$#"
 			count: 1

diff --git a/tine20/Tinebase/Controller.php b/tine20/Tinebase/Controller.php
@@ -366,6 +366,7 @@ public function initUser(Tinebase_Model_FullUser $_user, $fixCookieHeader = true
                     'id' => $_user->getId(),
                     'email' => $_user->accountEmailAddress,
                     'login' => $_user->accountLoginName,
+                    'locale' => Tinebase_Core::getLocale()->toString(),
                 ]);
             });
         }

diff --git a/tine20/Tinebase/Core.php b/tine20/Tinebase/Core.php
@@ -251,16 +251,18 @@ public static function dispatchRequest()
         $request = self::getRequest();
 
         // we need to initialize sentry at the very beginning to catch ALL errors
-        $ravenClient = self::setupSentry();
+        self::setupSentry();
 
         // check transaction header
         if ($request->getHeaders()->has('X-TINE20-TRANSACTIONID')) {
             $transactionId = $request->getHeaders()->get('X-TINE20-TRANSACTIONID')->getFieldValue();
             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
                 . " Client transaction $transactionId");
             Tinebase_Log_Formatter::setTransactionId(substr($transactionId, 0, 5));
-            if ($ravenClient) {
-                $ravenClient->tags['transaction_id'] = $transactionId;
+            if (Tinebase_Core::isRegistered('SENTRY')) {
+                Sentry\configureScope(function (\Sentry\State\Scope $scope) use ($transactionId): void {
+                    $scope->setContext('transaction_id', $transactionId);
+                });
             }
         }
 
@@ -2435,7 +2437,7 @@ public static function setupSentry()
             'tags' => array(
                 'php_version' => phpversion(),
                 'tine_url' => Tinebase_Config::getInstance()->get(Tinebase_Config::TINE20_URL) ?: 'unknown',
-                // TODO add more tags?
+                'request_id' => Tinebase_Log_Formatter::getRequestId(),
             ),
         ]);
         self::set('SENTRY', true);

diff --git a/tine20/Tinebase/Log/Formatter.php b/tine20/Tinebase/Log/Formatter.php
@@ -115,7 +115,7 @@ public function __construct($format = null)
         parent::__construct($format);
 
         if (!self::$_requestId || self::$_requestId === '-') {
-            self::$_requestId = Tinebase_Record_Abstract::generateUID($this->_requestIdLength);
+            $this->setRequestId();
         }
 
         if (self::$_starttime === NULL) {
@@ -142,6 +142,17 @@ public function __construct($format = null)
             }
         }
     }
+
+    /**
+     * @param string|null $requestId
+     */
+    public function setRequestId(string $requestId = null)
+    {
+        if (! $requestId) {
+            $requestId = Tinebase_Record_Abstract::generateUID($this->_requestIdLength);
+        }
+        self::$_requestId = $requestId;
+    }
 
     /**
      * add strings to replace in log output (passwords for example)
@@ -219,11 +230,11 @@ protected function _getLogDiffTime($format = true)
     }
 
     /**
-     * @param $output
+     * @param string $output
      * @param array $event
      * @return string
      */
-    protected function _getFormattedOutput($output, array $event)
+    protected function _getFormattedOutput(string $output, array $event): string
     {
         if (self::$_colorize) {
             $color = $this->_getColorByPrio($event['priority']);
@@ -234,10 +245,10 @@ protected function _getFormattedOutput($output, array $event)
     }
 
     /**
-     * @param $logPrio
+     * @param integer $logPrio
      * @return string
      */
-    protected function _getColorByPrio($logPrio)
+    protected function _getColorByPrio($logPrio): string
     {
         switch ($logPrio) {
             case 0:
@@ -277,9 +288,7 @@ public static function getUsername()
         if (self::$_username === NULL) {
             $user = Tinebase_Core::getUser();
             self::$_username = ($user && is_object($user))
-                ? (isset($user->accountLoginName)
-                    ? $user->accountLoginName
-                    : (isset($user->accountDisplayName) ? $user->accountDisplayName : NULL)) 
+                ? ($user->accountLoginName ?? ($user->accountDisplayName ?? NULL))
                 : NULL;
         }
 
@@ -295,8 +304,6 @@ public static function getUsername()
 
     /**
      * reset current username
-     *
-     * @return string
      */
     public static function resetUsername()
     {
@@ -305,8 +312,6 @@ public static function resetUsername()
 
     /**
      * reset username and options
-     *
-     * @return string
      */
     public static function reset()
     {