puppeteer-bidi 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50cd7d1f0b4246d67ee0efc626abb598e50e2f7d043df7d76ea9616ba5c366fe
-  data.tar.gz: cd7700bd4f70674e71e6ded417f357f84a5c0cdf2d9a6cf918db383f8c6f60d8
+  metadata.gz: 4d4180fa84d0b98325b3d8cddd680e4210cf40465addf4d0e12f366e95e51ba2
+  data.tar.gz: d6cc60b73af37fbe80bedec148ad6629d55dbf4237caf8d007cb86abcbf11839
 SHA512:
-  metadata.gz: 7dc2fe84ec1a08a05307f72206c85eabe7fd3452e946a7820a056a13761c2c9cf1dc79e1b69b567374cf278c2c68505c9ed3c70716132f72aba462f7fbf85301
-  data.tar.gz: 8b8586c88aba62bd88d7c0a49c770ae5be331c130616c068865a9f593e000fb820b2e928342841a28ca3d9b8550c1b124b7971a97db45f6afab80f03d5ad3993
+  metadata.gz: 90d9023d9a7b7c3d3c5efeba254889f913ae5569dc624102d6c0d312e3e92c33909f8e72fcb6f7c6092efac11080869376180f2c72ee750c5a014f1cb9e6a5ec
+  data.tar.gz: 81509cc86f61d0eeca316b69eb7b8dfec65e731df00163f5aafa0b44945630624d6c994993e27799e2c698b6b24d19f846f2247ecae7b1e0e020af069bdcc50f

data/lib/puppeteer/bidi/browser.rb

@@ -92,7 +92,6 @@ module Puppeteer
 
         # Create transport and connection
         transport = Transport.new(ws_endpoint)
-        ws_endpoint = transport.url
 
         # Start transport connection in background thread with Sync reactor
         # Sync is the preferred way to run async code at the top level
@@ -114,7 +113,6 @@ module Puppeteer
       # @rbs return: Browser -- Browser instance
       def self.connect(ws_endpoint, timeout: nil, accept_insecure_certs: false)
         transport = Transport.new(ws_endpoint)
-        ws_endpoint = transport.url
         timeout_ms = ((timeout || 30) * 1000).to_i
         AsyncUtils.async_timeout(timeout_ms) { transport.connect }.wait
         connection = Connection.new(transport)
@@ -260,36 +258,45 @@ module Puppeteer
       # Register event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: Browser -- This browser
       def on(event, &block)
-        return @emitter.on(event, &block) if TARGET_EVENTS.include?(event.to_sym)
-
-        @connection.on(event, &block)
+        if TARGET_EVENTS.include?(event.to_sym)
+          @emitter.on(event, &block)
+        else
+          @connection.on(event, &block)
+        end
+        self
       end
 
       # Register a one-time event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: Browser -- This browser
       def once(event, &block)
-        return @emitter.once(event, &block) if TARGET_EVENTS.include?(event.to_sym)
-
-        # @type var wrapper: ^(untyped) -> void
-        wrapper = proc do |data|
-          @connection.off(event, &wrapper)
-          block.call(data)
+        if TARGET_EVENTS.include?(event.to_sym)
+          @emitter.once(event, &block)
+        else
+          # @type var wrapper: ^(untyped) -> void
+          wrapper = proc do |data|
+            @connection.off(event, &wrapper)
+            block.call(data)
+          end
+          @connection.on(event, &wrapper)
         end
-        @connection.on(event, &wrapper)
+        self
       end
 
       # Remove an event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-      # @rbs return: void
+      # @rbs return: Browser -- This browser
       def off(event, &block)
-        return @emitter.off(event, &block) if TARGET_EVENTS.include?(event.to_sym)
-
-        @connection.off(event, &block)
+        if TARGET_EVENTS.include?(event.to_sym)
+          @emitter.off(event, &block)
+        else
+          @connection.off(event, &block)
+        end
+        self
       end
 
       # Close the browser

data/lib/puppeteer/bidi/browser_context.rb

@@ -54,25 +54,28 @@ module Puppeteer
       # Register an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: BrowserContext -- This browser context
       def on(event, &block)
         @emitter.on(event, &block)
+        self
       end
 
       # Register a one-time event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: BrowserContext -- This browser context
       def once(event, &block)
         @emitter.once(event, &block)
+        self
       end
 
       # Remove an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-      # @rbs return: void
+      # @rbs return: BrowserContext -- This browser context
       def off(event, &block)
         @emitter.off(event, &block)
+        self
       end
 
       # Create a new page (tab/window)

data/lib/puppeteer/bidi/browser_launcher.rb

@@ -50,7 +50,7 @@ module Puppeteer
           raise LaunchError, 'Failed to get BiDi WebSocket endpoint'
         end
 
-        @ws_endpoint
+        @ws_endpoint = "#{@ws_endpoint}/session"
       rescue => e
         kill
         raise LaunchError, "Failed to launch Firefox: #{e.message}"

data/lib/puppeteer/bidi/connection.rb

