Add extra logging for failed browsershot attempts

spatie · Apr 1, 2022 · 50eae92 · 50eae92
1 parent 36e8661
commit 50eae92
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 5 deletions.
diff --git a/src/Browsershot.php b/src/Browsershot.php
@@ -530,12 +530,12 @@ public function save(string $targetPath)
 
         $command = $this->createScreenshotCommand($targetPath);
 
-        $this->callBrowser($command);
+        $output = $this->callBrowser($command);
 
         $this->cleanupTemporaryHtmlFile();
 
         if (! file_exists($targetPath)) {
-            throw CouldNotTakeBrowsershot::chromeOutputEmpty($targetPath, $command);
+            throw CouldNotTakeBrowsershot::chromeOutputEmpty($targetPath, $output, $command);
         }
 
         if (! $this->imageManipulations->isEmpty()) {
@@ -797,7 +797,7 @@ protected function cleanupTemporaryOptionsFile()
         }
     }
 
-    protected function callBrowser(array $command)
+    protected function callBrowser(array $command): string
     {
         $fullCommand = $this->getFullCommand($command);
 

diff --git a/src/Exceptions/CouldNotTakeBrowsershot.php b/src/Exceptions/CouldNotTakeBrowsershot.php
@@ -6,11 +6,21 @@
 
 class CouldNotTakeBrowsershot extends Exception
 {
-    public static function chromeOutputEmpty(string $screenShotPath, array $command = [])
+    public static function chromeOutputEmpty(string $screenShotPath, string $output, array $command = [])
     {
         $command = json_encode($command);
 
-        return new static("For some reason Chrome did not write a file at `{$screenShotPath}`. Command payload: {$command}");
+        $message = <<<CONSOLE
+            For some reason Chrome did not write a file at `{$screenShotPath}`.
+            Command
+            =======
+            {$command}
+            Output
+            ======
+            {$output}
+            CONSOLE;
+
+        return new static($message);
     }
 
     public static function outputFileDidNotHaveAnExtension(string $path)