bidi2pdf 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71faf59892553b22a889f4502396d7c1670269b6223ce6aadf855a2651102e5d
-  data.tar.gz: 4af6722525e182f381430750e28ced8516fd6e3febbdd007560e4b5bf1e177a9
+  metadata.gz: 36afd0d1f8c64ff6d72a8051785d3f65a7efcb336c07e1a6756b772ff4f17414
+  data.tar.gz: 6ecddfbacf09de3757b65009e1c41ca3cb90b8667d2fe80972200159d9f0c2b3
 SHA512:
-  metadata.gz: 18ce08f28f70148e88c09f26238d4b840dacb75318cb36ef14b6d8d1e12d9fd475d734bf495ea30eb7bd4d41684b9da15d008b9d8f73f3e64a6881a8b09cdd9d
-  data.tar.gz: 62f78f1130380da20ffd72f5450e87db66bb7f21ae2c947d8f6b1ab1a3bc738690801c2b42117789c89d9a4566f1343f9e3d7b72fe5e5cd55c9e1f1e66d32c8c
+  metadata.gz: '0490c1e9e84467c4437eaf65128cf9adddac4509a66e7e41a791f10cb5fee6ee86d5fb821177af022a04a41441c6c57a37e8015e6a288c5e6838ecbc966bb628'
+  data.tar.gz: 935185356734aded9f38453cb2e6340501d1f99c482ffc17d62201867dd95224fe7018dfc079cfbdeed72ea44c63233fb5769987ddaa339ed7425ee6b0e281f5

data/.devcontainer/Dockerfile

