bidi2pdf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d773a323c63404e1c8dee00d180e6f774f5b45c33e59bc759b8186d3398aeed
-  data.tar.gz: 9b3452ac73398cc6037ca3d39b792afafbd2dfd47e55e3fe0c69783627b7fc88
+  metadata.gz: a67b40e096dd2b6b73fa65cec7d9d75182b995435c17186d755f89efebb2ab26
+  data.tar.gz: fde0861d58dd30788aa1b54a24d956d3438bd83cc08a5ec9d22e6750a3e646d6
 SHA512:
-  metadata.gz: e656e92c5a4aa8a82ab3d0dde12fdf3cd4a8743ab8dd47a77d229452e5ab0127f40ed5ee84c02c190bb35aed5de7fe14696d30b22de0bc9966cdb9fd94eaf9b9
-  data.tar.gz: 57b04e9c98c91e12ccfb432d292f13186f9a92776a81847736719843dffeed1d07adab9d32dd858709aa9803b8ac476c38cbfc9a87bbed5fc6ce88efec599ecd
+  metadata.gz: 52e199c72b902e046140e6d47a9b00a8354e53a88f3af6135f0d7ab587c7d59532a904388e4a62ed4ba29c03609eab3b8c7f3aea0aa131ba8880f8ecb6f9a503
+  data.tar.gz: a83f7091a455e5c8cb5f2b7e8e621c044b2184c2c6e5a6e11aaa4f4ca2f9879ada89eb7951e7ad78e07a2d473396bb529ce5c4dfc771130a40a1977bb6e60575

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.1.1] - 2025-04-01
+
+### Added
+
+- Docker Compose setup with Nginx for authentication examples
+- Sample configurations for different authentication methods:
+    - Basic HTTP authentication
+    - Cookie-based authentication
+    - API key header authentication
+
+### Fixed
+
+- HTTP cookie handling issues
+
 ## [0.1.0] - 2025-03-26
 
 - Initial release

data/README.md

