bidi2pdf 0.1.3 → 0.1.5

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CreateTab < CreateWindow
+        def type = "tab"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CreateWindow
+        include Base
+
+        def initialize(user_context_id: nil, reference_context: nil, background: false)
+          @user_context_id = user_context_id
+          @reference_context = reference_context
+          @background = background
+        end
+
+        def method_name
+          "browsingContext.create"
+        end
+
+        def params
+          {
+            type: type,
+            userContext: @user_context_id,
+            referenceContext: @reference_context,
+            background: @background
+          }.compact
+        end
+
+        def type = "window"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class GetUserContexts
+        include Base
+
+        def method_name
+          "browser.getUserContexts"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class NetworkContinue
+        include Base
+
+        attr_reader :request, :headers
+
+        def initialize(request:, headers:)
+          @headers = headers
+          @request = request
+        end
+
+        def method_name
+          "network.continueRequest"
+        end
+
+        def params
+          {
+            request: request,
+            headers: headers
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      # Validates parameters for the BiDi method `browsingContext.print`.
+      #
+      # Allowed structure of the params hash:
+      #
+      # {
+      #   background: Boolean (optional, default: false) – print background graphics,
+      #   margin: {
+      #     top: Float >= 0.0 (optional, default: 1.0),
+      #     bottom: Float >= 0.0 (optional, default: 1.0),
+      #     left: Float >= 0.0 (optional, default: 1.0),
+      #     right: Float >= 0.0 (optional, default: 1.0)
+      #   },
+      #   orientation: "portrait" or "landscape" (optional, default: "portrait"),
+      #   page: {
+      #     width: Float >= 0.0352 (optional, default: 21.59),
+      #     height: Float >= 0.0352 (optional, default: 27.94)
+      #   },
+      #   pageRanges: Array of Integers or Strings (optional),
+      #   scale: Float between 0.1 and 2.0 (optional, default: 1.0),
+      #   shrinkToFit: Boolean (optional, default: true)
+      # }
+      #
+      # This validator checks presence, types, allowed ranges, and values,
+      # and raises ArgumentError with a descriptive message if validation fails.
+      class PrintParametersValidator
+        def self.validate!(params)
+          new(params).validate!
+        end
+
+        def initialize(params)
+          @params = params
+        end
+
+        def validate!
+          raise ArgumentError, "params must be a Hash" unless @params.is_a?(Hash)
+
+          validate_boolean(:background)
+          validate_boolean(:shrinkToFit)
+          validate_orientation
+          validate_scale
+          validate_page_ranges
+          validate_margin
+          validate_page_size
+
+          true
+        end
+
+        private
+
+        def validate_boolean(key)
+          return unless @params.key?(key)
+          return if [true, false].include?(@params[key])
+
+          raise ArgumentError, ":#{key} must be a boolean"
+        end
+
+        def validate_orientation
+          return unless @params.key?(:orientation)
+          return if %w[portrait landscape].include?(@params[:orientation])
+
+          raise ArgumentError, ":orientation must be 'portrait' or 'landscape'"
+        end
+
+        def validate_scale
+          return unless @params.key?(:scale)
+
+          scale = @params[:scale]
+          return if scale.is_a?(Numeric) && scale >= 0.1 && scale <= 2.0
+
+          raise ArgumentError, ":scale must be a number between 0.1 and 2.0"
+        end
+
+        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) }
+            raise ArgumentError, ":pageRanges must be an array of integers or strings"
+          end
+        end
+
+        def validate_margin
+          return unless @params.key?(:margin)
+
+          margin = @params[:margin]
+          raise ArgumentError, ":margin must be a Hash" unless margin.is_a?(Hash)
+
+          %i[top bottom left right].each do |side|
+            next unless margin.key?(side)
+
+            val = margin[side]
+            raise ArgumentError, "margin[:#{side}] must be a float >= 0.0" unless val.is_a?(Numeric) && val >= 0.0
+          end
+        end
+
+        def validate_page_size
+          return unless @params.key?(:page)
+
+          page = @params[:page]
+          raise ArgumentError, ":page must be a Hash" unless page.is_a?(Hash)
+
+          %i[width height].each do |dim|
+            next unless page.key?(dim)
+
+            val = page[dim]
+            raise ArgumentError, "page[:#{dim}] must be a float >= 0.0352" unless val.is_a?(Numeric) && val >= 0.0352
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class ProvideCredentials
+        include Base
+
+        def initialize(request:, username:, password:)
+          @request = request
+          @username = username
+          @password = password
+        end
+
+        def params
+          {
+            request: @request,
+            action: "provideCredentials",
+            credentials: {
+              type: "password",
+              username: @username,
+              password: @password
+            }
+          }
+        end
+
+        def method_name
+          "network.continueWithAuth"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class ScriptEvaluate
+        include Base
+
+        def initialize(expression:,
+                       context:,
+                       await_promise: true)
+          @expression = expression
+          @context = context
+          @await_promise = await_promise
+        end
+
+        def params
+          {
+            expression: @expression,
+            target: {
+              context: @context
+            },
+            awaitPromise: @await_promise
+          }
+        end
+
+        def method_name
+          "script.evaluate"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionEnd
+        include Base
+
+        def method_name
+          "session.end"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionStatus
+        include Base
+
+        def method_name
+          "session.status"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionSubscribe
+        include Base
+
+        attr_reader :events
+
+        def initialize(events:)
+          @events = events
+        end
+
+        def method_name
+          "session.subscribe"
+        end
+
+        def params
+          { events: events }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SetTabCookie
+        include Base
+
+        class << self
+          attr_writer :time_provider
+
+          def time_provider
+            @time_provider ||= -> { Time.now }
+          end
+        end
+
+        attr_reader :name, :value, :domain, :path, :secure, :http_only, :same_site, :ttl, :browsing_context_id
+
+        def initialize(name:,
+                       value:,
+                       domain:,
+                       browsing_context_id:,
+                       path: "/",
+                       secure: true,
+                       http_only: false,
+                       same_site: "strict",
+                       ttl: 30)
+          @name = name
+          @value = value
+          @domain = domain
+          @path = path
+          @secure = secure
+          @http_only = http_only
+          @same_site = same_site
+          @ttl = ttl
+          @browsing_context_id = browsing_context_id
+        end
+
+        def expiry
+          self.class.time_provider.call.to_i + ttl
+        end
+
+        def method_name
+          "storage.setCookie"
+        end
+
+        def params
+          {
+            cookie: {
+              name: name,
+              value: {
+                type: "string",
+                value: value
+              },
+              domain: domain,
+              path: path,
+              secure: secure,
+              httpOnly: http_only,
+              sameSite: same_site,
+              expiry: expiry
+            },
+            partition: {
+              type: "context",
+              context: browsing_context_id
+            }
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SetUsercontextCookie < SetTabCookie
+        include Base
+
+        attr_reader :user_context_id, :source_origin
+
+        def initialize(name:,
+                       value:,
+                       domain:,
+                       user_context_id:,
+                       source_origin:,
+                       path: "/",
+                       secure: true,
+                       http_only: false,
+                       same_site: "strict",
+                       ttl: 30)
+          super(name: name, value: value,
+                domain: domain,
+                path: path,
+                secure: secure,
+                http_only: http_only,
+                same_site: same_site,
+                ttl: ttl,
+                browsing_context_id: nil)
+
+          @user_context_id = user_context_id
+          @source_origin = source_origin
+        end
+
+        def expiry
+          Time.now.to_i + ttl
+        end
+
+        def method_name
+          "storage.setCookie"
+        end
+
+        def params
+          {
+            cookie: {
+              name: name,
+              value: {
+                type: "string",
+                value: value
+              },
+              domain: domain,
+              path: path,
+              secure: secure,
+              httpOnly: http_only,
+              sameSite: same_site,
+              expiry: expiry
+            },
+            partition: {
+              type: "storageKey",
+              userContext: user_context_id,
+              sourceOrigin: source_origin
+            }
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      require_relative "commands/base"
+      require_relative "commands/create_window"
+      require_relative "commands/create_tab"
+      require_relative "commands/add_intercept"
+      require_relative "commands/set_tab_cookie"
+      require_relative "commands/set_usercontext_cookie"
+      require_relative "commands/session_status"
+      require_relative "commands/get_user_contexts"
+      require_relative "commands/script_evaluate"
+      require_relative "commands/browser_create_user_context"
+      require_relative "commands/browser_close"
+      require_relative "commands/browsing_context_close"
+      require_relative "commands/browsing_context_navigate"
+      require_relative "commands/browsing_context_print"
+      require_relative "commands/session_subscribe"
+      require_relative "commands/session_end"
+      require_relative "commands/cancel_auth"
+      require_relative "commands/network_continue"
+      require_relative "commands/provide_credentials"
+    end
+  end
+end

data/lib/bidi2pdf/bidi/connection_manager.rb

@@ -6,28 +6,31 @@ module Bidi2pdf
       def initialize(logger:)
         @logger = logger
         @connected = false
-        @mutex = Mutex.new
-        @cv = ConditionVariable.new
+        @connection_queue = Thread::Queue.new
       end
 
       def mark_connected
-        @mutex.synchronize do
-          @connected = true
-          @cv.broadcast
-        end
+        return if @connected
+
+        @connected = true
+        @logger.debug "WebSocket connection is open"
+        @connection_queue.push(true)
       end
 
       def wait_until_open(timeout:)
-        @mutex.synchronize do
-          unless @connected
-            @logger.debug "Waiting for WebSocket connection to open"
-            @cv.wait(@mutex, timeout)
+        return true if @connected
+
+        @logger.debug "Waiting for WebSocket connection to open"
+
+        begin
+          Timeout.timeout(timeout) do
+            @connection_queue.pop
           end
+        rescue Timeout::Error
+          raise Bidi2pdf::WebsocketError, "WebSocket connection did not open in time #{timeout} sec."
         end
 
-        raise "WebSocket connection did not open in time" unless @connected
-
-        @logger.debug "WebSocket connection is open"
+        true
       end
     end
   end

data/lib/bidi2pdf/bidi/event_manager.rb

@@ -39,6 +39,8 @@ module Bidi2pdf
         end
       end
 
+      private
+
       def log_msg(prefix, data)
         message = truncate_large_values(data)
         Bidi2pdf.logger.debug "#{prefix}: #{message.inspect}"

data/lib/bidi2pdf/bidi/interceptor.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Interceptor
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def phases = raise(NotImplementedError, "Interceptors must implement phases")
+
+        def events = raise(NotImplementedError, "Interceptors must implement events")
+      end
+
+      def url_patterns = raise(NotImplementedError, "Interceptors must implement url_patterns")
+
+      def context = raise(NotImplementedError, "Interceptors must implement context")
+
+      def process_interception(_event_response, _navigation_id, _network_id, _url) = raise(NotImplementedError, "Interceptors must implement process_interception")
+
+      def register_with_client(client:)
+        @client = client
+
+        cmd = Bidi2pdf::Bidi::Commands::AddIntercept.new context: context, phases: self.class.phases, url_patterns: url_patterns
+
+        client.send_cmd_and_wait(cmd) do |response|
+          @interceptor_id = response["result"]["intercept"]
+
+          Bidi2pdf.logger.debug "Interceptor added: #{@interceptor_id}"
+
+          client.on_event(*self.class.events, &method(:handle_event))
+
+          self
+        end
+      end
+
+      # rubocop: disable Metrics/AbcSize
+      def handle_event(response)
+        event_response = response["params"]
+
+        return unless event_response["intercepts"]&.include?(interceptor_id) && event_response["isBlocked"]
+
+        navigation_id = event_response["navigation"]
+        network_id = event_response["request"]["request"]
+        url = event_response["request"]["url"]
+
+        # Log the interception
+        Bidi2pdf.logger.debug "Interceptor #{interceptor_id} handling event: #{navigation_id}/#{network_id}/#{url}"
+
+        process_interception(event_response, navigation_id, network_id, url)
+      rescue StandardError => e
+        Bidi2pdf.logger.error "Error handling event: #{e.message}"
+        Bidi2pdf.logger.error e.backtrace.join("\n")
+        raise e
+      end
+
+      # rubocop: enable Metrics/AbcSize
+
+      def interceptor_id
+        @interceptor_id
+      end
+
+      def client
+        @client
+      end
+
+      def validate_phases!
+        valid_phases = [Phases::BEFORE_REQUEST, Phases::RESPONSE_STARTED, Phases::AUTH_REQUIRED]
+
+        raise ArgumentError, "Unsupported phase(s): #{self.class.phases}" unless self.class.phases.all? { |phase| valid_phases.include?(phase) }
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/network_events.rb

@@ -68,7 +68,6 @@ module Bidi2pdf
           end
 
           if Time.now - start_time > timeout
-            # rubocop:disable Layout/LineLength
             Bidi2pdf.logger.warn "⏰ Timeout while waiting for network events to complete. Still in progress: #{in_progress.map(&:id)}"
             # rubocop:enable Layout/LineLength
             break