@@ -0,0 +1,53 @@
+FROM mcr.microsoft.com/devcontainers/ruby:2-3.4-trixie
+
+# Install Rails
+RUN su vscode -c "/usr/local/rvm/bin/rvm fix-permissions"
+
+RUN rm -f /etc/apt/sources.list.d/yarn.list \
+    && find /etc/apt/sources.list.d -type f \
+       -exec sed -i '\|https://dl.yarnpkg.com/debian|d' {} + \
+    && apt-get update \
+    && apt-get install -y --no-install-recommends \
+        build-essential \
+       git \
+       nodejs \
+       ca-certificates \
+       curl \
+       openssh-server \
+       procps \
+       util-linux \
+       socat \
+       libjemalloc2 libvips sqlite3 libyaml-dev chromium-driver \
+    && rm -rf /var/lib/apt/lists/*
+
+# Default value to allow debug server to serve content over GitHub Codespace's port forwarding service
+# The value is a comma-separated list of allowed domains 
+ENV RAILS_DEVELOPMENT_HOSTS=".githubpreview.dev,.preview.app.github.dev,.app.github.dev"
+
+# Install rbenv and ruby-build as vscode.
+RUN su  vscode -c 'curl -fsSL https://rbenv.org/install.sh | bash'
+
+# Install and select Ruby 3.4.8.
+RUN su vscode -c '\
+    export RBENV_ROOT="$HOME/.rbenv" && \
+    export PATH="$RBENV_ROOT/bin:$PATH" && \
+    eval "$(rbenv init - bash)" && \
+    rbenv install 3.4.8 && \
+    rbenv global 3.4.8 && \
+    rbenv rehash && \
+    ruby --version \
+'
+
+RUN mkdir -p /home/vscode/.webdrivers \
+    && chown -R vscode:vscode /home/vscode/.webdrivers \
+    && ln -sfn /usr/bin/chromedriver /home/vscode/.webdrivers/chromedriver \
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN su vscode -c "gem install <your-gem-names-here>"
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby-rails-postgres
+{
+  "name": "Ruby-Bidi2PDF",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "app",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+  "runServices": [
+    "app",
+    "remote-chrome-debug"
+  ],
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/rails/devcontainer/features/activestorage": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:4": {
+      "version": "latest",
+      "moby": false
+    }
+  },
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // This can be used to network with other containers or the host.
+  // "forwardPorts": [3000, 5432],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "bundle install && rake db:setup",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "jetbrains": {
+      "settings": {
+        "com.intellij:app:HttpConfigurable.use_proxy_pac": true,
+        "com.intellij:app:BaseRefactoringSettings.safe_delete_when_delete": false,
+        "com.intellij:app:BaseRefactoringSettings.rename_search_in_comments_for_file": false,
+        "com.intellij:app:BaseRefactoringSettings.rename_search_for_references_for_file": false,
+        "com.intellij:app:BaseRefactoringSettings.rename_search_for_references_for_directory": false,
+        "com.intellij:app:BaseRefactoringSettings.move_search_for_references_for_file": false
+      },
+      "backend": "RubyMine"
+    }
+  },
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root",
+
+  "containerEnv": {
+    "IN_DEV_CONTAINER": "true",
+    "DISABLE_CHROME_SANDBOX": "true",
+    "REMOTE_BROWSER_URL": "http://remote-chrome:3000/session"
+  }
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,33 @@
+version: '3'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    #    volumes:
+    #      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:remote-chrome-debug
+
+    # volumes:
+    #  - /var/run/docker.sock:/var/run/docker.sock
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+  remote-chrome-debug:
+    image: dieters877565/chromedriver:latest
+    environment:
+      ENABLE_XVFB: true
+      ENABLE_VNC: true
+      VNC_PASS: ${REMOTE_CHROME_VNC_PASS:-supersecret}
+    cap_add:
+      - SYS_ADMIN
+    ports:
+      - "127.0.0.1:${REMOTE_CHROME_VNC_PORT:-5900}:5900"

data/.ruby-gemset

@@ -1 +1 @@
-bidi2pdf
+-global

data/.ruby-version

@@ -1 +1 @@
-ruby-3.4.3
+ruby-3.4.8

data/CHANGELOG.md

@@ -8,10 +8,95 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[unreleased]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.12..HEAD
+[unreleased]: https://github.com/dieter-medium/bidi2pdf/compare/v0.1.15..HEAD
 
 <!-- generated by git-cliff end -->
 
+## [0.1.15] - 2026-09-20
+
+### 🎨 Refactored
+
+- Remove deprecated benchmarking script
+
+### 🐛 Fixed
+
+- Handle partial Chrome session builds and cleanup
+- Ensure consistent use of alias in nginx_url helper
+- Use AtomicFixnum for thread-safe slot counting
+- Refactor Chrome session setup in specs
+- Improve session warmer configuration and timeout handling
+- Decouple chromedriver log level from logger level
+- Remove navigation ID generation for sub-resources
+- Remove redundant timeout error test
+- Improve string truncation for log safety
+- Improve release credentials check for missing keys
+- Enhance WebSocket handling for control frames and errors
+- Add chromedriver log level configuration
+- Adjust benchmark thresholds for CI environments
+- Add string truncation for safe log output
+- Set timeout for RSpec test runs
+- Prevent logging raw data URLs during navigation
+- Generate unique navigation IDs for sub-resource requests
+
+### 🔄 Changed
+
+- Merge pull request #124 from dieter-medium/feat/session-warmer
+- Merge pull request #123 from dieter-medium/feat/faster-pdf-generation
+- Merge pull request #122 from dieter-medium/chore-prepare-dev
+- Bump version to 0.1.15.pre
+
+### 🚀 Added
+
+- Implement session warmer idle time management
+- Improve session warmer threading and recovery
+- Enhance session warming and WebSocket health checks
+- Add session warmer and enhance version resolver error handling
+- Add session warming and programmatic configuration
+- Add chromedriver log level mapping and tests
+- Add release credential check for rubygems.org
+- Add navigation id handling in network events
+- Replace WebSocket client library for performance
+- Implement BufferedWebSocketClient and benchmarks
+
+## [0.1.14] - 2026-09-19
+
+### 🐛 Fixed
+
+- Update Dockerfile to use Ruby 3.4-slim
+
+### 🔄 Changed
+
+- Merge pull request #120 from dieter-medium/chore-fix-sig
+- Merge pull request #119 from dieter-medium/chore-update-gems
+- Merge pull request #118 from dieter-medium/enhance-test-helpers
+- Merge pull request #103 from dieter-medium/enhance-test-helpers
+- Merge pull request #95 from dieter-medium/dependabot/bundler/bundler-b0eb7e8c29
+- Merge pull request #82 from dieter-medium/dependabot/bundler/main/rake-13.4.2
+- Merge pull request #96 from dieter-medium/dependabot/bundler/main/rubocop-1.88.2
+- Merge pull request #100 from dieter-medium/dependabot/bundler/main/concurrent-ruby-1.3.8
+- Merge pull request #101 from dieter-medium/dependabot/bundler/main/rbs-4.1.0
+- Merge pull request #87 from dieter-medium/dependabot/bundler/main/rubocop-rspec-3.10.2
+- Merge pull request #92 from dieter-medium/dependabot/bundler/main/rubocop-1.88.0
+- Merge pull request #93 from dieter-medium/dependabot/bundler/bundler-0f363c4924
+- Merge pull request #79 from dieter-medium/fix-slim-image
+
+### 🔧 Build
+
+- Bump excon in the bundler group across 1 directory
+- Bump rake from 13.3.1 to 13.4.2
+- Bump rubocop from 1.88.0 to 1.88.2
+- Bump concurrent-ruby from 1.3.7 to 1.3.8
+- Bump rbs from 4.0.2 to 4.1.0
+- Bump rubocop-rspec from 3.9.0 to 3.10.2
+- Bump rubocop from 1.86.0 to 1.88.0
+- Bump concurrent-ruby
+
+### 🚀 Added
+
+- Add new RBS type definitions for Bidi2pdf
+- Add screenshot and viewport management
+- Add options for Chrome sandbox and flags wihtin the cli
+
 ## [0.1.13] - 2026-03-28
 
 ### 🔄 Changed
@@ -368,11 +453,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 🔄 Released
 
-- [unreleased](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.13..HEAD)
-- [0.1.13](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.12..V0.1.13)
-- [0.1.12](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.11..V0.1.12)
-- [0.1.11](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.10..V0.1.11)
-- [0.1.10](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.9..V0.1.10)
+- [unreleased](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.15..HEAD)
+- [0.1.15](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.14..v0.1.15)
+- [0.1.14](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.13..v0.1.14)
+- [0.1.13](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.12..v0.1.13)
+- [0.1.12](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.11..v0.1.12)
+- [0.1.11](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.10..v0.1.11)
+- [0.1.10](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.9..v0.1.10)
 - [0.1.9](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.8..v0.1.9)
 - [0.1.8](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.7..v0.1.8)
 - [0.1.7](https://github.com/dieter-medium/bidi2pdf/compare/v0.1.6..v0.1.7)

data/README.md

@@ -24,11 +24,12 @@ Bidi2pdf gives you **precision, flexibility, and full control**.
 7. [Architecture](#architecture)
 8. [Docker](#docker)
 9. [Configuration Options](#configuration-options)
-10. [Rails Integration](#rails-integration)
-11. [Test Helpers](#test-helpers)
-12. [Development](#development)
-13. [Contributing](#contributing)
-14. [License](#license)
+10. [Programmatic Configuration](#programmatic-configuration)
+11. [Rails Integration](#rails-integration)
+12. [Test Helpers](#test-helpers)
+13. [Development](#development)
+14. [Contributing](#contributing)
+15. [License](#license)
 
 ## ✨ Key Features
 
@@ -334,6 +335,68 @@ docker compose -f docker/docker-compose.yml down
 
 ---
 
+## 🔧 Programmatic Configuration
+
+Beyond the per-render CLI flags above, a few gem-wide defaults are set once via `Bidi2pdf.configure`:
+
+```ruby
+Bidi2pdf.configure do |config|
+  config.default_timeout = 60 # seconds - default BiDi command timeout
+  config.enable_default_logging_subscriber = true
+  config.log_truncate_limit = 200 # bytes - see below
+  config.chromedriver_log_level = "WARNING" # see below
+end
+```
+
+| Setting                             | Default | Description                                                                                                                                                                                                                      |
+|-------------------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `default_timeout`                   | `60`    | Default timeout (seconds) for BiDi commands that don't specify their own.                                                                                                                                                        |
+| `enable_default_logging_subscriber` | `true`  | Subscribes a default logger to the gem's internal instrumentation events.                                                                                                                                                        |
+| `log_truncate_limit`                | `200`   | Max bytes kept when logging a value that can be large (e.g. a `data:` URL) - truncated at a byte, not character, boundary.                                                                                                       |
+| `chromedriver_log_level`            | `nil`   | ChromeDriver's own `--log-level` (`"ALL"`/`"INFO"`/`"WARNING"`/`"SEVERE"`). Unset mirrors `Bidi2pdf.logger.level`; set explicitly to quiet ChromeDriver's own (often very verbose) output independently of your app's log level. |
+
+`Bidi2pdf.logger`, `Bidi2pdf.network_events_logger`, `Bidi2pdf.browser_console_logger`, and
+`Bidi2pdf.notification_service` are also configurable in the same block, for more advanced
+logging/instrumentation needs.
+
+### Pre-warmed sessions (`Bidi2pdf::SessionWarmer`)
+
+Optional. Keeps a few Chrome sessions started in the background so a render skips browser startup.
+Every slot is still used for exactly one render and then discarded - isolation is the same as
+launching a fresh Chrome per PDF.
+
+```ruby
+Bidi2pdf::SessionWarmer.configure do |c|
+  # warms c.size sessions right here, e.g. at boot
+  c.size = 2
+  c.max_idle_age = 300
+  # c.remote_browser_url = "http://remote-chrome:3000/session"
+end
+
+Bidi2pdf::SessionWarmer.with_tab do |tab|
+  tab.navigate_to(url)
+  tab.print("invoice.pdf")
+end
+
+Bidi2pdf::SessionWarmer.shutdown
+```
+
+| Setting              | Default               | Description                                                                                               |
+|----------------------|-----------------------|-----------------------------------------------------------------------------------------------------------|
+| `size`               | `1`                   | Number of sessions kept warm. With none ready, a render starts its own session as usual - it never waits. |
+| `max_idle_age`       | `300`                 | Seconds a warm session may sit unused before it is retired and replaced. `nil` disables the limit.        |
+| `headless`           | `true`                | Run Chrome headless.                                                                                      |
+| `chrome_args`        | `DEFAULT_CHROME_ARGS` | Chrome launch arguments.                                                                                  |
+| `remote_browser_url` | `nil`                 | Connect each slot to a remote chromedriver instead of starting a local one.                               |
+
+> **Security note:** an idle warm session is an open, unauthenticated automation endpoint
+> (chromedriver's port, Chrome's debugging port - loopback only for a local chromedriver) for as
+> long as it waits. `max_idle_age` bounds that window; keep it set unless the process runs somewhere
+> nothing else can reach those ports. With `remote_browser_url`, who can reach that endpoint on the
+> network is what matters, exactly as it does without the warmer.
+
+---
+
 ## 🚂 Rails Integration
 
 Rails integration is available as an additional gem:
@@ -390,6 +453,18 @@ This also provides the helper methods:
 With the environment variable `DISABLE_CHROME_SANDBOX` set to `true`, the container will run Chrome without
 the sandbox. This is useful for CI environments where the sandbox may cause issues.
 
+Container URLs (`session_url` and similar) are built from the Docker host's address plus the container's
+mapped port. That address is resolved by the `testcontainers` gem — which already handles a `tcp:`/`ssh:`
+`DOCKER_HOST`, a native local daemon, and a sibling container reaching the daemon over the bridge gateway —
+falling back to `"localhost"` only if the gem can't resolve a host at all (a known gap in
+`testcontainers-core` 0.2.0 when the test process itself runs in a container on a custom network).
+
+To override the Docker host address explicitly, set `TC_HOST` (e.g. `TC_HOST=localhost` for a test process
+running in a container that shares the Docker daemon's network namespace — true docker-in-docker). `TC_HOST`
+is a single global setting for where the daemon's published ports are reachable; it is not the name, URL, or
+IP of an individual container. To reach one container *from another* container, join the shared network and
+address it by alias instead (see `nginx_url(use_alias: true)` in the spec helpers).
+
 #### Example
 
 ```ruby

data/docker/Dockerfile

@@ -5,7 +5,7 @@ ENV DEBIAN_FRONTEND=noninteractive
 # Install dependencies
 RUN apt-get update && apt-get upgrade -y &&\
     apt-get install -y --no-install-recommends\
-    chromium chromium-driver\
+    chromium chromium-driver chromium-sandbox \
     libglib2.0-0 \
     libnss3 \
     libxss1 \

data/docker/Dockerfile.slim

@@ -1,4 +1,4 @@
-FROM ruby:3.3-slim AS builder
+FROM ruby:3.4-slim AS builder
 
 ENV DEBIAN_FRONTEND=noninteractive
 
@@ -31,7 +31,7 @@ RUN gem install ./bidi2pdf-*.gem
 
 # Stage 2
 
-FROM ruby:3.3-slim
+FROM ruby:3.4-slim
 
 ENV DEBIAN_FRONTEND=noninteractive