bidi2pdf 0.1.7 → 0.1.9

data/lib/bidi2pdf/test_helpers/testcontainers/chromedriver_test_helper.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "shared_docker_network"
+
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+      module ChromedriverTestHelper
+        def session_url
+          chromedriver_container.session_url
+        end
+
+        def chromedriver_container
+          RSpec.configuration.chromedriver_container
+        end
+      end
+
+      module SessionTestHelper
+        def chrome_args
+          chrome_args = Bidi2pdf::Bidi::Session::DEFAULT_CHROME_ARGS.dup
+
+          # within github actions, the sandbox is not supported, when we start our own container
+          # some privileges are not available ???
+          if ENV["DISABLE_CHROME_SANDBOX"]
+            chrome_args << "--no-sandbox"
+
+            puts "🚨 Chrome sandbox disabled"
+          end
+          chrome_args
+        end
+
+        def create_session(session_url)
+          Bidi2pdf::Bidi::Session.new(session_url: session_url, headless: true, chrome_args: chrome_args)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.add_setting :chromedriver_container, default: nil
+
+  config.include Bidi2pdf::TestHelpers::Testcontainers::ChromedriverTestHelper, chromedriver: true
+  config.include Bidi2pdf::TestHelpers::Testcontainers::SessionTestHelper, session: true
+
+  config.before(:suite) do
+    if chromedriver_tests_present?
+      config.chromedriver_container = start_chromedriver_container(
+        build_dir: File.join(config.docker_dir, ".."),
+        mounts: config.respond_to?(:chromedriver_mounts) ? config.chromedriver_mounts : {},
+        shared_network: config.shared_network
+      )
+
+      puts "🚀 chromedriver container started for tests"
+    end
+  end
+
+  config.after(:suite) do
+    stop_container config.chromedriver_container
+  end
+end
+
+def stop_container(container)
+  if container&.running?
+
+    if ENV["SHOW_CONTAINER_LOGS"]
+      puts "Container logs:"
+      logs_std, logs_error = container.logs
+
+      puts logs_error
+      puts logs_std
+    end
+
+    puts "🧹 #{container.image} stopping container..."
+    container.stop
+  end
+  container&.remove
+end
+
+def chromedriver_tests_present?
+  test_of_kind_present? :chromedriver
+end
+
+def test_of_kind_present?(type)
+  RSpec.world.filtered_examples.values.flatten.any? { |example| example.metadata[type] }
+end
+
+# alias the long class name
+ChromedriverTestcontainer = Bidi2pdf::TestHelpers::Testcontainers::ChromedriverContainer
+
+def start_chromedriver_container(build_dir:, mounts:, shared_network:)
+  container = ChromedriverTestcontainer.new(ChromedriverTestcontainer::DEFAULT_IMAGE,
+                                            build_dir: build_dir,
+                                            docker_file: "docker/Dockerfile.chromedriver")
+                                       .with_network(shared_network)
+                                       .with_network_aliases("remote-chrome")
+
+  container.with_filesystem_binds(mounts) if mounts&.any?
+
+  container.start
+
+  container
+end

data/lib/bidi2pdf/test_helpers/testcontainers/shared_docker_network.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.add_setting :shared_network, default: nil
+
+  config.before(:suite) do
+    examples = RSpec.world.filtered_examples.values.flatten
+    uses_containers = examples.any? do |ex|
+      ex.metadata[:nginx] || ex.metadata[:chrome] || ex.metadata[:chromedriver] || ex.metadata[:container]
+    end
+
+    if uses_containers
+      config.shared_network = Docker::Network.create("bidi2pdf-test-net-#{SecureRandom.hex(4)}")
+      puts "🕸️  started shared network #{config.shared_network}"
+    end
+  end
+
+  config.after(:suite) do
+    config.shared_network&.remove
+  end
+end

