bidi2pdf 0.1.8 → 0.1.10

data/lib/bidi2pdf/bidi/commands/cdp_get_session.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CdpGetSession
+        include Base
+
+        def initialize(context:)
+          @context = context
+        end
+
+        def params = { context: @context }
+
+        def method_name
+          "goog:cdp.getSession"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/page_print.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative "print_parameters_validator"
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class PagePrint
+        include Base
+
+        def initialize(cdp_session:, print_options:)
+          @cdp_session = cdp_session
+          @print_options = print_options || { background: true }
+
+          PrintParametersValidator.validate!(@print_options)
+
+          return unless @print_options[:page]&.key?(:format)
+
+          @print_options[:page] = Bidi2pdf.translate_paper_format @print_options[:page][:format]
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def params
+          {
+            # https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF
+            method: "Page.printToPDF",
+            session: @cdp_session,
+            params: {
+              "printBackground" => @print_options[:background],
+
+              "marginTop" => cm_to_inch(@print_options.dig(:margin, :top) || 0),
+              "marginBottom" => cm_to_inch(@print_options.dig(:margin, :bottom) || 0),
+              "marginLeft" => cm_to_inch(@print_options.dig(:margin, :left) || 0),
+              "marginRight" => cm_to_inch(@print_options.dig(:margin, :right) || 0),
+              "landscape" => (@print_options[:orientation] || "portrait").to_sym == :landscape,
+
+              "paperWidth" => cm_to_inch(@print_options.dig(:page, :width)),
+              "paperHeight" => cm_to_inch(@print_options.dig(:page, :height)),
+              "pageRanges" => page_ranges_to_string(@print_options[:pageRanges]),
+              "scale" => @print_options[:scale] || 1.0,
+
+              "displayHeaderFooter" => @print_options[:display_header_footer],
+              "headerTemplate" => @print_options[:header_template] || "",
+              "footerTemplate" => @print_options[:footer_template] || "",
+
+              "preferCSSPageSize" => @print_options.fetch(:prefer_css_page_size, true),
+
+              "generateTaggedPDF" => @print_options.fetch(:generate_tagged_pdf, false),
+              "generateDocumentOutline" => @print_options.fetch(:generate_document_outline, false),
+
+              transferMode: "ReturnAsBase64"
+            }.compact
+          }
+        end
+
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        def method_name
+          "goog:cdp.sendCommand"
+        end
+
+        private
+
+        # rubocop:disable  Naming/MethodParameterName
+        def cm_to_inch(cm)
+          return nil if cm.nil?
+
+          cm.to_f / 2.54
+        end
+
+        # rubocop:enable  Naming/MethodParameterName
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def page_ranges_to_string(input)
+          return nil if input.nil? || input.empty?
+
+          segments = input.map do |entry|
+            case entry
+            when Integer
+              entry.to_s
+            when String
+              raise ArgumentError, "Invalid page entry: #{entry.inspect}" unless entry =~ /\A\d+(-\d+)?\z/
+
+              entry
+            else
+              raise ArgumentError, "Unsupported page entry type: #{entry.class}"
+            end
+          end
+
+          # dedupe, sort by numeric start, and join
+          segments
+            .uniq
+            .sort_by { |seg| seg.split("-", 2).first.to_i }
+            .join(",")
+        end
+
+        # rubocop:enable Metrics/CyclomaticComplexity
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/print_parameters_validator.rb

@@ -37,6 +37,7 @@ module Bidi2pdf
           @params = params
         end
 
+        # rubocop:disable Naming/PredicateMethod
         def validate!
           raise ArgumentError, "params must be a Hash" unless @params.is_a?(Hash)
 
@@ -51,6 +52,8 @@ module Bidi2pdf
           true
         end
 
+        # rubocop:enable Naming/PredicateMethod
+
         private
 
         def validate_boolean(key)
