puppeteer-ruby 0.40.6 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b26b6b3710f06e7a7cfb7e9f5730bbb9517396fd30a7f271161820bb6902c6
-  data.tar.gz: 528fd6520a029cf9d85424a105cf19a156f428435dc795a8b8753c8cbfa442db
+  metadata.gz: 6b06e1f5f867ef4e7d648e93becc953f660bb707b29019ffe6e93f8e9f02acc4
+  data.tar.gz: ff082c6ba661e0f2d8b0d8bc0f92f5aeecf036f9edcd7bb6f8937db4fd019947
 SHA512:
-  metadata.gz: ad616ae1574e76f71cb7e7cb1dae5cba4ae4ad65865ab6a5e6cb92c6033b9ce654de2b364b5d5351e69302f88fc48231c2a9bd97765af9ed827862e762f9d748
-  data.tar.gz: 9a194d8df09c6c6eda97ef095d67dafd693b7ff386e612d926925bdbcf41b3b2a21c06862eff90525e39f85c7d8a5ded419bb8c4b4a3ecb33413c7ccdf47215e
+  metadata.gz: 19b67fb8ef13bac90538e8755905749427a7131bba5088c16f512b51d72833d80ee296ea7537b5122bb531a28d3c95c7924cd199dc6343ab17a1b3d2c391af9b
+  data.tar.gz: c65cb7780075ddea13c60b6c668b8a9a6d53627a8dbfa263f08694777ff10f1a3f3a98eeb2596a6497e0274a3a6d6aafc24a215ee6873c07485dc400444c0c17

data/CHANGELOG.md

@@ -1,7 +1,19 @@
-### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.6...main)]
+### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.42.0...main)]
 
 - xxx
 
+### 0.42.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.41.0...0.42.0)]
+
+- Port Puppeteer v15.3-v15.5 features, including `Frame#page`
+
+### 0.41.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.7...0.41.0)]
+
+- Port Puppeteer v14.0-v15.2 features, including `ElementHandle#wait_for_xpath`
+
+### 0.40.7 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.6...0.40.7)]
+
+- Port Puppeteer v13.6-v13.7 features.
+
 ### 0.40.6 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.40.5...0.40.6)]
 
 - Port Puppeteer v13.1-v13.5 features mainly for request interception.

data/README.md

@@ -229,6 +229,13 @@ end
 
 https://yusukeiwaki.github.io/puppeteer-ruby-docs/
 
+## Limitations
+
+### Not compatible with Firefox >= v97.0
+
+:sos: Help and contribution wanted! :sos:
+https://github.com/YusukeIwaki/puppeteer-ruby/issues/220
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/YusukeIwaki/puppeteer-ruby.

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v13.5.2
-- puppeteer-ruby version: 0.40.6
+- Puppeteer version: v15.5.0
+- puppeteer-ruby version: 0.42.0
 
 ## Puppeteer
 
@@ -14,20 +14,12 @@
 * executablePath => `#executable_path`
 * launch
 * networkConditions => `#network_conditions`
-* product
 * ~~registerCustomQueryHandler~~
 * ~~unregisterCustomQueryHandler~~
 
-## ~~BrowserFetcher~~
+## ~~Accessibility~~
 
-* ~~canDownload~~
-* ~~download~~
-* ~~host~~
-* ~~localRevisions~~
-* ~~platform~~
-* ~~product~~
-* ~~remove~~
-* ~~revisionInfo~~
+* ~~snapshot~~
 
 ## Browser
 
@@ -59,138 +51,55 @@
 * targets
 * waitForTarget => `#wait_for_target`
 
