bidi2pdf 0.1.16 → 0.1.18

data/sig/bidi2pdf/session_warmer.rbs

@@ -42,6 +42,12 @@ module Bidi2pdf
 
     @reaper_wakeup: untyped
 
+    @own_sessions: untyped
+
+    @registry: untyped
+
+    @sweeper: untyped
+
     @reaper: untyped
 
     # Configuration for the session warmer.
@@ -58,6 +64,12 @@ module Bidi2pdf
 
       @max_idle_age: untyped
 
+      @orphan_age: untyped
+
+      @registry_dir: untyped
+
+      @sweeper: untyped
+
       # @return [Integer] Number of Chrome slots to keep pre-warmed.
       attr_accessor size: untyped
 
@@ -84,10 +96,32 @@ module Bidi2pdf
       #   1.25x this value even when no render ever comes. +nil+ disables the limit.
       attr_accessor max_idle_age: untyped
 
+      # @return [Numeric, Symbol, nil] Seconds after which a session recorded by any warmer on the
+      #   same remote chromedriver counts as left behind - its process died without closing it - and
+      #   is closed when a warmer starts (SessionSweeper). +:auto+ (the default) is twice
+      #   max_idle_age: a live warmer recycles its own spares within ~1.25x of that, so no live
+      #   process's slot is ever taken. +nil+ disables the sweep. Remote mode only.
+      attr_accessor orphan_age: untyped
+
+      # @return [String, nil] Directory for the session registry file (SessionRegistry); +nil+ means
+      #   Dir.tmpdir. Every process that should clean up after the others must share it.
+      attr_accessor registry_dir: untyped
+
+      # @return [Hash, nil] Options for a ChromeSweeper on the remote chromedriver (+scope+,
+      #   +orphan_age+, +min_age+, +unresponsive_checks+, +max_sessions+, +pids_limit+, +interval+,
+      #   ...), or +nil+ (default) for none. This warmer's own sessions are never touched by it; with
+      #   an +interval+ it sweeps in the background, and a session that fails to start triggers one
+      #   sweep and one retry. Remote mode only.
+      attr_accessor sweeper: untyped
+
       DEFAULT_MAX_IDLE_AGE: 300
 
       def initialize: () -> void
 
+      # The orphan age in seconds, or nil when the sweep is off (also when +:auto+ has no
+      # max_idle_age to derive it from).
+      def effective_orphan_age: () -> untyped
+
       # @raise [ArgumentError] if a setting can't be honored - checked once, at construction.
       def validate!: () -> untyped
 
@@ -96,6 +130,10 @@ module Bidi2pdf
       def validate_size!: () -> (nil | untyped)
 
       def validate_max_idle_age!: () -> (nil | untyped)
+
+      def validate_orphan_age!: () -> (nil | untyped)
+
+      def validate_sweeper!: () -> (nil | untyped)
     end
 
     # Configures the warmer and eagerly (re)creates the singleton, warming config.size slots right
@@ -126,6 +164,10 @@ module Bidi2pdf
     # Checks out a slot, yields a fresh tab for one render, then retires the slot.
     def self.with_tab: () { (?) -> untyped } -> untyped
 
+    # Sweeps the remote chromedriver with the configured sweeper; nil when there is none (or no
+    # warmer yet - this never creates one).
+    def self.sweep!: (?reason: ::Symbol) -> untyped
+
     # Retires every currently-warm spare and resets the singleton.
     def self.shutdown: () -> untyped
 
@@ -143,6 +185,11 @@ module Bidi2pdf
 
     def initialize: (untyped config, ?slot_factory: untyped?) -> void
 
+    # Sweeps the remote chromedriver now - for an application that suspects leaked sessions.
+    #
+    # @return [ChromeSweeper::Result, nil] nil when no sweeper is configured.
+    def sweep!: (?reason: ::Symbol) -> untyped
+
     # Checks out a slot, creates an isolated UserContext/Window/Tab for one render, yields the tab,
     # then unconditionally closes those resources and retires the underlying slot.
     def with_tab: () { (untyped) -> untyped } -> untyped
@@ -161,6 +208,23 @@ module Bidi2pdf
 
     def create_slot: () -> untyped
 
+    # A chromedriver out of room for another Chrome refuses the session; with a sweeper, close
+    # everything nobody holds (a pressure sweep) and try once more.
+    def new_slot: () -> untyped
+
+    def start_background_work: () -> untyped
+
+    def build_sweeper: () -> (nil | untyped)
+
+    # Remote mode with an orphan age or a sweeper: sessions are recorded, so a later start (or the
+    # sweeper, whose default scope is :recorded) can close the ones this process leaves behind if it
+    # dies uncleanly. The start-up sweep itself needs the orphan age - see #sweep_leftovers.
+    def build_registry: () -> (nil | untyped)
+
+    def sweep_leftovers: () -> (nil | untyped)
+
+    def session_id_of: (untyped slot) -> untyped
+
     # Session#started? is just an internal flag set once at startup - it never flips back if Chrome,
     # ChromeDriver, or the WebSocket dies externally while a slot sits idle in the cache. The
     # client's own #open? is kept live by the reader thread noticing a real socket error, so
@@ -214,6 +278,8 @@ module Bidi2pdf
     # reservation is released here, in the same critical section as the stash.
     def stash_or_retire: (untyped slot) -> untyped
 