data/lib/bidi2pdf/test_helpers/testcontainers/testcontainers_refinement.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module TestHelpers
+    module TestcontainersRefinement
+      def id
+        @_id
+      end
+
+      def aliases
+        @aliases ||= []
+      end
+
+      def aliases=(aliases)
+        @aliases = aliases
+      end
+
+      def network
+        @_network
+      end
+
+      def with_network(network)
+        @_network = network
+        self
+      end
+
+      def with_network_aliases(*aliases)
+        self.aliases += aliases
+        self
+      end
+
+      def _container_create_options
+        opts = super
+        network_name = network ? network.info["Name"] : nil
+        opts["HostConfig"]["NetworkMode"] = network_name
+
+        if network && aliases.any?
+          opts["NetworkingConfig"] = {
+            "EndpointsConfig" => {
+              network_name => {
+                "Aliases" => aliases
+              }
+            }
+          }
+        end
+
+        opts.compact
+      end
+    end
+  end
+end
+
+Testcontainers::DockerContainer.prepend(Bidi2pdf::TestHelpers::TestcontainersRefinement)

data/lib/bidi2pdf/test_helpers/testcontainers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+%w[docker testcontainers].each do |dep|
+  require dep
+rescue LoadError
+  warn "Missing #{dep}. Add it to your Gemfile if you're using Bidi2pdf test helpers."
+end
+
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+      require_relative "testcontainers/testcontainers_refinement"
+      require_relative "testcontainers/chromedriver_container"
+      require_relative "testcontainers/chromedriver_test_helper"
+    end
+  end
+end

data/lib/bidi2pdf/test_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+%w[pdf-reader diff-lcs unicode_utils].each do |dep|
+  require dep
+rescue LoadError
+  warn "Missing #{dep}. Add it to your Gemfile if you're using Bidi2pdf test helpers."
+end
+
+require "bidi2pdf/test_helpers/pdf_text_sanitizer"
+require "bidi2pdf/test_helpers/pdf_reader_utils"
+require "bidi2pdf/test_helpers/matchers/match_pdf_text"
+require "bidi2pdf/test_helpers/matchers/contains_pdf_text"
+require "bidi2pdf/test_helpers/matchers/have_pdf_page_count"

data/lib/bidi2pdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bidi2pdf
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

data/lib/bidi2pdf.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "concurrent-ruby"
+require "logger"
+
 require_relative "bidi2pdf/process_tree"
 require_relative "bidi2pdf/launcher"
 require_relative "bidi2pdf/bidi/session"
@@ -8,8 +11,6 @@ require_relative "bidi2pdf/notifications"
 require_relative "bidi2pdf/notifications/logging_subscriber"
 require_relative "bidi2pdf/verbose_logger"
 
