Stop using Timer class due to memory leaks. Log and SpanMeta now use Timekeeper directly

Author: enobrev

src/Log.php

@@ -468,20 +468,23 @@ public static function dt(TimeKeeper $oTimer, array $aContext = []): void {
         }
 
         /**
-         * @param string $sLabel
-         * @return TimeKeeper
+         * @param TimeKeeper $oTimer
+         * @param array      $aContext
          */
-        public static function startTimer(string $sLabel): TimeKeeper {
-            return self::$aSpanMetas[self::getCurrentRequestHash()]->Timer->start($sLabel);
+        public static function et(TimeKeeper $oTimer, array $aContext = []): void {
+            $aContext['--ms'] = $oTimer->stop();
+
+            self::e($oTimer->label(), $aContext);
         }
 
         /**
          * @param string $sLabel
-         *
-         * @return float|null
+         * @return TimeKeeper
          */
-        public static function stopTimer(string $sLabel): ?float {
-            return self::$aSpanMetas[self::getCurrentRequestHash()]->Timer->stop($sLabel);
+        public static function startTimer(string $sLabel): TimeKeeper {
+            $oTimer = new TimeKeeper($sLabel);
+            $oTimer->start();
+            return $oTimer;
         }
 
         /**
@@ -514,7 +517,6 @@ public static function startChildRequest(?string $sThreadHash = null, ?string $s
          * Retrieves the previous request hash
          */
         public static function endChildRequest(): void {
-            self::stopTimer('_REQUEST');
             self::summary();
             array_pop(self::$aSpans);
         }
@@ -683,7 +685,7 @@ public static function initSpan(ServerRequestInterface $oRequest, array $aUser =
                 '--r'      => $sRequestHash
             ];
 
-            self::$aSpanMetas[$sRequestHash] = new SpanMeta($oStartTime, self::$bMetrics ? SpanMeta::METRICS_ON : SpanMeta::METRICS_OFF);
+            self::$aSpanMetas[$sRequestHash] = new SpanMeta($oStartTime);
 
             if ($sThreadHash = $sIncomingThreadHash ?? self::getThreadHash()) {
                 $aSpan['--t'] = $sThreadHash;
@@ -710,8 +712,6 @@ public static function initSpan(ServerRequestInterface $oRequest, array $aUser =
             }
 
             self::$aSpans[] = $aSpan;
-
-            self::startTimer('_REQUEST');
         }
 
         /**
@@ -720,12 +720,11 @@ public static function initSpan(ServerRequestInterface $oRequest, array $aUser =
          */
         public static function summary(string $sOverrideName = 'Summary'): void {
             self::incrementCurrentIndex();
-            $iTimer   = self::stopTimer('_REQUEST');
             $aMessage = array_merge(
                 self::prepareContext(
                     self::$sService . '.' . $sOverrideName,
                     [
-                        '--ms'      => $iTimer,
+                        '--ms'      => self::$aSpanMetas[self::getCurrentRequestHash()]->Timer->stop(),
                         '--summary' => true,
                         '--span'    => self::$aSpanMetas[self::getCurrentRequestHash()]->getMessage(self::$sService),
                     ],

src/SpanMeta.php

@@ -1,38 +1,32 @@
 <?php
-
-
     namespace Enobrev;
 
     use DateTime;
     use Adbar\Dot;
 
     class SpanMeta {
-        public const METRICS_ON  = 'metrics-on';
-        public const METRICS_OFF = 'metrics-off';
-
         private const TIMESTAMP_FORMAT = DATE_RFC3339_EXTENDED;
 
-        // const VERSION = 1: included tags, which were not used
-        private const VERSION = 2;
+//      private const VERSION = 1: included tags, which were not used
+//      private const VERSION = 2; included metrics and a memory-leaking timer
+        private const VERSION = 3;
 
         private string $sName = '';
 
-        private bool $bMetrics;
-
         private DateTime $oStart;
 
         private bool $bError;
 
         public Dot $Context;
 
-        public Timer $Timer;
+        public TimeKeeper $Timer;
 
-        public function __construct(DateTime $oStart, $sMetrics = self::METRICS_OFF) {
-            $this->bMetrics = $sMetrics === self::METRICS_ON;
+        public function __construct(DateTime $oStart) {
             $this->oStart   = $oStart;
             $this->bError   = false;
             $this->Context  = new Dot();
-            $this->Timer    = new Timer();
+            $this->Timer    = new TimeKeeper('_REQUEST');
+            $this->Timer->start();
         }
 
         public function getName():string {
@@ -60,8 +54,7 @@ public function getMessage(string $sService): array {
                 'start_timestamp' => $this->oStart->format(self::TIMESTAMP_FORMAT),
                 'end_timestamp'   => notNowButRightNow()->format(self::TIMESTAMP_FORMAT),
                 'error'           => $this->bError,
-                'context'         => $this->Context->all(),
-                'metrics'         => $this->bMetrics ? json_encode($this->Timer->stats()) : null
+                'context'         => $this->Context->all()
             ];
         }
     }

src/Timer.php

@@ -1,6 +1,9 @@
 <?php
     namespace Enobrev;
 
+    /**
+     * @deprecated for causing memory leaks
+     */
     class Timer {
         /**
          * @var TimeKeeper[][]
@@ -49,51 +52,26 @@ public function stats($bReturnTimers = false): array {
             return $aReturn;
         }
 
-        /**
-         * @param string $sLabel
-         * @return TimeKeeper|null
-         */
-        public function &get(string $sLabel): ?TimeKeeper {
-            if (!isset($this->aTimers[$sLabel])) {
-                return $this->start($sLabel);
-            }
-
-            $oTimer  = null;
-            $iTimers = count($this->aTimers[$sLabel]);
-            if ($iTimers > 0) {
-                $oTimer = &$this->aTimers[$sLabel][$iTimers - 1];
-            }
-
-            return $oTimer;
-        }
-
         /**
          * @param string $sLabel
          * @return TimeKeeper
          */
         public function &start(string $sLabel): TimeKeeper {
-            if (!isset($this->aTimers[$sLabel])) {
-                $this->aTimers[$sLabel] = [];
-            }
+            $this->aTimers[$sLabel] = new TimeKeeper($sLabel);
+            $this->aTimers[$sLabel]->start();
 
-            $oTimer = new TimeKeeper($sLabel);
-            $oTimer->start();
-
-            $this->aTimers[$sLabel][] = &$oTimer;
-
-            return $oTimer;
+            return $this->aTimers[$sLabel];
         }
 
         /**
          * @param string $sLabel
          * @return float|null
          */
         public function stop(string $sLabel): ?float {
-            $oTimeKeeper = &$this->get($sLabel);
-            if ($oTimeKeeper) {
-                return $oTimeKeeper->stop();
+            if (!isset($this->aTimers[$sLabel])) {
+                return null;
             }
 
-            return null;
+            return $this->aTimers[$sLabel]->stop();
         }
     }