@@ -84,33 +84,38 @@ module Puppeteer
               raise ProtocolError, "Protocol Error. Unexpected BiDi message type: #{result['type'].inspect}"
             end
           rescue Async::TimeoutError
-            @pending_commands.delete(id)
             raise TimeoutError, "Timeout waiting for #{method} (#{timeout}ms)"
           end
+        ensure
+          # A send that raises, an encoding failure for instance, would otherwise leave
+          # the command and its promise pending for the life of the connection.
+          @pending_commands.delete(id)
         end
       end
 
       # Subscribe to BiDi events
       # @rbs event: String
       # @rbs &block: (untyped) -> void
-      # @rbs return: void
+      # @rbs return: Connection -- This connection
       def on(event, &block)
         @event_listeners[event] ||= []
         @event_listeners[event] << block
+        self
       end
 
       # Unsubscribe from BiDi events
       # @rbs event: String
       # @rbs &block: ((untyped) -> void)?
-      # @rbs return: void
+      # @rbs return: Connection -- This connection
       def off(event, &block)
-        return unless @event_listeners[event]
+        return self unless @event_listeners[event]
 
         if block
           @event_listeners[event].delete(block)
         else
           @event_listeners.delete(event)
         end
+        self
       end
 
       # Close the connection

data/lib/puppeteer/bidi/core/event_emitter.rb

@@ -16,29 +16,33 @@ module Puppeteer
         # Register an event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: (untyped) -> void -- Event handler
-        # @rbs return: void
+        # @rbs return: EventEmitter -- This event emitter
         def on(event, &block)
-          return if @disposed
+          return self if @disposed
+
           @listeners[event.to_sym] << block
+          self
         end
 
         # Register a one-time event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: (untyped) -> void -- Event handler
-        # @rbs return: void
+        # @rbs return: EventEmitter -- This event emitter
         def once(event, &block)
-          return if @disposed
+          return self if @disposed
+
           wrapper = lambda do |*args|
             off(event, &wrapper)
             block.call(*args)
           end
           on(event, &wrapper)
+          self
         end
 
         # Remove an event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-        # @rbs return: void
+        # @rbs return: EventEmitter -- This event emitter
         def off(event, &block)
           event_sym = event.to_sym
           if block
@@ -46,6 +50,7 @@ module Puppeteer
           else
             @listeners.delete(event_sym)
           end
+          self
         end
 
         # Remove all listeners for an event or all events

data/lib/puppeteer/bidi/page.rb

@@ -94,34 +94,26 @@ module Puppeteer
       # Register an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: Page -- This page
       def on(event, &block)
-        return @emitter.on(event, &block) unless event.to_sym == :request
-
-        wrapper = @request_handlers[block]
-        unless wrapper
-          wrapper = lambda do |request|
-            request.enqueue_intercept_action do
-              block.call(request)
-            end
-          end
-          @request_handlers[block] = wrapper
-        end
-        @emitter.on(event, &wrapper)
+        listener = event.to_sym == :request ? request_listener_for(block) : block
+        @emitter.on(event, &listener)
+        self
       end
 
       # Register a one-time event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
+      # @rbs return: Page -- This page
       def once(event, &block)
         @emitter.once(event, &block)
+        self
       end
 
       # Remove an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler to remove
-      # @rbs return: void
+      # @rbs return: Page -- This page
       def off(event, &block)
         if event.to_sym == :request && block
           # WeakMap#delete was added in Ruby 3.3, so we need to handle older versions
@@ -130,10 +122,11 @@ module Puppeteer
                     else
                       @request_handlers[block]
                     end
-          return @emitter.off(event, &(wrapper || block))
+          @emitter.off(event, &(wrapper || block))
+        else
+          @emitter.off(event, &block)
         end
-
-        @emitter.off(event, &block)
+        self
       end
 
       # Emit an event to all registered listeners
@@ -1375,6 +1368,14 @@ module Puppeteer
 
       private
 
+      def request_listener_for(listener)
+        @request_handlers[listener] ||= lambda do |request|
+          request.enqueue_intercept_action do
+            listener.call(request)
+          end
+        end
+      end
+
       # Navigate history by delta.
       #
       # In Firefox, BFCache restores may emit `browsingContext.navigationStarted`

data/lib/puppeteer/bidi/transport.rb

@@ -5,7 +5,6 @@ require 'async'
 require 'async/websocket/client'
 require 'async/http/endpoint'
 require 'json'
-require 'uri'
 
 module Puppeteer
   module Bidi
@@ -17,8 +16,7 @@ module Puppeteer
       attr_reader :url
 
       def initialize(url)
-        # BiDi WebSocket endpoint requires /session path
-        @url = url.end_with?('/session') ? url : "#{url}/session"
+        @url = url
         @endpoint = nil
         @connection = nil
         @task = nil

data/lib/puppeteer/bidi/version.rb

@@ -2,7 +2,7 @@
 
 module Puppeteer
   module Bidi
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
     REF_PUPPETEER_VERSION = "25.5.0"
   end
 end

data/sig/puppeteer/bidi/browser.rbs