@@ -91,6 +91,27 @@ docker run -it --rm -v ./output:/reports bidi2pdf \
   bidi2pdf render --url=https://example.com --output /reports/example.pdf
 ```
 
+### Test it with docker compose
+
+```bash
+docker compose -f docker/docker-compose.yml up -d
+
+# simple example
+docker compose -f docker/docker-compose.yml exec app bidi2pdf render --url=http://nginx/sample.html --wait_window_loaded --wait_network_idle --output /reports/simple.pdf
+
+# basic auth example
+docker compose -f docker/docker-compose.yml exec app bidi2pdf render --url=http://nginx/basic/sample.html --auth admin:secret --wait_window_loaded --wait_network_idle --output /reports/basic.pdf
+
+# header example
+docker compose -f docker/docker-compose.yml exec app bidi2pdf render --url=http://nginx/header/sample.html --header "X-API-KEY=secret" --wait_window_loaded --wait_network_idle --output /reports/header.pdf
+
+# cookie example
+docker compose -f docker/docker-compose.yml exec app bidi2pdf render --url=http://nginx/cookie/sample.html --cookie "auth=secret" --wait_window_loaded --wait_network_idle --output /reports/cookie.pdf
+
+
+docker compose -f docker/docker-compose.yml down
+```
+
 ## Configuration Options
 
 | Option                 | Description                                                                                                         |

data/docker/docker-compose.yml

@@ -1 +1,18 @@
 name: bidi2pdf
+services:
+  nginx:
+    image: nginx:1.27-bookworm
+    ports:
+      - "9091:80"
+    volumes:
+      - ./nginx/default.conf:/etc/nginx/conf.d/default.conf
+      - ./nginx/htpasswd:/etc/nginx/conf.d/.htpasswd
+      - ../spec/fixtures:/var/www/html
+
+  app:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+    volumes:
+      - ../tmp/reports:/reports
+    command: tail -f /dev/null

data/docker/nginx/default.conf

@@ -0,0 +1,42 @@
+log_format with_headers_and_cookies '
+  $remote_addr - $remote_user [$time_local] "$request" '
+  'status=$status body_bytes_sent=$body_bytes_sent '
+  'cookie="$http_cookie" '
+  'ua="$http_user_agent" '
+  'referer="$http_referer" '
+  'custom-header-x="$http_x_custom_header" ';
+
+server {
+   # error_log /var/log/nginx/error.log debug;
+   access_log /var/log/nginx/access.log with_headers_and_cookies;
+
+    location / {
+        root /var/www/html;
+    }
+
+    location /basic {
+        alias /var/www/html;
+        try_files $uri $uri/ =404;
+
+        auth_basic "Restricted Area";
+        auth_basic_user_file /etc/nginx/conf.d/.htpasswd;
+    }
+
+    location /cookie {
+         alias /var/www/html;
+         try_files $uri $uri/ =404;
+
+         if ($cookie_auth != "secret") {
+             return 403;
+         }
+    }
+
+    location /header {
+         alias /var/www/html;
+         try_files $uri $uri/ =404;
+
+         if ($http_x_api_key != "secret") {
+             return 403;
+         }
+    }
+}

data/docker/nginx/htpasswd

@@ -0,0 +1 @@
+admin:$apr1$wwl1dIH7$Pm2PaGHWNnXhCoLzD1gr2/

data/lib/bidi2pdf/chromedriver_manager.rb

@@ -42,6 +42,8 @@ module Bidi2pdf
 
       term_chromedriver
 
+      detect_zombie_processes
+
       return unless process_alive?
 
       kill_chromedriver timeout: timeout
@@ -51,6 +53,33 @@ module Bidi2pdf
 
     private
 
+    # rubocop:disable Metrics/AbcSize
+    def detect_zombie_processes
+      debug_show_all_children
+
+      child_processes = Bidi2pdf::ProcessTree.new(@pid).children(@pid)
+      Bidi2pdf.logger.debug "Found child processes: #{child_processes.map(&:pid).join(", ")}"
+
+      zombie_processes = child_processes.select { |child| process_alive? child.pid }
+
+      return if zombie_processes.empty?
+
+      printable_zombie_processes = zombie_processes.map { |child| "#{child.name}:#{child.pid}" }
+      printable_zombie_processes_str = printable_zombie_processes.join(", ")
+
+      Bidi2pdf.logger.error "Zombie Processes detected #{printable_zombie_processes_str}"
+    end
+
+    # rubocop:enable Metrics/AbcSize
+
+    def debug_show_all_children
+      Bidi2pdf::ProcessTree.new(@pid).traverse do |process, level|
+        indent = "  " * level
+        prefix = level.zero? ? "" : "└─ "
+        Bidi2pdf.logger.debug "#{indent}#{prefix}PID #{process.pid} (#{process.name})"
+      end
+    end
+
     def close_session
       Bidi2pdf.logger.info "Closing session"
 
@@ -126,8 +155,8 @@ module Bidi2pdf
 
     # rubocop: enable Metrics/AbcSize
 
-    def process_alive?
-      return false unless @pid
+    def process_alive?(pid = @pid)
+      return false unless pid
 
       begin
         Process.waitpid(@pid, Process::WNOHANG)

data/lib/bidi2pdf/process_tree.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "sys/proctable"
+module Bidi2pdf
+  class ProcessTree
+    include Sys
+
+    def initialize(root_pid = nil)
+      @root_pid = root_pid
+      @process_map = build_process_map
+      connect_children
+    end
+
+    def children(of_pid)
+      return [] unless @process_map[of_pid]
+
+      direct_children = @process_map[of_pid][:children].map do |child_pid|
+        @process_map[child_pid][:info]
+      end
+
+      (direct_children + direct_children.flat_map { |child| children(child.pid) }).uniq
+    end
+
+    def traverse(&handler)
+      handler = method(:print_handler) unless handler.is_a?(Proc)
+
+      root_pids.each { |pid| traverse_branch(pid, &handler) }
+    end
+
+    private
+
+    def print_handler(process, level)
+      indent = "  " * level
+      prefix = level.zero? ? "" : "└─ "
+      puts "#{indent}#{prefix}PID #{process.pid} (#{process.name})"
+    end
+
+    def build_process_map
+      ProcTable.ps.each_with_object({}) do |process, map|
+        map[process.pid] = { info: process, children: [] }
+      end
+    end
+
+    def connect_children
+      @process_map.each_value do |entry|
+        parent_pid = entry[:info].ppid
+        @process_map[parent_pid][:children] << entry[:info].pid if parent_pid && @process_map.key?(parent_pid)
+      end
+    end
+
+    def root_pids
+      return [@root_pid] if @root_pid
+
+      @process_map.values
+                  .select { |entry| entry[:info].ppid.nil? || !@process_map.key?(entry[:info].ppid) }
+                  .map { |entry| entry[:info].pid }
+    end
+
+    def traverse_branch(pid, level = 0, &handler)
+      return unless @process_map[pid]
+
+      process = @process_map[pid][:info]
+
+      handler.call(process, level)
+
+      @process_map[pid][:children].each do |child_pid|
+        traverse_branch(child_pid, level + 1, &handler)
+      end
+    end
+  end
+end

data/lib/bidi2pdf/session_runner.rb

@@ -29,25 +29,25 @@ module Bidi2pdf
       browser = @session.browser
       user_context = browser.create_user_context
 
-      add_cookies(user_context)
-
       window = user_context.create_browser_window
       tab = window.create_browser_tab
 
       @window = window
       @tab = tab
 
+      add_cookies(tab)
+
       add_headers
       add_basic_auth
     end
 
-    def add_cookies(user_context)
+    def add_cookies(tab)
       @cookies.each do |name, value|
-        user_context.set_cookie(
+        tab.set_cookie(
           name: name,
           value: value,
           domain: domain,
-          source_origin: source_origin
+          secure: uri.scheme == "https"
         )
       end
     end

data/lib/bidi2pdf/version.rb

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

data/lib/bidi2pdf.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "bidi2pdf/utils"
+require_relative "bidi2pdf/process_tree"
 require_relative "bidi2pdf/launcher"
 require_relative "bidi2pdf/bidi/session"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bidi2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dieter S.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +281,8 @@ files:
 - Rakefile
 - docker/Dockerfile
 - docker/docker-compose.yml
+- docker/nginx/default.conf
+- docker/nginx/htpasswd
 - exe/bidi2pdf
 - lib/bidi2pdf.rb
 - lib/bidi2pdf/bidi/add_headers_interceptor.rb
@@ -284,6 +300,7 @@ files:
 - lib/bidi2pdf/chromedriver_manager.rb
 - lib/bidi2pdf/cli.rb
 - lib/bidi2pdf/launcher.rb
+- lib/bidi2pdf/process_tree.rb
 - lib/bidi2pdf/session_runner.rb
 - lib/bidi2pdf/utils.rb
 - lib/bidi2pdf/version.rb