bidi2pdf 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc473cb8b54517914bfa958b1925d97db54ab3e6ee640a28101b48346077192
-  data.tar.gz: 76c2d11f399a33a932f66348cfc3aad9d0c80f1e15407566b10d16a646b17d1c
+  metadata.gz: f132ccc5d9db5bb621f7e1a0adfa4150b77b4618542ba27873a602cf9c342a40
+  data.tar.gz: f3df228dc1de555d14baad4347a1b5b8d0bc8b63f88d6adfbcec86f0da571703
 SHA512:
-  metadata.gz: eb72b6bc4eeb2a65172c37138be3f2af5129a046a217acaf90236532c323547e0f1456f7743c509015808389da586b145cd069a26a85bbc35278c44cfea32249
-  data.tar.gz: e3b6d68003a6419e86fa33a68b51c065d7d60f95cc7bf657b12cb13ed5bef085938599b5387aca641b1a699ec47fab6804e300892b962a842d06748b061a1e5d
+  metadata.gz: d74e6e1b505493d47f66c2f1cb4d13bc07aacfa82dbba536439e3b458395bbcd7213103e5fbed167a65945af28bbfb239f6510e93bed2838fa583b95352df8d6
+  data.tar.gz: '096bb337a61db6d5392ba64c38bf4632695ca647b2fe95a227f3d56b189241cae1b19cc65e98115dff73997bb3df1cdcc2821058611683aa449acd11db4fe66f'

data/.rubocop.yml

@@ -20,11 +20,29 @@ RSpec/ExampleLength:
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Layout/BeginEndAlignment:
+  Enabled: false
+
+Layout/ArrayAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
 
 RSpec/MultipleMemoizedHelpers:
   Max: 10
@@ -48,6 +66,16 @@ RSpec/InstanceVariable:
 RSpec/BeforeAfterAll:
   Enabled: false
 
+RSpec/SpecFilePathFormat:
+  Enabled: true
+  Exclude:
+    - 'spec/acceptance/**/*_spec.rb'
+
+RSpec/DescribeClass:
+  Enabled: true
+  Exclude:
+    - 'spec/acceptance/**/*_spec.rb'
+
 plugins:
   - rubocop-rake
   - rubocop-rspec

data/CHANGELOG.md

@@ -6,8 +6,44 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+[unreleased]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.4..HEAD
+
 <!-- generated by git-cliff end -->
 
+## [0.1.4] - 2025-04-10
+
+### 🎨 Refactored
+
+- Modularize browser commands and remove redundancy by @dieter-medium
+- Implement interceptor validation and unit tests by @dieter-medium
+- Connection handling in ConnectionManager by @dieter-medium
+- Interceptors to enforce common interface methods by @dieter-medium
+- Interceptors to simplify client responsibilities by @dieter-medium
+- Enhance error handling and modularize interceptors by @dieter-medium
+
+### 🐛 Fixed
+
+- Resolve race condition between event subscription and emission by @dieter-medium
+- Close custom session on stop function by @dieter-medium
+- Add custom error classes for session management and improve error handling and testability by @dieter-medium
+- Add Chromedriver container support and helper methods for RSpec integration by @dieter-medium
+
+### 🔄 Changed
+
+- Enhance command manager with response handling by @dieter-medium
+
+### 🚀 Added
+
+- Add randomization to user data directory path by @dieter-medium
+- Introduce command abstraction for improved modularity by @dieter-medium
+
+## [0.1.3] - 2025-04-06
+
+### 🐛 Fixed
+
+- Improve zombie process detection and termination logic in Chromedriver manager by @dieter-medium
+- Add close method for WebSocket connection and update session close logic. Don't leak threads. by @dieter-medium
+
 ## [0.1.2] - 2025-04-05
 
 ### 🔄 Changed

data/cliff.toml