+    # Forgotten only after closing: a process that dies in between leaves a record whose session is
+    # already gone - the next sweep just drops it - never an open session nobody knows about.
     def retire: (untyped slot) -> untyped
 
     def safe_close: (untyped label) { (?) -> untyped } -> untyped

data/sig/bidi2pdf/version.rbs

@@ -1,3 +1,3 @@
 module Bidi2pdf
-  VERSION: "0.1.16"
+  VERSION: "0.1.18"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bidi2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
 platform: ruby
 authors:
 - Dieter S.
@@ -87,16 +87,22 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
@@ -423,11 +429,13 @@ files:
 - lib/bidi2pdf/bidi/commands/browser_create_user_context.rb
 - lib/bidi2pdf/bidi/commands/browser_remove_user_context.rb
 - lib/bidi2pdf/bidi/commands/browsing_context_close.rb
+- lib/bidi2pdf/bidi/commands/browsing_context_get_tree.rb
 - lib/bidi2pdf/bidi/commands/browsing_context_navigate.rb
 - lib/bidi2pdf/bidi/commands/browsing_context_print.rb
 - lib/bidi2pdf/bidi/commands/cancel_auth.rb
 - lib/bidi2pdf/bidi/commands/capture_screenshot.rb
 - lib/bidi2pdf/bidi/commands/cdp_get_session.rb
+- lib/bidi2pdf/bidi/commands/cdp_send_command.rb
 - lib/bidi2pdf/bidi/commands/create_tab.rb
 - lib/bidi2pdf/bidi/commands/create_window.rb
 - lib/bidi2pdf/bidi/commands/get_user_contexts.rb
@@ -457,9 +465,14 @@ files:
 - lib/bidi2pdf/bidi/session.rb
 - lib/bidi2pdf/bidi/user_context.rb
 - lib/bidi2pdf/bidi/web_socket_dispatcher.rb
+- lib/bidi2pdf/chrome_sweeper.rb
+- lib/bidi2pdf/chrome_sweeper/inspector.rb
+- lib/bidi2pdf/chrome_sweeper/settings.rb
+- lib/bidi2pdf/chromedriver_api.rb
 - lib/bidi2pdf/chromedriver_manager.rb
 - lib/bidi2pdf/cli.rb
 - lib/bidi2pdf/cli/json_output.rb
+- lib/bidi2pdf/cli/session_commands.rb
 - lib/bidi2pdf/diagnose.rb
 - lib/bidi2pdf/dsl.rb
 - lib/bidi2pdf/error_codes.rb
@@ -481,7 +494,10 @@ files:
 - lib/bidi2pdf/result.rb
 - lib/bidi2pdf/result_collector.rb
 - lib/bidi2pdf/schema.rb
+- lib/bidi2pdf/session_registry.rb
+- lib/bidi2pdf/session_registry/heartbeat.rb
 - lib/bidi2pdf/session_runner.rb
+- lib/bidi2pdf/session_sweeper.rb
 - lib/bidi2pdf/session_warmer.rb
 - lib/bidi2pdf/test_helpers.rb
 - lib/bidi2pdf/test_helpers/configuration.rb
@@ -521,11 +537,13 @@ files:
 - sig/bidi2pdf/bidi/commands/browser_create_user_context.rbs
 - sig/bidi2pdf/bidi/commands/browser_remove_user_context.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_close.rbs
+- sig/bidi2pdf/bidi/commands/browsing_context_get_tree.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_navigate.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_print.rbs
 - sig/bidi2pdf/bidi/commands/cancel_auth.rbs
 - sig/bidi2pdf/bidi/commands/capture_screenshot.rbs
 - sig/bidi2pdf/bidi/commands/cdp_get_session.rbs
+- sig/bidi2pdf/bidi/commands/cdp_send_command.rbs
 - sig/bidi2pdf/bidi/commands/create_tab.rbs
 - sig/bidi2pdf/bidi/commands/create_window.rbs
 - sig/bidi2pdf/bidi/commands/get_user_contexts.rbs
@@ -555,9 +573,14 @@ files:
 - sig/bidi2pdf/bidi/session.rbs
 - sig/bidi2pdf/bidi/user_context.rbs
 - sig/bidi2pdf/bidi/web_socket_dispatcher.rbs
+- sig/bidi2pdf/chrome_sweeper.rbs
+- sig/bidi2pdf/chrome_sweeper/inspector.rbs
+- sig/bidi2pdf/chrome_sweeper/settings.rbs
+- sig/bidi2pdf/chromedriver_api.rbs
 - sig/bidi2pdf/chromedriver_manager.rbs
 - sig/bidi2pdf/cli.rbs
 - sig/bidi2pdf/cli/json_output.rbs
+- sig/bidi2pdf/cli/session_commands.rbs
 - sig/bidi2pdf/diagnose.rbs
 - sig/bidi2pdf/dsl.rbs
 - sig/bidi2pdf/error_codes.rbs
@@ -579,7 +602,10 @@ files:
 - sig/bidi2pdf/result.rbs
 - sig/bidi2pdf/result_collector.rbs
 - sig/bidi2pdf/schema.rbs
+- sig/bidi2pdf/session_registry.rbs
+- sig/bidi2pdf/session_registry/heartbeat.rbs
 - sig/bidi2pdf/session_runner.rbs
+- sig/bidi2pdf/session_sweeper.rbs
 - sig/bidi2pdf/session_warmer.rbs
 - sig/bidi2pdf/test_helpers.rbs
 - sig/bidi2pdf/test_helpers/configuration.rbs