@@ -79,7 +82,7 @@ module Bidi2pdf
         def validate_page_ranges
           return unless @params.key?(:pageRanges)
           unless @params[:pageRanges].is_a?(Array) &&
-            @params[:pageRanges].all? { |v| v.is_a?(Integer) || v.is_a?(String) }
+                 @params[:pageRanges].all? { |v| v.is_a?(Integer) || v.is_a?(String) }
             raise ArgumentError, ":pageRanges must be an array of integers or strings"
           end
         end

data/lib/bidi2pdf/bidi/commands.rb

@@ -18,6 +18,8 @@ module Bidi2pdf
       require_relative "commands/browsing_context_close"
       require_relative "commands/browsing_context_navigate"
       require_relative "commands/browsing_context_print"
+      require_relative "commands/cdp_get_session"
+      require_relative "commands/page_print"
       require_relative "commands/session_subscribe"
       require_relative "commands/session_end"
       require_relative "commands/cancel_auth"

data/lib/bidi2pdf/bidi/connection_manager.rb

@@ -17,6 +17,7 @@ module Bidi2pdf
         @connection_latch.count_down
       end
 
+      # rubocop:disable Naming/PredicateMethod
       def wait_until_open(timeout:)
         return true if @connected
 
@@ -26,6 +27,8 @@ module Bidi2pdf
 
         true
       end
+
+      # rubocop:enable Naming/PredicateMethod
     end
   end
 end

data/lib/bidi2pdf/bidi/event_manager.rb

@@ -3,6 +3,27 @@
 module Bidi2pdf
   module Bidi
     class EventManager
+      Listener = Struct.new(:block, :id, :source_location) do
+        def initialize(block, id = SecureRandom.uuid)
+          super
+          self.source_location = block.source_location
+        end
+
+        def call(*args)
+          block.call(*args)
+        end
+
+        def ==(other)
+          other.is_a?(Listener) && id == other.id
+        end
+
+        alias_method :eql?, :==
+
+        def hash
+          id.hash
+        end
+      end
+
       attr_reader :type
 
       def initialize(type)
@@ -11,12 +32,21 @@ module Bidi2pdf
       end
 
       def on(*event_names, &block)
-        event_names.each { |event_name| @listeners[event_name.to_sym] << block }
-
-        block
+        Listener.new(block).tap do |listener|
+          event_names.each do |event_name|
+            @listeners[event_name.to_sym] << listener
+            log_msg("Adding #{event_name} listener", listener)
+          end
+        end
       end
 
-      def off(event_name, block) = @listeners[event_name.to_sym].delete(block)
+      def off(event_name, listener)
+        raise ArgumentError, "Listener not registered" unless listener.is_a?(Listener)
+
+        log_msg("Removing #{event_name} listener", listener)
+
+        @listeners[event_name.to_sym].delete(listener)
+      end
 
       def dispatch(event_name, *args)
         listeners = @listeners[event_name.to_sym] || []

data/lib/bidi2pdf/bidi/interceptor.rb

@@ -27,14 +27,24 @@ module Bidi2pdf
         client.send_cmd_and_wait(cmd) do |response|
           @interceptor_id = response["result"]["intercept"]
 
-          Bidi2pdf.logger.debug "Interceptor added: #{@interceptor_id}"
+          Bidi2pdf.logger.debug2 "Interceptor added: #{@interceptor_id}"
 
-          client.on_event(*self.class.events, &method(:handle_event))
+          @handle_event_listener = client.on_event(*self.class.events, &method(:handle_event))
 
           self
         end
       end
 
+      def unregister_with_client(client:)
+        return unless @handle_event_listener
+
+        client.remove_event_listener(*self.class.events, @handle_event_listener)
+
+        Bidi2pdf.logger.debug2 "Interceptor removed: #{@interceptor_id}"
+
+        @handle_event_listener = nil
+      end
+
       # rubocop: disable Metrics/AbcSize
       def handle_event(response)
         event_response = response["params"]

data/lib/bidi2pdf/bidi/session.rb