@@ -79,33 +79,57 @@ commit_preprocessors = [
 ]
 # regex for parsing and grouping commits
 commit_parsers = [
-    # ✅ Additions
-      { message = "^[a|A]dd", group = "🚀 Added" },
-      { message = "^[s|S]upport", group = "🚀 Added" },
-      { message = "^.*: add", group = "🚀 Added" },
-      { message = "^.*: support", group = "🚀 Added" },
-
-      # ❌ Removals
-      { message = "^[r|R]emove", group = "🗑️ Removed" },
-      { message = "^.*: remove", group = "🗑️ Removed" },
-      { message = "^.*: delete", group = "🗑️ Removed" },
-
-      # 🐛 Fixes
-      { message = "^test", group = "🐛 Fixed" },
-      { message = "^fix", group = "🐛 Fixed" },
-      { message = "^.*: fix", group = "🐛 Fixed" },
-
-      # ⛔️ Chore & CI commits to skip
-      { message = "^chore\\(release\\): prepare for", skip = true },
-      { message = "^chore\\(deps.*\\)", skip = true },
-      { message = "^chore\\(pr\\)", skip = true },
-      { message = "^chore\\(pull\\)", skip = true },
-      { message = "^chore", skip = true },
-      { message = "^ci", skip = true },
-
-      # 🌀 Catch-All
-      { message = "^.*", group = "🔄 Changed" }
+    # ✅ Features (additions)
+    { message = "^feat(?:\\([^)]+\\))?!?:", group = "🚀 Added" },
+    { message = "^[aA]dd", group = "🚀 Added" },
+    { message = "^[sS]upport", group = "🚀 Added" },
+
+    # ❌ Removals
+    { message = "^[rR]emove", group = "🗑️ Removed" },
+    { message = "^[dD]elete", group = "🗑️ Removed" },
+
+    # 🐛 Fixes
+    { message = "^fix(?:\\([^)]+\\))?!?:", group = "🐛 Fixed" },
+    { message = "^[tT]est", group = "🐛 Fixed" },
+    { message = "^[fF]ix", group = "🐛 Fixed" },
+
+    # 🎨 Refactors
+    { message = "^refactor(?:\\([^)]+\\))?!?:", group = "🎨 Refactored" },
+
+    # ⚡️ Performance
+    { message = "^perf(?:\\([^)]+\\))?!?:", group = "⚡️ Performance" },
+
+    # 📝 Docs
+    { message = "^docs(?:\\([^)]+\\))?!?:", group = "📝 Docs" },
+
+    # 💄 Style (formatting, whitespace, etc.)
+    { message = "^style(?:\\([^)]+\\))?!?:", group = "💄 Style" },
+
+    # 🧪 Tests
+    { message = "^test(?:\\([^)]+\\))?!?:", group = "🧪 Tests" },
+
+    # 🔧 Build
+    { message = "^build(?:\\([^)]+\\))?!?:", group = "🔧 Build" },
+
+    # 🛠️ CI
+    { message = "^ci(?:\\([^)]+\\))?!?:", skip = true },
+
+    # 🧹 Chores (skip)
+    { message = "^chore\\(release\\): prepare for", skip = true },
+    { message = "^chore\\(deps.*\\)", skip = true },
+    { message = "^chore\\(pr\\)", skip = true },
+    { message = "^chore\\(pull\\)", skip = true },
+    { message = "^chore(?:\\([^)]+\\))?!?:", skip = true },
+    { message = "^\\s*chore", skip = true },
+
+    # ⏪ Reverts
+    { message = "^revert(?:\\([^)]+\\))?!?:", group = "⏪ Reverted" },
+
+    # 🌀 Catch-all (only if nothing else matched)
+    { message = "^.*", group = "🔄 Changed" }
 ]
+
+
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
 # sort the tags topologically

data/docker/Dockerfile.chromedriver

@@ -1,5 +1,7 @@
 FROM ruby:3.3
 
+ARG CHROMEDRIVER_PORT=3000
+
 # Install dependencies
 RUN apt-get update && \
     apt-get install -y \
@@ -30,4 +32,7 @@ USER appuser
 
 RUN gem install chromedriver-binary && ruby -e 'require "chromedriver/binary"; puts Chromedriver::Binary::ChromedriverDownloader.update'
 
+ENV CHROMEDRIVER_PORT=${CHROMEDRIVER_PORT}
+EXPOSE ${CHROMEDRIVER_PORT}
+
 CMD ["/usr/local/bin/entrypoint.sh"]

data/docker/entrypoint.sh

@@ -1,3 +1,13 @@
 #!/bin/bash
 
-/home/appuser/.webdrivers/chromedriver --port=3000 --headless --whitelisted-ips="" --allowed-origins="*" --disable-dev-shm-usage --verbose
+USER_DATA_DIR=/home/appuser/.cache
+mkdir -p ${USER_DATA_DIR}
+
+/home/appuser/.webdrivers/chromedriver --port=${CHROMEDRIVER_PORT} \
+                                       --headless \
+                                       --whitelisted-ips="" \
+                                       --allowed-origins="*" \
+                                       --disable-dev-shm-usage \
+                                       --disable-gpu \
+                                       --user-data-dir=${USER_DATA_DIR} \
+                                       --verbose

data/docker/nginx/default.conf

@@ -39,4 +39,10 @@ server {
              return 403;
          }
     }
+
+    location /nginx_status {
+        stub_status on;
+
+        access_log off;
+    }
 }

data/lib/bidi2pdf/bidi/add_headers_interceptor.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
+require_relative "interceptor"
+
 module Bidi2pdf
   module Bidi
     class AddHeadersInterceptor