-require "logger"
-
 module Bidi2pdf
   PAPER_FORMATS_CM = {
     letter: { width: 21.59, height: 27.94 },
@@ -33,7 +34,16 @@ module Bidi2pdf
 
   class ClientError < WebsocketError; end
 
-  class CmdError < ClientError; end
+  class CmdError < ClientError
+    attr_reader :cmd, :response
+
+    def initialize(cmd, response)
+      @cmd = cmd
+      @response = response
+
+      super("Error response: #{response["error"]} #{cmd.inspect}")
+    end
+  end
 
   class CmdResponseNotStoredError < ClientError; end
 
@@ -55,6 +65,25 @@ module Bidi2pdf
     end
   end
 
+  class NavigationError < Error; end
+
+  class NavigationAuthError < NavigationError
+    attr_reader :url
+
+    def initialize(url, message = nil)
+      @url = url
+      super("Navigation to #{url} failed due to authentication error. #{message}")
+    end
+  end
+
+  class NavigationTimeoutError < NavigationError; end
+
+  class NavigationNotFoundError < NavigationError; end
+
+  class NavigationDNSError < NavigationError; end
+
+  # Global configuration for Bidi2pdf
+
   class << self
     attr_accessor :default_timeout, :enable_default_logging_subscriber
     attr_reader :logging_subscriber, :logger, :network_events_logger, :browser_console_logger, :notification_service

data/sig/bidi2pdf/bidi/event_manager.rbs

@@ -1,29 +1,35 @@
 module Bidi2pdf
   module Bidi
     class EventManager
-      @browser: Bidi2pdf::Bidi::Browser
-      @listeners: Hash[String, Array[Proc]]
-      @active: bool
+      class Listener
+        attr_reader block: untyped
+        attr_reader id: String
 
-      def initialize: (browser: Bidi2pdf::Bidi::Browser) -> void
+        def initialize: (untyped block, ?String id) -> void
 
-      def on: (String event_name) { (Hash[String, untyped]) -> void } -> void
+        def call: (*untyped args) -> untyped
 
-      def off: (String event_name) -> void
+        def ==: (untyped other) -> bool
 
-      def emit: (String event_name, Hash[String, untyped] params) -> void
+        def eql?: (untyped other) -> bool
 
-      def start_listening: () -> void
+        def hash: () -> Integer
+      end
 
-      def stop_listening: () -> void
+      @listeners: untyped
+      @type: untyped
 
-      private
+      attr_reader type: untyped
 
-      def register_browser_events: () -> void
+      def initialize: (untyped type) -> void
 
-      def handle_event: (String event_name, Hash[String, untyped] params) -> void
+      def on: (*untyped event_names, &untyped block) -> Listener
 
-      def process_event: (String event_name, Hash[String, untyped] params) -> void
+      def off: (untyped event_name, Listener listener) -> void
+
+      def dispatch: (untyped event_name, *untyped args) -> void
+
+      def clear: (?untyped event_name) -> void
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bidi2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Dieter S.
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -38,6 +37,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -379,6 +398,7 @@ files:
 - lib/bidi2pdf/bidi/interceptor.rb
 - lib/bidi2pdf/bidi/js_logger_helper.rb
 - lib/bidi2pdf/bidi/logger_events.rb
+- lib/bidi2pdf/bidi/navigation_failed_events.rb
 - lib/bidi2pdf/bidi/network_event.rb
 - lib/bidi2pdf/bidi/network_event_formatters.rb
 - lib/bidi2pdf/bidi/network_event_formatters/network_event_console_formatter.rb
@@ -398,6 +418,17 @@ files:
 - lib/bidi2pdf/notifications/logging_subscriber.rb
 - lib/bidi2pdf/process_tree.rb
 - lib/bidi2pdf/session_runner.rb
+- lib/bidi2pdf/test_helpers.rb
+- lib/bidi2pdf/test_helpers/matchers/contains_pdf_text.rb
+- lib/bidi2pdf/test_helpers/matchers/have_pdf_page_count.rb
+- lib/bidi2pdf/test_helpers/matchers/match_pdf_text.rb
+- lib/bidi2pdf/test_helpers/pdf_reader_utils.rb
+- lib/bidi2pdf/test_helpers/pdf_text_sanitizer.rb
+- lib/bidi2pdf/test_helpers/testcontainers.rb
+- lib/bidi2pdf/test_helpers/testcontainers/chromedriver_container.rb
+- lib/bidi2pdf/test_helpers/testcontainers/chromedriver_test_helper.rb
+- lib/bidi2pdf/test_helpers/testcontainers/shared_docker_network.rb
+- lib/bidi2pdf/test_helpers/testcontainers/testcontainers_refinement.rb
 - lib/bidi2pdf/verbose_logger.rb
 - lib/bidi2pdf/version.rb
 - sig/bidi2pdf.rbs
@@ -456,7 +487,6 @@ metadata:
   source_code_uri: https://github.com/dieter-medium/bidi2pdf
   changelog_uri: https://github.com/dieter-medium/bidi2pdf/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -471,8 +501,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: A Ruby gem that generates PDFs from web pages using Chrome's BiDi protocol,
   providing high-quality PDF documents from any URL with full support for modern web