-## Page
-
-* $ => `#query_selector`
-* $$ => `#query_selector_all`
-* $$eval => `#eval_on_selector_all`
-* $eval => `#eval_on_selector`
-* $x => `#Sx`
-* accessibility
-* addScriptTag => `#add_script_tag`
-* addStyleTag => `#add_style_tag`
-* authenticate
-* bringToFront => `#bring_to_front`
-* browser
-* browserContext => `#browser_context`
-* click
-* close
-* content
-* cookies
-* coverage
-* createPDFStream => `#create_pdf_stream`
-* deleteCookie => `#delete_cookie`
-* emulate
-* emulateCPUThrottling => `#emulate_cpu_throttling`
-* emulateIdleState => `#emulate_idle_state`
-* emulateMediaFeatures => `#emulate_media_features`
-* emulateMediaType => `#emulate_media_type`
-* emulateNetworkConditions => `#emulate_network_conditions`
-* emulateTimezone => `#emulate_timezone`
-* emulateVisionDeficiency => `#emulate_vision_deficiency`
-* evaluate
-* evaluateHandle => `#evaluate_handle`
-* evaluateOnNewDocument => `#evaluate_on_new_document`
-* exposeFunction => `#expose_function`
-* focus
-* frames
-* goBack => `#go_back`
-* goForward => `#go_forward`
-* goto
-* hover
-* isClosed => `#closed?`
-* isDragInterceptionEnabled => `#drag_interception_enabled?`
-* isJavaScriptEnabled => `#javascript_enabled?`
-* keyboard
-* mainFrame => `#main_frame`
-* metrics
-* mouse
-* pdf
-* queryObjects => `#query_objects`
-* reload
-* screenshot
-* select
-* setBypassCSP => `#bypass_csp=`
-* setCacheEnabled => `#cache_enabled=`
-* setContent => `#content=`
-* setCookie => `#set_cookie`
-* setDefaultNavigationTimeout => `#default_navigation_timeout=`
-* setDefaultTimeout => `#default_timeout=`
-* ~~setDragInterception~~
-* setExtraHTTPHeaders => `#extra_http_headers=`
-* setGeolocation => `#geolocation=`
-* setJavaScriptEnabled => `#javascript_enabled=`
-* setOfflineMode => `#offline_mode=`
-* setRequestInterception => `#request_interception=`
-* setUserAgent => `#user_agent=`
-* setViewport => `#viewport=`
-* tap
-* target
-* title
-* ~~touchscreen~~
-* tracing
-* type => `#type_text`
-* url
-* viewport
-* ~~waitFor~~
-* waitForFileChooser => `#wait_for_file_chooser`
-* waitForFrame => `#wait_for_frame`
-* waitForFunction => `#wait_for_function`
-* waitForNavigation => `#wait_for_navigation`
-* ~~waitForNetworkIdle~~
-* waitForRequest => `#wait_for_request`
-* waitForResponse => `#wait_for_response`
-* waitForSelector => `#wait_for_selector`
-* waitForTimeout => `#wait_for_timeout`
-* waitForXPath => `#wait_for_xpath`
-* workers
-
-## ~~WebWorker~~
+## ~~BrowserFetcher~~
 
-* ~~evaluate~~
-* ~~evaluateHandle~~
-* ~~executionContext~~
-* ~~url~~
+* ~~canDownload~~
+* ~~download~~
+* ~~host~~
+* ~~localRevisions~~
+* ~~platform~~
+* ~~product~~
+* ~~remove~~
+* ~~revisionInfo~~
 
-## ~~Accessibility~~
+## CDPSession
 
-* ~~snapshot~~
+* connection
+* detach
+* id
+* send
 
-## Keyboard
+## Connection
 
-* down
-* press
-* sendCharacter => `#send_character`
-* type => `#type_text`
-* up
+* createSession => `#create_session`
+* dispose
+* ~~fromSession~~
+* send
+* session
+* url
 
-## Mouse
+## ConsoleMessage
 
-* click
-* down
-* drag
-* dragAndDrop => `#drag_and_drop`
-* dragEnter => `#drag_enter`
-* dragOver => `#drag_over`
-* drop
-* move
-* up
-* wheel
+* args
+* location
+* stackTrace => `#stack_trace`
+* text
+* ~~type~~
 
-## ~~Touchscreen~~
+## Coverage
 
-* ~~tap~~
+* startCSSCoverage => `#start_css_coverage`
+* startJSCoverage => `#start_js_coverage`
+* stopCSSCoverage => `#stop_css_coverage`
+* stopJSCoverage => `#stop_js_coverage`
 
-## Tracing
+## CSSCoverage
 
 * start
 * stop
 
-## FileChooser
+## ~~CustomError~~
 
-* accept
-* cancel
-* isMultiple => `#multiple?`
 
 ## Dialog
 
@@ -200,49 +109,47 @@
 * message
 * type
 
-## ConsoleMessage
-
-* args
-* location
-* stackTrace => `#stack_trace`
-* text
-* ~~type~~
-
-## Frame
+## ElementHandle
 
 * $ => `#query_selector`
 * $$ => `#query_selector_all`
 * $$eval => `#eval_on_selector_all`
 * $eval => `#eval_on_selector`
 * $x => `#Sx`