@@ -119,20 +119,20 @@ module Puppeteer
       # Register event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def on: (String | Symbol event) { (untyped) -> void } -> void
+      # @rbs return: Browser -- This browser
+      def on: (String | Symbol event) { (untyped) -> void } -> Browser
 
       # Register a one-time event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def once: (String | Symbol event) { (untyped) -> void } -> void
+      # @rbs return: Browser -- This browser
+      def once: (String | Symbol event) { (untyped) -> void } -> Browser
 
       # Remove an event handler
       # @rbs event: String | Symbol -- Event name
       # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-      # @rbs return: void
-      def off: (String | Symbol event) ?{ (?) -> untyped } -> void
+      # @rbs return: Browser -- This browser
+      def off: (String | Symbol event) ?{ (?) -> untyped } -> Browser
 
       # Close the browser
       # @rbs return: void

data/sig/puppeteer/bidi/browser_context.rbs

@@ -21,20 +21,20 @@ module Puppeteer
       # Register an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def on: (Symbol | String event) { (untyped) -> void } -> void
+      # @rbs return: BrowserContext -- This browser context
+      def on: (Symbol | String event) { (untyped) -> void } -> BrowserContext
 
       # Register a one-time event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def once: (Symbol | String event) { (untyped) -> void } -> void
+      # @rbs return: BrowserContext -- This browser context
+      def once: (Symbol | String event) { (untyped) -> void } -> BrowserContext
 
       # Remove an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-      # @rbs return: void
-      def off: (Symbol | String event) ?{ (?) -> untyped } -> void
+      # @rbs return: BrowserContext -- This browser context
+      def off: (Symbol | String event) ?{ (?) -> untyped } -> BrowserContext
 
       # Create a new page (tab/window)
       # @rbs background: bool? -- Whether to open the page in background

data/sig/puppeteer/bidi/connection.rbs

@@ -27,14 +27,14 @@ module Puppeteer
       # Subscribe to BiDi events
       # @rbs event: String
       # @rbs &block: (untyped) -> void
-      # @rbs return: void
-      def on: (String event) { (untyped) -> void } -> void
+      # @rbs return: Connection -- This connection
+      def on: (String event) { (untyped) -> void } -> Connection
 
       # Unsubscribe from BiDi events
       # @rbs event: String
       # @rbs &block: ((untyped) -> void)?
-      # @rbs return: void
-      def off: (String event) ?{ (?) -> untyped } -> void
+      # @rbs return: Connection -- This connection
+      def off: (String event) ?{ (?) -> untyped } -> Connection
 
       # Close the connection
       # @rbs return: void

data/sig/puppeteer/bidi/core/event_emitter.rbs

@@ -12,20 +12,20 @@ module Puppeteer
         # Register an event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: (untyped) -> void -- Event handler
-        # @rbs return: void
-        def on: (Symbol | String event) { (untyped) -> void } -> void
+        # @rbs return: EventEmitter -- This event emitter
+        def on: (Symbol | String event) { (untyped) -> void } -> EventEmitter
 
         # Register a one-time event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: (untyped) -> void -- Event handler
-        # @rbs return: void
-        def once: (Symbol | String event) { (untyped) -> void } -> void
+        # @rbs return: EventEmitter -- This event emitter
+        def once: (Symbol | String event) { (untyped) -> void } -> EventEmitter
 
         # Remove an event listener
         # @rbs event: Symbol | String -- Event name
         # @rbs &block: ((untyped) -> void)? -- Event handler to remove
-        # @rbs return: void
-        def off: (Symbol | String event) ?{ (?) -> untyped } -> void
+        # @rbs return: EventEmitter -- This event emitter
+        def off: (Symbol | String event) ?{ (?) -> untyped } -> EventEmitter
 
         # Remove all listeners for an event or all events
         # @rbs event: (Symbol | String)? -- Event name

data/sig/puppeteer/bidi/page.rbs

@@ -23,20 +23,20 @@ module Puppeteer
       # Register an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def on: (Symbol | String event) { (untyped) -> void } -> void
+      # @rbs return: Page -- This page
+      def on: (Symbol | String event) { (untyped) -> void } -> Page
 
       # Register a one-time event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler
-      # @rbs return: void
-      def once: (Symbol | String event) { (untyped) -> void } -> void
+      # @rbs return: Page -- This page
+      def once: (Symbol | String event) { (untyped) -> void } -> Page
 
       # Remove an event listener
       # @rbs event: Symbol | String -- Event name
       # @rbs &block: (untyped) -> void -- Event handler to remove
-      # @rbs return: void
-      def off: (Symbol | String event) { (untyped) -> void } -> void
+      # @rbs return: Page -- This page
+      def off: (Symbol | String event) { (untyped) -> void } -> Page
 
       # Emit an event to all registered listeners
       # @rbs event: Symbol | String -- Event name
@@ -429,6 +429,8 @@ module Puppeteer
 
       private
 
+      def request_listener_for: (untyped listener) -> untyped
+
       # Navigate history by delta.
       #
       # In Firefox, BFCache restores may emit `browsingContext.navigationStarted`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-bidi
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - YusukeIwaki