-      attr_reader :id, :headers
+      include Interceptor
+
+      class << self
+        def phases = [Bidi2pdf::Bidi::Commands::AddIntercept::BEFORE_REQUEST]
+
+        def events = ["network.beforeRequestSent"]
+      end
+
+      attr_reader :headers, :url_patterns, :context
 
-      def initialize(id, headers:, client:)
-        @id = id
-        @client = client
+      def initialize(headers:, url_patterns:, context:)
         @headers = headers.map do |header|
           {
             name: header[:name],
@@ -17,26 +25,15 @@ module Bidi2pdf
             }
           }
         end
-      end
 
-      def handle_event(response)
-        event_response = response["params"]
-
-        return unless event_response["intercepts"]&.include?(id) && event_response["isBlocked"]
-
-        network_id = event_response["request"]["request"]
-
-        Bidi2pdf.logger.debug "Interceptor #{id} handle event: #{network_id}"
-
-        client.send_cmd "network.continueRequest", {
-          request: network_id,
-          headers: headers
-        }
+        @url_patterns = url_patterns
+        @context = context
       end
 
-      private
-
-      attr_reader :client
+      def process_interception(_event_response, _navigation_id, network_id, _url)
+        cmd = Bidi2pdf::Bidi::Commands::NetworkContinue.new request: network_id, headers: headers
+        client.send_cmd cmd
+      end
     end
   end
 end

data/lib/bidi2pdf/bidi/auth_interceptor.rb

@@ -1,67 +1,60 @@
 # frozen_string_literal: true
 
+require_relative "interceptor"
+
 module Bidi2pdf
   module Bidi
     class AuthInterceptor
-      attr_reader :id, :username, :password, :network_ids
+      include Interceptor
+
+      class << self
+        def phases = [Bidi2pdf::Bidi::Commands::AddIntercept::AUTH_REQUIRED]
+
+        def events = ["network.authRequired"]
+      end
 
-      def initialize(id, username:, password:, client:)
-        @id = id
-        @client = client
+      attr_reader :headers, :url_patterns, :context, :username, :password, :network_ids
+
+      def initialize(username:, password:, url_patterns:, context:)
+        @url_patterns = url_patterns
+        @context = context
         @username = username
         @password = password
         @network_ids = []
       end
 
-      # rubocop:disable Metrics/AbcSize
-      def handle_event(response)
-        event_response = response["params"]
-
-        return unless event_response["intercepts"]&.include?(id) && event_response["isBlocked"]
-
-        navigation_id = event_response["navigation"]
-        network_id = event_response["request"]["request"]
-        url = event_response["request"]["url"]
-
-        handle_bad_credentials(navigation_id, network_id, url)
+      def process_interception(_event_response, navigation_id, network_id, url)
+        return if handled_bad_credentials(navigation_id, network_id, url)
 
         network_ids << network_id
 
-        Bidi2pdf.logger.debug "Auth-Interceptor #{id} handle event: #{navigation_id}/#{network_id}/#{url}"
-
-        client.send_cmd("network.continueWithAuth", {
-          request: network_id,
-          action: "provideCredentials",
-          credentials: {
-            type: "password",
-            username: username,
-            password: password
-          }
-        })
-      end
+        cmd = Bidi2pdf::Bidi::Commands::ProvideCredentials.new request: network_id, username: username, password: password
 
-      # rubocop:enable Metrics/AbcSize
+        client.send_cmd(cmd)
+      rescue StandardError => e
+        Bidi2pdf.logger.error "Error handling auth event: #{e.message}"
+        Bidi2pdf.logger.error e.backtrace.join("\n")
+        raise e
+      end
 
       private
 
-      def handle_bad_credentials(navigation_id, network_id, url)
-        return unless network_ids.include?(network_id)
+      def handled_bad_credentials(navigation_id, network_id, url)
+        return false unless network_ids.include?(network_id)
 
         network_ids.delete(network_id)
 
-        Bidi2pdf.logger.debug "Auth-Interceptor #{id} already handled event: #{navigation_id}/#{network_id}/#{url}"
+        Bidi2pdf.logger.debug "Auth-Interceptor #{interceptor_id} already handled event: #{navigation_id}/#{network_id}/#{url}"
 
-        # rubocop: disable Layout/LineLength
         Bidi2pdf.logger.error "It seems that the same request is being intercepted multiple times. Check your credentials or the URL you are trying to access. If you are using a proxy, make sure it is configured correctly."
         # rubocop: enable Layout/LineLength
 
-        client.send_cmd("network.continueWithAuth", {
-          request: network_id,
-          action: "cancel"
-        })
-      end
+        cmd = Bidi2pdf::Bidi::Commands::CancelAuth.new request: network_id
+
+        client.send_cmd(cmd)
 
-      attr_reader :client
+        true
+      end
     end
   end
 end

data/lib/bidi2pdf/bidi/browser_tab.rb