-* addScriptTag => `#add_script_tag`
-* addStyleTag => `#add_style_tag`
-* childFrames => `#child_frames`
+* asElement => `#as_element`
+* boundingBox => `#bounding_box`
+* boxModel => `#box_model`
 * click
-* content
-* evaluate
-* evaluateHandle => `#evaluate_handle`
-* executionContext => `#execution_context`
+* clickablePoint => `#clickable_point`
+* contentFrame => `#content_frame`
+* drag
+* dragAndDrop => `#drag_and_drop`
+* dragEnter => `#drag_enter`
+* dragOver => `#drag_over`
+* drop
 * focus
-* goto
 * hover
-* isDetached => `#detached?`
-* isOOPFrame => `#oop_frame?`
-* name
-* parentFrame => `#parent_frame`
+* isIntersectingViewport => `#intersecting_viewport?`
+* press
+* screenshot
 * select
-* setContent => `#set_content`
 * tap
-* title
 * type => `#type_text`
-* url
-* ~~waitFor~~
-* waitForFunction => `#wait_for_function`
-* waitForNavigation => `#wait_for_navigation`
+* uploadFile => `#upload_file`
 * waitForSelector => `#wait_for_selector`
-* waitForTimeout => `#wait_for_timeout`
 * waitForXPath => `#wait_for_xpath`
 
+## ~~EventEmitter~~
+
+* ~~addListener~~
+* ~~emit~~
+* ~~listenerCount~~
+* ~~off~~
+* ~~on~~
+* ~~once~~
+* ~~removeAllListeners~~
+* ~~removeListener~~
+
 ## ExecutionContext
 
 * evaluate
@@ -250,53 +157,46 @@
 * frame
 * ~~queryObjects~~
 
-## JSHandle
+## FileChooser
 
-* asElement => `#as_element`
-* dispose
-* evaluate
-* evaluateHandle => `#evaluate_handle`
-* executionContext => `#execution_context`
-* getProperties => `#properties`
-* getProperty => `#[]`
-* jsonValue => `#json_value`
+* accept
+* cancel
+* isMultiple => `#multiple?`
 
-## ElementHandle
+## Frame
 
 * $ => `#query_selector`
 * $$ => `#query_selector_all`
 * $$eval => `#eval_on_selector_all`
 * $eval => `#eval_on_selector`
 * $x => `#Sx`
-* asElement => `#as_element`
-* boundingBox => `#bounding_box`
-* boxModel => `#box_model`
+* addScriptTag => `#add_script_tag`
+* addStyleTag => `#add_style_tag`
+* childFrames => `#child_frames`
 * click
-* clickablePoint => `#clickable_point`
-* contentFrame => `#content_frame`
-* dispose
-* drag
-* dragAndDrop => `#drag_and_drop`
-* dragEnter => `#drag_enter`
-* dragOver => `#drag_over`
-* drop
+* content
 * evaluate
 * evaluateHandle => `#evaluate_handle`
 * executionContext => `#execution_context`
 * focus
-* getProperties => `#properties`
-* getProperty => `#[]`
+* goto
 * hover
-* isIntersectingViewport => `#intersecting_viewport?`
-* jsonValue => `#json_value`
-* press
-* screenshot
+* isDetached => `#detached?`
+* isOOPFrame => `#oop_frame?`
+* name
+* page
+* parentFrame => `#parent_frame`
 * select
+* setContent => `#set_content`
 * tap
-* ~~toString~~
+* title
 * type => `#type_text`
-* uploadFile => `#upload_file`
+* url
+* waitForFunction => `#wait_for_function`
+* waitForNavigation => `#wait_for_navigation`
 * waitForSelector => `#wait_for_selector`
+* waitForTimeout => `#wait_for_timeout`
+* waitForXPath => `#wait_for_xpath`
 
 ## HTTPRequest
 
@@ -340,6 +240,131 @@
 * ~~timing~~
 * url
 
