Merge branch 'receipt-bank-stream-pdf-to-file'

Author: route

README.md

@@ -346,7 +346,7 @@ browser.screenshot(path: "google.jpg") # => 30902
 browser.screenshot(full: true, quality: 60) # "iVBORw0KGgoAAAANSUhEUgAABAAAAAMACAYAAAC6uhUNAAAAAXNSR0IArs4c6Q...
 ```
 
-#### pdf(\*\*options) : `String` | `Integer`
+#### pdf(\*\*options) : `String` | `Boolean`
 
 Saves PDF on a disk or returns it as base64.
 
@@ -366,7 +366,7 @@ Saves PDF on a disk or returns it as base64.
 ```ruby
 browser.go_to("https://google.com/")
 # Save to disk as a PDF
-browser.pdf(path: "google.pdf", paper_width: 1.0, paper_height: 1.0) # => 14983
+browser.pdf(path: "google.pdf", paper_width: 1.0, paper_height: 1.0) # => true
 ```
 
 #### mhtml(\*\*options) : `String` | `Integer`

lib/ferrum.rb

@@ -10,7 +10,10 @@ class NoSuchTargetError   < Error; end
   class NotImplementedError < Error; end
 
   class StatusError < Error
+    attr_reader :pendings
+
     def initialize(url, pendings = [])
+      @pendings = pendings
       message = if pendings.empty?
                   "Request to #{url} failed to reach server, check DNS and/or server status"
                 else

lib/ferrum/page/screenshot.rb

@@ -24,6 +24,8 @@ module Screenshot
         A6:       { width:  4.13, height:  5.83 },
       }.freeze
 
+      STREAM_CHUNK = 128 * 1024
+
       def screenshot(**opts)
         path, encoding = common_options(**opts)
         options = screenshot_options(path, **opts)
@@ -34,14 +36,16 @@ def screenshot(**opts)
         save_file(path, bin)
       end
 
-      def pdf(**opts)
+    def pdf(**opts)
         path, encoding = common_options(**opts)
-        options = pdf_options(**opts)
-        data = command("Page.printToPDF", **options).fetch("data")
-        return data if encoding == :base64
+        options = pdf_options(**opts).merge(transferMode: "ReturnAsStream")
+        handle = command("Page.printToPDF", **options).fetch("stream")
 
-        bin = Base64.decode64(data)
-        save_file(path, bin)
+        if path
+          stream_to_file(handle, path: path)
+        else
+          stream_to_memory(handle, encoding: encoding)
+        end
       end
 
       def mhtml(path: nil)
@@ -70,6 +74,29 @@ def save_file(path, data)
         File.open(path.to_s, "wb") { |f| f.write(data) }
       end
 
+      def stream_to_file(handle, path:)
+        File.open(path, "wb") { |f| stream_to(handle, f) }
+        true
+      end
+
+      def stream_to_memory(handle, encoding:)
+        data = String.new("") # Mutable string has << and compatible to File
+        stream_to(handle, data)
+        encoding == :base64 ? Base64.encode64(data) : data
+      end
+
+      def stream_to(handle, output)
+        loop do
+          result = command("IO.read", handle: handle, size: STREAM_CHUNK)
+
+          data_chunk = result["data"]
+          data_chunk = Base64.decode64(data_chunk) if result["base64Encoded"]
+          output << data_chunk
+
+          break if result["eof"]
+        end
+      end
+
       def common_options(encoding: :base64, path: nil, **_)
         encoding = encoding.to_sym
         encoding = :binary if path

spec/screenshot_spec.rb

@@ -295,7 +295,7 @@ def create_screenshot(path: file, **options)
           it "convert case correct" do
             browser.go_to("/ferrum/long_page")
 
-            allow(browser.page).to receive(:command).with("Page.printToPDF", {
+            allow(browser.page).to receive(:command).with("Page.printToPDF", hash_including(
                displayHeaderFooter: false,
                ignoreInvalidPageRanges: false,
                landscape: false,
@@ -310,23 +310,26 @@ def create_screenshot(path: file, **options)
                preferCSSPageSize: false,
                printBackground: false,
                scale: 1,
-               transferMode: "ReturnAsBase64"
-            }) { { "data" => "" } }
-
-            browser.pdf(path: file, landscape: false,
-                                    display_header_footer: false,
-                                    print_background: false,
-                                    scale: 1,
-                                    paper_width: 8.5,
-                                    paper_height: 11,
-                                    margin_top: 0.4,
-                                    margin_bottom: 0.4,
-                                    margin_left: 0.4,
-                                    margin_right: 0.4,
-                                    page_ranges: "",
-                                    ignore_invalid_page_ranges: false,
-                                    prefer_css_page_size: false,
-                                    transfer_mode: "ReturnAsBase64")
+            )) { { "stream" => "1" } }
+
+            allow(browser.page).to receive(:command).with("IO.read", hash_including(handle: "1")) {
+              { "data" => "", "base64Encoded" => false, "eof" => true }
+            }
+
+            browser.pdf(path: file,
+                        landscape: false,
+                        display_header_footer: false,
+                        print_background: false,
+                        scale: 1,
+                        paper_width: 8.5,
+                        paper_height: 11,
+                        margin_top: 0.4,
+                        margin_bottom: 0.4,
+                        margin_left: 0.4,
+                        margin_right: 0.4,
+                        page_ranges: "",
+                        ignore_invalid_page_ranges: false,
+                        prefer_css_page_size: false)
           end
         end
       end