Release v3.29.0

Author: imjoehaines

CHANGELOG.md

@@ -1,6 +1,19 @@
 Changelog
 =========
 
+## 3.29.0 (2022-10-19)
+
+### Enhancements
+
+* The maximum number of breadcrumbs can now be configured between 0-100 (inclusive)
+  [#652](https://github.com/bugsnag/bugsnag-php/pull/652)
+
+* Raised the default maximum number of breadcrumbs to 50
+  [#652](https://github.com/bugsnag/bugsnag-php/pull/652)
+
+* Add a `Report::getFeatureFlags` method to allow accessing feature flags in callbacks
+  [#653](https://github.com/bugsnag/bugsnag-php/pull/653)
+
 ## 3.28.0 (2022-05-18)
 
 ### Enhancements

src/Breadcrumbs/Recorder.php

@@ -15,72 +15,88 @@ class Recorder implements Countable, Iterator
      *
      * @var int
      */
-    const MAX_ITEMS = 25;
+    private $maxBreadcrumbs = 50;
 
     /**
      * The recorded breadcrumbs.
      *
      * @var \Bugsnag\Breadcrumbs\Breadcrumb[]
      */
-    protected $breadcrumbs = [];
+    private $breadcrumbs = [];
 
     /**
-     * The head position.
+     * The iteration position.
      *
      * @var int
      */
-    protected $head = 0;
+    private $position = 0;
 
     /**
-     * The pointer position.
+     * Record a breadcrumb.
      *
-     * @var int
+     * @param \Bugsnag\Breadcrumbs\Breadcrumb $breadcrumb
+     *
+     * @return void
      */
-    protected $pointer = 0;
+    public function record(Breadcrumb $breadcrumb)
+    {
+        $this->breadcrumbs[] = $breadcrumb;
+
+        // drop the oldest breadcrumb if we're over the max
+        if ($this->count() > $this->maxBreadcrumbs) {
+            array_shift($this->breadcrumbs);
+        }
+    }
 
     /**
-     * The iteration position.
+     * Clear all recorded breadcrumbs.
      *
-     * @var int
+     * @return void
      */
-    protected $position = 0;
+    public function clear()
+    {
+        $this->position = 0;
+        $this->breadcrumbs = [];
+    }
 
     /**
-     * Record a breadcrumb.
+     * Set the maximum number of breadcrumbs that are allowed to be stored.
      *
-     * We're recording a maximum of 25 breadcrumbs. Once we've recorded 25, we
-     * start wrapping back around and replacing the earlier ones. In order to
-     * indicate the start of the list, we advance a head pointer.
+     * This must be an integer between 0 and 100 (inclusive).
      *
-     * @param \Bugsnag\Breadcrumbs\Breadcrumb $breadcrumb
+     * @param int $maxBreadcrumbs
      *
      * @return void
      */
-    public function record(Breadcrumb $breadcrumb)
+    public function setMaxBreadcrumbs($maxBreadcrumbs)
     {
-        // advance the head by one if we've caught up
-        if ($this->breadcrumbs && $this->pointer === $this->head) {
-            $this->head = ($this->head + 1) % static::MAX_ITEMS;
+        if (!is_int($maxBreadcrumbs) || $maxBreadcrumbs < 0 || $maxBreadcrumbs > 100) {
+            error_log(
+                'Bugsnag Warning: maxBreadcrumbs should be an integer between 0 and 100 (inclusive)'
+            );
+
+            return;
         }
 
-        // record the new breadcrumb
-        $this->breadcrumbs[$this->pointer] = $breadcrumb;
+        $this->maxBreadcrumbs = $maxBreadcrumbs;
 
-        // advance the pointer so we set the next breadcrumb in the next slot
-        $this->pointer = ($this->pointer + 1) % static::MAX_ITEMS;
+        // drop the oldest breadcrumbs if we're over the max
+        if ($this->count() > $this->maxBreadcrumbs) {
+            $this->breadcrumbs = array_slice(
+                $this->breadcrumbs,
+                $this->count() - $this->maxBreadcrumbs
+            );
+        }
     }
 
     /**
-     * Clear all recorded breadcrumbs.
+     * Get the maximum number of breadcrumbs that are allowed to be stored.
      *
-     * @return void
+     * @return int
      */
-    public function clear()
+    public function getMaxBreadcrumbs()
     {
-        $this->head = 0;
-        $this->pointer = 0;
-        $this->position = 0;
-        $this->breadcrumbs = [];
+        return $this->maxBreadcrumbs;
     }
 
     /**
@@ -102,7 +118,7 @@ public function count()
     #[\ReturnTypeWillChange]
     public function current()
     {
-        return $this->breadcrumbs[($this->head + $this->position) % static::MAX_ITEMS];
+        return $this->breadcrumbs[$this->position];
     }
 
     /**

src/Client.php

@@ -1066,4 +1066,24 @@ public function getRedactedKeys()
     {
         return $this->config->getRedactedKeys();
     }
+
+    /**
+     * @param int $maxBreadcrumbs
+     *
+     * @return $this
+     */
+    public function setMaxBreadcrumbs($maxBreadcrumbs)
+    {
+        $this->recorder->setMaxBreadcrumbs($maxBreadcrumbs);
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMaxBreadcrumbs()
+    {
+        return $this->recorder->getMaxBreadcrumbs();
+    }
 }

src/Configuration.php

@@ -85,7 +85,7 @@ class Configuration implements FeatureDataStore
      */
     protected $notifier = [
         'name' => 'Bugsnag PHP (Official)',
-        'version' => '3.28.0',
+        'version' => '3.29.0',
         'url' => 'https://bugsnag.com',
     ];
 

src/Internal/FeatureFlagDelegate.php

@@ -74,21 +74,12 @@ public function clear()
     }
 
     /**
-     * Convert the list of stored feature flags into the format used by the
-     * Bugsnag Event API.
+     * Get the list of stored feature flags as an array.
      *
-     * For example: [{ "featureFlag": "name", "variant": "variant" }, ...]
-     *
-     * @return array[]
-     * @phpstan-return list<array{featureFlag: string, variant?: string}>
+     * @return \Bugsnag\FeatureFlag[]
      */
     public function toArray()
     {
-        return array_map(
-            function (FeatureFlag $flag) {
-                return $flag->toArray();
-            },
-            $this->storage
-        );
+        return $this->storage;
     }
 }

src/Report.php

@@ -632,6 +632,16 @@ public function clearFeatureFlags()
         $this->featureFlags->clear();
     }
 
+    /**
+     * Get the list of feature flags for this report.
+     *
+     * @return \Bugsnag\FeatureFlag[]
+     */
+    public function getFeatureFlags()
+    {
+        return $this->featureFlags->toArray();
+    }
+
     /**
      * Set the current user.
      *
@@ -763,7 +773,12 @@ public function toArray()
             'metaData' => $this->cleanupObj($this->getMetaData(), true),
             'unhandled' => $this->getUnhandled(),
             'severityReason' => $this->getSeverityReason(),
-            'featureFlags' => $this->featureFlags->toArray(),
+            'featureFlags' => array_map(
+                function (FeatureFlag $flag) {
+                    return $flag->toArray();
+                },
+                $this->featureFlags->toArray()
+            ),
         ];
 
         if ($hash = $this->getGroupingHash()) {