@@ -32,7 +32,38 @@ module Bidi2pdf
       SUBSCRIBE_EVENTS = %w[script].freeze
 
       # Default Chrome arguments for the session.
-      DEFAULT_CHROME_ARGS = %w[--disable-gpu --disable-popup-blocking --disable-hang-monitor].freeze
+      DEFAULT_CHROME_ARGS = [
+        "--allow-pre-commit-input", # Allow pre-commit input for form fields
+        "--disable-dev-shm-usage", # Disable /dev/shm usage; use /tmp instead
+        "--disable-gpu", # Disable GPU hardware acceleration; force software rendering
+        "--disable-popup-blocking", # Allow all pop-ups; bypass built-in popup blocker
+        "--disable-hang-monitor", # Disable “Page Unresponsive” / “Aw, Snap!” dialogs on hangs
+        "--disable-background-networking", # Turn off speculative/periodic network requests (DNS prefetch, Safe Browsing updates, etc.)
+        "--disable-background-timer-throttling", # Prevent JS timers from being throttled in background tabs
+        "--disable-client-side-phishing-detection", # Disable built-in phishing checks; rely only on server-side detection
+        "--disable-component-extensions-with-background-pages", # Block component extensions that run persistent background pages (PDF viewer, Translate, etc.)
+        "--disable-crash-reporter", # Disable crash-report uploads and UI
+        "--disable-default-apps", # Stop installation of Chrome’s default apps on a fresh profile
+        "--disable-infobars", # Suppress “Chrome is being controlled by automated test software” infobar (and similar)
+        "--disable-ipc-flooding-protection", # Turn off defenses against too-many IPC messages from renderers
+        "--disable-prompt-on-repost", # Skip “Confirm Form Resubmission” dialogs on page reloads after POST
+        "--disable-renderer-backgrounding", # Keep background tab renderers at full priority
+        "--disable-search-engine-choice-screen", # Skip first-run search engine selection UI
+        "--disable-sync", # Turn off all Google account sync (bookmarks, passwords, etc.)
+        "--enable-automation", # Expose WebDriver hooks (navigator.webdriver) for automation frameworks
+        "--export-tagged-pdf", # When printing to PDF, include tagged structure for accessibility
+        "--force-color-profile=srgb", # Force rendering to use the sRGB color profile
+        "--generate-pdf-document-outline", # Auto-generate PDF bookmarks/outlines from HTML headings, not supported by chrome/chromium https://issues.chromium.org/issues/41387522#comment48
+        "--metrics-recording-only", # Collect UMA metrics locally but never upload them
+        "--no-first-run", # Skip the “Welcome” or “What’s New” screens on fresh profiles
+        "--password-store=basic", # Use Chrome’s basic (in-profile) password storage vs. OS vault
+        "--use-mock-keychain", # On macOS, use a fake keychain for testing (don’t touch the real one)
+        "--disable-backgrounding-occluded-windows", # Prevent fully-occluded windows from being treated as background
+        "--disable-breakpad", # Disable the Breakpad crash-reporting library entirely
+        "--enable-features=PdfOopif", # Enable out-of-process iframe (OOPIF) architecture for PDF rendering
+        "--disable-features=Translate,AcceptCHFrame,MediaRouter,OptimizationHints,ProcessPerSiteUpToMainFrameThreshold,IsolateSandboxedIframes",
+        "--disable-extensions about:blank"
+      ].freeze
 
       # @return [URI] The URI of the session.
       attr_reader :session_uri
@@ -165,6 +196,7 @@ module Bidi2pdf
         Bidi2pdf.logger.info "Subscribing to events"
 
         Bidi::Client.new(websocket_url).tap do |event_client|
+          @event_socket = event_client
           event_client.start
           event_client.wait_until_open
 
@@ -208,7 +240,7 @@ module Bidi2pdf
       # @return [Hash] The session request payload.
       def session_request
         session_chrome_args = chrome_args.dup
