Merge pull request #7 from BinarCode/slack-reach

Adding more information to slack exceptions.

Author: binaryk

database/migrations/create_laravel_developer_table.php.stub

@@ -14,6 +14,10 @@ class CreateLaravelDeveloperTable extends Migration
            $table->string('name')->nullable();
            $table->text('payload')->nullable();
            $table->text('exception')->nullable();
+           $table->text('previous')->nullable();
+           $table->string('file')->nullable();
+           $table->string('line')->nullable();
+           $table->string('code')->nullable();
 
            $table->bigInteger('created_by')->nullable();
            $table->timestamps();

src/Dtos/DevNotificationDto.php

@@ -10,6 +10,9 @@
  * Class DevNotificationDto
  *
  * @property string message
+ * @property string file
+ * @property string line
+ * @property string code
  *
  * @property string attachment_title
  * @property string attachment_link
@@ -19,6 +22,9 @@
  */
 class DevNotificationDto implements JsonSerializable
 {
+    public $file;
+    public $line;
+    public $code;
     public $message;
 
     public $attachment_title;
@@ -62,6 +68,8 @@ public static function makeFromException(Throwable $t): self
     public function setException(Throwable $t): self
     {
         $this->message = $t->getMessage();
+        $this->code = $t->getCode();
+        $this->file = $t->getFile();
 
         return $this;
     }
@@ -78,9 +86,33 @@ public static function makeFromExceptionLog(ExceptionLog $log): self
         return tap(new static, fn (self $dto) => $dto
             ->setMessage($log->name)
             ->setTitle($log->identifier)
+            ->setLine($log->line)
+            ->setFile($log->file)
+            ->setCode($log->code)
             ->setAttachmentLink($log->getUrl()));
     }
 
+    protected function setLine($value): self
+    {
+        $this->line = $value;
+
+        return $this;
+    }
+
+    protected function setFile($value): self
+    {
+        $this->file = $value;
+
+        return $this;
+    }
+
+    protected function setCode($value): self
+    {
+        $this->code = $value;
+
+        return $this;
+    }
+
     protected function setTitle(string $title): self
     {
         $this->attachment_title = $title;
@@ -97,8 +129,22 @@ protected function setAttachmentLink($title = null): self
 
     public function jsonSerialize()
     {
+        $message = $this->message;
+
+        if ($this->code) {
+            $message .= "| Code[{$this->code}]";
+        }
+
+        if ($this->file) {
+            $message .= "| File[{$this->file}]";
+        }
+
+        if ($this->line) {
+            $message .= "| Line[{$this->line}]";
+        }
+
         return [
-            'message' => $this->message,
+            'message' => $message,
             'attachment_title' => $this->attachment_title,
             'attachment_content' => $this->attachment_content,
         ];

src/Models/ExceptionLog.php

@@ -17,7 +17,11 @@
  * @property string $uuid
  * @property-read string $identifier
  * @property string $name
+ * @property string $file
+ * @property string $line
+ * @property string $code
  * @property array $exception
+ * @property array $previous
  * @property array|mixed $payload
  * @package App\Models
  */
@@ -51,7 +55,11 @@ public static function makeFromException(Throwable $throwable, JsonSerializable
     {
         return new static([
             'name' => Str::substr($throwable->getMessage(), 0, 255),
+            'file' => $throwable->getFile(),
+            'line' => $throwable->getLine(),
+            'code' => $throwable->getCode(),
             'exception' => $throwable->__toString(),
+            'previous' => (string) $throwable->getPrevious(),
             'payload' => optional($payload)->jsonSerialize(),
         ]);
     }

src/Notifications/Slack.php

@@ -54,10 +54,12 @@ private function send($item)
 
         if ($item instanceof Throwable) {
             if ($this->persist) {
-                ExceptionLog::makeFromException($item)->save();
+                $dto = DevNotificationDto::makeFromExceptionLog(
+                    tap(ExceptionLog::makeFromException($item), fn (ExceptionLog $log) => $log->save())
+                );
+            } else {
+                $dto = DevNotificationDto::makeFromException($item);
             }
-
-            $dto->setException($item);
         }
 
         if (is_string($item)) {
@@ -74,6 +76,7 @@ private function send($item)
 
         $notification = new $class($dto);
 
+
         if (is_callable($cb = static::$notifyUsing)) {
             return call_user_func($cb, $notification);
         }

tests/Helpers/SlackHelperTest.php

@@ -2,6 +2,7 @@
 
 namespace Binarcode\LaravelDeveloper\Tests\Helpers;
 
+use Binarcode\LaravelDeveloper\Models\ExceptionLog;
 use Binarcode\LaravelDeveloper\Notifications\DevNotification;
 use Binarcode\LaravelDeveloper\Notifications\Slack;
 use Binarcode\LaravelDeveloper\Tests\TestCase;
@@ -33,10 +34,18 @@ public function test_slack_helper_can_send_throwable_to_slack()
     {
         Notification::fake();
 
-        $this->assertInstanceOf(Slack::class, slack(new Exception('wrong'))->persist());
+        config([
+            'developer.exception_log_base_url' => 'app.test/{uuid}',
+        ]);
+
+        $this->assertInstanceOf(Slack::class, slack(new Exception('not found', 404))->persist());
 
         $this->assertDatabaseCount('exception_logs', 1);
 
-        Notification::assertSentTo(new AnonymousNotifiable, DevNotification::class);
+        $uuid = ExceptionLog::latest()->first()->uuid;
+
+        Notification::assertSentTo(new AnonymousNotifiable, DevNotification::class, function (DevNotification $class) use ($uuid) {
+            return $class->notificationDto->attachment_link === "app.test/{$uuid}";
+        });
     }
 }