Merge pull request #17 from facade/add-version-support

Add version support
facade · Mar 31, 2021 · b523b8b · b523b8b
2 parents ef0f5bc + a0e4f73
commit b523b8b
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 4 deletions.
diff --git a/src/Flare.php b/src/Flare.php
@@ -47,13 +47,33 @@ class Flare
     /** @var callable|null */
     private $previousErrorHandler;
 
+    /** @var callable|null */
+    private $determineVersionCallable;
+
     public static function register(string $apiKey, string $apiSecret = null, ContextDetectorInterface $contextDetector = null, Container $container = null)
     {
         $client = new Client($apiKey, $apiSecret);
 
         return new static($client, $contextDetector, $container);
     }
 
+    public function determineVersionUsing($determineVersionCallable)
+    {
+        $this->determineVersionCallable = $determineVersionCallable;
+    }
+
+    /**
+     * @return null|string
+     */
+    public function version()
+    {
+        if (! $this->determineVersionCallable) {
+            return null;
+        }
+
+        return ($this->determineVersionCallable)();
+    }
+
     public function __construct(Client $client, ContextDetectorInterface $contextDetector = null, Container $container = null, array $middleware = [])
     {
         $this->client = $client;
@@ -215,7 +235,8 @@ public function createReport(Throwable $throwable): Report
         $report = Report::createForThrowable(
             $throwable,
             $this->contextDetector->detectCurrentContext(),
-            $this->applicationPath
+            $this->applicationPath,
+            $this->version()
         );
 
         return $this->applyMiddlewareToReport($report);

diff --git a/src/Report.php b/src/Report.php
@@ -38,6 +38,9 @@ class Report
     /** @var string */
     private $applicationPath;
 
+    /** @var ?string */
+    private $applicationVersion;
+
     /** @var array */
     private $userProvidedContext = [];
 
@@ -62,16 +65,21 @@ class Report
     /** @var string */
     private $groupBy ;
 
-    public static function createForThrowable(Throwable $throwable, ContextInterface $context, ?string $applicationPath = null): self
-    {
+    public static function createForThrowable(
+        Throwable $throwable,
+        ContextInterface $context,
+        ?string $applicationPath = null,
+        ?string $version = null
+    ): self {
         return (new static())
             ->setApplicationPath($applicationPath)
             ->throwable($throwable)
             ->useContext($context)
             ->exceptionClass(self::getClassForThrowable($throwable))
             ->message($throwable->getMessage())
             ->stackTrace(Stacktrace::createForThrowable($throwable, $applicationPath))
-            ->exceptionContext($throwable);
+            ->exceptionContext($throwable)
+            ->setApplicationVersion($version);
     }
 
     protected static function getClassForThrowable(Throwable $throwable): string
@@ -193,6 +201,18 @@ public function getApplicationPath(): ?string
         return $this->applicationPath;
     }
 
+    public function setApplicationVersion(?string $applicationVersion)
+    {
+        $this->applicationVersion = $applicationVersion;
+
+        return $this;
+    }
+
+    public function getApplicationVersion(): ?string
+    {
+        return $this->applicationVersion;
+    }
+
     public function view(?View $view)
     {
         $this->view = $view;
@@ -273,6 +293,7 @@ public function toArray()
             'message_level' => $this->messageLevel,
             'open_frame_index' => $this->openFrameIndex,
             'application_path' => $this->applicationPath,
+            'application_version' => $this->applicationVersion,
         ];
     }
 }
diff --git a/tests/FlareTest.php b/tests/FlareTest.php
@@ -255,4 +255,36 @@ public function it_can_add_glows()
             ],
         ], $glows);
     }
+
+    /** @test */
+    public function a_version_callable_can_be_set()
+    {
+        $this->assertNull($this->flare->version());
+
+        $this->flare->determineVersionUsing(function () {
+            return '123';
+        });
+
+        $this->assertEquals('123', $this->flare->version());
+    }
+
+    /** @test */
+    public function it_will_add_the_version_to_the_report()
+    {
+        $this->reportException();
+
+        $payload = $this->fakeClient->getLastPayload();
+
+        $this->assertNull($payload['application_version']);
+
+        $this->flare->determineVersionUsing(function () {
+            return '123';
+        });
+
+        $this->reportException();
+
+        $payload = $this->fakeClient->getLastPayload();
+
+        $this->assertEquals('123', $payload['application_version']);
+    }
 }
diff --git a/tests/__snapshots__/FlareTest__it_can_report_an_exception__1.yml b/tests/__snapshots__/FlareTest__it_can_report_an_exception__1.yml
@@ -15,3 +15,4 @@ stage: null
 message_level: null
 open_frame_index: null
 application_path: null
+application_version: null
diff --git a/tests/__snapshots__/ReportTest__it_can_create_a_report__1.yml b/tests/__snapshots__/ReportTest__it_can_create_a_report__1.yml
@@ -15,3 +15,4 @@ stage: null
 message_level: null
 open_frame_index: null
 application_path: null
+application_version: null
diff --git a/tests/__snapshots__/ReportTest__it_can_create_a_report_for_a_string_message__1.yml b/tests/__snapshots__/ReportTest__it_can_create_a_report_for_a_string_message__1.yml
@@ -15,3 +15,4 @@ stage: null
 message_level: null
 open_frame_index: 0
 application_path: null
+application_version: null
diff --git a/tests/__snapshots__/ReportTest__it_can_create_a_report_with_glows__1.yml b/tests/__snapshots__/ReportTest__it_can_create_a_report_with_glows__1.yml
@@ -22,3 +22,4 @@ stage: null
 message_level: null
 open_frame_index: null
 application_path: null
+application_version: null