+## JSCoverage
+
+* start
+* stop
+
+## JSHandle
+
+* asElement => `#as_element`
+* dispose
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* executionContext => `#execution_context`
+* getProperties => `#properties`
+* getProperty => `#[]`
+* getProperty => `#[]`
+* jsonValue => `#json_value`
+* remoteObject => `#remote_object`
+* ~~toString~~
+
+## Keyboard
+
+* down
+* press
+* sendCharacter => `#send_character`
+* type => `#type_text`
+* up
+
+## Mouse
+
+* click
+* down
+* drag
+* dragAndDrop => `#drag_and_drop`
+* dragEnter => `#drag_enter`
+* dragOver => `#drag_over`
+* drop
+* move
+* up
+* wheel
+
+## Page
+
+* $ => `#query_selector`
+* $$ => `#query_selector_all`
+* $$eval => `#eval_on_selector_all`
+* $eval => `#eval_on_selector`
+* $x => `#Sx`
+* addScriptTag => `#add_script_tag`
+* addStyleTag => `#add_style_tag`
+* authenticate
+* bringToFront => `#bring_to_front`
+* browser
+* browserContext => `#browser_context`
+* click
+* close
+* content
+* cookies
+* createPDFStream => `#create_pdf_stream`
+* deleteCookie => `#delete_cookie`
+* emulate
+* emulateCPUThrottling => `#emulate_cpu_throttling`
+* emulateIdleState => `#emulate_idle_state`
+* emulateMediaFeatures => `#emulate_media_features`
+* emulateMediaType => `#emulate_media_type`
+* emulateNetworkConditions => `#emulate_network_conditions`
+* emulateTimezone => `#emulate_timezone`
+* emulateVisionDeficiency => `#emulate_vision_deficiency`
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* evaluateOnNewDocument => `#evaluate_on_new_document`
+* exposeFunction => `#expose_function`
+* focus
+* frames
+* goBack => `#go_back`
+* goForward => `#go_forward`
+* goto
+* hover
+* isClosed => `#closed?`
+* isDragInterceptionEnabled => `#drag_interception_enabled?`
+* isJavaScriptEnabled => `#javascript_enabled?`
+* mainFrame => `#main_frame`
+* metrics
+* ~~off~~
+* on
+* once
+* pdf
+* queryObjects => `#query_objects`
+* reload
+* screenshot
+* select
+* setBypassCSP => `#bypass_csp=`
+* setCacheEnabled => `#cache_enabled=`
+* setContent => `#content=`
+* setCookie => `#set_cookie`
+* setDefaultNavigationTimeout => `#default_navigation_timeout=`
+* setDefaultTimeout => `#default_timeout=`
+* ~~setDragInterception~~
+* setExtraHTTPHeaders => `#extra_http_headers=`
+* setGeolocation => `#geolocation=`
+* setJavaScriptEnabled => `#javascript_enabled=`
+* setOfflineMode => `#offline_mode=`
+* setRequestInterception => `#request_interception=`
+* setUserAgent => `#user_agent=`
+* setViewport => `#viewport=`
+* tap
+* target
+* title
+* type => `#type_text`
+* url
+* viewport
+* waitForFileChooser => `#wait_for_file_chooser`
+* waitForFrame => `#wait_for_frame`
+* waitForFunction => `#wait_for_function`
+* waitForNavigation => `#wait_for_navigation`
+* ~~waitForNetworkIdle~~
+* waitForRequest => `#wait_for_request`
+* waitForResponse => `#wait_for_response`
+* waitForSelector => `#wait_for_selector`
+* waitForTimeout => `#wait_for_timeout`
+* waitForXPath => `#wait_for_xpath`
+* workers
+
+## ~~ProtocolError~~
+
+
 ## ~~SecurityDetails~~
 
 * ~~issuer~~
@@ -360,30 +385,21 @@
 * url
 * ~~worker~~
 
-## CDPSession
+## TimeoutError
 
-* connection
-* detach
-* id
-* send
 
-## Coverage
+## ~~Touchscreen~~
 
-* startCSSCoverage => `#start_css_coverage`
-* startJSCoverage => `#start_js_coverage`
-* stopCSSCoverage => `#stop_css_coverage`
-* stopJSCoverage => `#stop_js_coverage`
+* ~~tap~~
 
-## TimeoutError
+## Tracing
 
+* start
+* stop
 
-## ~~EventEmitter~~
+## ~~WebWorker~~
 
-* ~~addListener~~
-* ~~emit~~
-* ~~listenerCount~~
-* ~~off~~
-* ~~on~~
-* ~~once~~
-* ~~removeAllListeners~~
-* ~~removeListener~~
+* ~~evaluate~~
+* ~~evaluateHandle~~
+* ~~executionContext~~
+* ~~url~~

