bidi2pdf 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b92ff566ca3ae322033cd9602818c94ae30da2594c7075bbb86f4c16351d58ce
-  data.tar.gz: 1b4d46aa7fe35c1810522a51400c3558f04d8fdc4093c7b3efa0f507a4959392
+  metadata.gz: 766b41f0ee642cd7316d0f72d8dd707b0f45aae4a315a46c2b27fb6bb2d176a6
+  data.tar.gz: aeec0549f82ff7bdd68d1aa658ea6ad2033e5310fd5936f40b94007b4ae6c38f
 SHA512:
-  metadata.gz: 63aa303c4dc6245510cb212adaf22523190d8e00892f4ffe9dc9ba9b65e966f74517ee748f4a232736701a3271ae086879fcbf0adc02ce9f9cd82d103ea3e70d
-  data.tar.gz: 320a0a03c399541157bd192b6389fecf5541c994cdcaa186694085887ecc8de0829b63badc2be5fa0cd2b8c9baa4ee60bfe7a2f457743d4f21506f1d4bb44850
+  metadata.gz: cc7f1da58549b642521808b9ea2acc4b04068bdb7c877cf52943d2ae69bb989f2ade02601b8bfd0e409440ad8644206bba1e6e16603eb56099b8963a2136e350
+  data.tar.gz: 6258250ac5de22034cbb7816d3ff33c62680747a3eaee171fdd784d309bf1cd7880ca60e45342da8ee9195814ef1c78ca9b45b2c435f9fcbc4aaa43a8d7f95e6

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.3
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -44,6 +44,9 @@ Layout/ArrayAlignment:
 Layout/LineLength:
   Enabled: false
 
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: false
+
 RSpec/MultipleMemoizedHelpers:
   Max: 10
 

data/CHANGELOG.md

@@ -6,10 +6,60 @@ 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.5..HEAD
 
 <!-- generated by git-cliff end -->
 