@@ -3,7 +3,8 @@
 require "base64"
 
 require_relative "network_events"
-require_relative "print_parameters_validator"
+require_relative "auth_interceptor"
+require_relative "add_headers_interceptor"
 
 module Bidi2pdf
   module Bidi
@@ -20,10 +21,8 @@ module Bidi2pdf
       end
 
       def create_browser_tab
-        client.send_cmd_and_wait("browsingContext.create", {
-          type: "tab",
-          userContext: @user_context_id
-        }) do |response|
+        cmd = Bidi2pdf::Bidi::Commands::CreateTab.new(user_context_id: user_context_id)
+        client.send_cmd_and_wait(cmd) do |response|
           tab_browsing_context_id = response["result"]["context"]
 
           BrowserTab.new(client, tab_browsing_context_id, user_context_id).tap do |tab|
@@ -43,26 +42,18 @@ module Bidi2pdf
         same_site: "strict",
         ttl: 30
       )
-        expiry = Time.now.to_i + ttl
-        client.send_cmd_and_wait("storage.setCookie", {
-          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
-          }
-        }) do |response|
+        cmd = Bidi2pdf::Bidi::Commands::SetTabCookie.new(
+          browsing_context_id: browsing_context_id,
+          name: name,
+          value: value,
+          domain: domain,
+          path: path,
+          secure: secure,
+          http_only: http_only,
+          same_site: same_site,
+          ttl: ttl
+        )
+        client.send_cmd_and_wait(cmd) do |response|
           Bidi2pdf.logger.debug "Cookie set: #{response.inspect}"
         end
       end
@@ -71,43 +62,35 @@ module Bidi2pdf
         headers:,
         url_patterns:
       )
-        client.add_headers_interceptor(
+        AddHeadersInterceptor.new(
           context: browsing_context_id,
           url_patterns: url_patterns,
           headers: headers
-        )
+        ).tap { |interceptor| interceptor.register_with_client(client: client) }
       end
 
       def basic_auth(username:, password:, url_patterns:)
-        client.add_auth_interceptor(
+        AuthInterceptor.new(
           context: browsing_context_id,
           url_patterns: url_patterns,
-          username: username,
-          password: password
-        )
+          username: username, password: password
+        ).tap { |interceptor| interceptor.register_with_client(client: client) }
       end
 
       def open_page(url)
         client.on_event("network.responseStarted", "network.responseCompleted", "network.fetchError",
                         &network_events.method(:handle_event))
 
-        client.send_cmd_and_wait("browsingContext.navigate", {
-          url: url,
-          context: browsing_context_id,
-          wait: "complete"
-        }) do |response|
+        cmd = Bidi2pdf::Bidi::Commands::BrowsingContextNavigate.new url: url, context: browsing_context_id
+
+        client.send_cmd_and_wait(cmd) do |response|
           Bidi2pdf.logger.debug "Navigated to page url: #{url} response: #{response}"
         end
       end
 
       def execute_script(script)
-        client.send_cmd_and_wait("script.evaluate", {
-          expression: script,
-          target: {
-            context: browsing_context_id
-          },
-          awaitPromise: true
-        }) do |response|
+        cmd = Bidi2pdf::Bidi::Commands::ScriptEvaluate.new context: browsing_context_id, expression: script
+        client.send_cmd_and_wait(cmd) do |response|
           Bidi2pdf.logger.debug "Script Result: #{response.inspect}"
 
           response["result"]
@@ -128,13 +111,10 @@ module Bidi2pdf
         @open = false
       end
 
-      # rubocop:disable Metrics/AbcSize
       def print(outputfile, print_options: { background: true })
-        PrintParametersValidator.validate!(print_options)
-
-        cmd_params = (print_options || {}).merge(context: browsing_context_id)
+        cmd = Bidi2pdf::Bidi::Commands::BrowsingContextPrint.new context: browsing_context_id, print_options: print_options
 
-        client.send_cmd_and_wait("browsingContext.print", cmd_params) do |response|
+        client.send_cmd_and_wait(cmd) do |response|
           if response["result"]
             pdf_base64 = response["result"]["data"]
 
@@ -152,13 +132,13 @@ module Bidi2pdf
         end
       end
 
-      # rubocop:enable Metrics/AbcSize
-
       private
 
       def close_context
-        client.send_cmd_and_wait("browsingContext.close", { context: browsing_context_id }) do |response|
-          Bidi2pdf.logger.debug "Browsing context closed: #{response}"
+        that = self
+        cmd = Bidi2pdf::Bidi::Commands::BrowsingContextClose.new context: browsing_context_id
+        client.send_cmd_and_wait(cmd) do |response|
+          Bidi2pdf.logger.info "Browsing context closed: #{that.browsing_context_id} #{response}"
         end
       end