data/lib/puppeteer/browser.rb

@@ -13,7 +13,14 @@ class Puppeteer::Browser
   # @param {?Puppeteer.Viewport} defaultViewport
   # @param process [Puppeteer::BrowserRunner::BrowserProcess|NilClass]
   # @param {function()=} closeCallback
-  def self.create(connection:, context_ids:, ignore_https_errors:, default_viewport:, process:, close_callback:)
+  def self.create(connection:,
+                  context_ids:,
+                  ignore_https_errors:,
+                  default_viewport:,
+                  process:,
+                  close_callback:,
+                  target_filter_callback:,
+                  is_page_target_callback:)
     browser = Puppeteer::Browser.new(
       connection: connection,
       context_ids: context_ids,
@@ -21,6 +28,8 @@ class Puppeteer::Browser
       default_viewport: default_viewport,
       process: process,
       close_callback: close_callback,
+      target_filter_callback: target_filter_callback,
+      is_page_target_callback: is_page_target_callback,
     )
     connection.send_message('Target.setDiscoverTargets', discover: true)
     browser
@@ -32,12 +41,21 @@ class Puppeteer::Browser
   # @param {?Puppeteer.Viewport} defaultViewport
   # @param {?Puppeteer.ChildProcess} process
   # @param {(function():Promise)=} closeCallback
-  def initialize(connection:, context_ids:, ignore_https_errors:, default_viewport:, process:, close_callback:)
+  def initialize(connection:,
+                 context_ids:,
+                 ignore_https_errors:,
+                 default_viewport:,
+                 process:,
+                 close_callback:,
+                 target_filter_callback:,
+                 is_page_target_callback:)
     @ignore_https_errors = ignore_https_errors
     @default_viewport = default_viewport
     @process = process
     @connection = connection
     @close_callback = close_callback
+    @target_filter_callback = target_filter_callback || method(:default_target_filter_callback)
+    @is_page_target_callback = is_page_target_callback || method(:default_is_page_target_callback)
 
     @default_context = Puppeteer::BrowserContext.new(@connection, self, nil)
     @contexts = {}
@@ -54,6 +72,16 @@ class Puppeteer::Browser
     @connection.on_event('Target.targetInfoChanged', &method(:handle_target_info_changed))
   end
 
+  private def default_target_filter_callback(target_info)
+    true
+  end
+
+  private def default_is_page_target_callback(target_info)
+    ['page', 'background_page', 'webview'].include?(target_info.type)
+  end
+
+  attr_reader :is_page_target_callback
+
   # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
   def on(event_name, &block)
     unless BrowserEmittedEvents.values.include?(event_name.to_s)
@@ -119,12 +147,16 @@ class Puppeteer::Browser
     if @targets[target_info.target_id]
       raise TargetAlreadyExistError.new
     end
+
+    return unless @target_filter_callback.call(target_info)
+
     target = Puppeteer::Target.new(
       target_info: target_info,
       browser_context: context,
       session_factory: -> { @connection.create_session(target_info) },
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
+      is_page_target_callback: @is_page_target_callback,
     )
     @targets[target_info.target_id] = target
     if_present(@wait_for_creating_targets.delete(target_info.target_id)) do |promise|

data/lib/puppeteer/browser_context.rb

@@ -50,7 +50,9 @@ class Puppeteer::BrowserContext
 
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
-    targets.select { |target| target.type == 'page' }.map(&:page).reject { |page| !page }
+    targets.select { |target|
+      target.type == 'page' || (target.type == 'other' && @browser.is_page_target_callback&.call(target.target_info))
+    }.map(&:page).reject { |page| !page }
   end
 
   def incognito?

data/lib/puppeteer/browser_runner.rb

@@ -128,7 +128,7 @@ class Puppeteer::BrowserRunner
   def close
     return if @closed
 
-    if @using_temp_user_data_dir && !@for_firefox
+    if @using_temp_user_data_dir
       kill
     elsif @connection
       begin

data/lib/puppeteer/connection.rb

@@ -191,6 +191,7 @@ class Puppeteer::Connection
       'Network.responseReceived',
       'Network.responseReceivedExtraInfo',
       'Page.lifecycleEvent',
+      'Target.receivedMessageFromTarget', # only Firefox
     ]
 
     def handle_message(message)