From fec63ff2494b8740f5b4cfa284cb038b2000c5ef Mon Sep 17 00:00:00 2001
From: Matthias Guillitte <matthias@guillitte.com>
Date: Sun, 2 Mar 2025 10:03:27 +0100
Subject: [PATCH] Added Debug notifications

---
 app/Browser/BrowserJob.php                    |  2 +-
 app/Browser/JobDebugScreenshot.php            | 27 ++++++++++
 app/Browser/JobErrorScreenshot.php            |  2 +-
 app/Browser/Jobs/Hellcase/HellcaseJob.php     |  7 ++-
 .../JobDebugNotificationBody.php              | 53 +++++++++++++++++++
 .../Notifications/JobDebugNotification.php    | 40 ++++++++++++++
 6 files changed, 128 insertions(+), 3 deletions(-)
 create mode 100644 app/Browser/JobDebugScreenshot.php
 create mode 100644 app/Notification/NotificationBody/JobDebugNotificationBody.php
 create mode 100644 app/Notification/Notifications/JobDebugNotification.php

diff --git a/app/Browser/BrowserJob.php b/app/Browser/BrowserJob.php
index 5e40a0c..a1994b4 100644
--- a/app/Browser/BrowserJob.php
+++ b/app/Browser/BrowserJob.php
@@ -58,7 +58,7 @@ abstract class BrowserJob implements ShouldQueue
             //     throw $e;
             }
             catch (Throwable $e) {
-                $browser->screenshot("failure-{$this->jobId}");
+                $browser->screenshot(JobErrorScreenshot::getFileName($this->jobId));
                 AllNotification::send(new JobErrorNotification($this->jobId, $e->getMessage()));
                 dump($e);
                 throw $e;
diff --git a/app/Browser/JobDebugScreenshot.php b/app/Browser/JobDebugScreenshot.php
new file mode 100644
index 0000000..cc28557
--- /dev/null
+++ b/app/Browser/JobDebugScreenshot.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Browser;
+
+use Laravel\Dusk\Browser;
+use function rtrim;
+
+
+class JobDebugScreenshot {
+    public const IMG_FILE_NAME = "debug-";
+
+    public static function getFileName(int $jobId): string {
+        return static::IMG_FILE_NAME . $jobId . ".png";
+    }
+
+    public static function getImgFileAbsolutePath(int $jobId): string {
+        return rtrim(Browser::$storeScreenshotsAt, '/') . "/" . static::getFileName($jobId);
+    }
+
+    public static function getImgFileProjectPath(int $jobId): string {
+        return app_path("Browser/screenshots/" . static::getFileName($jobId));
+    }
+
+    public static function getImgFileExternalPath(int $jobId): string {
+        return "screenshots/" . static::getFileName($jobId);
+    }
+}
diff --git a/app/Browser/JobErrorScreenshot.php b/app/Browser/JobErrorScreenshot.php
index 22d455f..57e45c7 100644
--- a/app/Browser/JobErrorScreenshot.php
+++ b/app/Browser/JobErrorScreenshot.php
@@ -9,7 +9,7 @@ use function rtrim;
 class JobErrorScreenshot {
     public const IMG_FILE_NAME = "failure-";
 
-    private static function getFileName(int $jobId): string {
+    public static function getFileName(int $jobId): string {
         return static::IMG_FILE_NAME . $jobId . ".png";
     }
 
diff --git a/app/Browser/Jobs/Hellcase/HellcaseJob.php b/app/Browser/Jobs/Hellcase/HellcaseJob.php
index 181d8a1..221abb2 100644
--- a/app/Browser/Jobs/Hellcase/HellcaseJob.php
+++ b/app/Browser/Jobs/Hellcase/HellcaseJob.php
@@ -4,6 +4,7 @@ namespace App\Browser\Jobs\Hellcase;
 
 use App\Browser\BrowserJob;
 use App\Browser\Components\Hellcase\MainNav;
+use App\Browser\JobDebugScreenshot;
 use App\Browser\Jobs\Hellcase\HellcaseLoginQrCode;
 use App\Models\JobArtifact;
 use App\Models\JobRun;
@@ -11,6 +12,7 @@ use App\Notification\NotificationBody\Hellcase\HellcaseNotificationDailyFreeBody
 use App\Notification\NotificationBody\Hellcase\HellcaseNotificationLoginBody;
 use App\Notification\Notifications\Hellcase\HellcaseNotificationDailyFree;
 use App\Notification\Notifications\Hellcase\HellcaseNotificationLogin;
+use App\Notification\Notifications\JobDebugNotification;
 use App\Notification\Notifications\JobErrorNotification;
 use App\Notification\Providers\AllNotification;
 use Facebook\WebDriver\WebDriverBy;
@@ -102,7 +104,8 @@ class HellcaseJob extends BrowserJob implements ShouldBeUniqueUntilProcessing
             try {
                 $qrCode = $browser->driver->findElement(WebDriverBy::xpath('//div[./*[contains(text(), "Or sign in with QR")]]'));
             } catch (\Exception $e) {
-                AllNotification::send(new JobErrorNotification($this->jobId, "Le QR code de la page de connexion de Steam n'a pas été trouvé"));
+                $browser->takeScreenshot(JobDebugScreenshot::getFileName($this->jobId));
+                AllNotification::send(new JobDebugNotification($this->jobId, "Le QR code de la page de connexion de Steam n'a pas été trouvé"));
                 throw $e;
             }
 
@@ -206,6 +209,8 @@ class HellcaseJob extends BrowserJob implements ShouldBeUniqueUntilProcessing
             $hours = $availibleInButton->getText();
             // If the text is like "in 26 sec." we need to put one minute
             if (!str_contains($hours, "hr")) {
+                $browser->takeScreenshot(JobDebugScreenshot::getFileName($this->jobId));
+                AllNotification::send(new JobDebugNotification($this->jobId, "I hate niggers"));
                 // $this->reschedule(1);
                 sleep(60);
                 return $this->getDailyFree($browser);
diff --git a/app/Notification/NotificationBody/JobDebugNotificationBody.php b/app/Notification/NotificationBody/JobDebugNotificationBody.php
new file mode 100644
index 0000000..f668f69
--- /dev/null
+++ b/app/Notification/NotificationBody/JobDebugNotificationBody.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Notification\NotificationBody;
+
+use App\Models\Job;
+use App\Notification\NotificationBody;
+use App\Notification\Stringifiable;
+
+class JobDebugNotificationBody extends NotificationBody {
+
+    private Job $job;
+    private string $title;
+    private string $body;
+    private string $error;
+    private bool $hasScreenshot;
+
+    public function __construct(Job $job, string $title, string $body, string $error, bool $hasScreenshot = false) {
+        $this->job = $job;
+        $this->title = $title;
+        $this->body = $body;
+        $this->error = $error;
+        $this->hasScreenshot = $hasScreenshot;
+    }
+
+    private function constructString(bool $inMarkdown = false) {
+        $mdBody = "";
+        if ($this->body !== null) {
+            $mdBody .= $this->body;
+        }
+        if ($this->error !== null) {
+            $errorWrapper = $inMarkdown ? "```" : "";
+            $mdBody .= " :\n" . $errorWrapper . $this->error . $errorWrapper;
+        }
+        if ($inMarkdown && $this->hasScreenshot) {
+            $mdBody .= "\nScreenshot : ";
+        }
+        return $mdBody;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toMarkdownString(): string {
+        return $this->constructString(true);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toString(): string {
+        return $this->constructString();
+    }
+}
diff --git a/app/Notification/Notifications/JobDebugNotification.php b/app/Notification/Notifications/JobDebugNotification.php
new file mode 100644
index 0000000..dadb933
--- /dev/null
+++ b/app/Notification/Notifications/JobDebugNotification.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Notification\Notifications;
+
+use App\Browser\JobDebugScreenshot;
+use App\Notification\Notification;
+use App\Notification\NotificationBody\JobDebugNotificationBody;
+use App\Notification\Stringifiable;
+use App\Notification\Stringifiable\StringifiableSimpleText;
+
+class JobDebugNotification extends Notification {
+
+    private string|null $title;
+    private string|null $screenShotProjectPath;
+
+    public function __construct(int $jobId, string $body, string $title = null, string $error = null, string $screenshotProjectPath = JobDebugScreenshot::getImgFileProjectPath($jobId), bool $isError = false) {
+        parent::__construct($jobId, isError:$isError);
+        $this->title = $title;
+        $this->screenShotProjectPath = $screenshotProjectPath;
+        $this->setBody(new JobDebugNotificationBody($this->job, $this->title, $body, $error, $this->screenShotProjectPath != null));
+    }
+
+    public function getTitle(): Stringifiable {
+        return new StringifiableSimpleText($this->title ?? "DEBUG Job {$this->job->name}");
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getImageProjectPath(): string|null {
+        return $this->screenShotProjectPath;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getLinkURL(): string|null {
+        return route('jobs.show', ['job' => $this->job->id]);
+    }
+}