added method setContentUrl to set url when using html method

spatie · May 19, 2022 · 038cfec · 038cfec
1 parent 9c4f283
commit 038cfec
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 1 deletion.
diff --git a/bin/browser.js b/bin/browser.js
@@ -102,6 +102,15 @@ const callChrome = async pup => {
             });
         }
 
+        const contentUrl = request.options.contentUrl;
+        const parsedContentUrl = contentUrl ? contentUrl.replace(/\/$/, "") : undefined;
+        let pageContent;
+
+        if (contentUrl) {
+            pageContent = fs.readFileSync(request.url.replace('file://', ''));
+            request.url = contentUrl;
+        }
+
         page.on('request', interceptedRequest => {
             var headers = interceptedRequest.headers();
 
@@ -140,7 +149,20 @@ const callChrome = async pup => {
                 }
             }
 
-            interceptedRequest.continue({headers});
+            if (pageContent) {
+                const interceptedUrl = interceptedRequest.url().replace(/\/$/, "");
+
+                // if content url matches the intercepted request url, will return the content fetched from the local file system
+                if (interceptedUrl === parsedContentUrl) {
+                    interceptedRequest.respond({
+                        headers,
+                        body: pageContent,
+                    });
+                    return;
+                }
+            }
+
+            interceptedRequest.continue({ headers });
         });
 
         if (request.options && request.options.dismissDialogs) {

diff --git a/docs/miscellaneous-options/using-url-for-html-content.md b/docs/miscellaneous-options/using-url-for-html-content.md
@@ -0,0 +1,12 @@
+---
+title: Using url for html content
+weight: 21
+---
+
+Using the method *setContentUrl* you can set the base url of the request when using the *html* method. Sometimes you may have relative paths in your code. When passing a html page to puppeteer, you don't have a base url set. So any relative path present in your html content will not fetch correctly.
+
+```php
+Browsershot::html('<html>... relative paths to fetch ...</html>')
+   ->setContentUrl('https://www.example.com')
+   ...
+```
diff --git a/src/Browsershot.php b/src/Browsershot.php
@@ -745,6 +745,11 @@ public function setEnvironmentOptions(array $options = []): self
         return $this->setOption('env', $options);
     }
 
+    public function setContentUrl(string $contentUrl): self
+    {
+        return $this->html ? $this->setOption('contentUrl', $contentUrl) : $this;
+    }
+
     protected function getOptionArgs(): array
     {
         $args = $this->chromiumArguments;

diff --git a/tests/BrowsershotTest.php b/tests/BrowsershotTest.php
@@ -1481,3 +1481,30 @@
 
     $this->assertFileDoesNotExist($targetPath);
 });
+
+it('will allow passing a content url', function () {
+    $instance = Browsershot::html('<h1>Hello world!!</h1>')
+        ->setContentUrl('https://example.com');
+
+    $response = $instance->createScreenshotCommand('screenshot.png');
+
+    $responseUrl = $response['url'];
+    unset($response['url']);
+
+    $this->assertEquals([
+        'action' => 'screenshot',
+        'options' => [
+            'path' => 'screenshot.png',
+            'viewport' => [
+                'width' => 800,
+                'height' => 600,
+            ],
+            'args' => [],
+            'type' => 'png',
+            'displayHeaderFooter' => false,
+            'contentUrl' => 'https://example.com',
+        ],
+    ], $response);
+
+    $this->assertStringContainsString("file://", $responseUrl);
+});