-        session_chrome_args << "--headless" if @headless
+        session_chrome_args << "--headless=new" if @headless
 
         {
           "capabilities" => {
@@ -320,6 +352,7 @@ module Bidi2pdf
       # Cleans up resources associated with the session.
       def cleanup
         @client&.close
+        @event_socket&.close
         @client = @websocket_url = @browser = nil
       end
     end

data/lib/bidi2pdf/bidi/web_socket_dispatcher.rb

@@ -24,7 +24,7 @@ module Bidi2pdf
 
       def on_message(&) = socket_events.on(:message, &)
 
-      def on_event(name, &) = session_events.on(name, &)
+      def on_event(*event_names, &) = session_events.on(*event_names, &)
 
       def on_open(&) = socket_events.on(:open, &)
 
@@ -34,13 +34,13 @@ module Bidi2pdf
 
       def remove_message_listener(block) = socket_events.off(:message, block)
 
-      def remove_event_listener(name, block) = session_events.off(name, block)
+      def remove_event_listener(name, listener) = session_events.off(name, listener)
 
-      def remove_open_listener(block) = socket_events.off(:open, block)
+      def remove_open_listener(listener) = socket_events.off(:open, listener)
 
-      def remove_close_listener(block) = socket_events.off(:close, block)
+      def remove_close_listener(listener) = socket_events.off(:close, listener)
 
-      def remove_error_listener(block) = socket_events.off(:error, block)
+      def remove_error_listener(listener) = socket_events.off(:error, listener)
 
       private
 

data/lib/bidi2pdf/chromedriver_manager.rb

@@ -8,6 +8,7 @@ module Bidi2pdf
     include Chromedriver::Binary::Platform
 
     attr_reader :port, :pid, :started, :headless, :chrome_args, :shutdown_mutex
+    attr_accessor :reader_thread
 
     def initialize(port: 0, headless: true, chrome_args: Bidi::Session::DEFAULT_CHROME_ARGS)
       @port = port
@@ -49,10 +50,20 @@ module Bidi2pdf
       "http://localhost:#{@port}/session"
     end
 
+    # rubocop: disable Metrics/AbcSize
     def stop(timeout: 5)
       shutdown_mutex.synchronize do
         return unless @pid
 
+        if reader_thread&.alive?
+          begin
+            reader_thread.kill
+            reader_thread.join
+          rescue StandardError => e
+            Bidi2pdf.logger.error "Error killing reader thread: #{e.message}"
+          end
+        end
+
         @started = false
 
         close_session
@@ -72,6 +83,8 @@ module Bidi2pdf
       end
     end
 
+    # rubocop: enable Metrics/AbcSize
+
     private
 
     def spawn_process(cmd)
@@ -184,25 +197,26 @@ module Bidi2pdf
 
     # rubocop: disable Metrics/AbcSize
     def parse_port_from_output(io, timeout: 5)
-      Thread.new do
-        io.each_line do |line|
-          Bidi2pdf.logger.debug1 line.chomp
+      port_event = Concurrent::Event.new
 
-          next unless line =~ /ChromeDriver was started successfully on port (\d+)/
-
-          Bidi2pdf.logger.debug "Found port: #{::Regexp.last_match(1).to_i} setup port: #{@port}"
-
-          @port = ::Regexp.last_match(1).to_i if @port.nil? || @port.zero?
+      self.reader_thread = Thread.new do
+        io.each_line do |line|
+          Bidi2pdf.logger.info "[chromedriver] #{line.chomp}"
 
-          break
+          if line =~ /ChromeDriver was started successfully on port (\d+)/
+            @port = ::Regexp.last_match(1).to_i if @port.nil? || @port.zero?
+            port_event.set
+          end
         end
       rescue IOError
         # reader closed
       ensure
         io.close unless io.closed?
-      end.join(timeout)
+      end
+
+      return if port_event.wait(timeout)
 
-      raise "Chromedriver did not report a usable port in #{timeout}s" if @port.nil?
+      raise "Chromedriver did not report a usable port in #{timeout}s"
     end
 
     # rubocop: enable Metrics/AbcSize

data/lib/bidi2pdf/cli.rb

@@ -74,6 +74,8 @@ module Bidi2pdf
     option :page_ranges, type: :array, desc: "Page ranges to print (e.g., 1-2 4 6)"
     option :scale, type: :numeric, default: 1.0, desc: "Scale between 0.1 and 2.0"
     option :shrink_to_fit, type: :boolean, default: true, desc: "Shrink content to fit page"
+    option :generate_tagged_pdf, type: :boolean, default: false, desc: "Generate tagged PDF"
+    option :generate_document_outline, type: :boolean, default: false, desc: "Generate document outline"
 
     class << self
       def exit_on_failure?
@@ -150,7 +152,7 @@ module Bidi2pdf
       raise Thor::Error, "Invalid print option: #{e.message}"
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def print_options
       opts = {}
 
@@ -186,10 +188,15 @@ module Bidi2pdf
       assign_if_provided(page, :height, :page_height)
       opts[:page] = page unless page.empty?
 
+      assign_if_provided(opts, :generate_tagged_pdf)
+      assign_if_provided(opts, :generate_document_outline)
+
+      opts[:cmd_type] = :cdp if opts[:generate_tagged_pdf] || opts[:generate_document_outline]
+
       opts.empty? ? nil : opts
     end
 
-    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
 
     def option_provided?(key)
       ARGV.include?("--#{key.to_s.tr("_", "-")}") || ARGV.include?("--#{key}")

data/lib/bidi2pdf/test_helpers/configuration.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module TestHelpers
+    class Configuration
+      # @!attribute [rw] spec_dir
+      #   @return [Pathname] the directory where specs are located
+      attr_accessor :spec_dir
+
+      # @!attribute [rw] tmp_dir
+      #   @return [String] the directory for temporary files
+      attr_accessor :tmp_dir
+
+      # @!attribute [rw] prefix
+      #   @return [String] the prefix for temporary files
+      attr_accessor :prefix
+
+      # @!attribute [rw] docker_dir
+      #  @return [String] the directory for Docker files
+      attr_accessor :docker_dir
+
+      # @!attribute [rw] fixture_dir
+      # @return [String] the directory for fixture files
+      attr_accessor :fixture_dir
+
+      def initialize
+        project_root = if defined?(Rails) && Rails.respond_to?(:root)
+                         Pathname.new(Rails.root)
+                       elsif defined?(Bundler) && Bundler.respond_to?(:root)
+                         Pathname.new(Bundler.root)
+                       else
+                         Pathname.new(Dir.pwd)
+                       end
+
+        @spec_dir = project_root.join("spec").expand_path
+        @docker_dir = project_root.join("docker")
+        @fixture_dir = project_root.join("spec", "fixtures")
+        @tmp_dir = project_root.join("tmp")
+        @prefix = "tmp_"
+      end
+    end
+
+    class << self
+      # Retrieves the current configuration object for TestHelpers.
+      # @return [Configuration] the configuration object
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # Sets the configuration object for TestHelpers.
+      # @param [Configuration] config the configuration object to set
+      attr_writer :configuration
+
+      # Allows configuration of TestHelpers by yielding the configuration object.
+      # @yieldparam [Configuration] configuration the configuration object to modify
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+
+  # Configures RSpec to include and extend SpecPathsHelper for examples with the `:pdf` metadata.
+  RSpec.configure do |config|
+    # Adds a custom RSpec setting for TestHelpers configuration.
+    config.add_setting :bidi2pdf_test_helpers_config, default: TestHelpers.configuration
+  end
+end

data/lib/bidi2pdf/test_helpers/images/extractor.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      require "vips"
+      require "zlib"
+
+      class Extractor
+        include PDFReaderUtils
+        include TIFFHelper
+
+        attr_reader :pages, :logger
+
+        def initialize(pdf_data, logger: Bidi2pdf.logger)
+          reader = pdf_reader_for pdf_data
+          @pages = reader.pages
+          @logger = logger
+        end
+
+        def all_images
+          extracted_images.map { |images| images[:images] }.flatten
+        end
+
+        def image_on_page(page_number, image_number)
+          images = images_on_page(page_number)
+          return nil if images.empty? || image_number > images.size
+
+          images[image_number - 1]
+        end
+
+        def images_on_page(page_number)
+          extracted_images.find { |images| images[:page] == page_number }&.dig(:images) || []
+        end
+
+        private
+
+        def extracted_images
+          @extracted_images ||= @pages.each_with_index.with_object([]) do |(page, index), result|
+            result << { page: index + 1, images: extract_images(page) }
+          end
+        end
+
+        def extract_images(page)
+          xobjects = page.xobjects
+          return if xobjects.empty?
+
+          xobjects.each_value.map do |stream|
+            case stream.hash[:Subtype]
+            when :Image
+              process_image_stream(stream)
+            when :Form
+              extract_images(PDF::Reader::FormXObject.new(page, stream))
+            end
+          end.flatten
+        end
+
+        def process_image_stream(stream)
+          filter = Array(stream.hash[:Filter]).first
+          raw = extract_raw_image_data(stream, filter)
+
+          return nil if raw.nil? || raw.empty?
+
+          create_vips_image(raw, filter)
+        end
+
+        def extract_raw_image_data(stream, filter)
+          case filter
+          when :DCTDecode, :JPXDecode then stream.data
+          when :CCITTFaxDecode then tiff_header_for_CCITT(stream.hash, stream.data)
+          when :LZWDecode, :RunLengthDecode, :FlateDecode then handle_compressed_image(stream)
+          else
+            Bidi2pdf.logger.warn("Unsupported image filter '#{filter}'. Attempting to process raw data.")
+            stream.data
+          end
+        rescue StandardError => e
+          Bidi2pdf.logger.error("Error extracting raw image data with filter '#{filter}': #{e.message}")
+          nil # Return nil to indicate failure
+        end
+
+        def handle_compressed_image(stream)
+          hash = stream.hash
+          data = stream.unfiltered_data
+
+          header = tiff_header(hash, data)
+
+          header + data
+        end
+
+        def create_vips_image(raw, filter)
+          Vips::Image.new_from_buffer(raw, "", disc: true)
+        rescue Vips::Error => e
+          Bidi2pdf.logger.error("Error creating Vips image from buffer (filter: #{filter}): #{e.message}")
+          nil # Return nil if Vips fails
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/test_helpers/images/image_similarity_checker.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      require "dhash-vips"
+
+      class ImageSimilarityChecker
+        def initialize(expected_image, image_to_check)
+          @expected_image = expected_image.is_a?(Vips::Image) ? expected_image : Vips::Image.new_from_file(expected_image)
+          @image_to_check = image_to_check.is_a?(Vips::Image) ? image_to_check : Vips::Image.new_from_file(image_to_check)
+        end
+
+        def similar?(tolerance: 20)
+          distance < tolerance
+        end
+
+        def very_similar?
+          similar? tolerance: 20
+        end
+
+        def slightly_similar?
+          similar? tolerance: 25
+        end
+
+        def different?
+          !slightly_similar?
+        end
+
+        def expected_fingerprint
+          @expected_fingerprint ||= fingerprint @expected_image
+        end
+
+        def actual_fingerprint
+          @actual_fingerprint ||= fingerprint @image_to_check
+        end
+
+        def distance
+          @distance ||= DHashVips::IDHash.distance(expected_fingerprint, actual_fingerprint)
+        end
+
+        def fingerprint(image)
+          image = image.resize(32.0 / [image.width, image.height].min) if image.width < 32 || image.height < 32
+
+          DHashVips::IDHash.fingerprint image
+        end
+      end
+    end
+  end
+end