+## [0.1.7] - 2025-04-17
+
+### 🎨 Refactored
+
+- Move notification releated classes to new folder by @dieter-medium
+
+### 🔄 Changed
+
+- Refactore custom check script in wait_until_page_loaded by @dieter-medium
+- Add logger support to NetworkEventConsoleFormatter by @dieter-medium
+- Refactore browser console logger support for enhanced logging by @dieter-medium
+
+### 🚀 Added
+
+- Add support for predefined paper formats by @dieter-medium
+- Add support for websocket-native for performance boost by @dieter-medium
+- Add logging for print events by @dieter-medium
+- Add configurable logging and notification service by @dieter-medium
+- Introduce VerboseLogger for configurable debug levels by @dieter-medium
+- Instrument Bidi2pdf methods with notification service for enhanced logging by @dieter-medium
+- Introduce notifications system with event instrumentation and logging compatible to rails by @dieter-medium
+- Enhance ChromedriverManager with chrome_args and improve session handling by @dieter-medium
+- Add wait_until_page_loaded method for improved page load handling by @dieter-medium
+- Enhance Chromedriver process management with platform-specific options by @dieter-medium
+- Implement BrowserRemoveUserContext command and enhance user context cleanup by @dieter-medium
+- Add style injection functionality to BrowserTab class by @dieter-medium
+- Add script injection functionality to BrowserTab class by @dieter-medium
+
+## [0.1.6] - 2025-04-12
+
+### ⚠️ Breaking Changes
+
+- Rename view_html_page to render_html by @dieter-medium
+- Rename wait_until_all_finished to wait_until_network_idle by @dieter-medium
+
+### 📝 Docs
+
+- Update Docker instructions in README by @dieter-medium
+
+### 🔄 Changed
+
+- Add details on network logging and console capture by @dieter-medium
+
+### 🚀 Added
+
+- Add PDF network log formatting and customizable outputs by @dieter-medium
+- Add option to log network traffic and handle failures within the cli command by @dieter-medium
+- Add structured network traffic logging by @dieter-medium
+- Add slim variant Dockerfile and build matrix for CI by @dieter-medium
+- Add official image at [Docker Hub](https://hub.docker.com/r/dieters877565/bidi2pdf) by @dieter-medium
+
 ## [0.1.5] - 2025-04-10
 
 ### 📝 Docs
@@ -92,3 +142,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2025-03-26
 
 - Initial release
+
+[unreleased]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.7..HEAD
+
+[unreleased]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.6..v0.1.7
+
+[0.1.6]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.5..v0.1.6
+
+[0.1.5]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.4..v0.1.5
+
+[0.1.4]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.3..v0.1.4 

data/README.md

@@ -2,13 +2,14 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/6425d9893aa3a9ca243e/maintainability)](https://codeclimate.com/github/dieter-medium/bidi2pdf/maintainability)
 [![Gem Version](https://badge.fury.io/rb/bidi2pdf.svg)](https://badge.fury.io/rb/bidi2pdf)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/6425d9893aa3a9ca243e/test_coverage)](https://codeclimate.com/github/dieter-medium/bidi2pdf/test_coverage)
+[![Open Source Helpers](https://www.codetriage.com/dieter-medium/bidi2pdf/badges/users.svg)](https://www.codetriage.com/dieter-medium/bidi2pdf)
 
 ---
 
 # 📄 Bidi2pdf – Bulletproof PDF generation via Chrome's BiDi Protocol
 
-**Bidi2pdf** is a powerful Ruby gem that transforms modern web pages into high-fidelity PDFs using Chrome’s *
-*BiDirectional (BiDi)** protocol. Whether you're automating reports, archiving websites, or shipping documentation,
+**Bidi2pdf** is a powerful Ruby gem that transforms modern web pages into high-fidelity PDFs using Chrome’s
+**BiDirectional (BiDi)** protocol. Whether you're automating reports, archiving websites, or shipping documentation,
 Bidi2pdf gives you **precision, flexibility, and full control**.
 
 ---
@@ -20,7 +21,9 @@ Bidi2pdf gives you **precision, flexibility, and full control**.
 ✅ **Smart waiting** – Wait for complete page load or network idle  
 ✅ **Headless support** – Run quietly in the background  
 ✅ **Docker-ready** – Plug and play with containers  
-✅ **Modern architecture** – Built on Chrome's next-gen BiDi protocol
+✅ **Modern architecture** – Built on Chrome's next-gen BiDi protocol  
+✅ **Network logging** – Know which requests fail during rendering  
+✅ **Console log capture** – See what goes wrong inside the browser
 
 ---
 
@@ -96,8 +99,8 @@ launcher.launch
 require "bidi2pdf"
 
 Bidi2pdf::DSL.with_tab(headless: true) do |tab|
-  tab.open_page("https://example.com")
-  tab.wait_until_all_finished
+  tab.navigate_to("https://example.com")
+  tab.wait_until_network_idle
   tab.print("example.pdf")
 end
 ```
@@ -142,17 +145,30 @@ tab.basic_auth(url_patterns: [{ type: "pattern", protocol: "https", hostname: "e
                username: "username", password: "secret")
 
 # 4. Render PDF
-tab.open_page "https://example.com"
+tab.navigate_to "https://example.com"
 
 # Alternative: send html code to the browser
-# tab.view_html_page("<html>...</html>")
+# tab.render_html_content("<html>...</html>")
 
-tab.wait_until_all_finished
+# Inject JavaScript if, needed
+# as an url
+# tab.inject_script "https://example.com/script.js" 
+# or inline
+# tab.inject_script "console.log('Hello from injected script!')"
+
+# Inject CSS if needed
+# as an url
+# tab.inject_style url: "https://example.com/simple.css"
+# or inline
+# tab.inject_style content: "body { background-color: red; }"
+
+tab.wait_until_network_idle
 tab.print("my.pdf")
 
 # 5. Cleanup
 tab.close
 window.close
+context.close
 session.close
 ```
 
@@ -162,15 +178,36 @@ session.close
 
 ## 🐳 Docker Support
 
-### Build & Run
+### 🛠️ Build & Run Locally
 
 ```bash
+# Prepare the environment
 rake build
+
+# Build the Docker image
 docker build -t bidi2pdf -f docker/Dockerfile .
-docker run -it --rm -v ./output:/reports bidi2pdf \
+
+# Run the container and generate a PDF
+docker run -it --rm \
+  -v ./output:/reports \
+  bidi2pdf \
+  bidi2pdf render --url=https://example.com --output /reports/example.pdf
+
+```
+
+### ⚡ Use the Prebuilt Image (Recommended for Fast Start)
+
+Grab it directly from [Docker Hub](https://hub.docker.com/r/dieters877565/bidi2pdf)
+
+```bash
+docker run -it --rm \
+  -v ./output:/reports \
+  dieters877565/bidi2pdf:main-slim \
   bidi2pdf render --url=https://example.com --output /reports/example.pdf
 ```
 
+✅ Tip: Mount your local directory (e.g. ./output) to /reports in the container to easily access the generated PDFs.
+
 ### Docker Compose
 
 ```bash

data/docker/Dockerfile

@@ -1,9 +1,11 @@
 FROM ruby:3.3
 
+ENV DEBIAN_FRONTEND=noninteractive
+
 # Install dependencies
-RUN apt-get update && \
-    apt-get install -y \
-    chromium \
+RUN apt-get update && apt-get upgrade -y &&\
+    apt-get install -y --no-install-recommends\
+    chromium chromium-driver\
     libglib2.0-0 \
     libnss3 \
     libxss1 \
@@ -19,6 +21,12 @@ RUN apt-get update && \
 # Create a non-root user
 RUN groupadd -r appuser && useradd -r -g appuser -m -d /home/appuser appuser
 
+# ARM compatibility workaround:
+# On ARM architectures (such as Apple Silicon), downloading chromedriver via automated scripts may fail or cause ELF binary errors,
+# such as "rosetta error: failed to open elf at /lib64/ld-linux-x86-64.so.2".
+# To avoid these issues, we directly install 'chromium-driver' via the package manager and explicitly create a symlink in the expected location.
+
+RUN mkdir -p /home/appuser/.webdrivers && ln -s /usr/bin/chromedriver /home/appuser/.webdrivers/chromedriver
 
 # Set working directory
 WORKDIR /app

data/docker/Dockerfile.chromedriver

@@ -2,9 +2,11 @@ FROM ruby:3.3
 
 ARG CHROMEDRIVER_PORT=3000
 
+ENV DEBIAN_FRONTEND=noninteractive
+
 # Install dependencies
-RUN apt-get update && \
-    apt-get install -y \
+RUN apt-get update && apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends\
     chromium \
     libglib2.0-0 \
     libnss3 \

data/docker/Dockerfile.slim

@@ -0,0 +1,75 @@
+FROM ruby:3.3-slim AS builder
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install dependencies
+RUN apt-get update && apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends \
+    chromium \
+    libglib2.0-0 \
+    libnss3 \
+    libxss1 \
+    libasound2 \
+    libatk-bridge2.0-0 \
+    libgtk-3-0 \
+    libdrm2 \
+    curl \
+    unzip \
+    xvfb \
+    build-essential \
+    libpq-dev pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+# Copy your gem into container
+COPY ./pkg/bidi2pdf-*.gem ./
+
+RUN gem install ./bidi2pdf-*.gem
+
+
+# Stage 2
+
+FROM ruby:3.3-slim
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install dependencies
+RUN apt-get update && apt-get upgrade -y &&\
+    apt-get install -y --no-install-recommends\
+    chromium chromium-driver\
+    libglib2.0-0 \
+    libnss3 \
+    libxss1 \
+    libasound2 \
+    libatk-bridge2.0-0 \
+    libgtk-3-0 \
+    libdrm2 \
+    curl \
+    unzip \
+    xvfb \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local/bundle /usr/local/bundle
+
+# Create a non-root user
+RUN groupadd -r appuser && useradd -r -g appuser -m -d /home/appuser appuser
+
+# ARM compatibility workaround:
+# On ARM architectures (such as Apple Silicon), downloading chromedriver via automated scripts may fail or cause ELF binary errors,
+# such as "rosetta error: failed to open elf at /lib64/ld-linux-x86-64.so.2".
+# To avoid these issues, we directly install 'chromium-driver' via the package manager and explicitly create a symlink in the expected location.
+
+RUN mkdir -p /home/appuser/.webdrivers && ln -s /usr/bin/chromedriver /home/appuser/.webdrivers/chromedriver
+
+# Set working directory
+WORKDIR /app
+
+RUN chown -R appuser:appuser /app
+
+# Switch to non-root user
+USER appuser
+
+CMD ["/usr/bin/bash"]
+

data/lib/bidi2pdf/bidi/browser_console_logger.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "js_logger_helper"
+
+module Bidi2pdf
+  module Bidi
+    class BrowserConsoleLoggerSuggar
+      attr_reader :browser_console_logger
+
+      def initialize(browser_console_logger)
+        @browser_console_logger = browser_console_logger
+      end
+
+      def with_level(level)
+        @level = level
+        self
+      end
+
+      def with_prefix(prefix)
+        @prefix = prefix
+        self
+      end
+
+      def with_timestamp(timestamp)
+        @timestamp = timestamp
+        self
+      end
+
+      def with_text(text)
+        @text = text
+        self
+      end
+
+      def with_args(args)
+        @args = args
+        self
+      end
+
+      def with_stack_trace(stack_trace)
+        @stack_trace = stack_trace
+        self
+      end
+
+      def log_event
+        browser_console_logger.log_message(@level, @prefix, @text)
+        browser_console_logger.log_args(@prefix, @args)
+        browser_console_logger.log_stack_trace(@prefix, @stack_trace) if @stack_trace && @level == :error
+      end
+
+      def prefix
+        @prefix ||= "[#{BrowserConsoleLogger.format_timestamp(@timestamp)}][Browser Console Log]"
+      end
+    end
+
+    class BrowserConsoleLogger
+      include JsLoggerHelper
+
+      attr_accessor :logger
+
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def builder
+        BrowserConsoleLoggerSuggar.new(self)
+      end
+
+      def log_message(level, prefix, text)
+        return unless text
+
+        logger.send(level, "#{prefix} #{text}")
+      end
+
+      def log_args(prefix, args)
+        return if args.empty?
+
+        logger.debug("#{prefix} Args: #{args.inspect}")
+      end
+
+      def log_stack_trace(prefix, trace)
+        formatted_trace = format_stack_trace(trace)
+        logger.error("#{prefix} Stack trace captured:\n#{formatted_trace}")
+      end
+
+      def self.format_timestamp(timestamp)
+        return "N/A" unless timestamp
+
+        Time.at(timestamp.to_f / 1000).utc.strftime("%Y-%m-%d %H:%M:%S.%L UTC")
+      end
+    end
+  end
+end